Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Friends

SbXfBox3f Class Reference

The SbXfBox3f class is a 3 dimensional box with floating point coordinates and an attached transformation.This box class is used by many other classes in Coin for data exchange. It provides storage for two box corners with floating point coordinates, and for a floating point 4x4 transformation matrix. More...

#include <Inventor/SbBox.h>

Inheritance diagram for SbXfBox3f:
SbBox3f

List of all members.

Public Member Functions

 SbXfBox3f (void)
 SbXfBox3f (const SbVec3f &boxmin, const SbVec3f &boxmax)
 SbXfBox3f (const SbBox3f &box)
 ~SbXfBox3f ()
void setTransform (const SbMatrix &m)
const SbMatrixgetTransform (void) const
const SbMatrixgetInverse (void) const
SbVec3f getCenter (void) const
void extendBy (const SbVec3f &pt)
void extendBy (const SbBox3f &bb)
void extendBy (const SbXfBox3f &bb)
SbBool intersect (const SbVec3f &pt) const
SbBool intersect (const SbBox3f &bb) const
SbBool intersect (const SbXfBox3f &bb) const
void getSpan (const SbVec3f &direction, float &dMin, float &dMax) const
SbBox3f project (void) const
void transform (const SbMatrix &m)
float getVolume (void) const
void print (FILE *file) const

Friends

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

Detailed Description

The SbXfBox3f class is a 3 dimensional box with floating point coordinates and an attached transformation.

This box class is used by many other classes in Coin for data exchange. It provides storage for two box corners with floating point coordinates, and for a floating point 4x4 transformation matrix.

See also:
SbBox2d, SbBox2f, SbBox2i32, SbBox2s, SbBox3d, SbBox3f, SbBox3i32, SbBox3s, SbXfBox3d, SbMatrix.

Constructor & Destructor Documentation

SbXfBox3f::SbXfBox3f ( void  )

The default constructor makes an empty box and identity matrix.

References SbMatrix::makeIdentity().

SbXfBox3f::SbXfBox3f ( const SbVec3f boxmin,
const SbVec3f boxmax 
)

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.

References SbMatrix::makeIdentity().

SbXfBox3f::SbXfBox3f ( const SbBox3f box)

Constructs a box from the given SbBox3f.

The transformation is set to the identity matrix.

References SbMatrix::makeIdentity().

SbXfBox3f::~SbXfBox3f ( )

Default destructor does nothing.


Member Function Documentation

void SbXfBox3f::setTransform ( const SbMatrix m)
const SbMatrix & SbXfBox3f::getTransform ( void  ) const

Returns the current transformation matrix.

Referenced by extendBy(), and print().

const SbMatrix & SbXfBox3f::getInverse ( void  ) const

Returns the inverse of the current transformation matrix.

Referenced by extendBy(), and intersect().

SbVec3f SbXfBox3f::getCenter ( void  ) const

Return the transformed center point of the box.

Reimplemented from SbBox3f.

References SbMatrix::multVecMatrix().

Referenced by SoMultipleCopy::getBoundingBox(), and print().

void SbXfBox3f::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.

The point is assumed to be in transformed space.

Reimplemented from SbBox3f.

References getInverse(), SbBox3f::isEmpty(), SbMatrix::makeIdentity(), and SbMatrix::multVecMatrix().

Referenced by SoGetBoundingBoxAction::extendBy(), and SoMultipleCopy::getBoundingBox().

void SbXfBox3f::extendBy ( const SbBox3f bb)

Extend the boundaries of the box by the given bb parameter. The given box is assumed to be in transformed space.

The two given boxes will be combined in such a way so that the resultant bounding box always has the smallest possible volume. To accomplish this, the transformation on this SbXfBox3f will sometimes be flattened before it's combined with bb.

Reimplemented from SbBox3f.

References SbBox3f::extendBy(), getInverse(), SbBox3f::getMax(), SbBox3f::getMin(), SbBox3f::getVolume(), getVolume(), SbBox3f::isEmpty(), SbMatrix::makeIdentity(), SbMatrix::multVecMatrix(), SoDebugError::postInfo(), SoDebugError::postWarning(), project(), SbBox3f::setBounds(), setTransform(), and SbVec3f::setValue().

void SbXfBox3f::extendBy ( const SbXfBox3f bb)

Extend the boundaries of the box by the given bb parameter.

The given box is assumed to be in transformed space.

Note: is not guaranteed to give an optimal result if used for bbox calculation since the transformation matrix might change. See documentation in SoGetBoundingBoxAction for more details.

References getInverse(), getTransform(), getVolume(), SbBox3f::isEmpty(), SbMatrix::multRight(), SbMatrix::multVecMatrix(), SoDebugError::postInfo(), SoDebugError::postWarning(), and SbVec3f::setValue().

SbBool SbXfBox3f::intersect ( const SbVec3f pt) const

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

The point is assumed to be in transformed space.

Reimplemented from SbBox3f.

References SbMatrix::multVecMatrix().

Referenced by intersect().

SbBool SbXfBox3f::intersect ( const SbBox3f bb) const

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

The given box is assumed to be in transformed space.

Reimplemented from SbBox3f.

References SbBox3f::getMax(), SbBox3f::getMin(), SbMatrix::identity(), intersect(), SbBox3f::isEmpty(), and SoDebugError::postWarning().

SbBool SbXfBox3f::intersect ( const SbXfBox3f xfbb) const

Check if two transformed boxes intersect.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References getInverse(), intersect(), and transform().

void SbXfBox3f::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 from SbBox3f.

References SbBox3f::getSpan(), and project().

SbBox3f SbXfBox3f::project ( void  ) const

Project the SbXfBox3f into a SbBox3f.

This gives the same resulting SbBox3f as doing a SbBox3f::transform() with this transformation matrix as parameter.

References SbBox3f::isEmpty(), and SbBox3f::transform().

Referenced by extendBy(), SoGetBoundingBoxAction::getBoundingBox(), getSpan(), and print().

void SbXfBox3f::transform ( const SbMatrix m)

Overridden from SbBox3f, as the transformations are to be kept separate from the box in the SbXfBox3f class.

Reimplemented from SbBox3f.

References SbMatrix::multRight(), and setTransform().

Referenced by SoGetBoundingBoxAction::extendBy(), SoMultipleCopy::getBoundingBox(), and intersect().

float SbXfBox3f::getVolume ( void  ) const

Return box volume. Overridden from parent class to take into account the possibility of scaling in the transformation matrix.

Reimplemented from SbBox3f.

References SbMatrix::det3(), and SbBox3f::hasVolume().

Referenced by extendBy(), and print().

void SbXfBox3f::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 from SbBox3f.

References SbBox3f::getBounds(), getCenter(), SbBox3f::getOrigin(), SbBox3f::getSize(), getTransform(), getVolume(), SbBox3f::print(), SbMatrix::print(), SbVec3f::print(), and project().


Friends And Related Function Documentation

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

Check if b1 and b2 are equal. Return 1 if they are equal, or 0 if they are unequal. Note that the method will do a dumb component by component comparison.

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

Check if b1 and b2 are unequal. Return 0 if they are equal, or 1 if they are unequal. See the note on operator==().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:02 for Coin by Doxygen. 1.7.3