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

SbBox3s Class Reference

The SbBox3s class is a 3 dimensional box with short integer coordinates. More...

#include <Inventor/SbBox.h>

Public Member Functions

 SbBox3s (void)
 SbBox3s (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)
 SbBox3s (const SbVec3s &minvec, const SbVec3s &maxvec)
 SbBox3s (const SbBox3i32 &box)
 SbBox3s (const SbBox3f &box)
 SbBox3s (const SbBox3d &box)
 ~SbBox3s (void)
void setBounds (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)
void setBounds (const SbVec3s &minvec, const SbVec3s &maxvec)
SbBox3ssetBounds (const SbBox3i32 &box)
SbBox3ssetBounds (const SbBox3f &box)
SbBox3ssetBounds (const SbBox3d &box)
const SbVec3sgetMin (void) const
SbVec3sgetMin (void)
const SbVec3sgetMax (void) const
SbVec3sgetMax (void)
void extendBy (const SbVec3s &point)
void extendBy (const SbBox3s &box)
void makeEmpty (void)
SbBool isEmpty (void) const
SbBool hasVolume (void) const
int getVolume (void) const
SbBool intersect (const SbVec3s &point) const
SbBool intersect (const SbBox3s &box) const
void getBounds (short &xmin, short &ymin, short &zmin, short &xmax, short &ymax, short &zmax) const
void getBounds (SbVec3s &minvec, SbVec3s &maxvec) const
SbVec3f getCenter (void) const
void getOrigin (short &originX, short &originY, short &originZ) const
void getSize (short &sizeX, short &sizeY, short &sizeZ) const

Friends

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

Detailed Description

The SbBox3s class is a 3 dimensional box with short integer coordinates.

This box class is used by other classes in Coin for data exchange. It provides storage for two box corners with short integer coordinates, which is among other things useful for representing screen or canvas areas in absolute window coordinates.

See also
SbBox2d, SbBox2f, SbBox2i32, SbBox2s, SbBox3d, SbBox3f, SbBox3i32, SbXfBox3d, SbXfBox3f
Since
Coin 2.0
TGS Inventor ?.?

Constructor & Destructor Documentation

◆ SbBox3s() [1/6]

SbBox3s::SbBox3s ( void )

The default constructor makes an empty box.

References makeEmpty().

Referenced by extendBy(), intersect(), operator!=, and operator==.

◆ SbBox3s() [2/6]

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

Constructs a box with the given corner coordinates.

xmin should be less than xmax, ymin should be less than ymax, and zmin should be less than zmax if you want to make a valid box.

References setBounds().

◆ SbBox3s() [3/6]

SbBox3s::SbBox3s ( const SbVec3s & minvec,
const SbVec3s & maxvec )

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

◆ SbBox3s() [4/6]

SbBox3s::SbBox3s ( const SbBox3i32 & box)
inlineexplicit

Constructs a box with coordinates from box, converting the coordinates to short integers

Since
Coin-2.5

References setBounds().

◆ SbBox3s() [5/6]

SbBox3s::SbBox3s ( const SbBox3f & box)
inlineexplicit

Constructs a box with coordinates from box, converting the coordinates to short integers

Since
Coin-2.5

References setBounds().

◆ SbBox3s() [6/6]

SbBox3s::SbBox3s ( const SbBox3d & box)
inlineexplicit

Constructs a box with coordinates from box, converting the coordinates to short integers

Since
Coin-2.5

References setBounds().

◆ ~SbBox3s()

SbBox3s::~SbBox3s ( void )

Destructor does nothing.

Member Function Documentation

◆ setBounds() [1/5]

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

Reset the boundaries of the box.

xmin should be less than xmax, ymin should be less than ymax, and zmin should be less than xmax if you want to make a valid box.

See also
getBounds().

References SoDebugError::postWarning().

Referenced by SbBox3s(), SbBox3s(), SbBox3s(), SbBox3s(), and SbBox3s().

◆ setBounds() [2/5]

void SbBox3s::setBounds ( const SbVec3s & minvec,
const SbVec3s & maxvec )

Reset the boundaries of the box with the given corners.

The coordinates of minvec should be less than the coordinates of maxvec if you want to make a valid box.

See also
getBounds().

References SoDebugError::postWarning().

◆ setBounds() [3/5]

SbBox3s & SbBox3s::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(), and makeEmpty().

◆ setBounds() [4/5]

SbBox3s & SbBox3s::setBounds ( const SbBox3f & box)

Reset the boundaries to the boundaries of the given box.

Returns reference to self.

See also
getBounds().
Since
Coin-2.5

References SbBox3f::getMax(), SbBox3f::getMin(), SbBox3f::isEmpty(), and makeEmpty().

◆ setBounds() [5/5]

SbBox3s & SbBox3s::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(), and makeEmpty().

◆ getMin() [1/2]

const SbVec3s & SbBox3s::getMin ( void ) const

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

See also
getOrigin(), getMax().

Referenced by extendBy(), intersect(), operator==, SbBox3d::setBounds(), SbBox3f::setBounds(), and SbBox3i32::setBounds().

◆ getMin() [2/2]

SbVec3s & SbBox3s::getMin ( void )
inline

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

Since
Coin-2.5

◆ getMax() [1/2]

const SbVec3s & SbBox3s::getMax ( void ) const

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

See also
getMin().

Referenced by extendBy(), intersect(), operator==, SbBox3d::setBounds(), SbBox3f::setBounds(), and SbBox3i32::setBounds().

◆ getMax() [2/2]

SbVec3s & SbBox3s::getMax ( void )
inline

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

Since
Coin-2.5

◆ extendBy() [1/2]

void SbBox3s::extendBy ( const SbVec3s & 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 within it.

References SbVec3s::setValue().

Referenced by extendBy().

◆ extendBy() [2/2]

void SbBox3s::extendBy ( const SbBox3s & 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(), getMax(), getMin(), SoDebugError::postWarning(), and SbBox3s().

◆ makeEmpty()

void SbBox3s::makeEmpty ( void )

Marks this as an empty box.

See also
isEmpty().

Referenced by SbBox3s(), setBounds(), setBounds(), and setBounds().

◆ isEmpty()

SbBool SbBox3s::isEmpty ( void ) const
inline

Check if this has been marked as an empty box.

See also
makeEmpty().

Referenced by SbBox3d::setBounds(), SbBox3f::setBounds(), and SbBox3i32::setBounds().

◆ hasVolume()

SbBool SbBox3s::hasVolume ( void ) const
inline

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

◆ getVolume()

int SbBox3s::getVolume ( void ) const
inline

Check if the box has "positive" volume, i.e. the lower left corner is actually lower and more left than the maximum point. If so, return the volume.

References getSize().

◆ intersect() [1/2]

SbBool SbBox3s::intersect ( const SbVec3s & point) const

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

◆ intersect() [2/2]

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

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

References getMax(), getMin(), and SbBox3s().

◆ getBounds() [1/2]

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

Returns the box boundary coordinates.

See also
setBounds(), getMin(), getMax().

◆ getBounds() [2/2]

void SbBox3s::getBounds ( SbVec3s & minvec,
SbVec3s & maxvec ) const

Returns the box corner points.

See also
setBounds(), getMin(), getMax().

◆ getCenter()

SbVec3f SbBox3s::getCenter ( void ) const
inline

Returns the center point of the box.

◆ getOrigin()

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

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

See also
getMin().

◆ getSize()

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

Returns width and height of box.

References SoDebugError::postWarning().

Referenced by getVolume().

◆ operator==

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

Check b1 and b2 for equality.

References getMax(), getMin(), and SbBox3s().

◆ operator!=

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

Check b1 and b2 for inequality.

References SbBox3s().


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

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

Generated on Wed Jul 23 2025 for Coin by Doxygen. 1.14.0