Provided by: libcoin60-doc_3.1.3-2_all bug

NAME

       SbBox3f -

       The SbBox3f class is an abstraction for an axis aligned 3 dimensional box.

       This box abstraction class is used by other entities in the Coin library for data exchange
       and storage. It provides a representation of the defining corners of a box in 3D space,
       with the sides aligned with the 3 principal axes.

SYNOPSIS

       #include <Inventor/SbBox.h>

       Inherited by SbXfBox3f.

   Public Member Functions
       SbBox3f (void)
       SbBox3f (float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)
       SbBox3f (const SbVec3f &minpoint, const SbVec3f &maxpoint)
       SbBox3f (const SbBox3d &box)
       SbBox3f (const SbBox3s &box)
       SbBox3f (const SbBox3i32 &box)
       SbBox3f & setBounds (float xmin, float ymin, float zmin, float xmax, float ymax, float
           zmax)
       SbBox3f & setBounds (const SbVec3f &minpoint, const SbVec3f &maxpoint)
       SbBox3f & setBounds (const SbBox3d &box)
       SbBox3f & setBounds (const SbBox3s &box)
       SbBox3f & setBounds (const SbBox3i32 &box)
       void getBounds (float &xmin, float &ymin, float &zmin, float &xmax, float &ymax, float
           &zmax) const
       void getBounds (SbVec3f &minpoint, SbVec3f &maxpoint) const
       const SbVec3f & getMin (void) const
       SbVec3f & getMin (void)
       const SbVec3f & getMax (void) const
       SbVec3f & getMax (void)
       void extendBy (const SbVec3f &pt)
       void extendBy (const SbBox3f &box)
       void transform (const SbMatrix &matrix)
       void makeEmpty (void)
       SbBool isEmpty (void) const
       SbBool hasVolume (void) const
       float getVolume (void) const
       SbBool intersect (const SbVec3f &pt) const
       SbBool intersect (const SbBox3f &box) const
       SbVec3f getClosestPoint (const SbVec3f &point) const
       SbBool outside (const SbMatrix &mvp, int &cullbits) const
       SbVec3f getCenter (void) const
       void getOrigin (float &originX, float &originY, float &originZ) const
       void getSize (float &sizeX, float &sizeY, float &sizeZ) const
       SbVec3f getSize (void) const
       void getSpan (const SbVec3f &dir, float &dmin, float &dmax) const
       void print (FILE *file) const

   Related Functions
       (Note that these are not member functions.)
       int operator== (const SbBox3f &b1, const SbBox3f &b2)
       int operator!= (const SbBox3f &b1, const SbBox3f &b2)

Detailed Description

       The SbBox3f class is an abstraction for an axis aligned 3 dimensional box.

       This box abstraction class is used by other entities in the Coin library for data exchange
       and storage. It provides a representation of the defining corners of a box in 3D space,
       with the sides aligned with the 3 principal axes.

       See also:
           SbBox2s, SbBox2f, SbBox2d, SbBox3s, SbBox3d, SbXfBox3f.

Constructor & Destructor Documentation

   SbBox3f::SbBox3f (void) [inline] The default constructor makes an empty box.
   SbBox3f::SbBox3f (floatminx, floatminy, floatminz, floatmaxx, floatmaxy, floatmaxz) [inline]
       Constructs a box with the given corners.
       minx should be less than maxx, miny should be less than maxy and minz should be less than
       maxz if you want to make a valid box.

   SbBox3f::SbBox3f (const SbVec3f &minval, const SbVec3f &maxval) [inline] Constructs a box with
       the given corners.
       The coordinates of min should be less than the coordinates of max if you want to make a
       valid box.

