Linux Certif

Toute la documentation sur la certification Linux LPI

SbBox3s

NAME

SbBox3s -

SYNOPSIS

#include <Inventor/SbBox.h>

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

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)

SbBox3s & setBounds (const SbBox3i32 &box)

SbBox3s & setBounds (const SbBox3f &box)

SbBox3s & setBounds (const SbBox3d &box)

const SbVec3s & getMin (void) const

SbVec3s & getMin (void)

const SbVec3s & getMax (void) const

SbVec3s & getMax (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)

Constructor & Destructor Documentation

SbBox3s::SbBox3s (void)

The default constructor makes an empty box.

References makeEmpty().

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::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::SbBox3s (const SbBox3i32 & box) [inline, explicit]

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

Since:

Coin-2.5

SbBox3s::SbBox3s (const SbBox3f & box) [inline, explicit]

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

Since:

Coin-2.5

SbBox3s::SbBox3s (const SbBox3d & box) [inline, explicit]

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

Since:

Coin-2.5

SbBox3s::~SbBox3s (void)

Destructor does nothing.

Member Function Documentation

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(), and SbVec3s::setValue().

Referenced by SbBox3s().

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

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(), makeEmpty(), and SbVec3s::setValue().

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(), makeEmpty(), and SbVec3s::setValue().

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(), makeEmpty(), and SbVec3s::setValue().

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(), SbBox3i32::setBounds(), SbBox3f::setBounds(), and SbBox3d::setBounds().

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

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(), SbBox3i32::setBounds(), SbBox3f::setBounds(), and SbBox3d::setBounds().

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

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

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(), maxpt, minpt, and SoDebugError::postWarning().

void SbBox3s::makeEmpty (void)

Marks this as an empty box.

See also:

isEmpty().

References SbVec3s::setValue().

Referenced by SbBox3s(), and setBounds().

SbBool SbBox3s::isEmpty (void) const [inline]

Check if this has been marked as an empty box.

See also:

makeEmpty().

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

SbBool SbBox3s::hasVolume (void) const [inline]

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

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.

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

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

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

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

References getMax(), and getMin().

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

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

Returns the box corner points.

See also:

setBounds(), getMin(), getMax().

SbVec3f SbBox3s::getCenter (void) const [inline]

Returns the center point of the box.

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

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

Returns width and height of box.

References SoDebugError::postWarning().

Friends And Related Function Documentation

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

Check b1 and b2 for equality.

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

Check b1 and b2 for inequality.

Author

Generated automatically by Doxygen for Coin from the source code.