OpenSceneGraph 2.8.3

osgUtil::RenderBin Class Reference

RenderBin base class. More...

Inheritance diagram for osgUtil::RenderBin:

List of all members.

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 }
typedef std::vector< RenderLeaf * > RenderLeafList
typedef std::vector< StateGraph * > StateGraphList
typedef std::map< int,
osg::ref_ptr< RenderBin > > 
RenderBinList

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

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

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 

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 ( ) [protected, virtual]

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 [inline, virtual]

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 [inline, virtual]

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 [inline, virtual]

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]
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 [inline, virtual]

Reimplemented from osg::Object.

Reimplemented in osgUtil::RenderStage.

virtual const char* osgUtil::RenderBin::libraryName ( ) const [inline, virtual]

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.

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]

Member Data Documentation

int osgUtil::RenderBin::_binNum [protected]
bool osgUtil::RenderBin::_sorted [protected]

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

osg logo
Generated at Tue Mar 22 2011 13:20:30 for the OpenSceneGraph by doxygen 1.7.3.