3D box class. More...

#include <Inventor/SbBox.h>

Public Member Functions
	SbBox3s ()
	Constructor for a 3D short box.

	SbBox3s (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)
	Constructor for a 3D short box.

	SbBox3s (const SbVec3s &_min, const SbVec3s &_max)
	Constructor for a 3D short box.

	SbBox3s (const SbBox3i32 &box)
	Constructor given an SbBox3i32 (adapter).

	~SbBox3s ()
	Destructor.

const SbVec3s &	getMin () const
	Returns the minimum point of the box.

const SbVec3s &	getMax () const
	Returns the maximum point of the box.

SbVec3s &	getMin ()
	Returns the minimum point of the box.

SbVec3s &	getMax ()
	Returns the maximum point of the box.

SbVec3f	getCenter () const
	Returns the center of the box.

void	extendBy (const SbVec3f &pt)
	Extends this box (if necessary) to contain the specified point.

void	extendBy (const SbBox3s &bb)
	Extends this box (if necessary) to contain the specified box.

SbBool	intersect (const SbVec3f &pt) const
	Returns TRUE if the specified point intersects this box.

SbBool	intersect (const SbBox3s &bb) const
	Returns TRUE if the specified box intersects this box.

SbBox3s	intersection (const SbBox3s &box) const
	Returns the intersection of the specified box with this box.

SbBool	contains (const SbBox3s &bb) const
	Returns TRUE if the specified box is fully contained inside this box.

SbBool	outside (const SbMatrix &MVP, int &cullBits) const
	Returns TRUE if bounding box is completely outside the view-volume defined by the model+view+projection matrix given.

void	setBounds (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)
	Sets the corners of the box.

void	setBounds (const SbVec3s &_min, const SbVec3s &_max)
	Sets the corners of the box.

void	getBounds (short &xmin, short &ymin, short &zmin, short &xmax, short &ymax, short &zmax) const
	Gets the corners of the box.

void	getBounds (SbVec3s &_min, SbVec3s &_max) const
	Gets the corners of the box.

SbVec3f	getClosestPoint (const SbVec3f &point) const
	Returns the closest point on the box to the given point.

void	getOrigin (short &originX, short &originY, short &originZ) const
	Gets box origin which is the same as the minimum corner of the box.

void	getSize (short &sizeX, short &sizeY, short &sizeZ) const
	Gets box size.

void	makeEmpty ()
	Makes an empty box.

SbBool	isEmpty () const
	Returns TRUE if the box is empty, and FALSE otherwise.

SbBool	hasVolume () const
	Returns TRUE if all three dimensions of the box have positive size, and FALSE otherwise.

void	getSpan (const SbVec3f &direction, float &dMin, float &dMax) const
	Finds the span of a box along a specified direction.

void	transform (const SbMatrix &m)
	Transforms box by matrix, enlarging box to contain result.

float	getVolume () const
	Returns the volume of the box.

SbBox3s	operator= (const SbBox3i32 &box)
	Assignment operator given an SbBox3i32 (adapter).

Friends
int	operator== (const SbBox3s &b1, const SbBox3s &b2)
	Equality comparison.

int	operator!= (const SbBox3s &b1, const SbBox3s &b2)
	Inequality comparison.

Detailed Description

3D box class.

3D box which has planes parallel to the major axes and is specified by two points on a diagonal. This class is part of the standard Open Inventor datatype classes and is used as input and output to geometry operations (see SoGetBoundingBoxAction).

Constructor & Destructor Documentation

◆ SbBox3s() [1/4]

SbBox3s::SbBox3s ( )

inline

Constructor for a 3D short box.

The box is initially empty.

Definition at line 389 of file SbBox.h.

◆ SbBox3s() [2/4]

SbBox3s::SbBox3s	(	short	xmin,
		short	ymin,
		short	zmin,
		short	xmax,
		short	ymax,
		short	zmax
	)

inline

Constructor for a 3D short box.

xmin , ymin , zmin , xmax , ymax and zmax are the bounds of the box.

Definition at line 396 of file SbBox.h.

◆ SbBox3s() [3/4]

SbBox3s::SbBox3s	(	const SbVec3s &	_min,
		const SbVec3s &	_max
	)

inline

Constructor for a 3D short box.

m_min and m_max are the corners of the diagonal that define the box.

Definition at line 404 of file SbBox.h.

◆ SbBox3s() [4/4]

SbBox3s::SbBox3s ( const SbBox3i32 & box )

Constructor given an SbBox3i32 (adapter).

Note possible loss of data.

◆ ~SbBox3s()

SbBox3s::~SbBox3s ( )

inline

Destructor.

Definition at line 416 of file SbBox.h.

Member Function Documentation

◆ contains()

SbBool SbBox3s::contains ( const SbBox3s & bb ) const

inline

Returns TRUE if the specified box is fully contained inside this box.

Definition at line 484 of file SbBox.h.

◆ extendBy() [1/2]

void SbBox3s::extendBy ( const SbBox3s & bb )

Extends this box (if necessary) to contain the specified box.

◆ extendBy() [2/2]

void SbBox3s::extendBy ( const SbVec3f & pt )

Extends this box (if necessary) to contain the specified point.

◆ getBounds() [1/2]

void SbBox3s::getBounds	(	SbVec3s &	_min,
		SbVec3s &	_max
	)		const

inline

Gets the corners of the box.

Definition at line 536 of file SbBox.h.

◆ getBounds() [2/2]

void SbBox3s::getBounds	(	short &	xmin,
		short &	ymin,
		short &	zmin,
		short &	xmax,
		short &	ymax,
		short &	zmax
	)		const

inline

Gets the corners of the box.

Definition at line 528 of file SbBox.h.

◆ getCenter()

SbVec3f SbBox3s::getCenter ( ) const

