.TH "SbBox3s" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "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 \fR#include \fP .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBSbBox3s\fP (void)" .br .ti -1c .RI "\fBSbBox3s\fP (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)" .br .ti -1c .RI "\fBSbBox3s\fP (const \fBSbVec3s\fP &minpoint, const \fBSbVec3s\fP &maxpoint)" .br .ti -1c .RI "\fBSbBox3s\fP (const \fBSbBox3i32\fP &box)" .br .ti -1c .RI "\fBSbBox3s\fP (const \fBSbBox3f\fP &box)" .br .ti -1c .RI "\fBSbBox3s\fP (const \fBSbBox3d\fP &box)" .br .ti -1c .RI "\fBSbBox3s\fP & \fBsetBounds\fP (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)" .br .ti -1c .RI "\fBSbBox3s\fP & \fBsetBounds\fP (const \fBSbVec3s\fP &minpoint, const \fBSbVec3s\fP &maxpoint)" .br .ti -1c .RI "\fBSbBox3s\fP & \fBsetBounds\fP (const \fBSbBox3i32\fP &box)" .br .ti -1c .RI "\fBSbBox3s\fP & \fBsetBounds\fP (const \fBSbBox3f\fP &box)" .br .ti -1c .RI "\fBSbBox3s\fP & \fBsetBounds\fP (const \fBSbBox3d\fP &box)" .br .ti -1c .RI "void \fBgetBounds\fP (short &xmin, short &ymin, short &zmin, short &xmax, short &ymax, short &zmax) const" .br .ti -1c .RI "void \fBgetBounds\fP (\fBSbVec3s\fP &minpoint, \fBSbVec3s\fP &maxpoint) const" .br .ti -1c .RI "const \fBSbVec3s\fP & \fBgetMin\fP (void) const" .br .ti -1c .RI "\fBSbVec3s\fP & \fBgetMin\fP (void)" .br .ti -1c .RI "const \fBSbVec3s\fP & \fBgetMax\fP (void) const" .br .ti -1c .RI "\fBSbVec3s\fP & \fBgetMax\fP (void)" .br .ti -1c .RI "void \fBextendBy\fP (const \fBSbVec3s\fP &pt)" .br .ti -1c .RI "void \fBextendBy\fP (const \fBSbBox3s\fP &box)" .br .ti -1c .RI "void \fBmakeEmpty\fP (void)" .br .ti -1c .RI "SbBool \fBisEmpty\fP (void) const" .br .ti -1c .RI "SbBool \fBhasVolume\fP (void) const" .br .ti -1c .RI "int \fBgetVolume\fP (void) const" .br .ti -1c .RI "SbBool \fBintersect\fP (const \fBSbVec3s\fP &pt) const" .br .ti -1c .RI "SbBool \fBintersect\fP (const \fBSbBox3s\fP &box) const" .br .ti -1c .RI "\fBSbVec3f\fP \fBgetClosestPoint\fP (const \fBSbVec3f\fP &pt) const" .br .ti -1c .RI "\fBSbVec3f\fP \fBgetCenter\fP (void) const" .br .ti -1c .RI "void \fBgetOrigin\fP (short &originX, short &originY, short &originZ) const" .br .ti -1c .RI "void \fBgetSize\fP (short &sizeX, short &sizeY, short &sizeZ) const" .br .ti -1c .RI "\fBSbVec3s\fP \fBgetSize\fP (void) const" .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 (const \fBSbBox3s\fP &b1, const \fBSbBox3s\fP &b2)" .br .ti -1c .RI "int \fBoperator!=\fP (const \fBSbBox3s\fP &b1, const \fBSbBox3s\fP &b2)" .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 2\&.0 .PP TGS Inventor ?\&.? .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SbBox3s::SbBox3s (void )\fR [inline]\fP" The default constructor makes an empty box\&. .SS "SbBox3s::SbBox3s (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)\fR [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 (const \fBSbVec3s\fP & minvec, const \fBSbVec3s\fP & maxvec)\fR [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 (const \fBSbBox3i32\fP & box)\fR [inline]\fP, \fR [explicit]\fP" Constructs an \fBSbBox3s\fP instance from the value in an \fBSbBox3i32\fP instance\&. .PP \fBSince\fP .RS 4 Coin 2\&.5 .RE .PP .SS "SbBox3s::SbBox3s (const \fBSbBox3f\fP & box)\fR [inline]\fP, \fR [explicit]\fP" Constructs an \fBSbBox3s\fP instance from the value in an \fBSbBox3f\fP instance\&. .PP \fBSince\fP .RS 4 Coin 2\&.5 .RE .PP .SS "SbBox3s::SbBox3s (const \fBSbBox3d\fP & box)\fR [inline]\fP, \fR [explicit]\fP" Constructs an \fBSbBox3s\fP instance from the value in an \fBSbBox3d\fP instance\&. .PP \fBSince\fP .RS 4 Coin 2\&.5 .RE .PP .SH "Member Function Documentation" .PP .SS "\fBSbBox3s\fP & SbBox3s::setBounds (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)\fR [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\&. .RE .PP .SS "\fBSbBox3s\fP & SbBox3s::setBounds (const \fBSbVec3s\fP & minvec, const \fBSbVec3s\fP & maxvec)\fR [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 (const \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 (const \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 (const \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 "void SbBox3s::getBounds (short & xmin, short & ymin, short & zmin, short & xmax, short & ymax, short & zmax) const\fR [inline]\fP" Returns the box boundary coordinates\&. .PP \fBSee also\fP .RS 4 \fBsetBounds()\fP, \fBgetMin()\fP, \fBgetMax()\fP\&. .RE .PP .SS "void SbBox3s::getBounds (\fBSbVec3s\fP & minvec, \fBSbVec3s\fP & maxvec) const\fR [inline]\fP" Returns the box corner points\&. .PP \fBSee also\fP .RS 4 \fBsetBounds()\fP, \fBgetMin()\fP, \fBgetMax()\fP\&. .RE .PP .SS "const \fBSbVec3s\fP & SbBox3s::getMin (void ) const\fR [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 (void )\fR [inline]\fP" Returns a modifiable reference to the minimum point\&. .SS "const \fBSbVec3s\fP & SbBox3s::getMax (void ) const\fR [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 (void )\fR [inline]\fP" Returns a modifiable reference to the maximum point\&. .SS "void SbBox3s::extendBy (const \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 "void SbBox3s::extendBy (const \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 "void SbBox3s::makeEmpty (void )" Marks this as an empty box\&. .PP \fBSee also\fP .RS 4 \fBisEmpty()\fP\&. .RE .PP .SS "SbBool SbBox3s::isEmpty (void ) const\fR [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 (void ) const\fR [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 (void ) const\fR [inline]\fP" Returns the volume of the box\&. .SS "SbBool SbBox3s::intersect (const \fBSbVec3s\fP & point) const" Check if the given point lies within the boundaries of this box\&. .SS "SbBool SbBox3s::intersect (const \fBSbBox3s\fP & box) const" Check if \fIbox\fP lies entirely or partially within the boundaries of this box\&. .SS "\fBSbVec3f\fP SbBox3s::getClosestPoint (const \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 "\fBSbVec3f\fP SbBox3s::getCenter (void ) const\fR [inline]\fP" Returns the center point of the box\&. .SS "void SbBox3s::getOrigin (short & originX, short & originY, short & originZ) const\fR [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 "void SbBox3s::getSize (short & sizeX, short & sizeY, short & sizeZ) const\fR [inline]\fP" Returns width and height of box\&. .SS "\fBSbVec3s\fP SbBox3s::getSize (void ) const\fR [inline]\fP" Returns width, height and depth of box as a 3D vector\&. .PP \fBSince\fP .RS 4 Coin 3\&.0 .RE .PP .SH "Friends And Related Symbol Documentation" .PP .SS "int operator== (const \fBSbBox3s\fP & b1, const \fBSbBox3s\fP & b2)\fR [related]\fP" Check \fIb1\fP and \fIb2\fP for equality\&. .SS "int operator!= (const \fBSbBox3s\fP & b1, const \fBSbBox3s\fP & b2)\fR [related]\fP" Check \fIb1\fP and \fIb2\fP for inequality\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.