OpenSceneGraph  3.0.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgUtil::RenderBin Class Reference

RenderBin base class. More...

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

Classes

struct  DrawCallback
struct  SortCallback

Public Types

enum  SortMode {
  SORT_BY_STATE, SORT_BY_STATE_THEN_FRONT_TO_BACK, SORT_FRONT_TO_BACK, SORT_BACK_TO_FRONT,
  TRAVERSAL_ORDER
}
typedef std::vector< RenderLeaf * > RenderLeafList
typedef std::vector< StateGraph * > StateGraphList
typedef std::map< int,
osg::ref_ptr< RenderBin > > 
RenderBinList
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 RenderBin ()
 RenderBin (SortMode mode)
 RenderBin (const RenderBin &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual osg::ObjectcloneType () const
 Clone the type of an object, with Object* return type.
virtual osg::Objectclone (const osg::CopyOp &copyop) const
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const osg::Object *obj) const
virtual const char * libraryName () const
 return the name of the object's library.
virtual const char * className () const
 return the name of the object's class type.
virtual void reset ()
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
RenderBingetParent ()
const RenderBingetParent () const
RenderStagegetStage ()
const RenderStagegetStage () const
int getBinNum () const
StateGraphListgetStateGraphList ()
const StateGraphListgetStateGraphList () const
RenderBinListgetRenderBinList ()
const RenderBinListgetRenderBinList () const
RenderLeafListgetRenderLeafList ()
const RenderLeafListgetRenderLeafList () const
RenderBinfind_or_insert (int binNum, const std::string &binName)
void addStateGraph (StateGraph *rg)
virtual void sort ()
virtual void sortImplementation ()
void setSortMode (SortMode mode)
SortMode getSortMode () const
virtual void sortByState ()
virtual void sortByStateThenFrontToBack ()
virtual void sortFrontToBack ()
virtual void sortBackToFront ()
virtual void sortTraversalOrder ()
void setSortCallback (SortCallback *sortCallback)
SortCallbackgetSortCallback ()
const SortCallbackgetSortCallback () const
virtual void draw (osg::RenderInfo &renderInfo, RenderLeaf *&previous)
virtual void drawImplementation (osg::RenderInfo &renderInfo, RenderLeaf *&previous)
void setDrawCallback (DrawCallback *drawCallback)
DrawCallbackgetDrawCallback ()
const DrawCallbackgetDrawCallback () const
bool getStats (Statistics &primStats) const
 Extract stats for current draw list.
virtual unsigned int computeNumberOfDynamicRenderLeaves () const
 Compute the number of dynamic RenderLeaves.
