SbBox3d(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 NAME 🎀

okay bestie welcome to SbBox3d(3), fresh out of the Library Functions Manual, and here's the whole thing in one breath: the SbBox3d class is an abstraction for an axis aligned 3 dimensional box. that's it. that's the name. iconic behavior honestly 💅

✨ SYNOPSIS ✨

first things first, you gotta let it in the door:

#include <Inventor/SbBox.h>

Inherited by SbXfBox3d. (yes queen, it's a whole family tree situation 👑)

👑 Public Member Functions

here's the full roster, every single one, no skips:

SbBox3d (void)
SbBox3d (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax)
SbBox3d (const SbVec3d &minpoint, const SbVec3d &maxpoint)
SbBox3d (const SbBox3f &box)
SbBox3d (const SbBox3s &box)
SbBox3d (const SbBox3i32 &box)
SbBox3d & setBounds (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax)
SbBox3d & setBounds (const SbVec3d &minpoint, const SbVec3d &maxpoint)
SbBox3d & setBounds (const SbBox3f &box)
SbBox3d & setBounds (const SbBox3s &box)
SbBox3d & setBounds (const SbBox3i32 &box)
void getBounds (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) const
void getBounds (SbVec3d &minpoint, SbVec3d &maxpoint) const
const SbVec3d & getMin (void) const
SbVec3d & getMin (void)
const SbVec3d & getMax (void) const
SbVec3d & getMax (void)
void extendBy (const SbVec3d &pt)
void extendBy (const SbBox3d &box)
void transform (const SbDPMatrix &matrix)
void makeEmpty (void)
SbBool isEmpty (void) const
SbBool hasVolume (void) const
double getVolume (void) const
SbBool intersect (const SbVec3d &point) const
SbBool intersect (const SbBox3d &box) const
SbVec3d getClosestPoint (const SbVec3d &point) const
SbBool outside (const SbDPMatrix &mvp, int &cullbits) const
SbVec3d getCenter (void) const
void getOrigin (double &origoX, double &origoY, double &origoZ) const
void getSize (double &sizeX, double &sizeY, double &sizeZ) const
void getSpan (const SbVec3d &dir, double &dmin, double &dmax) const
void print (FILE *file) const

🔒 Protected Attributes

the internal secrets, lowkey protected:

  • SbVec3d minpt
  • SbVec3d maxpt

heads up bestie, these are not member symbols, they just live nearby:

  • int operator== (const SbBox3d &b1, const SbBox3d &b2)
  • int operator!= (const SbBox3d &b1, const SbBox3d &b2)

💖 Detailed Description 💖

so. the SbBox3d class is an abstraction for an axis aligned 3 dimensional box. say it with me: axis aligned 3D box. that's the whole main character energy of this file.

this box abstraction class is used by other entities in the Coin library for data exchange and storage. it gives you a representation of the defining corners of a box in 3D space, with the sides aligned with the 3 principal axes. so like — no tilting, no rotation, no drama. the box is straight. the box is honest. we love her for that 🦋

See also

  • SbBox2d, SbBox2f, SbBox2i32, SbBox2s, SbBox3f, SbBox3i32, SbBox3s, SbXfBox3d, SbXfBox3f

🧚 Constructor & Destructor Documentation 🧚

SbBox3d::SbBox3d (void ) [inline]

the default constructor makes an empty box. that's it. an empty little box. a blank canvas. a fresh start ✨

References makeEmpty().

Referenced by extendBy(), SbXfBox3d::extendBy(), SbXfBox3d::extendBy(), intersect(), SbXfBox3d::intersect(), SbXfBox3d::intersect(), operator!=(), operator==(), SbXfBox3d::project(), SbXfBox3d::SbXfBox3d(), setBounds(), setBounds(), and transform().

SbBox3d::SbBox3d (double minx, double miny, double minz, double maxx, double maxy, double maxz) [inline]

constructs a box with the given corners. simple as that 💅

ok but fr fr: minx should be less than maxx, miny should be less than maxy, and minz should be less than maxz if you want to make a valid box. if you don't, that's a you problem bestie, the box will not be valid and nobody can help you 😭

SbBox3d::SbBox3d (const SbVec3d & minval, const SbVec3d & maxval) [inline]

constructs a box with the given corners. again. but this time with vectors, she's fancy 💜

the coordinates of min should be less than the coordinates of max if you want to make a valid box. (same rule, different outfit.)

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

constructs a box with coordinates from box, converting the coordinates to floating point double precision values. glow-up arc, honestly 🌸

Since

Coin-2.5

References setBounds().

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

constructs a box with coordinates from box, converting the coordinates to floating point double precision values. same energy, different source type 🎀

Since

Coin-2.5

References setBounds().

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

constructs a box with coordinates from box, converting the coordinates to floating point double precision values. the third sibling. the trio is complete 👑

Since

Coin-2.5

References setBounds().

ok that's constructors done, but we are not done — part 2 is right behind this one, keep scrolling bestie 💖

💅 Member Function Documentation 💅

SbBox3d & SbBox3d::setBounds (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax) [inline]

Okay bestie, this one resets the boundaries of the box. 💖

Important: minx should be less than maxx, miny should be less than maxy, and minz should be less than maxz if you want to make a valid box. No cap.

Returns a reference to self, so you can chain like a queen. 👑

  • See also — getBounds().
  • References — SbBox3d().
  • Referenced by — extendBy(), SbXfBox3d::extendBy(), SbBox3d(), SbBox3d(), SbBox3d(), and transform().

SbBox3d & SbBox3d::setBounds (const SbVec3d & minval, const SbVec3d & maxval) [inline]

Reset the boundaries with the given corners. ✨

The coordinates of min should be less than the coordinates of max if you want a valid box. (Yes, the param is minval, but the docs say min. Keep it real.)

Returns reference to self.

  • See also — getBounds().
  • References — SbBox3d().

SbBox3d & SbBox3d::setBounds (const SbBox3f & box)

Reset the boundaries to the boundaries of the given box. 🎀

Returns reference to self.

  • See also — setBounds()
  • References — SbBox3f::getMax(), SbBox3f::getMin(), SbBox3f::isEmpty(), and makeEmpty().

SbBox3d & SbBox3d::setBounds (const SbBox3s & box)

Reset the boundaries to the boundaries of the given box. 🦋

Returns reference to self.

  • See also — setBounds()
  • References — SbBox3s::getMax(), SbBox3s::getMin(), SbBox3s::isEmpty(), and makeEmpty().

SbBox3d & SbBox3d::setBounds (const SbBox3i32 & box)

Reset the boundaries to the boundaries of the given box. 🌸

Returns reference to self.

  • See also — setBounds()
  • References — SbBox3i32::getMax(), SbBox3i32::getMin(), SbBox3i32::isEmpty(), and makeEmpty().

void SbBox3d::getBounds (double & minx, double & miny, double & minz, double & maxx, double & maxy, double & maxz) const [inline]

Returns the box boundaries. 💅

  • See also — setBounds().
  • Referenced by — print().

void SbBox3d::getBounds (SbVec3d & minobj, SbVec3d & maxobj) const [inline]

Returns the box corner points. 📦

  • See also — setBounds().

const SbVec3d & SbBox3d::getMin (void ) const [inline]

Returns the minimum point. This should usually be the lower left corner point of the box. 👑

  • See also — getOrigin(), getMax().
  • Referenced by — SbXfBox3d::extendBy(), SbXfBox3d::extendBy(), SbXfBox3d::intersect(), operator==(), SbXfBox3d::project(), SbBox3f::setBounds(), SbBox3i32::setBounds(), and SbBox3s::setBounds().

SbVec3d & SbBox3d::getMin (void ) [inline]

Returns a modifiable reference to the minimum point. 🔧

const SbVec3d & SbBox3d::getMax (void ) const [inline]

Returns the maximum point. This should usually be the upper right corner point of the box. 🌟

  • See also — getMin().
  • Referenced by — SbXfBox3d::extendBy(), SbXfBox3d::extendBy(), SbXfBox3d::intersect(), operator==(), SbXfBox3d::project(), SbBox3f::setBounds(), SbBox3i32::setBounds(), and SbBox3s::setBounds().

SbVec3d & SbBox3d::getMax (void ) [inline]

Returns a modifiable reference to the maximum point. 🔧

void SbBox3d::extendBy (const SbVec3d & 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. 🫶

  • References — isEmpty(), and setBounds().
  • Referenced by — extendBy(), SbXfBox3d::extendBy(), SbXfBox3d::extendBy(), and transform().

void SbBox3d::extendBy (const SbBox3d & 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(), isEmpty(), SoDebugError::postWarning(), and SbBox3d().

void SbBox3d::transform (const SbDPMatrix & matrix)

Transform the box by the matrix, and change its boundaries to contain the transformed box. 🔄

Doesn't touch illegal/empty boxes. (So if it's empty, it stays empty, no drama.)

  • References — extendBy(), isEmpty(), SbDPMatrix::multVecMatrix(), SoDebugError::postWarning(), SbBox3d(), setBounds(), and SbVec3d::setValue().
  • Referenced by — SbXfBox3d::project().

void SbBox3d::makeEmpty (void )

Marks this as an empty box. 💀

  • See also — isEmpty().
  • Referenced by — SbBox3d(), setBounds(), setBounds(), and setBounds().

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

Check if this has been marked as an empty box. 👀

  • See also — makeEmpty().
  • Referenced by — extendBy(), extendBy(), SbXfBox3d::extendBy(), SbXfBox3d::extendBy(), SbXfBox3d::extendBy(), getSize(), SbXfBox3d::intersect(), SbXfBox3d::project(), SbBox3f::setBounds(), SbBox3i32::setBounds(), SbBox3s::setBounds(), and transform().

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

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

  • Referenced by — SbXfBox3d::getVolume().

double SbBox3d::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. 📐

  • References — getSize().
  • Referenced by — SbXfBox3d::extendBy(), and SbXfBox3d::getVolume().

SbBool SbBox3d::intersect (const SbVec3d & point) const

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

  • Referenced by — SbXfBox3d::intersect(), and SbXfBox3d::intersect().

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

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

  • References — SbBox3d().

SbVec3d SbBox3d::getClosestPoint (const SbVec3d & point) const

Return the point on the box closest to the given point. 📍

  • References — getCenter().

SbBool SbBox3d::outside (const SbDPMatrix & mvp, int & cullbits) const

Check if the box is outside the view volume defined by the mvp matrix. Sets cullbits 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. 🎬

Returns TRUE if box is completely outside one of the clipping planes. FALSE otherwise.

  • References — SbDPMatrix::multVecMatrix().

SbVec3d SbBox3d::getCenter (void ) const [inline]

Returns the center point of the box. 🎯

  • Referenced by — SbXfBox3d::getCenter(), and getClosestPoint().

void SbBox3d::getOrigin (double & originX, double & originY, double & originZ) const [inline]

Returns the coordinates of the box origin (i.e. the lower left corner). 🌱

  • See also — getMin().

void SbBox3d::getSize (double & sizeX, double & sizeY, double & sizeZ) const [inline]

Returns width, height and depth of box. 📏

  • References — isEmpty().
  • Referenced by — getVolume().

void SbBox3d::getSpan (const SbVec3d & 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. 📐

  • References — SbVec3d::dot(), SbVec3d::normalize(), SoDebugError::postWarning(), and SbVec3d::setValue().
  • Referenced by — SbXfBox3d::getSpan().

void SbBox3d::print (FILE * fp) const

Dump the state of this object to the file stream. Only works in debug version of library, method does nothing in an optimized compile. 🖨️

  • References — getBounds(), and SbVec3d::print().

Check b1 and b2 for equality. ✅

  • References — getMax(), getMin(), and SbBox3d().

Check b1 and b2 for inequality. ❌

  • References — SbBox3d().

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. (So not a human, but still iconic.)

And that's a wrap on SbBox3d(3) from Coin, version 2.5.0! 💖 Thanks for reading, bestie. Now go make some boxes that actually have volume. 🎀✨

📦 where this page comes from