osgUtil::RenderBin Class Reference

RenderBin base class. More...

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. More...
virtual osg::Object *	cloneType () const
	Clone the type of an object, with Object* return type. More...
virtual osg::Object *	clone (const osg::CopyOp &copyop) const
	Clone an object, with Object* return type. More...
virtual bool	isSameKindAs (const osg::Object *obj) const
virtual const char *	libraryName () const
	return the name of the object's library. More...
virtual const char *	className () const
	return the name of the object's class type. More...
virtual void	reset ()
void	setStateSet (osg::StateSet *stateset)
osg::StateSet *	getStateSet ()
const osg::StateSet *	getStateSet () const
RenderBin *	getParent ()
const RenderBin *	getParent () const
RenderStage *	getStage ()
const RenderStage *	getStage () const
int	getBinNum () const
StateGraphList &	getStateGraphList ()
const StateGraphList &	getStateGraphList () const
RenderBinList &	getRenderBinList ()
const RenderBinList &	getRenderBinList () const
RenderLeafList &	getRenderLeafList ()
const RenderLeafList &	getRenderLeafList () const
RenderBin *	find_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)
SortCallback *	getSortCallback ()
const SortCallback *	getSortCallback () const
virtual void	draw (osg::RenderInfo &renderInfo, RenderLeaf *&previous)
virtual void	drawImplementation (osg::RenderInfo &renderInfo, RenderLeaf *&previous)
void	setDrawCallback (DrawCallback *drawCallback)
DrawCallback *	getDrawCallback ()
const DrawCallback *	getDrawCallback () const
bool	getStats (Statistics &primStats) const
	Extract stats for current draw list. More...
virtual unsigned int	computeNumberOfDynamicRenderLeaves () const
	Compute the number of dynamic RenderLeaves. More...
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. More...
Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...
	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. More...
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...
void	setName (const char *name)
	Set the name of object using a C style string. More...
const std::string &	getName () const
	Get the name of object. More...
void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...
DataVariance	getDataVariance () const
	Get the data variance of this object. More...
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...
template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	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. More...
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
template<class T >
void	setUserData (const ref_ptr< T > &ud)
virtual Referenced *	getUserData ()
	Get user data. More...
virtual const Referenced *	getUserData () const
	Get const user data. More...
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. More...
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. More...
virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...
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 More...
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
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...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () 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 RenderBin *	createRenderBin (const std::string &binName)
static RenderBin *	getRenderBinPrototype (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. 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 DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Protected Member Functions
virtual	~RenderBin ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor. More...
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

typedef std::map< int, osg::ref_ptr<RenderBin> > osgUtil::RenderBin::RenderBinList

typedef std::vector<RenderLeaf*> osgUtil::RenderBin::RenderLeafList

typedef std::vector<StateGraph*> osgUtil::RenderBin::StateGraphList

Member Enumeration Documentation

enum osgUtil::RenderBin::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

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.

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:

• osgUtil/RenderBin