openscenegraph
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
osgTerrain::Terrain Class Reference
Inheritance diagram for osgTerrain::Terrain:
osg::CoordinateSystemNode osg::Group osg::Node osg::Object osg::Referenced

Public Member Functions

 Terrain ()
 Terrain (const Terrain &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Node (osgTerrain, Terrain)
virtual void traverse (osg::NodeVisitor &nv)
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
void setSampleRatio (float ratio)
float getSampleRatio () const
void setVerticalScale (float scale)
float getVerticalScale () const
void setEqualizeBoundaries (bool equalizeBoundaries)
bool getEqualizeBoundaries () const
void setBlendingPolicy (TerrainTile::BlendingPolicy policy)
TerrainTile::BlendingPolicy getBlendingPolicy () const
TerrainTilegetTile (const TileID &tileID)
const TerrainTilegetTile (const TileID &tileID) const
void setTerrainTechniquePrototype (TerrainTechnique *technique)
TerrainTechniquegetTerrainTechniquePrototype ()
const TerrainTechniquegetTerrainTechniquePrototype () const
void updateTerrainTileOnNextFrame (TerrainTile *terrainTile)
- Public Member Functions inherited from osg::CoordinateSystemNode
 CoordinateSystemNode ()
 CoordinateSystemNode (const std::string &format, const std::string &cs)
 CoordinateSystemNode (const CoordinateSystemNode &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Node (osg, CoordinateSystemNode)
void set (const CoordinateSystemNode &csn)
void setFormat (const std::string &format)
const std::string & getFormat () const
void setCoordinateSystem (const std::string &cs)
const std::string & getCoordinateSystem () const
void setEllipsoidModel (EllipsoidModel *ellipsode)
EllipsoidModelgetEllipsoidModel ()
const EllipsoidModelgetEllipsoidModel () const
CoordinateFrame computeLocalCoordinateFrame (const Vec3d &position) const
osg::Vec3d computeLocalUpVector (const Vec3d &position) const
- Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Group)
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual bool addChild (Node *child)
virtual bool insertChild (unsigned int index, Node *child)
bool removeChild (Node *child)
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
virtual bool replaceChild (Node *origChild, Node *newChild)
unsigned int getNumChildren () const
virtual bool setChild (unsigned int i, Node *node)
NodegetChild (unsigned int i)
const NodegetChild (unsigned int i) const
bool containsNode (const Node *node) const
unsigned int getChildIndex (const Node *node) const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *=0) const
virtual BoundingSphere computeBound () const
- Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual void accept (NodeVisitor &nv)
virtual void ascend (NodeVisitor &nv)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Protected Types

typedef std::map< TileID,
TerrainTile * > 
TerrainTileMap
typedef std::set< TerrainTile * > TerrainTileSet

Protected Member Functions

virtual ~Terrain ()
void dirtyRegisteredTiles (int dirtyMask=TerrainTile::ALL_DIRTY)
void registerTerrainTile (TerrainTile *tile)
void unregisterTerrainTile (TerrainTile *tile)
- Protected Member Functions inherited from osg::CoordinateSystemNode
virtual ~CoordinateSystemNode ()
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
virtual void childRemoved (unsigned int, unsigned int)
virtual void childInserted (unsigned int)
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

float _sampleRatio
float _verticalScale
TerrainTile::BlendingPolicy _blendingPolicy
bool _equalizeBoundaries
OpenThreads::Mutex _mutex
TerrainTileSet _terrainTileSet
TerrainTileMap _terrainTileMap
TerrainTileSet _updateTerrainTileSet
osg::ref_ptr< TerrainTechnique_terrainTechnique
- Protected Attributes inherited from osg::CoordinateSystemNode
std::string _format
std::string _cs
ref_ptr< EllipsoidModel_ellipsoidModel
- Protected Attributes inherited from osg::Group
NodeList _children
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
ref_ptr
< ComputeBoundingSphereCallback
_computeBoundCallback
BoundingSphere _boundingSphere
bool _boundingSphereComputed
ParentList _parents
ref_ptr< NodeCallback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< NodeCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< NodeCallback_cullCallback
bool _cullingActive
unsigned int _numChildrenWithCullingDisabled
unsigned int _numChildrenWithOccluderNodes
NodeMask _nodeMask
ref_ptr< StateSet_stateset
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Friends

class TerrainTile

Additional Inherited Members

- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
typedef unsigned int NodeMask
typedef std::vector< std::string > DescriptionList
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

Detailed Description

Terrain provides a framework for loosely coupling height field data with height rendering algorithms. This allows TerrainTechniques to be plugged in at runtime.

Member Typedef Documentation

typedef std::map< TileID, TerrainTile* > osgTerrain::Terrain::TerrainTileMap
protected
typedef std::set< TerrainTile* > osgTerrain::Terrain::TerrainTileSet
protected

