Man Linux: Main Page and Category List

NAME

       SbBox2f -

       The SbBox2f class is a 2 dimensional box with floating point corner
       coordinates.

       This box class is used by many other classes in Coin for data exchange
       and storage. It provides two box corners with floating point
       coordinates, which is among other things useful for representing screen
       or canvas dimensions in normalized coordinates.

SYNOPSIS

       #include <Inventor/SbBox.h>

   Public Member Functions
       SbBox2f (void)
       SbBox2f (float xmin, float ymin, float xmax, float ymax)
       SbBox2f (const SbVec2f &minpoint, const SbVec2f &maxpoint)
       SbBox2f (const SbBox2d &box)
       SbBox2f (const SbBox2s &box)
       SbBox2f (const SbBox2i32 &box)
       SbBox2f & setBounds (float xmin, float ymin, float xmax, float ymax)
       SbBox2f & setBounds (const SbVec2f &minpoint, const SbVec2f &maxpoint)
       SbBox2f & setBounds (const SbBox2d &box)
       SbBox2f & setBounds (const SbBox2s &box)
       SbBox2f & setBounds (const SbBox2i32 &box)
       void getBounds (float &xmin, float &ymin, float &xmax, float &ymax)
           const
       void getBounds (SbVec2f &minpoint, SbVec2f &maxpoint) const
       const SbVec2f & getMin (void) const
       SbVec2f & getMin (void)
       const SbVec2f & getMax (void) const
       SbVec2f & getMax (void)
       void extendBy (const SbVec2f &point)
       void extendBy (const SbBox2f &box)
       void makeEmpty (void)
       SbBool isEmpty (void) const
       SbBool hasArea (void) const
       SbBool intersect (const SbVec2f &point) const
       SbBool intersect (const SbBox2f &box) const
       SbVec2f getClosestPoint (const SbVec2f &point) const
       SbVec2f getCenter (void) const
       void getOrigin (float &originX, float &originY) const
       void getSize (float &sizeX, float &sizeY) const
       float getAspectRatio (void) const

   Protected Attributes
       SbVec2f minpt
       SbVec2f maxpt

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

Detailed Description

       The SbBox2f class is a 2 dimensional box with floating point corner
       coordinates.

       This box class is used by many other classes in Coin for data exchange
       and storage. It provides two box corners with floating point
       coordinates, which is among other things useful for representing screen
       or canvas dimensions in normalized coordinates.

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

Constructor & Destructor Documentation

   SbBox2f::SbBox2f (void) [inline] The default constructor makes an empty
       box.
   SbBox2f::SbBox2f (float xmin, float ymin, float xmax, float ymax) [inline]
       Constructs a box with the given corners.
       xmin should be less than xmax and ymin should be less than ymax if you
       want to make a valid box.

   SbBox2f::SbBox2f (const SbVec2f & min, const SbVec2f & max) [inline]
       Constructs a box with the given lower left and upper right corners.
       The coordinates of min should be less than the coordinates of max if
       you want to make a valid box.

Member Function Documentation

   SbBox2f & SbBox2f::setBounds (float xmin, float ymin, float xmax, float
       ymax) [inline] Reset the boundaries of the box.
       xmin should be less than xmax and ymin should be less than ymax if you
       want to make a valid box.

       Returns reference to self.

       See also:
           getBounds().

   SbBox2f & SbBox2f::setBounds (const SbVec2f & min, const SbVec2f & max)
       [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().

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

       See also:
           getBounds()

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

       See also:
           getBounds()

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

       See also:
           getBounds()

   void SbBox2f::getBounds (float & xmin, float & ymin, float & xmax, float &
       ymax) const [inline] Returns the box boundaries.
       See also:
           setBounds(), getMin(), getMax().

   void SbBox2f::getBounds (SbVec2f & min, SbVec2f & max) const [inline]
       Returns the box corner points.
       See also:
           setBounds(), getMin(), getMax().

   const SbVec2f & SbBox2f::getMin (void) const [inline] Returns the lower
       left corner of the box.
       See also:
           getOrigin(), getMax().

   SbVec2f & SbBox2f::getMin (void) [inline] Returns a modifiable reference ot
       the lower left corner of the box.
       See also:
           getOrigin(), getMax().

   const SbVec2f & SbBox2f::getMax (void) const [inline] Returns the upper
       right corner of the box.
       See also:
           getMin().

   void SbBox2f::extendBy (const SbVec2f & point) Extend the boundaries of the
       box by the given point, i.e. make the box fit around the point if it
       isnt already situated within it.
   void SbBox2f::extendBy (const SbBox2f & box) Extend the boundaries of the
       box by the given box parameter. This is equal to calling the above
       method twice with the corner points.
   void SbBox2f::makeEmpty (void) Marks this as an empty box.
       See also:
           isEmpty().

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

   SbBool SbBox2f::hasArea (void) const [inline] Check if the box haspositivearea, i.e. the lower left corner is actually lower and more
       to the left than the other corner point.
   SbBool SbBox2f::intersect (const SbVec2f & point) const Check if point lies
       within the boundaries of this box.
   SbBool SbBox2f::intersect (const SbBox2f & box) const Check if box lies
       wholly or partly within the boundaries of this box.
   SbVec2f SbBox2f::getClosestPoint (const SbVec2f & p) const Return the point
       on the box closest to the given point p.
   SbVec2f SbBox2f::getCenter (void) const [inline] Returns the center point
       of the box.
   void SbBox2f::getOrigin (float & originX, float & originY) const [inline]
       Returns the coordinates of the box origin (i.e. the lower left corner).
       See also:
           getMin().

   void SbBox2f::getSize (float & sizeX, float & sizeY) const [inline] Returns
       width and height of box.
   float SbBox2f::getAspectRatio (void) const [inline] Returns aspect ratio of
       box, which is defined as box width divided on box height.

Friends And Related Function Documentation

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

Author

       Generated automatically by Doxygen for Coin from the source code.