RenderBin
Go to the documentation of this file.
/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
*
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* (at your option) any later version. The full license is in LICENSE file
* included with this distribution, and on the openscenegraph.org website.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* OpenSceneGraph Public License for more details.
*/
#ifndef OSGUTIL_RENDERBIN
#define OSGUTIL_RENDERBIN 1
#include <osgUtil/StateGraph>
#include <map>
#include <vector>
#include <string>
namespace osgUtil {
class RenderStage;
class Statistics;
class OSGUTIL_EXPORT RenderBin : public osg::Object
{
public:
typedef std::vector<RenderLeaf*> RenderLeafList;
typedef std::vector<StateGraph*> StateGraphList;
typedef std::map< int, osg::ref_ptr<RenderBin> > RenderBinList;
enum SortMode
{
SORT_BY_STATE,
SORT_BY_STATE_THEN_FRONT_TO_BACK,
SORT_FRONT_TO_BACK,
SORT_BACK_TO_FRONT,
TRAVERSAL_ORDER
};
// static methods.
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();
RenderBin();
RenderBin(SortMode mode);
RenderBin(const RenderBin& rhs,const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY);
virtual osg::Object* cloneType() const { return new RenderBin(); }
virtual osg::Object* clone(const osg::CopyOp& copyop) const { return new RenderBin(*this,copyop); } // note only implements a clone of type.
virtual bool isSameKindAs(const osg::Object* obj) const { return dynamic_cast<const RenderBin*>(obj)!=0L; }
virtual const char* libraryName() const { return "osgUtil"; }
virtual const char* className() const { return "RenderBin"; }
virtual void reset();
void setStateGraph(StateGraph* sg) { _rootStateGraph = sg; }
StateGraph* getStateGraph() { return _rootStateGraph.get(); }
void setStateSet(osg::StateSet* stateset) { _stateset = stateset; }
osg::StateSet* getStateSet() { return _stateset.get(); }
const osg::StateSet* getStateSet() const { return _stateset.get(); }
RenderBin* getParent() { return _parent; }
const RenderBin* getParent() const { return _parent; }
RenderStage* getStage() { return _stage; }
const RenderStage* getStage() const { return _stage; }
int getBinNum() const { return _binNum; }
StateGraphList& getStateGraphList() { return _stateGraphList; }
const StateGraphList& getStateGraphList() const { return _stateGraphList; }
RenderBinList& getRenderBinList() { return _bins; }
const RenderBinList& getRenderBinList() const { return _bins; }
RenderLeafList& getRenderLeafList() { return _renderLeafList; }
const RenderLeafList& getRenderLeafList() const { return _renderLeafList; }
RenderBin* find_or_insert(int binNum,const std::string& binName);
void addStateGraph(StateGraph* rg)
{
_stateGraphList.push_back(rg);
}
virtual void sort();
virtual void sortImplementation();
void setSortMode(SortMode mode);
SortMode getSortMode() const { return _sortMode; }
virtual void sortByState();
virtual void sortByStateThenFrontToBack();
virtual void sortFrontToBack();
virtual void sortBackToFront();
virtual void sortTraversalOrder();
struct SortCallback : public osg::Referenced
{
virtual void sortImplementation(RenderBin*) = 0;
};
void setSortCallback(SortCallback* sortCallback) { _sortCallback = sortCallback; }
SortCallback* getSortCallback() { return _sortCallback.get(); }
const SortCallback* getSortCallback() const { return _sortCallback.get(); }
virtual void draw(osg::RenderInfo& renderInfo,RenderLeaf*& previous);
virtual void drawImplementation(osg::RenderInfo& renderInfo,RenderLeaf*& previous);
struct DrawCallback : public osg::Referenced
{
virtual void drawImplementation(RenderBin* bin,osg::RenderInfo& renderInfo,RenderLeaf*& previous) = 0;
};
void setDrawCallback(DrawCallback* drawCallback) { _drawCallback = drawCallback; }
DrawCallback* getDrawCallback() { return _drawCallback.get(); }
const DrawCallback* getDrawCallback() const { return _drawCallback.get(); }
bool getStats(Statistics& primStats) const;
virtual unsigned int computeNumberOfDynamicRenderLeaves() const;
void copyLeavesFromStateGraphListToRenderLeafList();
virtual void releaseGLObjects(osg::State* state= 0) const;
protected:
virtual ~RenderBin();
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;
};
}
#endif
StateGraph
osgUtil::RenderBin::RenderBin
RenderBin()
osgUtil::RenderBin::getParent
RenderBin * getParent()
Definition RenderBin:84
osgUtil::RenderBin::getStateSet
osg::StateSet * getStateSet()
Definition RenderBin:80
osgUtil::RenderBin::setStateSet
void setStateSet(osg::StateSet *stateset)
Definition RenderBin:79
osgUtil::RenderBin::getParent
const RenderBin * getParent() const
Definition RenderBin:85
osgUtil::RenderBin::sortBackToFront
virtual void sortBackToFront()
osgUtil::RenderBin::sortImplementation
virtual void sortImplementation()
osgUtil::RenderBin::_binNum
int _binNum
Definition RenderBin:165
osgUtil::RenderBin::getBinNum
int getBinNum() const
Definition RenderBin:90
osgUtil::RenderBin::libraryName
virtual const char * libraryName() const
Definition RenderBin:71
osgUtil::RenderBin::getRenderLeafList
const RenderLeafList & getRenderLeafList() const
Definition RenderBin:99
osgUtil::RenderBin::getStage
RenderStage * getStage()
Definition RenderBin:87
osgUtil::RenderBin::RenderLeafList
std::vector< RenderLeaf * > RenderLeafList
Definition RenderBin:37
osgUtil::RenderBin::getStateGraph
StateGraph * getStateGraph()
Definition RenderBin:77
osgUtil::RenderBin::getDrawCallback
const DrawCallback * getDrawCallback() const
Definition RenderBin:144
osgUtil::RenderBin::cloneType
virtual osg::Object * cloneType() const
Definition RenderBin:68
osgUtil::RenderBin::getRenderLeafList
RenderLeafList & getRenderLeafList()
Definition RenderBin:98
osgUtil::RenderBin::sortFrontToBack
virtual void sortFrontToBack()
osgUtil::RenderBin::_drawCallback
osg::ref_ptr< DrawCallback > _drawCallback
Definition RenderBin:176
osgUtil::RenderBin::_parent
RenderBin * _parent
Definition RenderBin:166
osgUtil::RenderBin::RenderBinList
std::map< int, osg::ref_ptr< RenderBin > > RenderBinList
Definition RenderBin:39
osgUtil::RenderBin::getStats
bool getStats(Statistics &primStats) const
osgUtil::RenderBin::_sortCallback
osg::ref_ptr< SortCallback > _sortCallback
Definition RenderBin:174
osgUtil::RenderBin::sortTraversalOrder
virtual void sortTraversalOrder()
osgUtil::RenderBin::SortMode
SortMode
Definition RenderBin:42
osgUtil::RenderBin::SORT_BY_STATE_THEN_FRONT_TO_BACK
@ SORT_BY_STATE_THEN_FRONT_TO_BACK
Definition RenderBin:44
osgUtil::RenderBin::SORT_BACK_TO_FRONT
@ SORT_BACK_TO_FRONT
Definition RenderBin:46
osgUtil::RenderBin::TRAVERSAL_ORDER
@ TRAVERSAL_ORDER
Definition RenderBin:47
osgUtil::RenderBin::SORT_BY_STATE
@ SORT_BY_STATE
Definition RenderBin:43
osgUtil::RenderBin::SORT_FRONT_TO_BACK
@ SORT_FRONT_TO_BACK
Definition RenderBin:45
osgUtil::RenderBin::reset
virtual void reset()
osgUtil::RenderBin::_renderLeafList
RenderLeafList _renderLeafList
Definition RenderBin:170
osgUtil::RenderBin::StateGraphList
std::vector< StateGraph * > StateGraphList
Definition RenderBin:38
osgUtil::RenderBin::_stateGraphList
StateGraphList _stateGraphList
Definition RenderBin:169
osgUtil::RenderBin::getSortMode
SortMode getSortMode() const
Definition RenderBin:114
osgUtil::RenderBin::drawImplementation
virtual void drawImplementation(osg::RenderInfo &renderInfo, RenderLeaf *&previous)
osgUtil::RenderBin::RenderBin
RenderBin(SortMode mode)
osgUtil::RenderBin::setSortCallback
void setSortCallback(SortCallback *sortCallback)
Definition RenderBin:127
osgUtil::RenderBin::addRenderBinPrototype
static void addRenderBinPrototype(const std::string &binName, RenderBin *proto)
osgUtil::RenderBin::sortByStateThenFrontToBack
virtual void sortByStateThenFrontToBack()
osgUtil::RenderBin::setStateGraph
void setStateGraph(StateGraph *sg)
Definition RenderBin:76
osgUtil::RenderBin::getRenderBinList
RenderBinList & getRenderBinList()
Definition RenderBin:95
osgUtil::RenderBin::copyLeavesFromStateGraphListToRenderLeafList
void copyLeavesFromStateGraphListToRenderLeafList()
osgUtil::RenderBin::removeRenderBinPrototype
static void removeRenderBinPrototype(RenderBin *proto)
osgUtil::RenderBin::getDrawCallback
DrawCallback * getDrawCallback()
Definition RenderBin:143
osgUtil::RenderBin::RenderBin
RenderBin(const RenderBin &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
osgUtil::RenderBin::createRenderBin
static RenderBin * createRenderBin(const std::string &binName)
osgUtil::RenderBin::isSameKindAs
virtual bool isSameKindAs(const osg::Object *obj) const
Definition RenderBin:70
osgUtil::RenderBin::setDrawCallback
void setDrawCallback(DrawCallback *drawCallback)
Definition RenderBin:142
osgUtil::RenderBin::getDefaultRenderBinSortMode
static SortMode getDefaultRenderBinSortMode()
osgUtil::RenderBin::className
virtual const char * className() const
Definition RenderBin:72
osgUtil::RenderBin::sort
virtual void sort()
osgUtil::RenderBin::getStateGraphList
const StateGraphList & getStateGraphList() const
Definition RenderBin:93
osgUtil::RenderBin::getRenderBinList
const RenderBinList & getRenderBinList() const
Definition RenderBin:96
osgUtil::RenderBin::getRenderBinPrototype
static RenderBin * getRenderBinPrototype(const std::string &binName)
osgUtil::RenderBin::_sortMode
SortMode _sortMode
Definition RenderBin:173
osgUtil::RenderBin::getStateSet
const osg::StateSet * getStateSet() const
Definition RenderBin:81
osgUtil::RenderBin::getSortCallback
SortCallback * getSortCallback()
Definition RenderBin:128
osgUtil::RenderBin::getStage
const RenderStage * getStage() const
Definition RenderBin:88
osgUtil::RenderBin::sortByState
virtual void sortByState()
osgUtil::RenderBin::setDefaultRenderBinSortMode
static void setDefaultRenderBinSortMode(SortMode mode)
osgUtil::RenderBin::_stateset
osg::ref_ptr< osg::StateSet > _stateset
Definition RenderBin:178
osgUtil::RenderBin::_rootStateGraph
osg::ref_ptr< StateGraph > _rootStateGraph
Definition RenderBin:163
osgUtil::RenderBin::_stage
RenderStage * _stage
Definition RenderBin:167
osgUtil::RenderBin::_bins
RenderBinList _bins
Definition RenderBin:168
osgUtil::RenderBin::~RenderBin
virtual ~RenderBin()
osgUtil::RenderBin::getStateGraphList
StateGraphList & getStateGraphList()
Definition RenderBin:92
osgUtil::RenderBin::computeNumberOfDynamicRenderLeaves
virtual unsigned int computeNumberOfDynamicRenderLeaves() const
osgUtil::RenderBin::setSortMode
void setSortMode(SortMode mode)
osgUtil::RenderBin::find_or_insert
RenderBin * find_or_insert(int binNum, const std::string &binName)
osgUtil::RenderBin::_sorted
bool _sorted
Definition RenderBin:172
osgUtil::RenderBin::getSortCallback
const SortCallback * getSortCallback() const
Definition RenderBin:129
osgUtil::RenderBin::clone
virtual osg::Object * clone(const osg::CopyOp &copyop) const
Definition RenderBin:69
osgUtil::RenderBin::addStateGraph
void addStateGraph(StateGraph *rg)
Definition RenderBin:104
osgUtil::RenderBin::releaseGLObjects
virtual void releaseGLObjects(osg::State *state=0) const
osgUtil::RenderBin::draw
virtual void draw(osg::RenderInfo &renderInfo, RenderLeaf *&previous)
osgUtil::RenderLeaf
Definition RenderLeaf:34
osgUtil::RenderStage
Definition RenderStage:38
osgUtil::StateGraph
Definition StateGraph:42
osgUtil::Statistics
Definition Statistics:48
osg::CopyOp
Definition CopyOp:41
osg::CopyOp::SHALLOW_COPY
@ SHALLOW_COPY
Definition CopyOp:47
osg::Object
Definition Object:61
osg::Referenced
Definition Referenced:44
osg::RenderInfo
Definition RenderInfo:28
osg::StateSet
Definition StateSet:46
osg::State
Definition State:80
osg::ref_ptr
Definition ref_ptr:32
osgUtil
Definition NodeVisitor:25
OSGUTIL_EXPORT
#define OSGUTIL_EXPORT
Definition osgUtil/Export:40
osgUtil::RenderBin::DrawCallback
Definition RenderBin:138
osgUtil::RenderBin::DrawCallback::drawImplementation
virtual void drawImplementation(RenderBin *bin, osg::RenderInfo &renderInfo, RenderLeaf *&previous)=0
osgUtil::RenderBin::SortCallback
Definition RenderBin:123
osgUtil::RenderBin::SortCallback::sortImplementation
virtual void sortImplementation(RenderBin *)=0