SbBox3d Class Reference

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

#include <Inventor/SbBox3d.h>

Inheritance diagram for SbBox3d:

Public Member Functions
	SbBox3d (const SbBox3f &box)
	SbBox3d (const SbBox3i32 &box)
	SbBox3d (const SbBox3s &box)
	SbBox3d (const SbVec3d &minpoint, const SbVec3d &maxpoint)
	SbBox3d (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax)
	SbBox3d (void)
void	extendBy (const SbBox3d &box)
void	extendBy (const SbVec3d &pt)
void	getBounds (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) const
void	getBounds (SbVec3d &minpoint, SbVec3d &maxpoint) const
SbVec3d	getCenter (void) const
SbVec3d	getClosestPoint (const SbVec3d &point) const
SbVec3d &	getMax (void)
const SbVec3d &	getMax (void) const
SbVec3d &	getMin (void)
const SbVec3d &	getMin (void) const
void	getOrigin (double &origoX, double &origoY, double &origoZ) const
void	getSize (double &sizeX, double &sizeY, double &sizeZ) const
SbVec3d	getSize (void) const
void	getSpan (const SbVec3d &dir, double &dmin, double &dmax) const
double	getVolume (void) const
SbBool	hasVolume (void) const
SbBool	intersect (const SbBox3d &box) const
SbBool	intersect (const SbVec3d &point) const
SbBool	isEmpty (void) const
void	makeEmpty (void)
SbBool	outside (const SbDPMatrix &mvp, int &cullbits) const
void	print (FILE *file) const
SbBox3d &	setBounds (const SbBox3f &box)
SbBox3d &	setBounds (const SbBox3i32 &box)
SbBox3d &	setBounds (const SbBox3s &box)
SbBox3d &	setBounds (const SbVec3d &minpoint, const SbVec3d &maxpoint)
SbBox3d &	setBounds (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax)
void	transform (const SbDPMatrix &matrix)

Protected Attributes
SbVec3d	maxpt
SbVec3d	minpt

Related Symbols
(Note that these are not member symbols.)
int	operator!= (const SbBox3d &b1, const SbBox3d &b2)
int	operator== (const SbBox3d &b1, const SbBox3d &b2)

Detailed Description

The SbBox3d 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

SbBox2s, SbBox2f, SbBox2d, SbBox3s, SbBox3f, SbXfBox3f.

Constructor & Destructor Documentation

SbBox3d() [1/6]

SbBox3d::SbBox3d ( void )

inline

The default constructor makes an empty box.

SbBox3d() [2/6]

SbBox3d::SbBox3d ( double minx, double miny, double minz, double maxx, double maxy, double maxz )

inline

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.

SbBox3d() [3/6]

SbBox3d::SbBox3d ( const SbVec3d & minval, const SbVec3d & maxval )

inline

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.

SbBox3d() [4/6]

SbBox3d::SbBox3d ( const SbBox3f & box )

inlineexplicit

Constructs an SbBox3d instance from the value in an SbBox3f instance.

Since

Coin 2.5

SbBox3d() [5/6]

SbBox3d::SbBox3d ( const SbBox3s & box )

inlineexplicit

Constructs an SbBox3d instance from the value in an SbBox3s instance.

Since

Coin 2.5

SbBox3d() [6/6]

SbBox3d::SbBox3d ( const SbBox3i32 & box )

inlineexplicit

Constructs an SbBox3d instance from the value in an SbBox3i32 instance.

Since

Coin 2.5

Member Function Documentation

extendBy() [1/2]

void SbBox3d::extendBy

(

const SbBox3d &

box

)

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

extendBy() [2/2]

void SbBox3d::extendBy

(

const SbVec3d &

point

)

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.

getBounds() [1/2]

void SbBox3d::getBounds ( double & minx, double & miny, double & minz, double & maxx, double & maxy, double & maxz ) const

inline

Returns the box boundaries.

See also

setBounds().

getBounds() [2/2]

void SbBox3d::getBounds ( SbVec3d & minobj, SbVec3d & maxobj ) const

inline

Returns the box corner points.

See also

setBounds().

getCenter()

SbVec3d SbBox3d::getCenter ( void ) const

inline

Returns the center point of the box.

getClosestPoint()

SbVec3d SbBox3d::getClosestPoint

(

const SbVec3d &

point

)

const

Return the point on the box closest to the given point. If the given point equals the center, the center point of the positive Z face is returned.

getMax() [1/2]

SbVec3d & SbBox3d::getMax ( void )

inline

Returns a modifiable reference the maximum point.

getMax() [2/2]

const SbVec3d & SbBox3d::getMax ( void ) const

inline

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

See also

getMin().

getMin() [1/2]

SbVec3d & SbBox3d::getMin ( void )

inline

Returns a modifiable reference the minimum point.

getMin() [2/2]

const SbVec3d & SbBox3d::getMin ( void ) const

inline

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

See also

getOrigin(), getMax().

getOrigin()

void SbBox3d::getOrigin ( double & originX, double & originY, double & originZ ) const

inline

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

See also

getMin().

getSize() [1/2]

void SbBox3d::getSize ( double & sizeX, double & sizeY, double & sizeZ ) const

inline

Returns width, height and depth of box.

getSize() [2/2]

SbVec3d SbBox3d::getSize ( void ) const

inline

Returns width, height and depth of box as a 3D vector.

Since

Coin 3.0

getSpan()

void SbBox3d::getSpan	(	const SbVec3d &	dir,
		double &	dmin,
		double &	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.

getVolume()

double SbBox3d::getVolume ( void ) const

inline

Returns the volume of the box.

hasVolume()

SbBool SbBox3d::hasVolume ( void ) const

inline

Check if the box has been correctly specified and by that virtue has "positive" volume, i.e. all coordinates of its upper right corner (the maximum point) are greater than the corresponding coordinates of its lower left corner (the minimum point).

intersect() [1/2]

SbBool SbBox3d::intersect

(

const SbBox3d &

box

)

const

Check if the given box lies entirely or partially within the boundaries of this box.

intersect() [2/2]

SbBool SbBox3d::intersect

(

const SbVec3d &

point

)

const

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

isEmpty()

SbBool SbBox3d::isEmpty ( void ) const

inline

Check if this has been marked as an empty box.

See also

makeEmpty().

makeEmpty()

void SbBox3d::makeEmpty

(

void

)

Marks this as an empty box.

See also

isEmpty().

outside()

SbBool SbBox3d::outside	(	const SbDPMatrix &	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.

print()

void SbBox3d::print

(

FILE *

fp

)

const

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

setBounds() [1/5]

SbBox3d & SbBox3d::setBounds

(

const SbBox3f &

box

)

Reset the boundaries to the boundaries of the given box.

Returns reference to self.

See also

setBounds()

setBounds() [2/5]

SbBox3d & SbBox3d::setBounds

(

const SbBox3i32 &

box

)

Reset the boundaries to the boundaries of the given box.

Returns reference to self.

See also

setBounds()

setBounds() [3/5]

SbBox3d & SbBox3d::setBounds

(

const SbBox3s &

box

)

Reset the boundaries to the boundaries of the given box.

Returns reference to self.

See also

setBounds()

setBounds() [4/5]

SbBox3d & SbBox3d::setBounds ( const SbVec3d & minval, const SbVec3d & maxval )

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

setBounds() [5/5]

SbBox3d & SbBox3d::setBounds ( double xmin, double ymin, double zmin, double xmax, double ymax, double zmax )

inline

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.

Returns reference to self.

See also

getBounds().

transform()

void SbBox3d::transform

(

const SbDPMatrix &

matrix

)

Transform the box by the matrix, and change its boundaries to contain the transformed box.

Doesn't touch illegal/empty boxes.

Friends And Related Symbol Documentation

operator!=()

int operator!= ( const SbBox3d & b1, const SbBox3d & b2 )

related

Check b1 and b2 for inequality.

operator==()

int operator== ( const SbBox3d & b1, const SbBox3d & b2 )

related

Check b1 and b2 for equality.

---

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

• SbBox3d.h
• SbBox3d.cpp