2001-09-20 05:19:47 +08:00
<!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.3.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.3.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 >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline < B > < A HREF = "#DOC.2.3.3" > BoundingBox< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< DD > < I > construct to invalid values to represent an unset bounding box< / I >
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline < B > < A HREF = "#DOC.2.3.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.3.5" > BoundingBox< / A > < / B > (const <!1> < A HREF = "Vec3.html" > Vec3< / A > & min, const <!1> < A HREF = "Vec3.html" > Vec3< / A > & 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.3.6" > init< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< DD > < I > initialize to invalid values to represent an unset bounding box< / I >
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const bool < B > < A HREF = "#DOC.2.3.7" > isValid< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DD > < I > return true if the bounding box contains valid values, false if the bounding box is effectively unset/empty< / I >
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.3.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.3.9" > set< / A > < / B > (const <!1> < A HREF = "Vec3.html" > Vec3< / A > & min, const <!1> < A HREF = "Vec3.html" > Vec3< / A > & max)
< DD > < I > construct to with specified min and max values< / I >
< DT >
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float& < B > < A HREF = "#DOC.2.3.10" > xMin< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const float < B > < A HREF = "#DOC.2.3.11" > xMin< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float& < B > < A HREF = "#DOC.2.3.12" > yMin< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const float < B > < A HREF = "#DOC.2.3.13" > yMin< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float& < B > < A HREF = "#DOC.2.3.14" > zMin< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const float < B > < A HREF = "#DOC.2.3.15" > zMin< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float& < B > < A HREF = "#DOC.2.3.16" > xMax< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const float < B > < A HREF = "#DOC.2.3.17" > xMax< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float& < B > < A HREF = "#DOC.2.3.18" > yMax< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const float < B > < A HREF = "#DOC.2.3.19" > yMax< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float& < B > < A HREF = "#DOC.2.3.20" > zMax< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const float < B > < A HREF = "#DOC.2.3.21" > zMax< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const <!1> < A HREF = "Vec3.html" > Vec3< / A > < B > < A HREF = "#DOC.2.3.22" > center< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DD > < I > Calculate and return the center of the bounding box< / I >
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const float < B > < A HREF = "#DOC.2.3.23" > radius< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DD > < I > Calculate and return the radius of the bounding box< / I >
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const float < B > < A HREF = "#DOC.2.3.24" > radius2< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DD > < I > Calculate and return the radius squared of the bounding box.< / I >
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const <!1> < A HREF = "Vec3.html" > Vec3< / A > < B > < A HREF = "#DOC.2.3.25" > corner< / A > < / B > (unsigned int pos) const
2001-09-20 05:19:47 +08:00
< DD > < I > return the corner of the bounding box.< / I >
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > void < B > < A HREF = "#DOC.2.3.26" > expandBy< / A > < / B > (const <!1> < A HREF = "Vec3.html" > Vec3< / A > & v)
< DD > < I > If the vertex is out-with the box expand to encompass vertex.< / I >
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > void < B > < A HREF = "#DOC.2.3.27" > expandBy< / A > < / B > (const <!1> < A HREF = "BoundingBox.html" > BoundingBox< / A > & bb)
< DD > < I > If incoming box is out-with the box expand to encompass incoming box.< / I >
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > void < B > < A HREF = "#DOC.2.3.28" > expandBy< / A > < / B > (const <!1> < A HREF = "BoundingSphere.html" > BoundingSphere< / A > & sh)
< DD > < I > If incoming sphere is out-with the box expand to encompass incoming sphere.< / I >
2001-09-20 05:19:47 +08:00
< DT >
2001-12-25 05:56:22 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const bool < B > < A HREF = "#DOC.2.3.29" > contains< / A > < / B > (const <!1> < A HREF = "Vec3.html" > Vec3< / A > & v) const
2001-09-20 05:19:47 +08:00
< 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.3.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.3.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.3.3" > < / A >
2001-12-25 05:56:22 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline BoundingBox()< / B > < / TT >
2001-09-20 05:19:47 +08:00
< DD > construct to invalid values to represent an unset bounding box
< DL > < DT > < DD > < / DL > < P >
2001-12-25 05:56:22 +08:00
< A NAME = "BoundingBox" > < / A >
2001-09-20 05:19:47 +08:00
< A NAME = "DOC.2.3.4" > < / A >
2001-12-25 05:56:22 +08:00
< 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.3.5" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline BoundingBox(const <!1> < A HREF = "Vec3.html" > Vec3< / A > & min, const <!1> < A HREF = "Vec3.html" > Vec3< / A > & 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.3.6" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.7" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "set" > < / A >
< A NAME = "DOC.2.3.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.3.9" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void set(const <!1> < A HREF = "Vec3.html" > Vec3< / A > & min, const <!1> < A HREF = "Vec3.html" > Vec3< / A > & max)< / B > < / TT >
< DD > construct to with specified min and max values
< DL > < DT > < DD > < / DL > < P >
2001-09-20 05:19:47 +08:00
< A NAME = "xMin" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.10" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float& xMin()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "xMin" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.11" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.12" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float& yMin()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "yMin" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.13" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.14" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float& zMin()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "zMin" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.15" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.16" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float& xMax()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "xMax" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.17" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.18" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float& yMax()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "yMax" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.19" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.20" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float& zMax()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "zMax" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.21" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.22" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.23" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.24" > < / A >
2001-09-20 05:19:47 +08:00
< 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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.25" > < / A >
2001-09-20 05:19:47 +08:00
< 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.
2001-12-25 05:56:22 +08:00
Position (pos) is specified by a number between 0 and 7,
2001-09-20 05:19:47 +08:00
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 >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.26" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > void expandBy(const <!1> < A HREF = "Vec3.html" > Vec3< / A > & v)< / B > < / TT >
2001-12-25 05:56:22 +08:00
< DD > If the vertex is out-with the box expand to encompass vertex.
2001-09-20 05:19:47 +08:00
If this box is empty then move set this box's min max to vertex.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "expandBy" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.27" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > void expandBy(const <!1> < A HREF = "BoundingBox.html" > BoundingBox< / A > & bb)< / B > < / TT >
2001-12-25 05:56:22 +08:00
< 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.
2001-09-20 05:19:47 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "expandBy" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.28" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > void expandBy(const <!1> < A HREF = "BoundingSphere.html" > BoundingSphere< / A > & sh)< / B > < / TT >
2001-12-25 05:56:22 +08:00
< DD > If incoming sphere is out-with the box expand to encompass incoming sphere.
2001-09-20 05:19:47 +08:00
If this box is empty then move set this box to encompass the sphere.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "contains" > < / A >
2001-12-25 05:56:22 +08:00
< A NAME = "DOC.2.3.29" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const bool contains(const <!1> < A HREF = "Vec3.html" > Vec3< / A > & 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 >