Constructor & Destructor Documentation

osgTerrain::Terrain::Terrain ( )
osgTerrain::Terrain::Terrain ( const Terrain ,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osgTerrain::Terrain::~Terrain ( )
protectedvirtual

Member Function Documentation

virtual osgTerrain::Terrain* osgTerrain::Terrain::asTerrain ( )
inlinevirtual

Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. Equivalent to dynamic_cast<Terrrain*>(this).

Reimplemented from osg::Node.

virtual const osgTerrain::Terrain* osgTerrain::Terrain::asTerrain ( ) const
inlinevirtual

convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. Equivalent to dynamic_cast<const Terrain*>(this).

Reimplemented from osg::Node.

void osgTerrain::Terrain::dirtyRegisteredTiles ( int  dirtyMask = TerrainTile::ALL_DIRTY)
protected
TerrainTile::BlendingPolicy osgTerrain::Terrain::getBlendingPolicy ( ) const
inline

Get the default policy to use when deciding whether to enable/disable blending and use of transparent bin.

bool osgTerrain::Terrain::getEqualizeBoundaries ( ) const
inline

If true the boundaries between adjacent tiles will be equalized.

float osgTerrain::Terrain::getSampleRatio ( ) const
inline

Get the sample ratio hint.

TerrainTechnique* osgTerrain::Terrain::getTerrainTechniquePrototype ( )
inline

Get the TerrainTechnique prototype

const TerrainTechnique* osgTerrain::Terrain::getTerrainTechniquePrototype ( ) const
inline

Get the const TerrainTechnique protype

TerrainTile* osgTerrain::Terrain::getTile ( const TileID tileID)

Get the TerrainTile for a given TileID.

const TerrainTile* osgTerrain::Terrain::getTile ( const TileID tileID) const

Get the const TerrainTile for a given TileID.

float osgTerrain::Terrain::getVerticalScale ( ) const
inline

Get the vertical scale hint.

osgTerrain::Terrain::META_Node ( osgTerrain  ,
Terrain   
)
void osgTerrain::Terrain::registerTerrainTile ( TerrainTile tile)
protected
void osgTerrain::Terrain::setBlendingPolicy ( TerrainTile::BlendingPolicy  policy)

Set the default policy to use when deciding whether to enable/disable blending and use of transparent bin. Note, the Terrain::BlendingPolicy value only sets the value for the TerrainTiles it encloses for the TerrainTile's that have their policy set to INHERIT. INHERIT is the default BlendingPolicy for both Terrain and TerrainTile, and if both are left to INERHIT then the policy used is ENABLE_BLENDING_WHEN_ALPHA_PRESENT.

void osgTerrain::Terrain::setEqualizeBoundaries ( bool  equalizeBoundaries)

If set to true the boundaries between adjacent tiles should be equalized. Note, it is only possible to equalizae boundaries when the TerrainTile's contain properly assigned TileID's, databases built with VirtualPlanetBuilder-0.9.11 and older do not set the TileID, so databases must be built with later versions of VirtualPlanetBuilder to take advantage of boundary equalization.

void osgTerrain::Terrain::setSampleRatio ( float  ratio)

Set the sample ratio hint that TerrainTile should use when building geometry. Defaults to 1.0, which means use all original sample points.

void osgTerrain::Terrain::setTerrainTechniquePrototype ( TerrainTechnique technique)
inline

Set the TerrainTechnique prototype from which TerrainTiles can clone the techniques from.

void osgTerrain::Terrain::setVerticalScale ( float  scale)

Set the vertical scale hint.

virtual void osgTerrain::Terrain::traverse ( osg::NodeVisitor )
virtual

Traverse downwards : calls children's accept method with NodeVisitor.

Reimplemented from osg::Group.

void osgTerrain::Terrain::unregisterTerrainTile ( TerrainTile tile)
protected
void osgTerrain::Terrain::updateTerrainTileOnNextFrame ( TerrainTile terrainTile)

Tell the Terrain node to call the terrainTile's TerrainTechnique on the next update traversal.

Friends And Related Function Documentation

friend class TerrainTile
friend

Member Data Documentation

TerrainTile::BlendingPolicy osgTerrain::Terrain::_blendingPolicy
protected
bool osgTerrain::Terrain::_equalizeBoundaries
protected
OpenThreads::Mutex osgTerrain::Terrain::_mutex
mutableprotected
float osgTerrain::Terrain::_sampleRatio
protected
osg::ref_ptr<TerrainTechnique> osgTerrain::Terrain::_terrainTechnique
protected
TerrainTileMap osgTerrain::Terrain::_terrainTileMap
protected
TerrainTileSet osgTerrain::Terrain::_terrainTileSet
protected
TerrainTileSet osgTerrain::Terrain::_updateTerrainTileSet
protected
float osgTerrain::Terrain::_verticalScale
protected

The documentation for this class was generated from the following file: