OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Geode Class Reference

A Geode is a "geometry node", that is, a leaf node on the scene graph that can have "renderable things" attached to it. More...

Inheritance diagram for osg::Geode:
Inheritance graph
[legend]

Public Types

typedef std::vector< ref_ptr
< Drawable > > 
DrawableList
 
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 A vector of osg::Group pointers which is used to store the parent(s) of node. More...
 
typedef unsigned int NodeMask
 This is a set of bits (flags) that represent the Node. More...
 
typedef std::vector< std::string > DescriptionList
 A vector of std::string's which are used to describe the object. More...
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Geode ()
 
 Geode (const Geode &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
 META_Node (osg, Geode)
 
virtual GeodeasGeode ()
 Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0. More...
 
virtual const GeodeasGeode () const
 convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0. More...
 
virtual bool addDrawable (Drawable *drawable)
 Add a Drawable to the Geode. More...
 
virtual bool removeDrawable (Drawable *drawable)
 Remove a Drawable from the Geode. More...
 
virtual bool removeDrawables (unsigned int i, unsigned int numDrawablesToRemove=1)
 Remove Drawable(s) from the specified position in Geode's drawable list. More...
 
virtual bool replaceDrawable (Drawable *origDraw, Drawable *newDraw)
 Replace specified Drawable with another Drawable. More...
 
virtual bool setDrawable (unsigned int i, Drawable *drawable)
 Set Drawable at position i. More...
 
unsigned int getNumDrawables () const
 Return the number of Drawables currently attached to the Geode. More...
 
DrawablegetDrawable (unsigned int i)
 Return the Drawable at position i. More...
 
const DrawablegetDrawable (unsigned int i) const
 Return the Drawable at position i. More...
 
bool containsDrawable (const Drawable *gset) const
 Return true if a given Drawable is contained within Geode. More...
 
unsigned int getDrawableIndex (const Drawable *drawable) const
 Get the index number of drawable. More...
 
const DrawableListgetDrawableList () const
 Get the list of drawables. More...
 
void compileDrawables (RenderInfo &renderInfo)
 Compile OpenGL Display List for each drawable. More...
 
const BoundingBoxgetBoundingBox () const
 Return the Geode's bounding box, which is the union of all the bounding boxes of the geode's drawables. More...
 
virtual BoundingSphere computeBound () const
 Compute the bounding sphere around Node's geometry or children. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
- Public Member Functions inherited from osg::Node
 Node ()
 Construct a node. More...
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
virtual ObjectcloneType () const
 clone an object of the same type as the node. More...
 
virtual Objectclone (const CopyOp &copyop) const
 return a clone of a node, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *obj) const
 return true if this and obj are of the same kind of object. More...
 
virtual const char * libraryName () const
 return the name of the node's library. More...
 
virtual const char * className () const
 return the name of the node's class type. More...
 
virtual GroupasGroup ()
 convert 'this' into a Group pointer if Node is a Group, otherwise return 0. More...
 
virtual const GroupasGroup () const
 convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. More...
 
virtual TransformasTransform ()
 Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. More...
 
virtual const TransformasTransform () const
 convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. More...
 
virtual SwitchasSwitch ()
 Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0. More...
 
virtual const SwitchasSwitch () const
 convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0. More...
 
virtual osgTerrain::TerrainasTerrain ()
 Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. More...
 
virtual const osgTerrain::TerrainasTerrain () const
 convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. More...
 
virtual void accept (NodeVisitor &nv)
 Visitor Pattern : calls the apply method of a NodeVisitor with this node's type. More...
 
virtual void ascend (NodeVisitor &nv)
 Traverse upwards : calls parents' accept method with NodeVisitor. More...
 
virtual void traverse (NodeVisitor &)
 Traverse downwards : calls children's accept method with NodeVisitor. More...
 
const ParentListgetParents () const
 Get the parent list of node. More...
 
ParentList getParents ()
 Get the a copy of parent list of node. More...
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 Get a single const parent of node. More...
 
unsigned int getNumParents () const
 Get the number of parents of node. More...
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 Get the list of node paths parent paths. More...
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates. More...
 
void setUpdateCallback (NodeCallback *nc)
 Set update node callback, called during update traversal. More...
 
NodeCallbackgetUpdateCallback ()
 Get update node callback, called during update traversal. More...
 
const NodeCallbackgetUpdateCallback () const
 Get const update node callback, called during update traversal. More...
 
void addUpdateCallback (NodeCallback *nc)
 Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one. More...
 
void removeUpdateCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested. More...
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children. More...
 
void setEventCallback (NodeCallback *nc)
 Set event node callback, called during event traversal. More...
 
NodeCallbackgetEventCallback ()
 Get event node callback, called during event traversal. More...
 
const NodeCallbackgetEventCallback () const
 Get const event node callback, called during event traversal. More...
 
void addEventCallback (NodeCallback *nc)
 Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one. More...
 
void removeEventCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested. More...
 
unsigned int getNumChildrenRequiringEventTraversal () const
 Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children. More...
 
void setCullCallback (NodeCallback *nc)
 Set cull node callback, called during cull traversal. More...
 
NodeCallbackgetCullCallback ()
 Get cull node callback, called during cull traversal. More...
 
const NodeCallbackgetCullCallback () const
 Get const cull node callback, called during cull traversal. More...
 
void addCullCallback (NodeCallback *nc)
 Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one. More...
 
void removeCullCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested. More...
 
void setCullingActive (bool active)
 Set the view frustum/small feature culling of this node to be active or inactive. More...
 
bool getCullingActive () const
 Get the view frustum/small feature _cullingActive flag for this node. More...
 
unsigned int getNumChildrenWithCullingDisabled () const
 Get the number of Children of this node which have culling disabled. More...
 
bool isCullingActive () const
 Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. More...
 
unsigned int getNumChildrenWithOccluderNodes () const
 Get the number of Children of this node which are or have OccluderNode's. More...
 
bool containsOccluderNodes () const
 return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes. More...
 
void setNodeMask (NodeMask nm)
 Set the node mask. More...
 
NodeMask getNodeMask () const
 Get the node Mask. More...
 
void setStateSet (osg::StateSet *stateset)
 Set the node's StateSet. More...
 
osg::StateSetgetOrCreateStateSet ()
 return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet. More...
 
osg::StateSetgetStateSet ()
 Return the node's StateSet. More...
 
const osg::StateSetgetStateSet () const
 Return the node's const StateSet. More...
 
void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions. More...
 
DescriptionListgetDescriptions ()
 Get the description list of the node. More...
 
const DescriptionListgetDescriptions () const
 Get the const description list of the const node. More...
 
const std::string & getDescription (unsigned int i) const
 Get a single const description of the const node. More...
 
std::string & getDescription (unsigned int i)
 Get a single description of the node. More...
 
unsigned int getNumDescriptions () const
 Get the number of descriptions of the node. More...
 
void addDescription (const std::string &desc)
 Add a description string to the node. More...
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
const BoundingSpheregetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume. More...
 
void dirtyBound ()
 Mark this node's bounding sphere dirty. More...
 
const BoundingSpheregetBound () const
 Get the bounding sphere of node. More...
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 Set the compute bound callback to override the default computeBound. More...
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 Get the compute bound callback. More...
 
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
 Get the const compute bound callback. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject bool 
getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

virtual ~Geode ()
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 Node destructor. More...
 
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 ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

osg::BoundingBox _bbox
 
DrawableList _drawables
 
- 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
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

A Geode is a "geometry node", that is, a leaf node on the scene graph that can have "renderable things" attached to it.

In OSG, renderable things are represented by objects from the Drawable class, so a Geode is a Node whose purpose is grouping Drawables.

Member Typedef Documentation

typedef std::vector< ref_ptr<Drawable> > osg::Geode::DrawableList

Constructor & Destructor Documentation

osg::Geode::Geode ( )
osg::Geode::Geode ( const Geode ,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Geode::~Geode ( )
protectedvirtual

Member Function Documentation

virtual bool osg::Geode::addDrawable ( Drawable drawable)
virtual

Add a Drawable to the Geode.

If drawable is not NULL and is not contained in the Geode then increment its reference count, add it to the drawables list and dirty the bounding sphere to force it to be recomputed on the next call to getBound().

Parameters
drawableThe Drawable to be added to the Geode.
Returns
true for success; false otherwise.

Reimplemented in osg::Billboard.

virtual Geode* osg::Geode::asGeode ( )
inlinevirtual

Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.

Equivalent to dynamic_cast<Geode*>(this).

Reimplemented from osg::Node.

virtual const Geode* osg::Geode::asGeode ( ) const
inlinevirtual

convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.

Equivalent to dynamic_cast<const Geode*>(this).

Reimplemented from osg::Node.

void osg::Geode::compileDrawables ( RenderInfo renderInfo)

Compile OpenGL Display List for each drawable.

virtual BoundingSphere osg::Geode::computeBound ( ) const
virtual

Compute the bounding sphere around Node's geometry or children.

This method is automatically called by getBound() when the bounding sphere has been marked dirty via dirtyBound().

Reimplemented from osg::Node.

Reimplemented in osg::Billboard.

bool osg::Geode::containsDrawable ( const Drawable gset) const
inline

Return true if a given Drawable is contained within Geode.

const BoundingBox& osg::Geode::getBoundingBox ( ) const
inline

Return the Geode's bounding box, which is the union of all the bounding boxes of the geode's drawables.

Drawable* osg::Geode::getDrawable ( unsigned int  i)
inline

Return the Drawable at position i.

Referenced by osgUtil::Simplifier::apply().

const Drawable* osg::Geode::getDrawable ( unsigned int  i) const
inline

Return the Drawable at position i.

unsigned int osg::Geode::getDrawableIndex ( const Drawable drawable) const
inline

Get the index number of drawable.

Returns
A value between 0 and getNumDrawables()-1 if drawable is found; if not found, then getNumDrawables() is returned.
const DrawableList& osg::Geode::getDrawableList ( ) const
inline

Get the list of drawables.

unsigned int osg::Geode::getNumDrawables ( ) const
inline

Return the number of Drawables currently attached to the Geode.

Referenced by osgUtil::Simplifier::apply().

osg::Geode::META_Node ( osg  ,
Geode   
)
virtual void osg::Geode::releaseGLObjects ( osg::State = 0) const
virtual

If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.

Otherwise, releases OpenGL objects for all graphics contexts.

Reimplemented from osg::Node.

virtual bool osg::Geode::removeDrawable ( Drawable drawable)
virtual

Remove a Drawable from the Geode.

Equivalent to removeDrawable(getDrawableIndex(drawable).

Parameters
drawableThe drawable to be removed.
Returns
true if at least one Drawable was removed. false otherwise.

Reimplemented in osg::Billboard.

virtual bool osg::Geode::removeDrawables ( unsigned int  i,
unsigned int  numDrawablesToRemove = 1 
)
virtual

Remove Drawable(s) from the specified position in Geode's drawable list.

Parameters
iThe index of the first Drawable to remove.
numDrawablesToRemoveThe number of Drawable to remove.
Returns
true if at least one Drawable was removed. false otherwise.
virtual bool osg::Geode::replaceDrawable ( Drawable origDraw,
Drawable newDraw 
)
virtual

Replace specified Drawable with another Drawable.

Equivalent to setDrawable(getDrawableIndex(origDraw),newDraw), see docs for setDrawable() for further details on implementation.

virtual void osg::Geode::resizeGLObjectBuffers ( unsigned int  maxSize)
virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Node.

virtual bool osg::Geode::setDrawable ( unsigned int  i,
Drawable drawable 
)
virtual

Set Drawable at position i.

Decrement the reference count origGSet and increments the reference count of newGset, and dirty the bounding sphere to force it to recompute on next getBound() and returns true. If origDrawable is not found then return false and do not add newGset. If newGset is NULL then return false and do not remove origGset.

Returns
true if set correctly, false on failure (if node==NULL || i is out of range).
virtual void osg::Geode::setThreadSafeRefUnref ( bool  threadSafe)
virtual

Set whether to use a mutex to ensure ref() and unref() are thread safe.

Reimplemented from osg::Node.

Member Data Documentation

osg::BoundingBox osg::Geode::_bbox
mutableprotected
DrawableList osg::Geode::_drawables
protected

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

osg logo
Generated at Fri Mar 1 2013 18:58:21 for the OpenSceneGraph by doxygen 1.8.3.1.