Member Function Documentation

   SbBox3f & SbBox3f::setBounds (floatminx, floatminy, floatminz, floatmaxx, floatmaxy,
       floatmaxz) [inline] Reset the boundaries of the box.
       minx should be less than maxx, miny should be less than maxy and minz should be less than
       maxz if you want to make a valid box.

       Returns reference to self.

       See also:
           getBounds().

   SbBox3f & SbBox3f::setBounds (const SbVec3f &minval, const SbVec3f &maxval) [inline] Reset the
       boundaries of the box with the given corners.
       The coordinates of min should be less than the coordinates of max if you want to make a
       valid box.

       Returns reference to self.

       See also:
           getBounds().

   SbBox3f & SbBox3f::setBounds (const SbBox3d &box) Reset the boundaries to the boundaries of
       the given box.
       Returns reference to self.

       See also:
           getBounds().

   SbBox3f & SbBox3f::setBounds (const SbBox3s &box) Reset the boundaries to the boundaries of
       the given box.
       Returns reference to self.

       See also:
           getBounds().

   SbBox3f & SbBox3f::setBounds (const SbBox3i32 &box) Reset the boundaries to the boundaries of
       the given box.
       Returns reference to self.

       See also:
           getBounds().

   void SbBox3f::getBounds (float &minx, float &miny, float &minz, float &maxx, float &maxy,
       float &maxz) const [inline] Returns the box boundaries.
       See also:
           setBounds().

   void SbBox3f::getBounds (SbVec3f &minobj, SbVec3f &maxobj) const [inline] Returns the box
       corner points.
       See also:
           setBounds().

   const SbVec3f & SbBox3f::getMin (void) const [inline] Returns the minimum point. This should
       usually be the lower left corner point of the box.
       See also:
           getOrigin(), getMax().

   SbVec3f & SbBox3f::getMin (void) [inline] Returns a modifiable reference the minimum point.
   const SbVec3f & SbBox3f::getMax (void) const [inline] Returns the maximum point. This should
       usually be the upper right corner point of the box.
       See also:
           getMin().

   SbVec3f & SbBox3f::getMax (void) [inline] Returns a modifiable reference the maximum point.
   void SbBox3f::extendBy (const SbVec3f &point) Extend the boundaries of the box by the given
       point, i.e. make the point fit inside the box if it isn't already so.
       Reimplemented in SbXfBox3f.

   void SbBox3f::extendBy (const SbBox3f &box) Extend the boundaries of the box by the given box
       parameter. This is equal to calling extendBy() twice with the corner points.
       Reimplemented in SbXfBox3f.

   void SbBox3f::transform (const SbMatrix &matrix) Transform the box by the matrix, and change
       its boundaries to contain the transformed box.
       Doesn't touch illegal/empty boxes.

       Reimplemented in SbXfBox3f.

   void SbBox3f::makeEmpty (void) Marks this as an empty box.
       See also:
           isEmpty().

   SbBool SbBox3f::isEmpty (void) const [inline] Check if this has been marked as an empty box.
       See also:
           makeEmpty().

   SbBool SbBox3f::hasVolume (void) const [inline] Check if the box has been correctly specified
       and by that virtue has volume.
   float SbBox3f::getVolume (void) const [inline] Check if the box has 'positive' volume, i.e.
       the lower left corner is actually lower and more left than the maximum point.
       Reimplemented in SbXfBox3f.

   SbBool SbBox3f::intersect (const SbVec3f &point) const Check if the given point lies within
       the boundaries of this box.
       Reimplemented in SbXfBox3f.

   SbBool SbBox3f::intersect (const SbBox3f &box) const Check if the given box lies wholly or
       partly within the boundaries of this box.
       Reimplemented in SbXfBox3f.

   SbVec3f SbBox3f::getClosestPoint (const SbVec3f &point) const Return the point on the box
       closest to the given point.
   SbBool SbBox3f::outside (const SbMatrix &mvp, int &cullbits) const Check if the box is outside
       the view volume defined by the mvp matrix. Sets cullbits according to which planes we're
       inside or outside. Bit 0 (0x1) is cleared when box is completely inside left and right
       clipping planes. Bit 1 (0x2) is cleared when box is inside top and bottom clipping planes.
       Bit 2 (0x4) is cleared when box is inside near and far clipping planes.
       Returns TRUE if box is completely outside one of the clipping planes. FALSE otherwise.

   SbVec3f SbBox3f::getCenter (void) const [inline] Returns the center point of the box.
       Reimplemented in SbXfBox3f.

   void SbBox3f::getOrigin (float &x0, float &y0, float &z0) const [inline] Returns the
       coordinates of the box origin (i.e. the lower left corner).
       See also:
           getMin().

   void SbBox3f::getSize (float &dx, float &dy, float &dz) const [inline] Returns width, height
       and depth of box.
   SbVec3f SbBox3f::getSize (void) const [inline] Returns width, height and depth of box as a 3D
       vector.
       Since:
           Coin 3.0

   void SbBox3f::getSpan (const SbVec3f &dir, float &dmin, float &dmax) const Find the span of
       the box in the given direction (i.e. how much room in the given direction the box needs).
       The distance is returned as the minimum and maximum distance from origo to the closest and
       furthest plane defined by the direction vector and each of the box' corners. The
       difference between these values gives the span.
       Reimplemented in SbXfBox3f.

   void SbBox3f::print (FILE *fp) const Dump the state of this object to the file stream. Only
       works in debug version of library, method does nothing in an optimized compile.
       Reimplemented in SbXfBox3f.

Friends And Related Function Documentation

   int operator== (const SbBox3f &b1, const SbBox3f &b2) [related] Check b1 and b2 for equality.
   int operator!= (const SbBox3f &b1, const SbBox3f &b2) [related] Check b1 and b2 for
       inequality.

Author

       Generated automatically by Doxygen for Coin from the source code.