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

SbBox3f Class Reference

The SbBox3f class is an abstraction for an axis aligned 3 dimensional box. More...

#include <Inventor/SbBox.h>

Inheritance diagram for SbBox3f::

Public Methods
	SbBox3f (void)
	SbBox3f (const float minx, const float miny, const float minz, const float maxx, const float maxy, const float maxz)
	SbBox3f (const SbVec3f &min, const SbVec3f &max)
	~SbBox3f ()
const SbVec3f &	getMin (void) const
const SbVec3f &	getMax (void) const
SbVec3f &	getMin (void)
SbVec3f &	getMax (void)
SbVec3f	getCenter (void) const
void	extendBy (const SbVec3f &point)
void	extendBy (const SbBox3f &box)
SbBool	intersect (const SbVec3f &point) const
SbBool	intersect (const SbBox3f &box) const
void	setBounds (const float minx, const float miny, const float minz, const float maxx, const float maxy, const float maxz)
void	setBounds (const SbVec3f &min, const SbVec3f &max)
void	getBounds (float &minx, float &miny, float &minz, float &maxx, float &maxy, float &maxz) const
void	getBounds (SbVec3f &min, SbVec3f &max) const
void	getOrigin (float &x0, float &y0, float &z0) const
void	getSize (float &dx, float &dy, float &dz) const
void	makeEmpty (void)
SbBool	isEmpty (void) const
SbBool	hasVolume (void) const
void	getSpan (const SbVec3f &dir, float &dmin, float &dmax) const
void	transform (const SbMatrix &matrix)
float	getVolume (void) const
SbBool	outside (const SbMatrix &mvp, int &cullbits) const
SbVec3f	getClosestPoint (const SbVec3f &point) const
void	print (FILE *file) const
Friends
COIN_DLL_API int	operator== (const SbBox3f &b1, const SbBox3f &b2)
COIN_DLL_API int	operator!= (const SbBox3f &b1, const SbBox3f &b2)

Detailed Description

The SbBox3f class is an abstraction for an axis aligned 3 dimensional box.

This box abstraction class is used by other entities in the Coin library for data exchange and storage. It provides a representation of the defining corners of a box in 3D space, with the sides aligned with the 3 principal axes.

See also:: SbBox2f, SbBox2s, SbXfBox3f

Constructor & Destructor Documentation

SbBox3f::SbBox3f ( void )

The default constructor makes an empty box.

SbBox3f::SbBox3f ( const float minx,

const float miny,

const float minz,

const float maxx,

const float maxy,

const float maxz

)

Constructs a box with the given corners.
minx should be less than maxx, miny should be less than maxy and minz should be less than maxz if you want to make a valid box.

SbBox3f::SbBox3f ( const SbVec3f & min,

const SbVec3f & max

)

Constructs a 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.

SbBox3f::~SbBox3f ( void )

Default destructor does nothing.

Member Function Documentation

const SbVec3f & SbBox3f::getMin ( void ) const

Returns the minimum point. This should usually be the lower left corner point of the box.

See also:
getOrigin(), getMax().

const SbVec3f & SbBox3f::getMax ( void ) const

Returns the maximum point. This should usually be the upper right corner point of the box.

See also:
getMin().

SbVec3f & SbBox3f::getMin ( void )

Returns a modifiable reference the minimum point.

SbVec3f & SbBox3f::getMax ( void )

Returns a modifiable reference the maximum point.

SbVec3f SbBox3f::getCenter ( void ) const

Returns the center point of the box.
Reimplemented in SbXfBox3f.

void SbBox3f::extendBy ( const SbVec3f & pt )

Extend the boundaries of the box by the given point, i.e. make the point fit inside the box if it isn't already so.
Reimplemented in SbXfBox3f.

void SbBox3f::extendBy ( const SbBox3f & bb )

Extend the boundaries of the box by the given box parameter. This is equal to calling extendBy() twice with the corner points.
Reimplemented in SbXfBox3f.

