FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
5a939f5420
OpenSceneGraph/doc/doc++/osg/CullingSet.html
Robert Osfield c269cc88b2 Added doc++ documentation.
2003-04-17 16:22:51 +00:00

285 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class SG_EXPORT osg::CullingSet</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class SG_EXPORT <A HREF="#DOC.DOCU">osg::CullingSet</A></H2></H2><BLOCKQUOTE>A CullingSet class which contains a frustum and a list of occluder.</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=65>
<param name=classes value="CReferenced,MReferenced.html,CCullingSet,MCullingSet.html">
<param name=before value="M,M">
<param name=after value="Md_,M">
<param name=indent value="0,1">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.57.1">CullingSet</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.57.2">CullingSet</A></B>(const <!1><A HREF="CullingSet.html#DOC.2.57.2">CullingSet</A>&amp; cs, const <!1><A HREF="Matrix.html">Matrix</A>&amp; matrix, const <!1><A HREF="Vec4.html">Vec4</A>&amp; pixelSizeVector)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.57.6">setCullingMask</A></B>(<!1><A HREF="CullingSet.html#DOC.2.57.4">Mask</A> mask)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.57.7">setFrustum</A></B>(<!1><A HREF="Polytope.html">Polytope</A>&amp; cv)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Polytope.html">Polytope</A>&amp; <B><A HREF="#DOC.2.57.8">getFrustum</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>const <!1><A HREF="Polytope.html">Polytope</A>&amp; <B><A HREF="#DOC.2.57.9">getFrustum</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.57.10">addOccluder</A></B>(<!1><A HREF="ShadowVolumeOccluder.html">ShadowVolumeOccluder</A>&amp; cv)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.57.11">setPixelSizeVector</A></B>(const <!1><A HREF="Vec4.html">Vec4</A>&amp; v)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Vec4.html">Vec4</A>&amp; <B><A HREF="#DOC.2.57.12">getPixelSizeVector</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>const <!1><A HREF="Vec4.html">Vec4</A>&amp; <B><A HREF="#DOC.2.57.13">getPixelSizeVector</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.57.14">setSmallFeatureCullingPixelSize</A></B>(float value)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float&amp; <B><A HREF="#DOC.2.57.15">getSmallFeatureCullingPixelSize</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.57.16">getSmallFeatureCullingPixelSize</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.57.17">pixelSize</A></B>(const <!1><A HREF="Vec3.html">Vec3</A>&amp; v, float <!1><A HREF="BoundingSphere.html#DOC.2.29.10">radius</A>) const
<DD><I>Compute the pixel of an object at position v, with specified radius</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.57.18">pixelSize</A></B>(const <!1><A HREF="BoundingSphere.html">BoundingSphere</A>&amp; bs) const
<DD><I>Compute the pixel of an bounding sphere</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.57.19">isCulled</A></B>(const std::vector&lt;<!1><A HREF="Vec3.html">Vec3</A>&gt;&amp; vertices)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.57.20">isCulled</A></B>(const <!1><A HREF="BoundingBox.html">BoundingBox</A>&amp; bb)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.57.21">isCulled</A></B>(const <!1><A HREF="BoundingSphere.html">BoundingSphere</A>&amp; bs)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.57.22">pushCurrentMask</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.57.23">popCurrentMask</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.57.24">disableAndPushOccludersCurrentMask</A></B>(<!1><A HREF="NodePath.html">NodePath</A>&amp; nodePath)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.57.25">popOccludersCurrentMask</A></B>(<!1><A HREF="NodePath.html">NodePath</A>&amp; nodePath)
</DL></P>
<P><DL>
<DT><H3>Public Members</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>typedef std::vector&lt;<!1><A HREF="ShadowVolumeOccluder.html">ShadowVolumeOccluder</A>&gt; <B><A HREF="#DOC.2.57.3">OccluderList</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>typedef unsigned int <B><A HREF="#DOC.2.57.4">Mask</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>enum <B><A HREF="#DOC.2.57.5">MaskValues</A></B>
</DL></P>
<P><DL>
<DT><H3>Protected Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="CullingSet.html#DOC.2.57.4">Mask</A> <B><A HREF="#DOC.2.57.27">_mask</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Polytope.html">Polytope</A> <B><A HREF="#DOC.2.57.28">_frustum</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="CullingSet.html#DOC.2.57.3">OccluderList</A> <B><A HREF="#DOC.2.57.29">_occluderList</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Vec4.html">Vec4</A> <B><A HREF="#DOC.2.57.30">_pixelSizeVector</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.57.31">_smallFeatureCullingPixelSize</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.57.26">~CullingSet</A></B>()
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="Referenced.html">Referenced</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>inline <!1><A HREF="Referenced.html">Referenced</A>&amp; <B>operator = </B>(<!1><A HREF="Referenced.html">Referenced</A>&amp;)
<DT>
<IMG ALT="o" SRC=icon2.gif>static void <B>setDeleteHandler</B>(<!1><A HREF="DeleteHandler.html">DeleteHandler</A>* handler)
<DT>
<IMG ALT="o" SRC=icon2.gif>static <!1><A HREF="DeleteHandler.html">DeleteHandler</A>* <B>getDeleteHandler</B>()
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>ref</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>unref_nodelete</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline int <B>referenceCount</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>unref</B>() const
</DL></P>
<P><DL>
<DT><H3>Protected Fields</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>mutable int <B>_refCount</B>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>A CullingSet class which contains a frustum and a list of occluder. </BLOCKQUOTE>
<DL>
<A NAME="CullingSet"></A>
<A NAME="DOC.2.57.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> CullingSet()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="CullingSet"></A>
<A NAME="DOC.2.57.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> CullingSet(const <!1><A HREF="CullingSet.html#DOC.2.57.2">CullingSet</A>&amp; cs, const <!1><A HREF="Matrix.html">Matrix</A>&amp; matrix, const <!1><A HREF="Vec4.html">Vec4</A>&amp; pixelSizeVector)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="OccluderList"></A>
<A NAME="DOC.2.57.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>typedef std::vector&lt;<!1><A HREF="ShadowVolumeOccluder.html">ShadowVolumeOccluder</A>&gt; OccluderList</B></TT>
<DL><DT><DD></DL><P>
<A NAME="Mask"></A>
<A NAME="DOC.2.57.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>typedef unsigned int Mask</B></TT>
<DL><DT><DD></DL><P>
<A NAME="MaskValues"></A>
<A NAME="DOC.2.57.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>enum MaskValues</B></TT>
<DL><DT><DD></DL><P><DL>
<A NAME="VIEW_FRUSTUM_CULLING"></A>
<A NAME="DOC.2.57.5.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> VIEW_FRUSTUM_CULLING</B></TT>
<DL><DT><DD></DL><P>
<A NAME="SMALL_FEATURE_CULLING"></A>
<A NAME="DOC.2.57.5.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> SMALL_FEATURE_CULLING</B></TT>
<DL><DT><DD></DL><P>
<A NAME="SHADOW_OCCLUSION_CULLING"></A>
<A NAME="DOC.2.57.5.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> SHADOW_OCCLUSION_CULLING</B></TT>
<DL><DT><DD></DL><P>
<A NAME="ALL_CULLING"></A>
<A NAME="DOC.2.57.5.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ALL_CULLING</B></TT>
<DL><DT><DD></DL><P></DL>
<A NAME="setCullingMask"></A>
<A NAME="DOC.2.57.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setCullingMask(<!1><A HREF="CullingSet.html#DOC.2.57.4">Mask</A> mask)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setFrustum"></A>
<A NAME="DOC.2.57.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setFrustum(<!1><A HREF="Polytope.html">Polytope</A>&amp; cv)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getFrustum"></A>
<A NAME="DOC.2.57.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Polytope.html">Polytope</A>&amp; getFrustum()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getFrustum"></A>
<A NAME="DOC.2.57.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>const <!1><A HREF="Polytope.html">Polytope</A>&amp; getFrustum() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="addOccluder"></A>
<A NAME="DOC.2.57.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addOccluder(<!1><A HREF="ShadowVolumeOccluder.html">ShadowVolumeOccluder</A>&amp; cv)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setPixelSizeVector"></A>
<A NAME="DOC.2.57.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setPixelSizeVector(const <!1><A HREF="Vec4.html">Vec4</A>&amp; v)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getPixelSizeVector"></A>
<A NAME="DOC.2.57.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Vec4.html">Vec4</A>&amp; getPixelSizeVector()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getPixelSizeVector"></A>
<A NAME="DOC.2.57.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>const <!1><A HREF="Vec4.html">Vec4</A>&amp; getPixelSizeVector() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="setSmallFeatureCullingPixelSize"></A>
<A NAME="DOC.2.57.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setSmallFeatureCullingPixelSize(float value)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getSmallFeatureCullingPixelSize"></A>
<A NAME="DOC.2.57.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float&amp; getSmallFeatureCullingPixelSize()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getSmallFeatureCullingPixelSize"></A>
<A NAME="DOC.2.57.16"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float getSmallFeatureCullingPixelSize() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="pixelSize"></A>
<A NAME="DOC.2.57.17"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float pixelSize(const <!1><A HREF="Vec3.html">Vec3</A>&amp; v, float <!1><A HREF="BoundingSphere.html#DOC.2.29.10">radius</A>) const </B></TT>
<DD>Compute the pixel of an object at position v, with specified radius
<DL><DT><DD></DL><P>
<A NAME="pixelSize"></A>
<A NAME="DOC.2.57.18"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float pixelSize(const <!1><A HREF="BoundingSphere.html">BoundingSphere</A>&amp; bs) const </B></TT>
<DD>Compute the pixel of an bounding sphere
<DL><DT><DD></DL><P>
<A NAME="isCulled"></A>
<A NAME="DOC.2.57.19"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool isCulled(const std::vector&lt;<!1><A HREF="Vec3.html">Vec3</A>&gt;&amp; vertices)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="isCulled"></A>
<A NAME="DOC.2.57.20"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool isCulled(const <!1><A HREF="BoundingBox.html">BoundingBox</A>&amp; bb)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="isCulled"></A>
<A NAME="DOC.2.57.21"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool isCulled(const <!1><A HREF="BoundingSphere.html">BoundingSphere</A>&amp; bs)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="pushCurrentMask"></A>
<A NAME="DOC.2.57.22"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void pushCurrentMask()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="popCurrentMask"></A>
<A NAME="DOC.2.57.23"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void popCurrentMask()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="disableAndPushOccludersCurrentMask"></A>
<A NAME="DOC.2.57.24"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void disableAndPushOccludersCurrentMask(<!1><A HREF="NodePath.html">NodePath</A>&amp; nodePath)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="popOccludersCurrentMask"></A>
<A NAME="DOC.2.57.25"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void popOccludersCurrentMask(<!1><A HREF="NodePath.html">NodePath</A>&amp; nodePath)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="~CullingSet"></A>
<A NAME="DOC.2.57.26"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~CullingSet()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_mask"></A>
<A NAME="DOC.2.57.27"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="CullingSet.html#DOC.2.57.4">Mask</A> _mask</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_frustum"></A>
<A NAME="DOC.2.57.28"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Polytope.html">Polytope</A> _frustum</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_occluderList"></A>
<A NAME="DOC.2.57.29"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="CullingSet.html#DOC.2.57.3">OccluderList</A> _occluderList</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_pixelSizeVector"></A>
<A NAME="DOC.2.57.30"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Vec4.html">Vec4</A> _pixelSizeVector</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_smallFeatureCullingPixelSize"></A>
<A NAME="DOC.2.57.31"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float _smallFeatureCullingPixelSize</B></TT>
<DL><DT><DD></DL><P></DL>
<HR><DL><DT><B>This class has no child classes.</B></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>
Reference in New Issue View Git Blame Copy Permalink