SbBox3s Class Reference
[Basics]

VSG extension 3D box class. More...

#include <Inventor/SbBox.h>

List of all members.

Public Member Functions

 SbBox3s ()
 SbBox3s (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)
 SbBox3s (const SbVec3s &_min, const SbVec3s &_max)
 SbBox3s (const SbBox3i32 &box)
 ~SbBox3s ()
const SbVec3sgetMin () const
const SbVec3sgetMax () const
SbVec3sgetMin ()
SbVec3sgetMax ()
SbVec3f getCenter () const
void extendBy (const SbVec3f &pt)
void extendBy (const SbBox3s &bb)
SbBool intersect (const SbVec3f &pt) const
SbBool intersect (const SbBox3s &bb) const
SbBox3s intersection (const SbBox3s &box) const
SbBool contains (const SbBox3s &bb) const
SbBool outside (const SbMatrix &MVP, int &cullBits) const
void setBounds (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)
void setBounds (const SbVec3s &_min, const SbVec3s &_max)
void getBounds (short &xmin, short &ymin, short &zmin, short &xmax, short &ymax, short &zmax) const
void getBounds (SbVec3s &_min, SbVec3s &_max) const
SbVec3f getClosestPoint (const SbVec3f &point) const
void getOrigin (short &originX, short &originY, short &originZ) const
void getSize (short &sizeX, short &sizeY, short &sizeZ) const
void makeEmpty ()
SbBool isEmpty () const
SbBool hasVolume () const
void getSpan (const SbVec3f &direction, float &dMin, float &dMax) const
void transform (const SbMatrix &m)
float getVolume () const
SbBox3s operator= (const SbBox3i32 &box)

Friends

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

Detailed Description

VSG extension 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).

SEE ALSO

SbXfBox3f, SbBox2f, SbBox2s, SbVec3s, SbVec2f, SbVec2s, SbMatrix, SoGetBoundingBoxAction


Constructor & Destructor Documentation

SbBox3s::SbBox3s (  )  [inline]

Constructor for a 3D short box.

The box is initially empty.

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.

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.

SbBox3s::SbBox3s ( const SbBox3i32 box  ) 

Constructor given an SbBox3i32 (adapter).

Note possible loss of data.

SbBox3s::~SbBox3s (  )  [inline]

Destructor.


Member Function Documentation

SbBool SbBox3s::contains ( const SbBox3s bb  )  const [inline]

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

void SbBox3s::extendBy ( const SbBox3s bb  ) 

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

void SbBox3s::extendBy ( const SbVec3f pt  ) 

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

void SbBox3s::getBounds ( SbVec3s _min,
SbVec3s _max 
) const [inline]

Gets the corners of the box.

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

Gets the corners of the box.

SbVec3f SbBox3s::getCenter (  )  const

Returns the center of the box.

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

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.

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.

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.

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.

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.

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

Gets box size.

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.

float SbBox3s::getVolume (  )  const

Returns the volume of the box.

SbBool SbBox3s::hasVolume (  )  const [inline]

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

SbBool SbBox3s::intersect ( const SbBox3s bb  )  const

Returns TRUE if the specified box intersects this box.

SbBool SbBox3s::intersect ( const SbVec3f pt  )  const

Returns TRUE if the specified point intersects this box.

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.

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

void SbBox3s::makeEmpty (  ) 

Makes an empty box.

SbBox3s SbBox3s::operator= ( const SbBox3i32 box  ) 

Assignment operator given an SbBox3i32 (adapter).

Note possible loss of data.

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

void SbBox3s::setBounds ( const SbVec3s _min,
const SbVec3s _max 
) [inline]

Sets the corners of the box.

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

Sets the corners of the box.

void SbBox3s::transform ( const SbMatrix m  ) 

Transforms box by matrix, enlarging box to contain result.


Friends And Related Function Documentation

int operator!= ( const SbBox3s b1,
const SbBox3s b2 
) [friend]

Inequality comparison.

int operator== ( const SbBox3s b1,
const SbBox3s b2 
) [friend]

Equality comparison.


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

Open Inventor Toolkit reference manual, generated on 8 Apr 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/