SbBox2f(3IV)

NAME
     SbBox2f (SbBox2f) - 2D box class

INHERITS FROM
     SbBox2f

SYNOPSIS
     #include <Inventor_c/SbBox.h>

          Functions from class SbBox2f:

     SbBox2f *           SbBox2fCreate()
     SbBox2f *           SbBox2fCreateBounds(float xmin, float ymin, float
                              xmax float ymax)
     SbBox2f *           SbBox2fCreateMinMax(const SbVec2f *min, const SbVec2f
                              *max)
     voidvoid            SbBox2fDelete(SbBox2f *this)
     const SbVec2f *     SbBox2fGetMin(SbBox2f *this)
     const SbVec2f *     SbBox2fGetMax(SbBox2f *this)
     SbVec2f             SbBox2fGetCenter(SbBox2f *this)
     void                SbBox2fExtendByPt(SbBox2f *this, const SbVec2f
                              *point)
     void                SbBox2fExtendByBox(SbBox2f *this, const SbBox2f *box)
     SbBool              SbBox2fIntersectPt(SbBox2f *this, const SbVec2f
                              *point)
     SbBool              SbBox2fIntersectBox(SbBox2f *this, const SbBox2f
                              *box)
     void                SbBox2fSetBounds(SbBox2f *this, float xmin, float
                              ymin, float xmax, float ymax)
     void                SbBox2fSetBoundsMinMax(SbBox2f *this, const SbVec2f
                              *min, const SbVec2f *max)
     void                SbBox2fGetBounds(SbBox2f *this, float *xmin, float
                              *ymin, float *xmax, float *ymax)
     void                SbBox2fGetBoundsMinMax(SbBox2f *this, SbVec2f *min,
                              SbVec2f *max)
     void                SbBox2fGetOrigin(SbBox2f *this, float *x0, float *y0)
     void                SbBox2fGetSize(SbBox2f *this, float *x, float *y)
     float               SbBox2fGetAspectRatio(SbBox2f *this)
     void                SbBox2fMakeEmpty(SbBox2f *this)
     SbBool              SbBox2fIsEmpty(SbBox2f *this)
     SbBool              SbBox2fHasArea(SbBox2f *this)


DESCRIPTION
     2D box which has planes parallel to the major axes and is specified by
     two points (specified as floating point) on a diagonal. This class is
     part of the standard Inventor datatype classes and is used as input and
     output to geometry operations.

FUNCTIONS
     SbBox2f *           SbBox2fCreate()
     SbBox2f *           SbBox2fCreateBounds(float xmin, float ymin, float
                              xmax float ymax)
     SbBox2f *           SbBox2fCreateMinMax(const SbVec2f *min, const SbVec2f
                              *max)
     voidvoid            SbBox2fDelete(SbBox2f *this)
          Constructors and destructor for a 2D float box. xmin, ymin, xmax,
          and ymax are the bounds of the box. min and max are the corners of
          the diagonal that define the box.

     const SbVec2f *     SbBox2fGetMin(SbBox2f *this)
     const SbVec2f *     SbBox2fGetMax(SbBox2f *this)
          Returns the minimum and maximum points of the box.

     SbVec2f             SbBox2fGetCenter(SbBox2f *this)
          Returns the center of the box.

     void                SbBox2fExtendByPt(SbBox2f *this, const SbVec2f
                              *point)
     void                SbBox2fExtendByBox(SbBox2f *this, const SbBox2f *box)
          Extends this box (if necessary) to contain the specified point or
          other box.

     SbBool              SbBox2fIntersectPt(SbBox2f *this, const SbVec2f
                              *point)
     SbBool              SbBox2fIntersectBox(SbBox2f *this, const SbBox2f
                              *box)
          Returns TRUE if the specified point or box intersects this box.

     void                SbBox2fSetBounds(SbBox2f *this, float xmin, float
                              ymin, float xmax, float ymax)
     void                SbBox2fSetBoundsMinMax(SbBox2f *this, const SbVec2f
                              *min, const SbVec2f *max)
          Sets the corners of the box.

     void                SbBox2fGetBounds(SbBox2f *this, float *xmin, float
                              *ymin, float *xmax, float *ymax)
     void                SbBox2fGetBoundsMinMax(SbBox2f *this, SbVec2f *min,
                              SbVec2f *max)
          Gets the corners of the box.

     void                SbBox2fGetOrigin(SbBox2f *this, float *x0, float *y0)
          Gets box origin.

     void                SbBox2fGetSize(SbBox2f *this, float *x, float *y)
          Gets box size.

     float               SbBox2fGetAspectRatio(SbBox2f *this)
          Gets box aspect ratio.

     void                SbBox2fMakeEmpty(SbBox2f *this)
          Makes an empty box.
     SbBool              SbBox2fIsEmpty(SbBox2f *this)
          Returns TRUE if the box is empty, and FALSE otherwise.

     SbBool              SbBox2fHasArea(SbBox2f *this)
          Returns TRUE if both dimensions of the box have positive size, and
          FALSE otherwise.


FILE FORMAT/DEFAULTS
     Box2f {
     }

SEE ALSO
     SbBox3f, SbXfBox3f, SbBox2s, SbVec3f, SbVec2f, SbVec2s, SbMatrix