OpenSceneGraph  3.5.1
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
osgUtil::StateGraph Class Reference

StateGraph - contained in a renderBin, defines the scene to be drawn. More...

Inheritance diagram for osgUtil::StateGraph:
Inheritance graph
[legend]

Public Types

typedef std::map< const osg::StateSet *, osg::ref_ptr< StateGraph > > ChildList
 
typedef std::vector< osg::ref_ptr< RenderLeaf > > LeafList
 

Public Member Functions

 StateGraph ()
 
 StateGraph (StateGraph *parent, const osg::StateSet *stateset)
 
 ~StateGraph ()
 
StateGraphcloneType () const
 
void setUserData (osg::Referenced *obj)
 
osg::ReferencedgetUserData ()
 
const osg::ReferencedgetUserData () const
 
void setStateSet (const osg::StateSet *stateset)
 
const osg::StateSetgetStateSet () const
 
bool empty () const
 return true if all of drawables, lights and children are empty. More...
 
bool leaves_empty () const
 
float getAverageDistance () const
 
float getMinimumDistance () const
 
void sortFrontToBack ()
 
void reset ()
 Reset the internal contents of a StateGraph, including deleting all children. More...
 
void clean ()
 Recursively clean the StateGraph of all its drawables, lights and depths. More...
 
void prune ()
 Recursively prune the StateGraph of empty children. More...
 
StateGraphfind_or_insert (const osg::StateSet *stateset)
 
void addLeaf (RenderLeaf *leaf)
 add a render leaf. More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
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 no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer 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...
 

Static Public Member Functions

static void moveStateGraph (osg::State &state, StateGraph *sg_curr, StateGraph *sg_new)
 
static void moveToRootStateGraph (osg::State &state, StateGraph *sg_curr)
 
static int numToPop (StateGraph *sg_curr)
 
- 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...
 

Public Attributes

StateGraph_parent
 
const osg::StateSet_stateset
 
int _depth
 
ChildList _children
 
LeafList _leaves
 
float _averageDistance
 
float _minimumDistance
 
osg::ref_ptr< osg::Referenced_userData
 
bool _dynamic
 

Additional Inherited Members

- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Detailed Description

StateGraph - contained in a renderBin, defines the scene to be drawn.

Member Typedef Documentation

Constructor & Destructor Documentation

osgUtil::StateGraph::StateGraph ( )
inline
osgUtil::StateGraph::StateGraph ( StateGraph parent,
const osg::StateSet stateset 
)
inline
osgUtil::StateGraph::~StateGraph ( )
inline

Member Function Documentation

void osgUtil::StateGraph::addLeaf ( RenderLeaf leaf)
inline

add a render leaf.

void osgUtil::StateGraph::clean ( )

Recursively clean the StateGraph of all its drawables, lights and depths.

Leaves children intact, and ready to be populated again.

StateGraph* osgUtil::StateGraph::cloneType ( ) const
inline
bool osgUtil::StateGraph::empty ( ) const
inline

return true if all of drawables, lights and children are empty.

StateGraph* osgUtil::StateGraph::find_or_insert ( const osg::StateSet stateset)
inline
float osgUtil::StateGraph::getAverageDistance ( ) const
inline
float osgUtil::StateGraph::getMinimumDistance ( ) const
inline
const osg::StateSet* osgUtil::StateGraph::getStateSet ( ) const
inline
osg::Referenced* osgUtil::StateGraph::getUserData ( )
inline
const osg::Referenced* osgUtil::StateGraph::getUserData ( ) const
inline
bool osgUtil::StateGraph::leaves_empty ( ) const
inline
static void osgUtil::StateGraph::moveStateGraph ( osg::State state,
StateGraph sg_curr,
StateGraph sg_new 
)
inlinestatic
static void osgUtil::StateGraph::moveToRootStateGraph ( osg::State state,
StateGraph sg_curr 
)
inlinestatic
static int osgUtil::StateGraph::numToPop ( StateGraph sg_curr)
inlinestatic
void osgUtil::StateGraph::prune ( )

Recursively prune the StateGraph of empty children.

void osgUtil::StateGraph::reset ( )

Reset the internal contents of a StateGraph, including deleting all children.

void osgUtil::StateGraph::setStateSet ( const osg::StateSet stateset)
inline
void osgUtil::StateGraph::setUserData ( osg::Referenced obj)
inline
void osgUtil::StateGraph::sortFrontToBack ( )
inline

Member Data Documentation

float osgUtil::StateGraph::_averageDistance
mutable
ChildList osgUtil::StateGraph::_children
int osgUtil::StateGraph::_depth
bool osgUtil::StateGraph::_dynamic
LeafList osgUtil::StateGraph::_leaves
float osgUtil::StateGraph::_minimumDistance
mutable
StateGraph* osgUtil::StateGraph::_parent
const osg::StateSet* osgUtil::StateGraph::_stateset
osg::ref_ptr<osg::Referenced> osgUtil::StateGraph::_userData

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

osg logo
Generated at Wed Nov 11 2015 22:15:18 for the OpenSceneGraph by doxygen 1.8.10.