.TH "SbBox3s" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SbBox3s \- The \fBSbBox3s\fP class is a 3 dimensional box with short integer coordinates\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/SbBox3s\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSbBox3s\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP (short \fBxmin\fP, short ymin, short \fBzmin\fP, short \fBxmax\fP, short ymax, short \fBzmax\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP (\fBconst\fP \fBSbVec3s\fP &\fBminpoint\fP, \fBconst\fP \fBSbVec3s\fP &\fBmaxpoint\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP (\fBconst\fP \fBSbBox3i32\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP (\fBconst\fP \fBSbBox3f\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP (\fBconst\fP \fBSbBox3d\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP & \fBsetBounds\fP (short \fBxmin\fP, short ymin, short \fBzmin\fP, short \fBxmax\fP, short ymax, short \fBzmax\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP & \fBsetBounds\fP (\fBconst\fP \fBSbVec3s\fP &\fBminpoint\fP, \fBconst\fP \fBSbVec3s\fP &\fBmaxpoint\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP & \fBsetBounds\fP (\fBconst\fP \fBSbBox3i32\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP & \fBsetBounds\fP (\fBconst\fP \fBSbBox3f\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox3s\fP & \fBsetBounds\fP (\fBconst\fP \fBSbBox3d\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetBounds\fP (short &\fBxmin\fP, short &ymin, short &\fBzmin\fP, short &\fBxmax\fP, short &ymax, short &\fBzmax\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetBounds\fP (\fBSbVec3s\fP &\fBminpoint\fP, \fBSbVec3s\fP &\fBmaxpoint\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSbVec3s\fP & \fBgetMin\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBgetMin\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSbVec3s\fP & \fBgetMax\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBgetMax\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBextendBy\fP (\fBconst\fP \fBSbVec3s\fP &\fBpt\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBextendBy\fP (\fBconst\fP \fBSbBox3s\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBmakeEmpty\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisEmpty\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBhasVolume\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetVolume\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBintersect\fP (\fBconst\fP \fBSbVec3s\fP &\fBpt\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBintersect\fP (\fBconst\fP \fBSbBox3s\fP &\fBbox\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec3f\fP \fBgetClosestPoint\fP (\fBconst\fP \fBSbVec3f\fP &\fBpt\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec3f\fP \fBgetCenter\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetOrigin\fP (short &\fBoriginX\fP, short &\fBoriginY\fP, short &\fBoriginZ\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetSize\fP (short &\fBsizeX\fP, short &\fBsizeY\fP, short &\fBsizeZ\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBgetSize\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSbVec3s\fP \fBminpt\fP"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBmaxpt\fP"
.br
.in -1c
.SS "Related Symbols"
(Note that these are not member symbols\&.) 
.in +1c
.ti -1c
.RI "int \fBoperator==\fP (\fBconst\fP \fBSbBox3s\fP &\fBb1\fP, \fBconst\fP \fBSbBox3s\fP &\fBb2\fP)"
.br
.ti -1c
.RI "int \fBoperator!=\fP (\fBconst\fP \fBSbBox3s\fP &\fBb1\fP, \fBconst\fP \fBSbBox3s\fP &\fBb2\fP)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSbBox3s\fP 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\&.
.PP
\fBSee also\fP
.RS 4
\fBSbBox2s\fP, \fBSbBox2f\fP, \fBSbBox2d\fP, \fBSbBox3f\fP, \fBSbBox3d\fP, \fBSbXfBox3f\fP\&. 
.RE
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.0\fP 
.PP
TGS Inventor ?\&.? 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SbBox3s::SbBox3s (\fBvoid\fP)\fC [inline]\fP"
The default constructor makes an empty box\&. 
.SS "SbBox3s::SbBox3s (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)\fC [inline]\fP"
Constructs a box with the given corner coordinates\&.
.PP
\fIxmin\fP should be less than \fIxmax\fP, \fIymin\fP should be less than \fIymax\fP, and \fIzmin\fP should be less than \fIzmax\fP if you want to make a valid box\&. 
.SS "SbBox3s::SbBox3s (\fBconst\fP \fBSbVec3s\fP & minvec, \fBconst\fP \fBSbVec3s\fP & maxvec)\fC [inline]\fP"
Constructs a box with the given corners\&.
.PP
The coordinates of \fImin\fP should be less than the coordinates of \fImax\fP if you want to make a valid box\&. 
.SS "SbBox3s::SbBox3s (\fBconst\fP \fBSbBox3i32\fP & box)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an \fBSbBox3s\fP instance from the value in an \fBSbBox3i32\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "SbBox3s::SbBox3s (\fBconst\fP \fBSbBox3f\fP & box)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an \fBSbBox3s\fP instance from the value in an \fBSbBox3f\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "SbBox3s::SbBox3s (\fBconst\fP \fBSbBox3d\fP & box)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an \fBSbBox3s\fP instance from the value in an \fBSbBox3d\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBSbBox3s\fP & SbBox3s::setBounds (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)\fC [inline]\fP"
Reset the boundaries of the box\&.
.PP
\fIxmin\fP should be less than \fIxmax\fP, \fIymin\fP should be less than \fIymax\fP, and \fIzmin\fP should be less than \fIxmax\fP if you want to make a valid box\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP\&. 
.br
 
.RE
.PP

.SS "\fBSbBox3s\fP & SbBox3s::setBounds (\fBconst\fP \fBSbVec3s\fP & minvec, \fBconst\fP \fBSbVec3s\fP & maxvec)\fC [inline]\fP"
Reset the boundaries of the box with the given corners\&.
.PP
The coordinates of \fIminvec\fP should be less than the coordinates of \fImaxvec\fP if you want to make a valid box\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP\&. 
.RE
.PP

.SS "\fBSbBox3s\fP & SbBox3s::setBounds (\fBconst\fP \fBSbBox3i32\fP & box)"
Reset the boundaries to the boundaries of the given \fIbox\fP\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP\&. 
.RE
.PP

.SS "\fBSbBox3s\fP & SbBox3s::setBounds (\fBconst\fP \fBSbBox3f\fP & box)"
Reset the boundaries to the boundaries of the given \fIbox\fP\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP\&. 
.RE
.PP

.SS "\fBSbBox3s\fP & SbBox3s::setBounds (\fBconst\fP \fBSbBox3d\fP & box)"
Reset the boundaries to the boundaries of the given \fIbox\fP\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP\&. 
.RE
.PP

.SS "\fBvoid\fP SbBox3s::getBounds (short & xmin, short & ymin, short & zmin, short & xmax, short & ymax, short & zmax) const\fC [inline]\fP"
Returns the box boundary coordinates\&.
.PP
\fBSee also\fP
.RS 4
\fBsetBounds()\fP, \fBgetMin()\fP, \fBgetMax()\fP\&. 
.RE
.PP

.SS "\fBvoid\fP SbBox3s::getBounds (\fBSbVec3s\fP & minvec, \fBSbVec3s\fP & maxvec) const\fC [inline]\fP"
Returns the box corner points\&.
.PP
\fBSee also\fP
.RS 4
\fBsetBounds()\fP, \fBgetMin()\fP, \fBgetMax()\fP\&. 
.RE
.PP

.SS "\fBconst\fP \fBSbVec3s\fP & SbBox3s::getMin (\fBvoid\fP) const\fC [inline]\fP"
Returns the minimum point\&. This should usually be the lower left corner point of the box\&.
.PP
\fBSee also\fP
.RS 4
\fBgetOrigin()\fP, \fBgetMax()\fP\&. 
.RE
.PP

.SS "\fBSbVec3s\fP & SbBox3s::getMin (\fBvoid\fP)\fC [inline]\fP"
Returns a modifiable reference to the minimum point\&. 
.SS "\fBconst\fP \fBSbVec3s\fP & SbBox3s::getMax (\fBvoid\fP) const\fC [inline]\fP"
Returns the maximum point\&. This should usually be the upper right corner point of the box\&.
.PP
\fBSee also\fP
.RS 4
\fBgetMin()\fP\&. 
.RE
.PP

.SS "\fBSbVec3s\fP & SbBox3s::getMax (\fBvoid\fP)\fC [inline]\fP"
Returns a modifiable reference to the maximum point\&. 
.SS "\fBvoid\fP SbBox3s::extendBy (\fBconst\fP \fBSbVec3s\fP & 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\&. 
.SS "\fBvoid\fP SbBox3s::extendBy (\fBconst\fP \fBSbBox3s\fP & box)"
Extend the boundaries of the box by the given \fIbox\fP parameter\&. This is equal to calling \fBextendBy()\fP twice with the corner points\&. 
.SS "\fBvoid\fP SbBox3s::makeEmpty (\fBvoid\fP)"
Marks this as an empty box\&.
.PP
\fBSee also\fP
.RS 4
\fBisEmpty()\fP\&. 
.RE
.PP

.SS "SbBool SbBox3s::isEmpty (\fBvoid\fP) const\fC [inline]\fP"
Check if this has been marked as an empty box\&.
.PP
\fBSee also\fP
.RS 4
\fBmakeEmpty()\fP\&. 
.RE
.PP

.SS "SbBool SbBox3s::hasVolume (\fBvoid\fP) const\fC [inline]\fP"
Check if the box has been correctly specified and by that virtue has 'positive' volume, i\&.e\&. all coordinates of its upper right corner (the maximum point) are greater than the corresponding coordinates of its lower left corner (the minimum point)\&. 
.SS "int SbBox3s::getVolume (\fBvoid\fP) const\fC [inline]\fP"
Returns the volume of the box\&. 
.SS "SbBool SbBox3s::intersect (\fBconst\fP \fBSbVec3s\fP & point) const"
Check if the given point lies within the boundaries of this box\&. 
.SS "SbBool SbBox3s::intersect (\fBconst\fP \fBSbBox3s\fP & box) const"
Check if \fIbox\fP lies entirely or partially within the boundaries of this box\&. 
.SS "\fBSbVec3f\fP SbBox3s::getClosestPoint (\fBconst\fP \fBSbVec3f\fP & point) const"
Return the point on the box closest to the given \fIpoint\fP\&. If the given point equals the center, the center point of the positive Z face is returned\&. 
.SS "\fBSbVec3s\fP SbBox3s::getCenter (\fBvoid\fP) const\fC [inline]\fP"
Returns the center point of the box\&. 
.SS "\fBvoid\fP SbBox3s::getOrigin (short & originX, short & originY, short & originZ) const\fC [inline]\fP"
Returns the coordinates of the box origin (i\&.e\&. the lower left corner)\&.
.PP
\fBSee also\fP
.RS 4
\fBgetMin()\fP\&. 
.RE
.PP

.SS "\fBvoid\fP SbBox3s::getSize (short & sizeX, short & sizeY, short & sizeZ) const\fC [inline]\fP"
Returns width and height of box\&. 
.SS "\fBSbVec3s\fP SbBox3s::getSize (\fBvoid\fP) const\fC [inline]\fP"
Returns width, height and depth of box as a 3D vector\&.
.PP
\fBSince\fP
.RS 4
Coin \fB3\&.0\fP 
.RE
.PP

.SH "Friends And Related Symbol Documentation"
.PP 
.SS "int \fBoperator\fP== (\fBconst\fP \fBSbBox3s\fP & b1, \fBconst\fP \fBSbBox3s\fP & b2)\fC [related]\fP"
Check \fIb1\fP and \fIb2\fP for equality\&. 
.SS "int operator!= (\fBconst\fP \fBSbBox3s\fP & b1, \fBconst\fP \fBSbBox3s\fP & b2)\fC [related]\fP"
Check \fIb1\fP and \fIb2\fP for inequality\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.