FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
5feba17410
OpenSceneGraph/doc/doc++/osg/BoundingBox.html
Robert Osfield a0cb66ed78 A second try at commit these updates to docs.
2002-04-21 21:53:03 +00:00

255 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class SG_EXPORT osg::BoundingBox</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class SG_EXPORT <A HREF="#DOC.DOCU">osg::BoundingBox</A></H2></H2><BLOCKQUOTE>General purpose axis-aligned bounding box class for enclosing objects/vertices.</BLOCKQUOTE>
<HR>
<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Vec3.html">Vec3</A> <B><A HREF="#DOC.2.4.1">_min</A></B>
<DD><I>The corner with the smallest values for each coordinate of the bounding box</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Vec3.html">Vec3</A> <B><A HREF="#DOC.2.4.2">_max</A></B>
<DD><I>The corner with the largest values for each coordinate of the bounding box</I>
</DL></P>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <B><A HREF="#DOC.2.4.3">BoundingBox</A></B>()
<DD><I>construct to invalid values to represent an unset bounding box</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <B><A HREF="#DOC.2.4.4">BoundingBox</A></B>(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)
<DD><I>construct to with specified min and max values</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <B><A HREF="#DOC.2.4.5">BoundingBox</A></B>(const <!1><A HREF="Vec3.html">Vec3</A>&amp; min, const <!1><A HREF="Vec3.html">Vec3</A>&amp; max)
<DD><I>construct to with specified min and max values</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.4.6">init</A></B>()
<DD><I>initialize to invalid values to represent an unset bounding box</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const bool <B><A HREF="#DOC.2.4.7">isValid</A></B>() const
<DD><I>return true if the bounding box contains valid values, false if the bounding box is effectively unset/empty</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.4.8">set</A></B>(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.4.9">set</A></B>(const <!1><A HREF="Vec3.html">Vec3</A>&amp; min, const <!1><A HREF="Vec3.html">Vec3</A>&amp; max)
<DD><I>construct to with specified min and max values</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline float&amp; <B><A HREF="#DOC.2.4.10">xMin</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const float <B><A HREF="#DOC.2.4.11">xMin</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline float&amp; <B><A HREF="#DOC.2.4.12">yMin</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const float <B><A HREF="#DOC.2.4.13">yMin</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline float&amp; <B><A HREF="#DOC.2.4.14">zMin</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const float <B><A HREF="#DOC.2.4.15">zMin</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline float&amp; <B><A HREF="#DOC.2.4.16">xMax</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const float <B><A HREF="#DOC.2.4.17">xMax</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline float&amp; <B><A HREF="#DOC.2.4.18">yMax</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const float <B><A HREF="#DOC.2.4.19">yMax</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline float&amp; <B><A HREF="#DOC.2.4.20">zMax</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const float <B><A HREF="#DOC.2.4.21">zMax</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Vec3.html">Vec3</A> <B><A HREF="#DOC.2.4.22">center</A></B>() const
<DD><I>Calculate and return the center of the bounding box</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const float <B><A HREF="#DOC.2.4.23">radius</A></B>() const
<DD><I>Calculate and return the radius of the bounding box</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const float <B><A HREF="#DOC.2.4.24">radius2</A></B>() const
<DD><I>Calculate and return the radius squared of the bounding box.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Vec3.html">Vec3</A> <B><A HREF="#DOC.2.4.25">corner</A></B>(unsigned int pos) const
<DD><I>return the corner of the bounding box.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.4.26">expandBy</A></B>(const <!1><A HREF="Vec3.html">Vec3</A>&amp; v)
<DD><I>If the vertex is out-with the box expand to encompass vertex.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.4.27">expandBy</A></B>(const <!1><A HREF="BoundingBox.html">BoundingBox</A>&amp; bb)
<DD><I>If incoming box is out-with the box expand to encompass incoming box.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.4.28">expandBy</A></B>(const <!1><A HREF="BoundingSphere.html">BoundingSphere</A>&amp; sh)
<DD><I>If incoming sphere is out-with the box expand to encompass incoming sphere.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const bool <B><A HREF="#DOC.2.4.29">contains</A></B>(const <!1><A HREF="Vec3.html">Vec3</A>&amp; v) const
<DD><I>return true is vertex v is within the box</I>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>General purpose axis-aligned bounding box class for enclosing objects/vertices.
Used to bounding the leaf objects in the scene,
i.e. osg::GeoSet's to assist in view frustum culling etc.</BLOCKQUOTE>
<DL>
<A NAME="_min"></A>
<A NAME="DOC.2.4.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Vec3.html">Vec3</A> _min</B></TT>
<DD>The corner with the smallest values for each coordinate of the
bounding box
<DL><DT><DD></DL><P>
<A NAME="_max"></A>
<A NAME="DOC.2.4.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Vec3.html">Vec3</A> _max</B></TT>
<DD>The corner with the largest values for each coordinate of the
bounding box
<DL><DT><DD></DL><P>
<A NAME="BoundingBox"></A>
<A NAME="DOC.2.4.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline BoundingBox()</B></TT>
<DD>construct to invalid values to represent an unset bounding box
<DL><DT><DD></DL><P>
<A NAME="BoundingBox"></A>
<A NAME="DOC.2.4.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline BoundingBox(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)</B></TT>
<DD>construct to with specified min and max values
<DL><DT><DD></DL><P>
<A NAME="BoundingBox"></A>
<A NAME="DOC.2.4.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline BoundingBox(const <!1><A HREF="Vec3.html">Vec3</A>&amp; min, const <!1><A HREF="Vec3.html">Vec3</A>&amp; max)</B></TT>
<DD>construct to with specified min and max values
<DL><DT><DD></DL><P>
<A NAME="init"></A>
<A NAME="DOC.2.4.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void init()</B></TT>
<DD>initialize to invalid values to represent an unset bounding box
<DL><DT><DD></DL><P>
<A NAME="isValid"></A>
<A NAME="DOC.2.4.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const bool isValid() const </B></TT>
<DD>return true if the bounding box contains valid values,
false if the bounding box is effectively unset/empty
<DL><DT><DD></DL><P>
<A NAME="set"></A>
<A NAME="DOC.2.4.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void set(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="set"></A>
<A NAME="DOC.2.4.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void set(const <!1><A HREF="Vec3.html">Vec3</A>&amp; min, const <!1><A HREF="Vec3.html">Vec3</A>&amp; max)</B></TT>
<DD>construct to with specified min and max values
<DL><DT><DD></DL><P>
<A NAME="xMin"></A>
<A NAME="DOC.2.4.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline float&amp; xMin()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="xMin"></A>
<A NAME="DOC.2.4.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const float xMin() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="yMin"></A>
<A NAME="DOC.2.4.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline float&amp; yMin()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="yMin"></A>
<A NAME="DOC.2.4.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const float yMin() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="zMin"></A>
<A NAME="DOC.2.4.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline float&amp; zMin()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="zMin"></A>
<A NAME="DOC.2.4.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const float zMin() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="xMax"></A>
<A NAME="DOC.2.4.16"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline float&amp; xMax()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="xMax"></A>
<A NAME="DOC.2.4.17"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const float xMax() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="yMax"></A>
<A NAME="DOC.2.4.18"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline float&amp; yMax()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="yMax"></A>
<A NAME="DOC.2.4.19"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const float yMax() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="zMax"></A>
<A NAME="DOC.2.4.20"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline float&amp; zMax()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="zMax"></A>
<A NAME="DOC.2.4.21"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const float zMax() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="center"></A>
<A NAME="DOC.2.4.22"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec3.html">Vec3</A> center() const </B></TT>
<DD>Calculate and return the center of the bounding box
<DL><DT><DD></DL><P>
<A NAME="radius"></A>
<A NAME="DOC.2.4.23"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const float radius() const </B></TT>
<DD>Calculate and return the radius of the bounding box
<DL><DT><DD></DL><P>
<A NAME="radius2"></A>
<A NAME="DOC.2.4.24"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const float radius2() const </B></TT>
<DD>Calculate and return the radius squared of the bounding box.
Note, radius2() is faster to calculate than radius().
<DL><DT><DD></DL><P>
<A NAME="corner"></A>
<A NAME="DOC.2.4.25"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec3.html">Vec3</A> corner(unsigned int pos) const </B></TT>
<DD>return the corner of the bounding box.
Position (pos) is specified by a number between 0 and 7,
the first bit toggles between x min and x max, second
bit toggles between y min and y max, third bit toggles
between z min and z max.
<DL><DT><DD></DL><P>
<A NAME="expandBy"></A>
<A NAME="DOC.2.4.26"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void expandBy(const <!1><A HREF="Vec3.html">Vec3</A>&amp; v)</B></TT>
<DD>If the vertex is out-with the box expand to encompass vertex.
If this box is empty then move set this box's min max to vertex.
<DL><DT><DD></DL><P>
<A NAME="expandBy"></A>
<A NAME="DOC.2.4.27"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void expandBy(const <!1><A HREF="BoundingBox.html">BoundingBox</A>&amp; bb)</B></TT>
<DD>If incoming box is out-with the box expand to encompass incoming box.
If this box is empty then move set this box to incoming box.
<DL><DT><DD></DL><P>
<A NAME="expandBy"></A>
<A NAME="DOC.2.4.28"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void expandBy(const <!1><A HREF="BoundingSphere.html">BoundingSphere</A>&amp; sh)</B></TT>
<DD>If incoming sphere is out-with the box expand to encompass incoming sphere.
If this box is empty then move set this box to encompass the sphere.
<DL><DT><DD></DL><P>
<A NAME="contains"></A>
<A NAME="DOC.2.4.29"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const bool contains(const <!1><A HREF="Vec3.html">Vec3</A>&amp; v) const </B></TT>
<DD>return true is vertex v is within the box
<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