Returns the center of the box.

◆ getClosestPoint()

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

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

(Returns the point on the center of the Z face if passed the center.)

◆ getMax() [1/2]

SbVec3s & SbBox3s::getMax ( )

inline

Returns the maximum point of the box.

The maximum point is the corner of the box with the highest X, Y, and Z values.

Definition at line 446 of file SbBox.h.

◆ getMax() [2/2]

const SbVec3s & SbBox3s::getMax ( ) const

inline

Returns the maximum point of the box.

The maximum point is the corner of the box with the highest X, Y, and Z values.

Definition at line 432 of file SbBox.h.

◆ getMin() [1/2]

SbVec3s & SbBox3s::getMin ( )

inline

Returns the minimum point of the box.

The minimum point is the corner of the box with the lowest X, Y, and Z values.

Definition at line 439 of file SbBox.h.

◆ getMin() [2/2]

const SbVec3s & SbBox3s::getMin ( ) const

inline

Returns the minimum point of the box.

The minimum point is the corner of the box with the lowest X, Y, and Z values.

Definition at line 424 of file SbBox.h.

◆ getOrigin()

void SbBox3s::getOrigin	(	short &	originX,
		short &	originY,
		short &	originZ
	)		const

inline

Gets box origin which is the same as the minimum corner of the box.

Definition at line 548 of file SbBox.h.

◆ getSize()

void SbBox3s::getSize	(	short &	sizeX,
		short &	sizeY,
		short &	sizeZ
	)		const

inline

Gets box size.

Definition at line 554 of file SbBox.h.

◆ getSpan()

void SbBox3s::getSpan	(	const SbVec3f &	direction,
		float &	dMin,
		float &	dMax
	)		const

Finds the span of a box along a specified direction.

The span is the total distance the box occupies along a given direction. The total distance is returned in the form of a minimum and maximum distance from the origin of each of the corners of the box along the given direction. The difference between these two values is the span.

◆ getVolume()

float SbBox3s::getVolume ( ) const

Returns the volume of the box.

◆ hasVolume()

SbBool SbBox3s::hasVolume ( ) const

inline

Returns TRUE if all three dimensions of the box have positive size, and FALSE otherwise.

Definition at line 582 of file SbBox.h.

◆ intersect() [1/2]

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

Returns TRUE if the specified box intersects this box.

◆ intersect() [2/2]

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

Returns TRUE if the specified point intersects this box.

◆ intersection()

SbBox3s SbBox3s::intersection ( const SbBox3s & box ) const

Returns the intersection of the specified box with this box.

Returned box is empty if there is no intersection.

◆ isEmpty()

SbBool SbBox3s::isEmpty ( ) const

inline

Returns TRUE if the box is empty, and FALSE otherwise.

Note: Setting the box to all zeros does not make it "empty". Use the makeEmpty() method. (This method only returns true if the maximum X value is less than the minimum X value.)

Definition at line 575 of file SbBox.h.

◆ makeEmpty()

void SbBox3s::makeEmpty ( )

Makes an empty box.

◆ operator=()

SbBox3s SbBox3s::operator= ( const SbBox3i32 & box )

Assignment operator given an SbBox3i32 (adapter).

Note possible loss of data.

◆ outside()

SbBool SbBox3s::outside	(	const SbMatrix &	MVP,
		int &	cullBits
	)		const

Returns TRUE if bounding box is completely outside the view-volume defined by the model+view+projection matrix given.

"cullBits" keeps track of which view-volume clipping planes the box is completely inside of; if a 'parent' bounding box of this bounding box was found to be completely inside the left/right clipping planes, the low bit of cullBits will be set to zero, and this routine will not test this box against those planes. When cullBits is zero, it is a waste of time to call this function! Before calling this the first time, set cullBits to 7 (SoGLRenderAction and SoSeparator will handle this automatically for render culling).

◆ setBounds() [1/2]

void SbBox3s::setBounds	(	const SbVec3s &	_min,
		const SbVec3s &	_max
	)

inline

Sets the corners of the box.

Definition at line 522 of file SbBox.h.

◆ setBounds() [2/2]

void SbBox3s::setBounds	(	short	xmin,
		short	ymin,
		short	zmin,
		short	xmax,
		short	ymax,
		short	zmax
	)

inline

Sets the corners of the box.

Definition at line 515 of file SbBox.h.

◆ transform()

void SbBox3s::transform ( const SbMatrix & m )

Transforms box by matrix, enlarging box to contain result.

Friends And Related Symbol Documentation

◆ operator!=

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

friend

Inequality comparison.

Definition at line 618 of file SbBox.h.

◆ operator==

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

friend

Equality comparison.

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

Inventor/SbBox.h

Open Inventor Release 2024.1.3

Public Member Functions

Friends

Detailed Description

SEE ALSO

Constructor & Destructor Documentation

◆ SbBox3s() [1/4]

◆ SbBox3s() [2/4]

◆ SbBox3s() [3/4]

◆ SbBox3s() [4/4]

◆ ~SbBox3s()

Member Function Documentation

◆ contains()

◆ extendBy() [1/2]

◆ extendBy() [2/2]

◆ getBounds() [1/2]

◆ getBounds() [2/2]

◆ getCenter()

◆ getClosestPoint()

◆ getMax() [1/2]

◆ getMax() [2/2]

◆ getMin() [1/2]

◆ getMin() [2/2]

◆ getOrigin()

◆ getSize()

◆ getSpan()

◆ getVolume()

◆ hasVolume()

◆ intersect() [1/2]

◆ intersect() [2/2]

◆ intersection()

◆ isEmpty()

◆ makeEmpty()

◆ operator=()

◆ outside()

◆ setBounds() [1/2]

◆ setBounds() [2/2]

◆ transform()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator==