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

SbBox3s Class Reference
[Base classes]

#include <Inventor/SbBox.h>

List of all members.


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:
SbBox2s, SbBox2f, SbBox2d, SbBox3f, 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 (void)
const SbVec3sgetMin (void) const
const SbVec3sgetMax (void) const
void extendBy (const SbVec3s &point)
void extendBy (const SbBox3s &box)
SbBool intersect (const SbVec3s &point) const
SbBool intersect (const SbBox3s &box) const
void setBounds (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)
void setBounds (const SbVec3s &minvec, const SbVec3s &maxvec)
void getBounds (short &xmin, short &ymin, short &zmin, short &xmax, short &ymax, short &zmax) const
void getBounds (SbVec3s &minvec, SbVec3s &maxvec) const
void getOrigin (short &originX, short &originY, short &originZ) const
void getSize (short &sizeX, short &sizeY, short &sizeZ) const
void makeEmpty (void)

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.

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.

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.

SbBox3s::~SbBox3s ( void   ) 

Default destructor does nothing.


Member Function Documentation

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

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

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.

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.

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.

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

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

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

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.

void SbBox3s::makeEmpty ( void   ) 

Marks this as an empty box.

See also:
isEmpty().


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.


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

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

Generated on Sun Sep 9 20:59:53 2007 for Coin by Doxygen. 1.5.2