SbBox2s(3IV)

NAME
     SbBox2s (SbBox2s) - 2D box class

INHERITS FROM
     SbBox2s

SYNOPSIS
     #include <Inventor_c/SbBox.h>

          Functions from class SbBox2s:

     SbBox2s *           SbBox2sCreate()
     SbBox2s *           SbBox2sCreateBounds(short xmin, short ymin, short
                              xmax, short ymax)
     SbBox2s *           SbBox2sCreateMinMax(const SbVec2s *_min, const
                              SbVec2s *_max)
     voidvoid            SbBox2sDelete(SbBox2s *this)
     const SbVec2s *     SbBox2sGetMin(const SbBox2s *this)
     const SbVec2s *     SbBox2sGetMax(const SbBox2s *this)
     void                SbBox2sExtendByPt(SbBox2s *this, const SbVec2s
                              *point)
     void                SbBox2sExtendByBox(SbBox2s *this, const SbBox2s *box)
     SbBool              SbBox2sIntersectPt(const SbBox2s *this, const SbVec2s
                              *point)
     SbBool              SbBox2sIntersectBox(const SbBox2s *this, const
                              SbBox2s *box)
     void                SbBox2sSetBounds(SbBox2s *this, short xmin, short
                              ymin, short xmax, short ymax)
     void                SbBox2sSetBoundsMinMax(SbBox2s *this, const SbVec2s
                              *_min, const SbVec2s *_max)
     void                SbBox2sGetBounds(const SbBox2s *this, short *xmin,
                              short *ymin, short *xmax, short *ymax)
     void                SbBox2sGetBoundsMinMax(const SbBox2s *this, SbVec2s
                              *_min, SbVec2s *_max)
     void                SbBox2sGetOrigin(const SbBox2s *this, short *originX,
                              short *originY)
     void                SbBox2sGetSize(const SbBox2s *this, short *sizeX,
                              short *sizeY)
     float               SbBox2sGetAspectRatio(const SbBox2s *this)
     void                SbBox2sMakeEmpty(SbBox2s *this)
     int                 SbBox2sIsEq(SbBox2s *this, const SbBox2s *b1, const
                              SbBox2s *b2)
     int                 SbBox2sIsNEq(SbBox2s *this, const SbBox2s *b1, const
                              SbBox2s *b2)


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

FUNCTIONS
     SbBox2s *           SbBox2sCreate()
     SbBox2s *           SbBox2sCreateBounds(short xmin, short ymin, short
                              xmax, short ymax)
     SbBox2s *           SbBox2sCreateMinMax(const SbVec2s *_min, const
                              SbVec2s *_max)
     voidvoid            SbBox2sDelete(SbBox2s *this)
          Constructors and destructor for a 2D integer 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 SbVec2s *     SbBox2sGetMin(const SbBox2s *this)
     const SbVec2s *     SbBox2sGetMax(const SbBox2s *this)
          Returns the minimum and maximum points of the box.

     void                SbBox2sExtendByPt(SbBox2s *this, const SbVec2s
                              *point)
     void                SbBox2sExtendByBox(SbBox2s *this, const SbBox2s *box)
          Extends this box (if necessary) to contain the specified point or
          other box.

     SbBool              SbBox2sIntersectPt(const SbBox2s *this, const SbVec2s
                              *point)
     SbBool              SbBox2sIntersectBox(const SbBox2s *this, const
                              SbBox2s *box)
          Returns TRUE if the specified point or box intersects this box.

     void                SbBox2sSetBounds(SbBox2s *this, short xmin, short
                              ymin, short xmax, short ymax)
     void                SbBox2sSetBoundsMinMax(SbBox2s *this, const SbVec2s
                              *_min, const SbVec2s *_max)
          Sets the corners of the box.

     void                SbBox2sGetBounds(const SbBox2s *this, short *xmin,
                              short *ymin, short *xmax, short *ymax)
     void                SbBox2sGetBoundsMinMax(const SbBox2s *this, SbVec2s
                              *_min, SbVec2s *_max)
          Gets the corners of the box.

     void                SbBox2sGetOrigin(const SbBox2s *this, short *originX,
                              short *originY)
          Returns origin (minimum point) of box.

     void                SbBox2sGetSize(const SbBox2s *this, short *sizeX,
                              short *sizeY)
          Returns box size.

     float               SbBox2sGetAspectRatio(const SbBox2s *this)
          Returns aspect ratio (ratio of width to height) of box.

     void                SbBox2sMakeEmpty(SbBox2s *this)
          Makes an empty box.
     int                 SbBox2sIsEq(SbBox2s *this, const SbBox2s *b1, const
                              SbBox2s *b2)
     int                 SbBox2sIsNEq(SbBox2s *this, const SbBox2s *b1, const
                              SbBox2s *b2)
          Equality comparisons.


FILE FORMAT/DEFAULTS
     Box2s {
     }

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