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

Public Member Functions | Friends | List of all members
SbBox3f Class Reference

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

#include <Inventor/SbBox.h>

Inheritance diagram for SbBox3f:
SbXfBox3f

Public Member Functions

 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 SbBox3d &box)
 
 SbBox3f (const SbBox3s &box)
 
 SbBox3f (const SbBox3i32 &box)
 
 ~SbBox3f ()
 
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)
 
SbBox3fsetBounds (const SbBox3d &box)
 
SbBox3fsetBounds (const SbBox3s &box)
 
SbBox3fsetBounds (const SbBox3i32 &box)
 
void getBounds (float &minx, float &miny, float &minz, float &maxx, float &maxy, float &maxz) const
 
void getBounds (SbVec3f &min, SbVec3f &max) const
 
const SbVec3fgetMin (void) const
 
SbVec3fgetMin (void)
 
const SbVec3fgetMax (void) const
 
SbVec3fgetMax (void)
 
void extendBy (const SbVec3f &point)
 
void extendBy (const SbBox3f &box)
 
void transform (const SbMatrix &matrix)
 
void makeEmpty (void)
 
SbBool isEmpty (void) const
 
SbBool hasVolume (void) const
 
float getVolume (void) const
 
SbBool intersect (const SbVec3f &point) const
 
SbBool intersect (const SbBox3f &box) const
 
SbVec3f getClosestPoint (const SbVec3f &point) const
 
SbBool outside (const SbMatrix &mvp, int &cullbits) const
 
SbVec3f getCenter (void) const
 
void getOrigin (float &x0, float &y0, float &z0) const
 
void getSize (float &dx, float &dy, float &dz) const
 
void getSpan (const SbVec3f &dir, float &dmin, float &dmax) const
 
void print (FILE *file) const
 

Friends

int operator== (const SbBox3f &b1, const SbBox3f &b2)
 
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
SbBox2d, SbBox2f, SbBox2i32, SbBox2s, SbBox3d, SbBox3i32, SbBox3s, SbXfBox3d, SbXfBox3f

Constructor & Destructor Documentation

◆ SbBox3f() [1/6]

SbBox3f::SbBox3f ( void  )

The default constructor makes an empty box.

References makeEmpty().

◆ SbBox3f() [2/6]

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.

References setBounds().

◆ SbBox3f() [3/6]

SbBox3f::SbBox3f ( const SbVec3f minval,
const SbVec3f maxval 
)

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() [4/6]

SbBox3f::SbBox3f ( const SbBox3d box)
inlineexplicit

Constructs a box with coordinates from box, converting the coordinates to floating point precision values

Since
Coin-2.5

◆ SbBox3f() [5/6]

SbBox3f::SbBox3f ( const SbBox3s box)
inlineexplicit

Constructs a box with coordinates from box, converting the coordinates to floating point precision values

Since
Coin-2.5

◆ SbBox3f() [6/6]

SbBox3f::SbBox3f ( const SbBox3i32 box)
inlineexplicit

Constructs a box with coordinates from box, converting the coordinates to floating point precision values

Since
Coin-2.5

◆ ~SbBox3f()

SbBox3f::~SbBox3f ( void  )

Default destructor does nothing.

Member Function Documentation

◆ setBounds() [1/5]

void SbBox3f::setBounds ( const float  minx,
const float  miny,
const float  minz,
const float  maxx,
const float  maxy,
const float  maxz 
)

◆ setBounds() [2/5]

void SbBox3f::setBounds ( const SbVec3f minval,
const SbVec3f maxval 
)

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

References SoDebugError::postWarning().

◆ setBounds() [3/5]

SbBox3f & SbBox3f::setBounds ( const SbBox3d box)

Reset the boundaries to the boundaries of the given box.

Returns reference to self.

See also
getBounds().
Since
Coin-2.5

References SbBox3d::getMax(), SbBox3d::getMin(), SbBox3d::isEmpty(), makeEmpty(), and SbVec3f::setValue().

◆ setBounds() [4/5]

SbBox3f & SbBox3f::setBounds ( const SbBox3s box)

Reset the boundaries to the boundaries of the given box.

Returns reference to self.

See also
getBounds().
Since
Coin-2.5

References SbBox3s::getMax(), SbBox3s::getMin(), SbBox3s::isEmpty(), makeEmpty(), and SbVec3f::setValue().

◆ setBounds() [5/5]

SbBox3f & SbBox3f::setBounds ( const SbBox3i32 box)

Reset the boundaries to the boundaries of the given box.

Returns reference to self.

See also
getBounds().
Since
Coin-2.5

References SbBox3i32::getMax(), SbBox3i32::getMin(), SbBox3i32::isEmpty(), makeEmpty(), and SbVec3f::setValue().

◆ getBounds() [1/2]

void SbBox3f::getBounds ( float &  minx,
float &  miny,
float &  minz,
float &  maxx,
float &  maxy,
float &  maxz 
) const

Returns the box boundaries.

See also
setBounds().

References SbVec3f::getValue().

Referenced by SoShape::getScreenSize(), SbXfBox3f::print(), and print().

◆ getBounds() [2/2]

void SbBox3f::getBounds ( SbVec3f minobj,
SbVec3f maxobj 
) const

Returns the box corner points.

See also
setBounds().

◆ getMin() [1/2]

const SbVec3f & SbBox3f::getMin ( void  ) const

◆ getMin() [2/2]

SbVec3f & SbBox3f::getMin ( void  )

Returns a modifiable reference the minimum point.

◆ getMax() [1/2]

const SbVec3f & SbBox3f::getMax ( void  ) const

◆ getMax() [2/2]

SbVec3f & SbBox3f::getMax ( void  )

Returns a modifiable reference the maximum point.

◆ extendBy() [1/2]

void SbBox3f::extendBy ( const SbVec3f point)

◆ extendBy() [2/2]

void SbBox3f::extendBy ( const SbBox3f box)

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

References extendBy(), isEmpty(), and SoDebugError::postWarning().

◆ transform()

void SbBox3f::transform ( const SbMatrix matrix)

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

Doesn't touch illegal/empty boxes.

References extendBy(), isEmpty(), SbMatrix::multVecMatrix(), SoDebugError::postWarning(), setBounds(), and SbVec3f::setValue().

Referenced by SbProjector::findVanishingDistance(), and SbXfBox3f::project().

◆ makeEmpty()

void SbBox3f::makeEmpty ( void  )

◆ isEmpty()

SbBool SbBox3f::isEmpty ( void  ) const

◆ hasVolume()

SbBool SbBox3f::hasVolume ( void  ) const

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

Referenced by SbXfBox3f::getVolume(), and getVolume().

◆ getVolume()

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.

References hasVolume().

Referenced by SbXfBox3f::extendBy(), and SbXfBox3f::getVolume().

◆ intersect() [1/2]

SbBool SbBox3f::intersect ( const SbVec3f point) const

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

Referenced by SoVRMLProximitySensor::doAction(), and SbXfBox3f::intersect().

◆ intersect() [2/2]

SbBool SbBox3f::intersect ( const SbBox3f box) const

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

◆ getClosestPoint()

SbVec3f SbBox3f::getClosestPoint ( const SbVec3f point) const

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

References getCenter().

◆ outside()

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.

References SbMatrix::multVecMatrix().

◆ getCenter()

SbVec3f SbBox3f::getCenter ( void  ) const

◆ getOrigin()

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

References SbVec3f::getValue().

Referenced by SbXfBox3f::print().

◆ getSize()

void SbBox3f::getSize ( float &  dx,
float &  dy,
float &  dz 
) const

◆ getSpan()

void SbBox3f::getSpan ( const SbVec3f dir,
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.

References SbVec3f::dot(), SbVec3f::normalize(), SoDebugError::postWarning(), and SbVec3f::setValue().

Referenced by SbXfBox3f::getSpan().

◆ print()

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.

References getBounds(), and SbVec3f::print().

Referenced by SbXfBox3f::print().

Friends And Related Function Documentation

◆ operator==

int operator== ( const SbBox3f b1,
const SbBox3f b2 
)
friend

Check b1 and b2 for equality.

◆ operator!=

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:

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

Generated on Fri Jul 20 2018 for Coin by Doxygen. 1.8.14