SbBool SbBox3f::intersect ( const SbVec3f & pt ) const

Check if the given point lies within the boundaries of this box.
Reimplemented in SbXfBox3f.

SbBool SbBox3f::intersect ( const SbBox3f & bb ) const

Check if the given box lies wholly or partly within the boundaries of this box.
Reimplemented in SbXfBox3f.

void SbBox3f::setBounds ( const float minx,

const float miny,

const float minz,

const float maxx,

const float maxy,

const float maxz

)

Reset the boundaries of the box.
minx should be less than maxx, miny should be less than maxy and minz should be less than maxz if you want to make a valid box.

See also:
getBounds().

void SbBox3f::setBounds ( const SbVec3f & min,

const SbVec3f & 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 SbBox3f::getBounds ( float & minx,

float & miny,

float & minz,

float & maxx,

float & maxy,

float & maxz

) const

Returns the box boundaries.

See also:
setBounds().

void SbBox3f::getBounds ( SbVec3f & min,

SbVec3f & max

) const

Returns the box corner points.

See also:
setBounds().

void SbBox3f::getOrigin ( float & x0,

float & y0,

float & z0

) const

Returns the coordinates of the box origin (i.e. the lower left corner).

See also:
getMin().

void SbBox3f::getSize ( float & dx,

float & dy,

float & dz

) const

Returns width, height and depth of box.

void SbBox3f::makeEmpty ( void )

Marks this as an empty box.

See also:
isEmpty().

SbBool SbBox3f::isEmpty ( void ) const

Check if this has been marked as an empty box.

See also:
makeEmpty().

SbBool SbBox3f::hasVolume ( void ) const

Check if the box has been correctly specified and by that virtue has volume.

void SbBox3f::getSpan ( const SbVec3f & direction,

float & dMin,

float & dMax

) const

Find the span of the box in the given direction (i.e. how much room in the given direction the box needs). The distance is returned as the minimum and maximum distance from origo to the closest and furthest plane defined by the direction vector and each of the box' corners. The difference between these values gives the span.
Reimplemented in SbXfBox3f.

void SbBox3f::transform ( const SbMatrix & m )

Transform the box by the matrix, and change its boundaries to contain the transformed box.
Doesn't touch illegal/empty boxes.
Reimplemented in SbXfBox3f.

float SbBox3f::getVolume ( void ) const

Check if the box has "positive" volume, i.e. the lower left corner is actually lower and more left than the maximum point.
Reimplemented in SbXfBox3f.

SbBool SbBox3f::outside ( const SbMatrix & mvp,

int & cullbits

) const

Check if the box is outside the view volume defined by the mvp matrix. Sets cullbits according to which planes we're inside or outside. Bit 0 (0x1) is cleared when box is completely inside left and right clipping planes. Bit 1 (0x2) is cleared when box is inside top and bottom clipping planes. Bit 2 (0x4) is cleared when box is inside near and far clipping planes.
Returns TRUE if box is completely outside one of the clipping planes. FALSE otherwise.

SbVec3f SbBox3f::getClosestPoint ( const SbVec3f & point ) const

Return the point on the box closest to the given point.

void SbBox3f::print ( FILE * fp ) const

Dump the state of this object to the file stream. Only works in debug version of library, method does nothing in an optimized compile.
Reimplemented in SbXfBox3f.

Friends And Related Function Documentation

int operator== ( const SbBox3f & b1,

const SbBox3f & b2

) [friend]

Check b1 and b2 for equality.

int operator!= ( const SbBox3f & b1,

const SbBox3f & b2

) [friend]

Check b1 and b2 for inequality.

The documentation for this class was generated from the following files:

SbBox3f.cpp
SbBox3f.h

Generated at Tue Mar 5 03:31:22 2002 for Coin by

SbBox3f Class Reference

Public Methods

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation