openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Geode Class Reference

#include <Geode>

Inheritance diagram for osg::Geode:
osg::Group osg::Node osg::Object osg::Referenced osg::Billboard osgSim::ScalarBar osgSim::SphereSegment osgWidget::Browser osgWidget::PdfReader osgWidget::VncClient

Public Member Functions

 Geode ()
 
 Geode (const Geode &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, Geode)
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual bool addDrawable (Drawable *drawable)
 
template<class T >
bool addDrawable (const ref_ptr< T > &drawable)
 
virtual bool removeDrawable (Drawable *drawable)
 
template<class T >
bool removeDrawable (const ref_ptr< T > &drawable)
 
virtual bool removeDrawables (unsigned int i, unsigned int numDrawablesToRemove=1)
 
virtual bool replaceDrawable (Drawable *origDraw, Drawable *newDraw)
 
template<class T , class R >
bool replaceDrawable (const ref_ptr< T > &origDraw, const ref_ptr< R > &newDraw)
 
virtual bool setDrawable (unsigned int i, Drawable *drawable)
 
template<class T >
bool setDrawable (unsigned int i, const ref_ptr< T > &drawable)
 
unsigned int getNumDrawables () const
 
DrawablegetDrawable (unsigned int i)
 
const DrawablegetDrawable (unsigned int i) const
 
bool containsDrawable (const Drawable *drawable) const
 
template<class T >
bool containsDrawable (const ref_ptr< T > &drawable) const
 
unsigned int getDrawableIndex (const Drawable *drawable) const
 
template<class T >
unsigned int getDrawableIndex (const ref_ptr< T > &drawable) const
 
void compileDrawables (RenderInfo &renderInfo)
 
const BoundingBoxgetBoundingBox () const
 
virtual BoundingSphere computeBound () 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 void traverse (NodeVisitor &nv)
 
virtual bool addChild (Node *child)
 
template<class T >
bool addChild (const ref_ptr< T > &child)
 
virtual bool insertChild (unsigned int index, Node *child)
 
template<class T >
bool insertChild (unsigned int index, const ref_ptr< T > &child)
 
virtual bool removeChild (Node *child)
 
template<class T >
bool removeChild (const ref_ptr< T > &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)
 
template<class T , class R >
bool replaceChild (const ref_ptr< T > &origChild, const ref_ptr< R > &newChild)
 
virtual 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
 
template<class T >
bool containsNode (const ref_ptr< T > &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
 
- 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 NodeasNode ()
 
virtual const NodeasNode () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual GeometryasGeometry ()
 
virtual const GeometryasGeometry () const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () 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 (Callback *nc)
 
template<class T >
void setUpdateCallback (const ref_ptr< T > &nc)
 
CallbackgetUpdateCallback ()
 
const CallbackgetUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
template<class T >
void addUpdateCallback (const ref_ptr< T > &nc)
 
void removeUpdateCallback (Callback *nc)
 
template<class T >
void removeUpdateCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
template<class T >
void setEventCallback (const ref_ptr< T > &nc)
 
CallbackgetEventCallback ()
 
const CallbackgetEventCallback () const
 
void addEventCallback (Callback *nc)
 
template<class T >
void addEventCallback (const ref_ptr< T > &nc)
 
void removeEventCallback (Callback *nc)
 
template<class T >
void removeEventCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
template<class T >
void setCullCallback (const ref_ptr< T > &nc)
 
CallbackgetCullCallback ()
 
const CallbackgetCullCallback () const
 
void addCullCallback (Callback *nc)
 
template<class T >
void addCullCallback (const ref_ptr< T > &nc)
 
void removeCullCallback (Callback *nc)
 
template<class T >
void removeCullCallback (const ref_ptr< T > &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)
 
template<class T >
void setStateSet (const osg::ref_ptr< T > &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)
 
template<class T >
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
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)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
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)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- 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 Member Functions

virtual ~Geode ()
 
- 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 *parent)
 
void removeParent (osg::Group *parent)
 
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

osg::BoundingBox _bbox
 
- 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< Callback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< Callback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< Callback_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

- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 
typedef unsigned int NodeMask
 
typedef std::vector< std::string > DescriptionList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

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.

Constructor & Destructor Documentation

◆ Geode() [1/2]

osg::Geode::Geode ( )

◆ Geode() [2/2]

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

Copy constructor using CopyOp to manage deep vs shallow copy.

◆ ~Geode()

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

Member Function Documentation

◆ addDrawable() [1/2]

template<class T >
bool osg::Geode::addDrawable ( const ref_ptr< T > &  drawable)
inline

◆ addDrawable() [2/2]

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.

◆ asGeode() [1/2]

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.

◆ asGeode() [2/2]

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.

◆ compileDrawables()

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

Compile OpenGL Display List for each drawable.

◆ computeBound()

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::Group.

Reimplemented in osg::Billboard, and osgSim::SphereSegment.

◆ containsDrawable() [1/2]

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

Return true if a given Drawable is contained within Geode.

◆ containsDrawable() [2/2]

template<class T >
bool osg::Geode::containsDrawable ( const ref_ptr< T > &  drawable) const
inline

◆ getBoundingBox()

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.

◆ getDrawable() [1/2]

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

Return the Drawable at position i.

◆ getDrawable() [2/2]

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

Return the Drawable at position i.

◆ getDrawableIndex() [1/2]

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.

◆ getDrawableIndex() [2/2]

template<class T >
unsigned int osg::Geode::getDrawableIndex ( const ref_ptr< T > &  drawable) const
inline

◆ getNumDrawables()

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

Return the number of Drawables currently attached to the Geode.

◆ META_Node()

osg::Geode::META_Node ( osg  ,
Geode   
)

◆ removeDrawable() [1/2]

template<class T >
bool osg::Geode::removeDrawable ( const ref_ptr< T > &  drawable)
inline

◆ removeDrawable() [2/2]

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.

◆ removeDrawables()

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.

◆ replaceDrawable() [1/2]

template<class T , class R >
bool osg::Geode::replaceDrawable ( const ref_ptr< T > &  origDraw,
const ref_ptr< R > &  newDraw 
)
inline

◆ replaceDrawable() [2/2]

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.

◆ setDrawable() [1/2]

template<class T >
bool osg::Geode::setDrawable ( unsigned int  i,
const ref_ptr< T > &  drawable 
)
inline

◆ setDrawable() [2/2]

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).

Member Data Documentation

◆ _bbox

osg::BoundingBox osg::Geode::_bbox
mutableprotected

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