openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Geode Class Reference
Inheritance diagram for osg::Geode:
osg::Node osg::Object osg::Referenced osg::Billboard osgSim::ScalarBar osgSim::SphereSegment osgWidget::Browser osgWidget::PdfReader osgWidget::VncClient

Public Types

typedef std::vector< ref_ptr< Drawable > > DrawableList
 
- 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 }
 

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)
 
virtual bool removeDrawable (Drawable *drawable)
 
virtual bool removeDrawables (unsigned int i, unsigned int numDrawablesToRemove=1)
 
virtual bool replaceDrawable (Drawable *origDraw, Drawable *newDraw)
 
virtual bool setDrawable (unsigned int i, Drawable *drawable)
 
unsigned int getNumDrawables () const
 
DrawablegetDrawable (unsigned int i)
 
const DrawablegetDrawable (unsigned int i) const
 
bool containsDrawable (const Drawable *gset) const
 
unsigned int getDrawableIndex (const Drawable *drawable) const
 
const DrawableListgetDrawableList () const
 
void compileDrawables (RenderInfo &renderInfo)
 
const BoundingBoxgetBoundingBox () const
 
virtual BoundingSphere computeBound () 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 GroupasGroup ()
 
virtual const GroupasGroup () const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () 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)
 
virtual void traverse (NodeVisitor &)
 
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 ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () 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)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject 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::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

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::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
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.

Member Typedef Documentation

§ DrawableList

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

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

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

Reimplemented in osg::Billboard.

§ containsDrawable()

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

Return true if a given Drawable is contained within Geode.

§ 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()

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.

§ getDrawableList()

const DrawableList& osg::Geode::getDrawableList ( ) const
inline

Get the list of drawables.

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

§ releaseGLObjects()

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.

§ removeDrawable()

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

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.

§ resizeGLObjectBuffers()

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Node.

§ setDrawable()

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

§ setThreadSafeRefUnref()

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

§ _bbox

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

§ _drawables

DrawableList osg::Geode::_drawables
protected

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