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

#include <RenderBin>

Inheritance diagram for osgUtil::RenderBin:
osg::Object osg::Referenced osgUtil::RenderStage

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)
 
virtual osg::ObjectcloneType () const
 
virtual osg::Objectclone (const osg::CopyOp &copyop) const
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
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
 
virtual unsigned int computeNumberOfDynamicRenderLeaves () const
 
void copyLeavesFromStateGraphListToRenderLeafList ()
 
virtual void releaseGLObjects (osg::State *state=0) 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 NodeasNode ()
 
virtual const NodeasNode () 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 DrawableasDrawable ()
 
virtual const DrawableasDrawable () 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 setThreadSafeRefUnref (bool threadSafe)
 
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)
 
virtual void resizeGLObjectBuffers (unsigned int)
 
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
 

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::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Protected Member Functions

virtual ~RenderBin ()
 
- 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::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]

osgUtil::RenderBin::RenderBin ( )

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

◆ ~RenderBin()

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

Member Function Documentation

◆ addRenderBinPrototype()

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

◆ addStateGraph()

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

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

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

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

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

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

◆ getBinNum()

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

◆ getDefaultRenderBinSortMode()

static SortMode osgUtil::RenderBin::getDefaultRenderBinSortMode ( )
static

◆ getDrawCallback() [1/2]

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

◆ getDrawCallback() [2/2]

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

◆ getParent() [1/2]

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

◆ getParent() [2/2]

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

◆ getRenderBinList() [1/2]

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

◆ getRenderBinList() [2/2]

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

◆ getRenderBinPrototype()

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

◆ getRenderLeafList() [1/2]

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

◆ getRenderLeafList() [2/2]

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

◆ getSortCallback() [1/2]

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

◆ getSortCallback() [2/2]

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

◆ getSortMode()

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

◆ getStage() [1/2]

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

◆ getStage() [2/2]

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

◆ getStateGraph()

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

◆ getStateGraphList() [1/2]

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

◆ getStateGraphList() [2/2]

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

◆ getStateSet() [1/2]

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

◆ getStateSet() [2/2]

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

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

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

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

◆ reset()

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

Reimplemented in osgUtil::RenderStage.

◆ setDefaultRenderBinSortMode()

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

◆ setDrawCallback()

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

◆ setSortCallback()

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

◆ setSortMode()

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

◆ setStateGraph()

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

◆ setStateSet()

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

◆ 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

◆ _bins

RenderBinList osgUtil::RenderBin::_bins
protected

◆ _drawCallback

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

◆ _parent

RenderBin* osgUtil::RenderBin::_parent
protected

◆ _renderLeafList

RenderLeafList osgUtil::RenderBin::_renderLeafList
protected

◆ _rootStateGraph

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

◆ _sortCallback

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

◆ _sorted

bool osgUtil::RenderBin::_sorted
protected

◆ _sortMode

SortMode osgUtil::RenderBin::_sortMode
protected

◆ _stage

RenderStage* osgUtil::RenderBin::_stage
protected

◆ _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: