OpenSceneGraph 3.6.5
osgUtil::RenderBin Class Reference

RenderBin base class. More...

#include <RenderBin>

Inheritance diagram for osgUtil::RenderBin:

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 setStateGraph (StateGraph *sg)
StateGraphgetStateGraph ()
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.
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name.
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
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.
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience 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.
template<class T>
void setUserData (const ref_ptr< T > &ud)
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
 Convenience 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)
 Convenience 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.
template<typename T>
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
 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 no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer 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 ()
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.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

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

osg::ref_ptr< StateGraph_rootStateGraph
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

◆ RenderBinList

◆ RenderLeafList

◆ StateGraphList

Member Enumeration Documentation

◆ SortMode

Enumerator
SORT_BY_STATE 
SORT_BY_STATE_THEN_FRONT_TO_BACK 
SORT_FRONT_TO_BACK 
SORT_BACK_TO_FRONT 
TRAVERSAL_ORDER 

Constructor & Destructor Documentation

◆ RenderBin() [1/3]

◆ RenderBin() [2/3]

osgUtil::RenderBin::RenderBin ( SortMode mode)

◆ RenderBin() [3/3]

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

Copy constructor using CopyOp to manage deep vs shallow copy.

References RenderBin(), and osg::CopyOp::SHALLOW_COPY.

◆ ~RenderBin()

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

Member Function Documentation

◆ addRenderBinPrototype()

void osgUtil::RenderBin::addRenderBinPrototype ( const std::string & binName,
RenderBin * proto )
static

References RenderBin().

◆ addStateGraph()

void osgUtil::RenderBin::addStateGraph ( StateGraph * rg)
inline

References _stateGraphList.

◆ className()

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.

◆ clone()

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.

References RenderBin().

◆ cloneType()

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.

References RenderBin().

◆ computeNumberOfDynamicRenderLeaves()

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

Compute the number of dynamic RenderLeaves.

Reimplemented in osgUtil::RenderStage.

◆ copyLeavesFromStateGraphListToRenderLeafList()

void osgUtil::RenderBin::copyLeavesFromStateGraphListToRenderLeafList ( )

◆ createRenderBin()

RenderBin * osgUtil::RenderBin::createRenderBin ( const std::string & binName)
static

References RenderBin().

◆ draw()

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

Reimplemented in osgUtil::RenderStage.

◆ drawImplementation()

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

Reimplemented in osgUtil::RenderStage.

◆ find_or_insert()

RenderBin * osgUtil::RenderBin::find_or_insert ( int binNum,
const std::string & binName )

References RenderBin().

◆ getBinNum()

int osgUtil::RenderBin::getBinNum ( ) const
inline

References _binNum.

◆ getDefaultRenderBinSortMode()

SortMode osgUtil::RenderBin::getDefaultRenderBinSortMode ( )
static

◆ getDrawCallback() [1/2]

DrawCallback * osgUtil::RenderBin::getDrawCallback ( )
inline

References _drawCallback.

◆ getDrawCallback() [2/2]

const DrawCallback * osgUtil::RenderBin::getDrawCallback ( ) const
inline

References _drawCallback.

◆ getParent() [1/2]

RenderBin * osgUtil::RenderBin::getParent ( )
inline

References _parent, and RenderBin().

◆ getParent() [2/2]

const RenderBin * osgUtil::RenderBin::getParent ( ) const
inline

References _parent, and RenderBin().

◆ getRenderBinList() [1/2]

RenderBinList & osgUtil::RenderBin::getRenderBinList ( )
inline

References _bins.

◆ getRenderBinList() [2/2]

const RenderBinList & osgUtil::RenderBin::getRenderBinList ( ) const
inline

References _bins.

◆ getRenderBinPrototype()

RenderBin * osgUtil::RenderBin::getRenderBinPrototype ( const std::string & binName)
static

References RenderBin().

◆ getRenderLeafList() [1/2]

RenderLeafList & osgUtil::RenderBin::getRenderLeafList ( )
inline

References _renderLeafList.

◆ getRenderLeafList() [2/2]

const RenderLeafList & osgUtil::RenderBin::getRenderLeafList ( ) const
inline

References _renderLeafList.

◆ getSortCallback() [1/2]

SortCallback * osgUtil::RenderBin::getSortCallback ( )
inline

References _sortCallback.

◆ getSortCallback() [2/2]

const SortCallback * osgUtil::RenderBin::getSortCallback ( ) const
inline

References _sortCallback.

◆ getSortMode()

SortMode osgUtil::RenderBin::getSortMode ( ) const
inline

References _sortMode.

◆ getStage() [1/2]

RenderStage * osgUtil::RenderBin::getStage ( )
inline

References _stage.

◆ getStage() [2/2]

const RenderStage * osgUtil::RenderBin::getStage ( ) const
inline

References _stage.

◆ getStateGraph()

StateGraph * osgUtil::RenderBin::getStateGraph ( )
inline

References _rootStateGraph.

◆ getStateGraphList() [1/2]

StateGraphList & osgUtil::RenderBin::getStateGraphList ( )
inline

References _stateGraphList.

◆ getStateGraphList() [2/2]

const StateGraphList & osgUtil::RenderBin::getStateGraphList ( ) const
inline

References _stateGraphList.

◆ getStateSet() [1/2]

osg::StateSet * osgUtil::RenderBin::getStateSet ( )
inline

References _stateset.

◆ getStateSet() [2/2]

const osg::StateSet * osgUtil::RenderBin::getStateSet ( ) const
inline

References _stateset.

◆ getStats()

bool osgUtil::RenderBin::getStats ( Statistics & primStats) const

Extract stats for current draw list.

◆ isSameKindAs()

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

Reimplemented from osg::Object.

Reimplemented in osgUtil::RenderStage.

References RenderBin().

◆ libraryName()

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.

◆ releaseGLObjects()

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.

◆ removeRenderBinPrototype()

void osgUtil::RenderBin::removeRenderBinPrototype ( RenderBin * proto)
static

References RenderBin().

◆ reset()

virtual void osgUtil::RenderBin::reset ( )
virtual

Reimplemented in osgUtil::RenderStage.

◆ setDefaultRenderBinSortMode()

void osgUtil::RenderBin::setDefaultRenderBinSortMode ( SortMode mode)
static

◆ setDrawCallback()

void osgUtil::RenderBin::setDrawCallback ( DrawCallback * drawCallback)
inline

References _drawCallback.

◆ setSortCallback()

void osgUtil::RenderBin::setSortCallback ( SortCallback * sortCallback)
inline

References _sortCallback.

◆ setSortMode()

void osgUtil::RenderBin::setSortMode ( SortMode mode)

◆ setStateGraph()

void osgUtil::RenderBin::setStateGraph ( StateGraph * sg)
inline

References _rootStateGraph.

◆ setStateSet()

void osgUtil::RenderBin::setStateSet ( osg::StateSet * stateset)
inline

References _stateset.

◆ sort()

virtual void osgUtil::RenderBin::sort ( )
virtual

Reimplemented in osgUtil::RenderStage.

◆ sortBackToFront()

virtual void osgUtil::RenderBin::sortBackToFront ( )
virtual

◆ sortByState()

virtual void osgUtil::RenderBin::sortByState ( )
virtual

◆ sortByStateThenFrontToBack()

virtual void osgUtil::RenderBin::sortByStateThenFrontToBack ( )
virtual

◆ sortFrontToBack()

virtual void osgUtil::RenderBin::sortFrontToBack ( )
virtual

◆ sortImplementation()

virtual void osgUtil::RenderBin::sortImplementation ( )
virtual

◆ sortTraversalOrder()

virtual void osgUtil::RenderBin::sortTraversalOrder ( )
virtual

Member Data Documentation

◆ _binNum

int osgUtil::RenderBin::_binNum
protected

Referenced by getBinNum().

◆ _bins

RenderBinList osgUtil::RenderBin::_bins
protected

◆ _drawCallback

osg::ref_ptr<DrawCallback> osgUtil::RenderBin::_drawCallback
protected

◆ _parent

RenderBin* osgUtil::RenderBin::_parent
protected

Referenced by getParent(), and getParent().

◆ _renderLeafList

RenderLeafList osgUtil::RenderBin::_renderLeafList
protected

◆ _rootStateGraph

osg::ref_ptr<StateGraph> osgUtil::RenderBin::_rootStateGraph
protected

Referenced by getStateGraph(), and setStateGraph().

◆ _sortCallback

osg::ref_ptr<SortCallback> osgUtil::RenderBin::_sortCallback
protected

◆ _sorted

bool osgUtil::RenderBin::_sorted
protected

◆ _sortMode

SortMode osgUtil::RenderBin::_sortMode
protected

Referenced by getSortMode().

◆ _stage

RenderStage* osgUtil::RenderBin::_stage
protected

Referenced by getStage(), and getStage().

◆ _stateGraphList

StateGraphList osgUtil::RenderBin::_stateGraphList
protected

◆ _stateset

osg::ref_ptr<osg::StateSet> osgUtil::RenderBin::_stateset
protected

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

osg logo
Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.