void copyLeavesFromStateGraphListToRenderLeafList ()
virtual void releaseGLObjects (osg::State *state=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 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.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
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.
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.
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size.
- 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.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Static Public Member Functions

static RenderBincreateRenderBin (const std::string &binName)
static RenderBingetRenderBinPrototype (const std::string &binName)
static void addRenderBinPrototype (const std::string &binName, RenderBin *proto)
static void removeRenderBinPrototype (RenderBin *proto)
static void setDefaultRenderBinSortMode (SortMode mode)
static SortMode getDefaultRenderBinSortMode ()

Protected Member Functions

virtual ~RenderBin ()
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

int _binNum
RenderBin_parent
RenderStage_stage
RenderBinList _bins
StateGraphList _stateGraphList
RenderLeafList _renderLeafList
bool _sorted
SortMode _sortMode
osg::ref_ptr< SortCallback_sortCallback
osg::ref_ptr< DrawCallback_drawCallback
osg::ref_ptr< osg::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

Detailed Description

RenderBin base class.

Renderbin contains geometries to be rendered as a group, renderbins are rendered once each. They can improve efficiency or use different rendering algorithms. A renderBin can contain further renderBins producing a tree hierarchy of renderBins.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator:
SORT_BY_STATE 
SORT_BY_STATE_THEN_FRONT_TO_BACK 
SORT_FRONT_TO_BACK 
SORT_BACK_TO_FRONT 
TRAVERSAL_ORDER 

Constructor & Destructor Documentation

osgUtil::RenderBin::RenderBin ( )
osgUtil::RenderBin::RenderBin ( SortMode  mode)
osgUtil::RenderBin::RenderBin ( const RenderBin rhs,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osgUtil::RenderBin::~RenderBin ( )
protectedvirtual

Member Function Documentation

static void osgUtil::RenderBin::addRenderBinPrototype ( const std::string &  binName,
RenderBin proto 
)
static
void osgUtil::RenderBin::addStateGraph ( StateGraph rg)
inline
virtual const char* osgUtil::RenderBin::className ( ) const
inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osgUtil::RenderStage.

virtual osg::Object* osgUtil::RenderBin::clone ( const osg::CopyOp ) const
inlinevirtual

Clone an object, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osgUtil::RenderStage.

virtual osg::Object* osgUtil::RenderBin::cloneType ( ) const
inlinevirtual

Clone the type of an object, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osgUtil::RenderStage.

virtual unsigned int osgUtil::RenderBin::computeNumberOfDynamicRenderLeaves ( ) const
virtual

Compute the number of dynamic RenderLeaves.

Reimplemented in osgUtil::RenderStage.

void osgUtil::RenderBin::copyLeavesFromStateGraphListToRenderLeafList ( )
static RenderBin* osgUtil::RenderBin::createRenderBin ( const std::string &  binName)
static
virtual void osgUtil::RenderBin::draw ( osg::RenderInfo renderInfo,
RenderLeaf *&  previous 
)
virtual

Reimplemented in osgUtil::RenderStage.

virtual void osgUtil::RenderBin::drawImplementation ( osg::RenderInfo renderInfo,
RenderLeaf *&  previous 
)
virtual

Reimplemented in osgUtil::RenderStage.

RenderBin* osgUtil::RenderBin::find_or_insert ( int  binNum,
const std::string &  binName 
)
int osgUtil::RenderBin::getBinNum ( ) const
inline
static SortMode osgUtil::RenderBin::getDefaultRenderBinSortMode ( )
static
DrawCallback* osgUtil::RenderBin::getDrawCallback ( )
inline
const DrawCallback* osgUtil::RenderBin::getDrawCallback ( ) const
inline
RenderBin* osgUtil::RenderBin::getParent ( )
inline
const RenderBin* osgUtil::RenderBin::getParent ( ) const
inline
RenderBinList& osgUtil::RenderBin::getRenderBinList ( )
inline
const RenderBinList& osgUtil::RenderBin::getRenderBinList ( ) const
inline
static RenderBin* osgUtil::RenderBin::getRenderBinPrototype ( const std::string &  binName)
static
RenderLeafList& osgUtil::RenderBin::getRenderLeafList ( )
inline
const RenderLeafList& osgUtil::RenderBin::getRenderLeafList ( ) const
inline
SortCallback* osgUtil::RenderBin::getSortCallback ( )
inline
const SortCallback* osgUtil::RenderBin::getSortCallback ( ) const
inline
SortMode osgUtil::RenderBin::getSortMode ( ) const
inline
RenderStage* osgUtil::RenderBin::getStage ( )
inline
const RenderStage* osgUtil::RenderBin::getStage ( ) const
inline
StateGraphList& osgUtil::RenderBin::getStateGraphList ( )
inline
const StateGraphList& osgUtil::RenderBin::getStateGraphList ( ) const
inline
osg::StateSet* osgUtil::RenderBin::getStateSet ( )
inline
const osg::StateSet* osgUtil::RenderBin::getStateSet ( ) const
inline
bool osgUtil::RenderBin::getStats ( Statistics primStats) const

Extract stats for current draw list.

Reimplemented in osgUtil::RenderStage.

virtual bool osgUtil::RenderBin::isSameKindAs ( const osg::Object obj) const
inlinevirtual

Reimplemented from osg::Object.

Reimplemented in osgUtil::RenderStage.

virtual const char* osgUtil::RenderBin::libraryName ( ) const
inlinevirtual

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

virtual void osgUtil::RenderBin::releaseGLObjects ( osg::State state = 0) const
virtual

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

Otherwise, releases OpenGL objexts for all graphics contexts.

Reimplemented from osg::Object.

Reimplemented in osgUtil::RenderStage.

static void osgUtil::RenderBin::removeRenderBinPrototype ( RenderBin proto)
static
virtual void osgUtil::RenderBin::reset ( )
virtual

Reimplemented in osgUtil::RenderStage.

static void osgUtil::RenderBin::setDefaultRenderBinSortMode ( SortMode  mode)
static
void osgUtil::RenderBin::setDrawCallback ( DrawCallback drawCallback)
inline
void osgUtil::RenderBin::setSortCallback ( SortCallback sortCallback)
inline
void osgUtil::RenderBin::setSortMode ( SortMode  mode)
void osgUtil::RenderBin::setStateSet ( osg::StateSet stateset)
inline
virtual void osgUtil::RenderBin::sort ( )
virtual

Reimplemented in osgUtil::RenderStage.

virtual void osgUtil::RenderBin::sortBackToFront ( )
virtual
virtual void osgUtil::RenderBin::sortByState ( )
virtual
virtual void osgUtil::RenderBin::sortByStateThenFrontToBack ( )
virtual
virtual void osgUtil::RenderBin::sortFrontToBack ( )
virtual
virtual void osgUtil::RenderBin::sortImplementation ( )
virtual
virtual void osgUtil::RenderBin::sortTraversalOrder ( )
virtual

Member Data Documentation

int osgUtil::RenderBin::_binNum
protected
RenderBinList osgUtil::RenderBin::_bins
protected
osg::ref_ptr<DrawCallback> osgUtil::RenderBin::_drawCallback
protected
RenderBin* osgUtil::RenderBin::_parent
protected
RenderLeafList osgUtil::RenderBin::_renderLeafList
protected
osg::ref_ptr<SortCallback> osgUtil::RenderBin::_sortCallback
protected
bool osgUtil::RenderBin::_sorted
protected
SortMode osgUtil::RenderBin::_sortMode
protected
RenderStage* osgUtil::RenderBin::_stage
protected
StateGraphList osgUtil::RenderBin::_stateGraphList
protected
osg::ref_ptr<osg::StateSet> osgUtil::RenderBin::_stateset
protected

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

osg logo
Generated at Tue Sep 4 2012 06:15:41 for the OpenSceneGraph by doxygen 1.8.1.2.