.TH "SbBox3d" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SbBox3d \- .PP The \fBSbBox3d\fP class is an abstraction for an axis aligned 3 dimensional box\&. .PP This box abstraction class is used by other entities in the Coin library for data exchange and storage\&. It provides a representation of the defining corners of a box in 3D space, with the sides aligned with the 3 principal axes\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherited by \fBSbXfBox3d\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBSbBox3d\fP (void)" .br .ti -1c .RI "\fBSbBox3d\fP (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax)" .br .ti -1c .RI "\fBSbBox3d\fP (const \fBSbVec3d\fP &minpoint, const \fBSbVec3d\fP &maxpoint)" .br .ti -1c .RI "\fBSbBox3d\fP (const \fBSbBox3f\fP &box)" .br .ti -1c .RI "\fBSbBox3d\fP (const \fBSbBox3s\fP &box)" .br .ti -1c .RI "\fBSbBox3d\fP (const SbBox3i32 &box)" .br .ti -1c .RI "\fBSbBox3d\fP & \fBsetBounds\fP (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax)" .br .ti -1c .RI "\fBSbBox3d\fP & \fBsetBounds\fP (const \fBSbVec3d\fP &minpoint, const \fBSbVec3d\fP &maxpoint)" .br .ti -1c .RI "\fBSbBox3d\fP & \fBsetBounds\fP (const \fBSbBox3f\fP &box)" .br .ti -1c .RI "\fBSbBox3d\fP & \fBsetBounds\fP (const \fBSbBox3s\fP &box)" .br .ti -1c .RI "\fBSbBox3d\fP & \fBsetBounds\fP (const SbBox3i32 &box)" .br .ti -1c .RI "void \fBgetBounds\fP (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) const " .br .ti -1c .RI "void \fBgetBounds\fP (\fBSbVec3d\fP &minpoint, \fBSbVec3d\fP &maxpoint) const " .br .ti -1c .RI "const \fBSbVec3d\fP & \fBgetMin\fP (void) const " .br .ti -1c .RI "\fBSbVec3d\fP & \fBgetMin\fP (void)" .br .ti -1c .RI "const \fBSbVec3d\fP & \fBgetMax\fP (void) const " .br .ti -1c .RI "\fBSbVec3d\fP & \fBgetMax\fP (void)" .br .ti -1c .RI "void \fBextendBy\fP (const \fBSbVec3d\fP &pt)" .br .ti -1c .RI "void \fBextendBy\fP (const \fBSbBox3d\fP &box)" .br .ti -1c .RI "void \fBtransform\fP (const \fBSbDPMatrix\fP &matrix)" .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 "double \fBgetVolume\fP (void) const " .br .ti -1c .RI "SbBool \fBintersect\fP (const \fBSbVec3d\fP &point) const " .br .ti -1c .RI "SbBool \fBintersect\fP (const \fBSbBox3d\fP &box) const " .br .ti -1c .RI "\fBSbVec3d\fP \fBgetClosestPoint\fP (const \fBSbVec3d\fP &point) const " .br .ti -1c .RI "SbBool \fBoutside\fP (const \fBSbDPMatrix\fP &mvp, int &cullbits) const " .br .ti -1c .RI "\fBSbVec3d\fP \fBgetCenter\fP (void) const " .br .ti -1c .RI "void \fBgetOrigin\fP (double &origoX, double &origoY, double &origoZ) const " .br .ti -1c .RI "void \fBgetSize\fP (double &sizeX, double &sizeY, double &sizeZ) const " .br .ti -1c .RI "\fBSbVec3d\fP \fBgetSize\fP (void) const " .br .ti -1c .RI "void \fBgetSpan\fP (const \fBSbVec3d\fP &dir, double &dmin, double &dmax) const " .br .ti -1c .RI "void \fBprint\fP (FILE *file) const " .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBSbVec3d\fP \fBminpt\fP" .br .ti -1c .RI "\fBSbVec3d\fP \fBmaxpt\fP" .br .in -1c .SS "Related Functions" (Note that these are not member functions\&.) .in +1c .ti -1c .RI "int \fBoperator==\fP (const \fBSbBox3d\fP &b1, const \fBSbBox3d\fP &b2)" .br .ti -1c .RI "int \fBoperator!=\fP (const \fBSbBox3d\fP &b1, const \fBSbBox3d\fP &b2)" .br .in -1c .SH "Detailed Description" .PP The \fBSbBox3d\fP class is an abstraction for an axis aligned 3 dimensional box\&. .PP This box abstraction class is used by other entities in the Coin library for data exchange and storage\&. It provides a representation of the defining corners of a box in 3D space, with the sides aligned with the 3 principal axes\&. .PP \fBSee also:\fP .RS 4 \fBSbBox2s\fP, \fBSbBox2f\fP, \fBSbBox2d\fP, \fBSbBox3s\fP, \fBSbBox3f\fP, \fBSbXfBox3f\fP\&. .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SbBox3d::SbBox3d (void)\fC [inline]\fP" The default constructor makes an empty box\&. .SS "SbBox3d::SbBox3d (doubleminx, doubleminy, doubleminz, doublemaxx, doublemaxy, doublemaxz)\fC [inline]\fP" Constructs a box with the given corners\&. .PP \fIminx\fP should be less than \fImaxx\fP, \fIminy\fP should be less than \fImaxy\fP and \fIminz\fP should be less than \fImaxz\fP if you want to make a valid box\&. .SS "SbBox3d::SbBox3d (const \fBSbVec3d\fP &minval, const \fBSbVec3d\fP &maxval)\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\&. .SH "Member Function Documentation" .PP .SS "\fBSbBox3d\fP & SbBox3d::setBounds (doublexmin, doubleymin, doublezmin, doublexmax, doubleymax, doublezmax)\fC [inline]\fP" Reset the boundaries of the box\&. .PP \fIminx\fP should be less than \fImaxx\fP, \fIminy\fP should be less than \fImaxy\fP and \fIminz\fP should be less than \fImaxz\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 "\fBSbBox3d\fP & SbBox3d::setBounds (const \fBSbVec3d\fP &minval, const \fBSbVec3d\fP &maxval)\fC [inline]\fP" Reset the boundaries of the 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\&. .PP Returns reference to self\&. .PP \fBSee also:\fP .RS 4 \fBgetBounds()\fP\&. .RE .PP .SS "\fBSbBox3d\fP & SbBox3d::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 \fBsetBounds()\fP .RE .PP .SS "\fBSbBox3d\fP & SbBox3d::setBounds (const \fBSbBox3s\fP &box)" Reset the boundaries to the boundaries of the given \fIbox\fP\&. .PP Returns reference to self\&. .PP \fBSee also:\fP .RS 4 \fBsetBounds()\fP .RE .PP .SS "\fBSbBox3d\fP & SbBox3d::setBounds (const SbBox3i32 &box)" Reset the boundaries to the boundaries of the given \fIbox\fP\&. .PP Returns reference to self\&. .PP \fBSee also:\fP .RS 4 \fBsetBounds()\fP .RE .PP .SS "void SbBox3d::getBounds (double &minx, double &miny, double &minz, double &maxx, double &maxy, double &maxz) const\fC [inline]\fP" Returns the box boundaries\&. .PP \fBSee also:\fP .RS 4 \fBsetBounds()\fP\&. .RE .PP .SS "void SbBox3d::getBounds (\fBSbVec3d\fP &minobj, \fBSbVec3d\fP &maxobj) const\fC [inline]\fP" Returns the box corner points\&. .PP \fBSee also:\fP .RS 4 \fBsetBounds()\fP\&. .RE .PP .SS "const \fBSbVec3d\fP & SbBox3d::getMin (void) 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 "\fBSbVec3d\fP & SbBox3d::getMin (void)\fC [inline]\fP" Returns a modifiable reference the minimum point\&. .SS "const \fBSbVec3d\fP & SbBox3d::getMax (void) 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 "\fBSbVec3d\fP & SbBox3d::getMax (void)\fC [inline]\fP" Returns a modifiable reference the maximum point\&. .SS "void SbBox3d::extendBy (const \fBSbVec3d\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 so\&. .SS "void SbBox3d::extendBy (const \fBSbBox3d\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 SbBox3d::transform (const \fBSbDPMatrix\fP &matrix)" Transform the box by the matrix, and change its boundaries to contain the transformed box\&. .PP Doesn't touch illegal/empty boxes\&. .SS "void SbBox3d::makeEmpty (void)" Marks this as an empty box\&. .PP \fBSee also:\fP .RS 4 \fBisEmpty()\fP\&. .RE .PP .SS "SbBool SbBox3d::isEmpty (void) 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 SbBox3d::hasVolume (void) const\fC [inline]\fP" Check if the box has been correctly specified and by that virtue has volume\&. .SS "double SbBox3d::getVolume (void) const\fC [inline]\fP" Check if the box has 'positive' volume, i\&.e\&. the lower left corner is actually lower and more left than the maximum point\&. .SS "SbBool SbBox3d::intersect (const \fBSbVec3d\fP &point) const" Check if the given point lies within the boundaries of this box\&. .SS "SbBool SbBox3d::intersect (const \fBSbBox3d\fP &box) const" Check if the given \fIbox\fP lies wholly or partly within the boundaries of this box\&. .SS "\fBSbVec3d\fP SbBox3d::getClosestPoint (const \fBSbVec3d\fP &point) const" Return the point on the box closest to the given \fIpoint\fP\&. .SS "SbBool SbBox3d::outside (const \fBSbDPMatrix\fP &mvp, int &cullbits) const" Check if the box is outside the view volume defined by the \fImvp\fP matrix\&. Sets \fIcullbits\fP according to which planes we're inside or outside\&. Bit 0 (0x1) is cleared when box is completely inside left and right clipping planes\&. Bit 1 (0x2) is cleared when box is inside top and bottom clipping planes\&. Bit 2 (0x4) is cleared when box is inside near and far clipping planes\&. .PP Returns \fCTRUE\fP if box is completely outside one of the clipping planes\&. \fCFALSE\fP otherwise\&. .SS "\fBSbVec3d\fP SbBox3d::getCenter (void) const\fC [inline]\fP" Returns the center point of the box\&. .SS "void SbBox3d::getOrigin (double &originX, double &originY, double &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 "void SbBox3d::getSize (double &sizeX, double &sizeY, double &sizeZ) const\fC [inline]\fP" Returns width, height and depth of box\&. .SS "\fBSbVec3d\fP SbBox3d::getSize (void) const\fC [inline]\fP" Returns width, height and depth of box as a 3D vector\&. .PP \fBSince:\fP .RS 4 Coin 3\&.0 .RE .PP .SS "void SbBox3d::getSpan (const \fBSbVec3d\fP &dir, double &dmin, double &dmax) const" Find the span of the box in the given direction (i\&.e\&. how much room in the given direction the box needs)\&. The distance is returned as the minimum and maximum distance from origo to the closest and furthest plane defined by the direction vector and each of the box' corners\&. The difference between these values gives the span\&. .SS "void SbBox3d::print (FILE *fp) const" Dump the state of this object to the \fIfile\fP stream\&. Only works in debug version of library, method does nothing in an optimized compile\&. .SH "Friends And Related Function Documentation" .PP .SS "int operator== (const \fBSbBox3d\fP &b1, const \fBSbBox3d\fP &b2)\fC [related]\fP" Check \fIb1\fP and \fIb2\fP for equality\&. .SS "int operator!= (const \fBSbBox3d\fP &b1, const \fBSbBox3d\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\&.