sbbox2f(3)
NAME
SbBox2f
SYNOPSIS
#include <Inventor/SbBox.h>
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:
- SbBox2d, SbBox2i32, SbBox2s, SbBox3d, SbBox3f, SbBox3i32, SbBox3s, SbXfBox3d, SbXfBox3f
- Public Member Functions
- SbBox2f (void)
SbBox2f (float xmin, float ymin, float xmax, float ymax) SbBox2f (const SbVec2f &min, const SbVec2f &max) SbBox2f (const SbBox2d &box)
SbBox2f (const SbBox2s &box)
SbBox2f (const SbBox2i32 &box)
~SbBox2f (void)
void setBounds (float xmin, float ymin, float xmax, float ymax) void setBounds (const SbVec2f &min, const SbVec2f &max) 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 &min, SbVec2f &max) 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 &p) const SbVec2f getCenter (void) const
void getOrigin (float &x0, float &y0) const
void getSize (float &w, float &h) const
float getAspectRatio (void) const - Friends
- int operator== (const SbBox2f &b1, const SbBox2f &b2) int operator!= (const SbBox2f &b1, const SbBox2f &b2)
Constructor & Destructor Documentation
- SbBox2f::SbBox2f (void)
- The default constructor makes an empty box.
- References makeEmpty().
- SbBox2f::SbBox2f (float xmin, float ymin, float xmax, float ymax)
- 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.
- References setBounds().
- SbBox2f::SbBox2f (const SbVec2f & min, const SbVec2f & max)
- 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.
- References setBounds().
- SbBox2f::SbBox2f (const SbBox2d & box) [inline, explicit]
- Constructs a box with coordinates from box, converting the coordinates to floating point values
- Since:
Coin-2.5
- SbBox2f::SbBox2f (const SbBox2s & box) [inline, explicit]
- Constructs a box with coordinates from box, converting the coordinates to floating point values
- Since:
Coin-2.5
- SbBox2f::SbBox2f (const SbBox2i32 & box) [inline, explicit]
- Constructs a box with coordinates from box, converting the coordinates to floating point values
- Since:
Coin-2.5
- SbBox2f::~SbBox2f (void)
- Destructor.
Member Function Documentation
- void SbBox2f::setBounds (float xmin, float ymin, float xmax, float ymax)
- 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.
- See also:
getBounds().
- References SoDebugError::postWarning(), and SbVec2f::setValue().
- Referenced by SbBox2f().
- void SbBox2f::setBounds (const SbVec2f & min, const SbVec2f & max)
- 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.
- See also:
getBounds().
- References SoDebugError::postWarning().
- 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()
- Since:
Coin-2.5
- References SbBox2d::getMax(), SbBox2d::getMin(), SbBox2d::isEmpty(),
makeEmpty(), and SbVec2f::setValue(). - 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()
- Since:
Coin-2.5
- References SbBox2s::getMax(), SbBox2s::getMin(), SbBox2s::isEmpty(),
makeEmpty(), and SbVec2f::setValue(). - 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()
- Since:
Coin-2.5
- References SbBox2i32::getMax(), SbBox2i32::getMin(),
SbBox2i32::isEmpty(), makeEmpty(), and SbVec2f::setValue(). - void SbBox2f::getBounds (float & xmin, float & ymin, float & xmax, float &
- ymax) const
Returns the box boundaries. - See also:
setBounds(), getMin(), getMax().
- References SbVec2f::getValue().
- void SbBox2f::getBounds (SbVec2f & min, SbVec2f & max) const
- Returns the box corner points.
- See also:
setBounds(), getMin(), getMax().
- const SbVec2f & SbBox2f::getMin (void) const
- Returns the lower left corner of the box.
- See also:
getOrigin(), getMax().
- Referenced by extendBy(), SoGlyph::getWidth(), intersect(),
SbBox2s::setBounds(), SbBox2i32::setBounds(), and SbBox2d::setBounds(). - SbVec2f & SbBox2f::getMin (void) [inline]
- Returns the lower left corner of the box.
- See also:
getOrigin(), getMax().
- Since:
Coin-2.5
- const SbVec2f & SbBox2f::getMax (void) const
- Returns the upper right corner of the box.
- See also:
getMin().
- Referenced by extendBy(), SoGlyph::getWidth(), intersect(),
SbBox2s::setBounds(), SbBox2i32::setBounds(), and SbBox2d::setBounds(). - SbVec2f & SbBox2f::getMax (void) [inline]
- Returns the upper right corner of the box.
- See also:
getMin().
- Since:
Coin-2.5
- 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 isn't already situated within it.
- References SbVec2f::setValue().
- Referenced by extendBy(), and SoShape::getScreenSize().
- 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.
- References extendBy(), getMax(), getMin(), maxpt, minpt, and
SoDebugError::postWarning(). - void SbBox2f::makeEmpty (void)
- Marks this as an empty box.
- See also:
isEmpty().
- References SbVec2f::setValue().
- Referenced by SbBox2f(), and setBounds().
- SbBool SbBox2f::isEmpty (void) const
- Check if this has been marked as an empty box.
- See also:
makeEmpty().
- Referenced by SbBox2s::setBounds(), SbBox2i32::setBounds(), and
SbBox2d::setBounds(). - SbBool SbBox2f::hasArea (void) const
- Check if the box has 'positive' area, 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.
- References getMax(), and getMin().
- SbVec2f SbBox2f::getClosestPoint (const SbVec2f & p) const
- Return the point on the box closest to the given point p.
- References getCenter().
- SbVec2f SbBox2f::getCenter (void) const
- Returns the center point of the box.
- Referenced by getClosestPoint().
- void SbBox2f::getOrigin (float & x0, float & y0) const
- Returns the coordinates of the box origin (i.e. the lower left corner).
- See also:
getMin().
- void SbBox2f::getSize (float & w, float & h) const
- Returns width and height of box.
- References SoDebugError::postWarning().
- float SbBox2f::getAspectRatio (void) const
- Returns aspect ratio of box, which is defined as box width divided on
box height. - References SoDebugError::postWarning().
Friends And Related Function Documentation
- int operator== (const SbBox2f & b1, const SbBox2f & b2) [friend]
- Check b1 and b2 for equality.
- int operator!= (const SbBox2f & b1, const SbBox2f & b2) [friend]
- Check b1 and b2 for inequality.
Author
- Generated automatically by Doxygen for Coin from the source code.