Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SbBox2f Class Reference

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

#include <Inventor/SbBox.h>

List of all members.

Public Methods

 SbBox2f (void)
 SbBox2f (float xmin, float ymin, float xmax, float ymax)
 SbBox2f (const SbVec2f &min, const SbVec2f &max)
 ~SbBox2f (void)
const SbVec2fgetMin (void) const
const SbVec2fgetMax (void) const
SbVec2f getCenter (void) const
void extendBy (const SbVec2f &point)
void extendBy (const SbBox2f &box)
SbBool intersect (const SbVec2f &point) const
SbBool intersect (const SbBox2f &box) const
SbVec2f getClosestPoint (const SbVec2f &p) const
void setBounds (float xmin, float ymin, float xmax, float ymax)
void setBounds (const SbVec2f &min, const SbVec2f &max)
void getBounds (float &xmin, float &ymin, float &xmax, float &ymax) const
void getBounds (SbVec2f &min, SbVec2f &max) const
void getOrigin (float &x0, float &y0) const
void getSize (float &w, float &h) const
float getAspectRatio (void) const
void makeEmpty (void)
SbBool isEmpty (void) const
SbBool hasArea (void) const

Friends

COIN_DLL_API int operator== (const SbBox2f &b1, const SbBox2f &b2)
COIN_DLL_API 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, SbBox3f


Constructor & Destructor Documentation

SbBox2f::SbBox2f void
 

The default constructor makes an empty box.

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.

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.

SbBox2f::~SbBox2f void
 

Destructor.


Member Function Documentation

const SbVec2f & SbBox2f::getMin void const
 

Returns the lower left corner of the box.

See also:
getOrigin(), getMax().

const SbVec2f & SbBox2f::getMax void const
 

Returns the upper right corner of the box.

See also:
getMin().

SbVec2f SbBox2f::getCenter void const
 

Returns the center point of the box.

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.

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.

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.

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().

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().

void SbBox2f::getBounds float & xmin,
float & ymin,
float & xmax,
float & ymax
const
 

Returns the box boundaries.

See also:
setBounds(), getMin(), getMax().

void SbBox2f::getBounds SbVec2f & min,
SbVec2f & max
const
 

Returns the box corner points.

See also:
setBounds(), getMin(), getMax().

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.

float SbBox2f::getAspectRatio void const
 

Returns aspect ratio of box, which is defined as box width divided on box height.

void SbBox2f::makeEmpty void
 

Marks this as an empty box.

See also:
isEmpty().

SbBool SbBox2f::isEmpty void const
 

Check if this has been marked as an empty box.

See also:
makeEmpty().

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.


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.


The documentation for this class was generated from the following files:
Generated at Tue Mar 5 03:31:22 2002 for Coin by doxygen1.2.9 written by Dimitri van Heesch, © 1997-2001