Files
OpenSceneGraph/doc/doc++/osgUtil/RenderBin.html
Robert Osfield 6c08183b45 Updated docs.
2002-08-29 14:29:49 +00:00

318 lines
15 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class OSGUTIL_EXPORT osgUtil::RenderBin</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class OSGUTIL_EXPORT <A HREF="#DOC.DOCU">osgUtil::RenderBin</A></H2></H2><BLOCKQUOTE> RenderBin base class</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=125>
<param name=classes value="Mosg::Object,M,CRenderBin,MRenderBin.html,CRenderStage,MRenderStage.html,CDepthSortedBin,MDepthSortedBin.html">
<param name=before value="M,M,M|_,Mr_">
<param name=after value="Md_,M,M,M">
<param name=indent value="0,1,1,1">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.2.10.31">_binNum</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="RenderBin.html">RenderBin</A>* <B><A HREF="#DOC.2.10.32">_parent</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="RenderStage.html">RenderStage</A>* <B><A HREF="#DOC.2.10.33">_stage</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>RenderBinList <B><A HREF="#DOC.2.10.34">_bins</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>RenderGraphList <B><A HREF="#DOC.2.10.35">_renderGraphList</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>RenderLeafList <B><A HREF="#DOC.2.10.36">_renderLeafList</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="RenderBin.html#DOC.2.10.14">SortMode</A> <B><A HREF="#DOC.2.10.37">_sortMode</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::ref_ptr&lt;<!1><A HREF="RenderBin.html#DOC.2.10.21">SortCallback</A>&gt; <B><A HREF="#DOC.2.10.38">_sortLocalCallback</A></B>
</DL></P>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>typedef std::map&lt; int, osg::ref_ptr&lt;<!1><A HREF="RenderBin.html">RenderBin</A>&gt; &gt;static RenderBinList <!1><A HREF="RenderBin.html">RenderBin</A>* <B><A HREF="#DOC.2.10.1">createRenderBin</A></B>(const std::string&amp; binName)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static void <B><A HREF="#DOC.2.10.2">addRenderBinPrototype</A></B>(<!1><A HREF="RenderBin.html">RenderBin</A>* proto)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static void <B><A HREF="#DOC.2.10.3">removeRenderBinPrototype</A></B>(<!1><A HREF="RenderBin.html">RenderBin</A>* proto)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.10.4">RenderBin</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual osg::Object* <B><A HREF="#DOC.2.10.5">cloneType</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual osg::Object* <B><A HREF="#DOC.2.10.6">clone</A></B>(const osg::CopyOp&amp;) const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual bool <B><A HREF="#DOC.2.10.7">isSameKindAs</A></B>(const osg::Object* obj) const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual const char* <B><A HREF="#DOC.2.10.8">libraryName</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual const char* <B><A HREF="#DOC.2.10.9">className</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.10">reset</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="RenderBin.html">RenderBin</A>* <B><A HREF="#DOC.2.10.11">find_or_insert</A></B>(int binNum, const std::string&amp; binName)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.10.12">addRenderGraph</A></B>(<!1><A HREF="RenderGraph.html">RenderGraph</A>* rg)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.10.13">sort</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.10.15">setSortMode</A></B>(<!1><A HREF="RenderBin.html#DOC.2.10.14">SortMode</A> mode)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="RenderBin.html#DOC.2.10.14">SortMode</A> <B><A HREF="#DOC.2.10.16">getSortMode</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.17">sort_local</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.18">sort_local_by_state</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.19">sort_local_front_to_back</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.20">sort_local_back_to_front</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.10.22">setSortLocalCallback</A></B>(<!1><A HREF="RenderBin.html#DOC.2.10.21">SortCallback</A>* sortCallback)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="RenderBin.html#DOC.2.10.21">SortCallback</A>* <B><A HREF="#DOC.2.10.23">getSortLocalCallback</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>const <!1><A HREF="RenderBin.html#DOC.2.10.21">SortCallback</A>* <B><A HREF="#DOC.2.10.24">getSortLocalCallback</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.25">draw</A></B>(osg::State&amp; state, <!1><A HREF="RenderLeaf.html">RenderLeaf</A>*&amp; previous)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.26">draw_local</A></B>(osg::State&amp; state, <!1><A HREF="RenderLeaf.html">RenderLeaf</A>*&amp; previous)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.10.27">getStats</A></B>(osg::Statistics* primStats)
<DD><I>extract stats for current draw list.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.10.28">getPrims</A></B>(osg::Statistics* primStats)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.10.29">getPrims</A></B>(osg::Statistics* primStats, const int nbin)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.10.30">copyLeavesFromRenderGraphListToRenderLeafList</A></B>()
</DL></P>
<P><DL>
<DT><H3>Public Members</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>enum <B><A HREF="#DOC.2.10.14">SortMode</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>struct <B><A HREF="#DOC.2.10.21">SortCallback</A></B>: public osg::Referenced
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>typedef std::map&lt; std::string, osg::ref_ptr&lt;<!1><A HREF="RenderBin.html">RenderBin</A>&gt; &gt;static RenderBinPrototypeList RenderBinPrototypeList <B><A HREF="#DOC.2.10.39">s_renderBinPrototypeList</A></B>
</DL></P>
<P><DL>
<DT><H3>Protected Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.2.10.40">~RenderBin</A></B>()
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>
RenderBin base class</BLOCKQUOTE>
<DL>
<A NAME="createRenderBin"></A>
<A NAME="DOC.2.10.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>typedef std::map&lt; int, osg::ref_ptr&lt;<!1><A HREF="RenderBin.html">RenderBin</A>&gt; &gt;static RenderBinList <!1><A HREF="RenderBin.html">RenderBin</A>* createRenderBin(const std::string&amp; binName)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="addRenderBinPrototype"></A>
<A NAME="DOC.2.10.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static void addRenderBinPrototype(<!1><A HREF="RenderBin.html">RenderBin</A>* proto)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="removeRenderBinPrototype"></A>
<A NAME="DOC.2.10.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static void removeRenderBinPrototype(<!1><A HREF="RenderBin.html">RenderBin</A>* proto)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="RenderBin"></A>
<A NAME="DOC.2.10.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> RenderBin()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="cloneType"></A>
<A NAME="DOC.2.10.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual osg::Object* cloneType() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="clone"></A>
<A NAME="DOC.2.10.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual osg::Object* clone(const osg::CopyOp&amp;) const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="isSameKindAs"></A>
<A NAME="DOC.2.10.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual bool isSameKindAs(const osg::Object* obj) const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="libraryName"></A>
<A NAME="DOC.2.10.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual const char* libraryName() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="className"></A>
<A NAME="DOC.2.10.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual const char* className() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="reset"></A>
<A NAME="DOC.2.10.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void reset()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="find_or_insert"></A>
<A NAME="DOC.2.10.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="RenderBin.html">RenderBin</A>* find_or_insert(int binNum, const std::string&amp; binName)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="addRenderGraph"></A>
<A NAME="DOC.2.10.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addRenderGraph(<!1><A HREF="RenderGraph.html">RenderGraph</A>* rg)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="sort"></A>
<A NAME="DOC.2.10.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void sort()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="SortMode"></A>
<A NAME="DOC.2.10.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>enum SortMode</B></TT>
<DL><DT><DD></DL><P><DL>
<A NAME="SORT_BY_STATE"></A>
<A NAME="DOC.2.10.14.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> SORT_BY_STATE</B></TT>
<DL><DT><DD></DL><P>
<A NAME="SORT_FRONT_TO_BACK"></A>
<A NAME="DOC.2.10.14.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> SORT_FRONT_TO_BACK</B></TT>
<DL><DT><DD></DL><P>
<A NAME="SORT_BACK_TO_FONT"></A>
<A NAME="DOC.2.10.14.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> SORT_BACK_TO_FONT</B></TT>
<DL><DT><DD></DL><P></DL>
<A NAME="setSortMode"></A>
<A NAME="DOC.2.10.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setSortMode(<!1><A HREF="RenderBin.html#DOC.2.10.14">SortMode</A> mode)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getSortMode"></A>
<A NAME="DOC.2.10.16"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="RenderBin.html#DOC.2.10.14">SortMode</A> getSortMode() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="sort_local"></A>
<A NAME="DOC.2.10.17"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void sort_local()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="sort_local_by_state"></A>
<A NAME="DOC.2.10.18"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void sort_local_by_state()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="sort_local_front_to_back"></A>
<A NAME="DOC.2.10.19"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void sort_local_front_to_back()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="sort_local_back_to_front"></A>
<A NAME="DOC.2.10.20"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void sort_local_back_to_front()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="SortCallback"></A>
<A NAME="DOC.2.10.21"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>struct SortCallback: public osg::Referenced</B></TT>
<DL><DT><DD></DL><P><DL>
<A NAME="sort"></A>
<A NAME="DOC.2.10.21.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void sort(<!1><A HREF="RenderBin.html">RenderBin</A>*) = 0</B></TT>
<DL><DT><DD></DL><P></DL>
<A NAME="setSortLocalCallback"></A>
<A NAME="DOC.2.10.22"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setSortLocalCallback(<!1><A HREF="RenderBin.html#DOC.2.10.21">SortCallback</A>* sortCallback)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getSortLocalCallback"></A>
<A NAME="DOC.2.10.23"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="RenderBin.html#DOC.2.10.21">SortCallback</A>* getSortLocalCallback()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getSortLocalCallback"></A>
<A NAME="DOC.2.10.24"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>const <!1><A HREF="RenderBin.html#DOC.2.10.21">SortCallback</A>* getSortLocalCallback() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="draw"></A>
<A NAME="DOC.2.10.25"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void draw(osg::State&amp; state, <!1><A HREF="RenderLeaf.html">RenderLeaf</A>*&amp; previous)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="draw_local"></A>
<A NAME="DOC.2.10.26"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void draw_local(osg::State&amp; state, <!1><A HREF="RenderLeaf.html">RenderLeaf</A>*&amp; previous)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getStats"></A>
<A NAME="DOC.2.10.27"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool getStats(osg::Statistics* primStats)</B></TT>
<DD>extract stats for current draw list.
<DL><DT><DD></DL><P>
<A NAME="getPrims"></A>
<A NAME="DOC.2.10.28"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void getPrims(osg::Statistics* primStats)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getPrims"></A>
<A NAME="DOC.2.10.29"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool getPrims(osg::Statistics* primStats, const int nbin)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="copyLeavesFromRenderGraphListToRenderLeafList"></A>
<A NAME="DOC.2.10.30"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void copyLeavesFromRenderGraphListToRenderLeafList()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_binNum"></A>
<A NAME="DOC.2.10.31"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int _binNum</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_parent"></A>
<A NAME="DOC.2.10.32"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="RenderBin.html">RenderBin</A>* _parent</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_stage"></A>
<A NAME="DOC.2.10.33"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="RenderStage.html">RenderStage</A>* _stage</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_bins"></A>
<A NAME="DOC.2.10.34"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>RenderBinList _bins</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_renderGraphList"></A>
<A NAME="DOC.2.10.35"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>RenderGraphList _renderGraphList</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_renderLeafList"></A>
<A NAME="DOC.2.10.36"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>RenderLeafList _renderLeafList</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_sortMode"></A>
<A NAME="DOC.2.10.37"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="RenderBin.html#DOC.2.10.14">SortMode</A> _sortMode</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_sortLocalCallback"></A>
<A NAME="DOC.2.10.38"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::ref_ptr&lt;<!1><A HREF="RenderBin.html#DOC.2.10.21">SortCallback</A>&gt; _sortLocalCallback</B></TT>
<DL><DT><DD></DL><P>
<A NAME="s_renderBinPrototypeList"></A>
<A NAME="DOC.2.10.39"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>typedef std::map&lt; std::string, osg::ref_ptr&lt;<!1><A HREF="RenderBin.html">RenderBin</A>&gt; &gt;static RenderBinPrototypeList RenderBinPrototypeList s_renderBinPrototypeList</B></TT>
<DL><DT><DD></DL><P>
<A NAME="~RenderBin"></A>
<A NAME="DOC.2.10.40"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~RenderBin()</B></TT>
<DL><DT><DD></DL><P></DL>
<HR>
<DL><DT><B>Direct child classes:
</B><DD><A HREF="RenderStage.html">RenderStage</A><BR>
<A HREF="DepthSortedBin.html">DepthSortedBin</A><BR>
</DL>
<DL><DT><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>