SbBox3s(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SbBox3s 💖

okay bestie, welcome to the Coin manual, section 3, and today's main character is SbBox3s — a whole 3 dimensional box with short integer coordinates. she's small, she's boxy, she's got range (literally, x y and z). let's go 🎀

🌸 NAME 🌸

SbBox3s — the SbBox3s class is a 3 dimensional box with short integer coordinates. periodt.

✨ SYNOPSIS ✨

#include <Inventor/SbBox3s.h>

🫶 Public Member Functions 🫶

SbBox3s (void)
SbBox3s (short xmin, short ymin, short zmin, short xmax, short ymax,
    short zmax)
SbBox3s (const SbVec3s &minpoint, const SbVec3s &maxpoint)
SbBox3s (const SbBox3i32 &box)
SbBox3s (const SbBox3f &box)
SbBox3s (const SbBox3d &box)
SbBox3s & setBounds (short xmin, short ymin, short zmin, short xmax,
    short ymax, short zmax)
SbBox3s & setBounds (const SbVec3s &minpoint, const SbVec3s &maxpoint)
SbBox3s & setBounds (const SbBox3i32 &box)
SbBox3s & setBounds (const SbBox3f &box)
SbBox3s & setBounds (const SbBox3d &box)
void getBounds (short &xmin, short &ymin, short &zmin, short &xmax,
    short &ymax, short &zmax) const
void getBounds (SbVec3s &minpoint, SbVec3s &maxpoint) const
const SbVec3s & getMin (void) const
SbVec3s & getMin (void)
const SbVec3s & getMax (void) const
SbVec3s & getMax (void)
void extendBy (const SbVec3s &pt)
void extendBy (const SbBox3s &box)
void makeEmpty (void)
SbBool isEmpty (void) const
SbBool hasVolume (void) const
int getVolume (void) const
SbBool intersect (const SbVec3s &pt) const
SbBool intersect (const SbBox3s &box) const
SbVec3f getClosestPoint (const SbVec3f &pt) const
SbVec3f getCenter (void) const
void getOrigin (short &originX, short &originY, short &originZ) const
void getSize (short &sizeX, short &sizeY, short &sizeZ) const
SbVec3s getSize (void) const

🧚 Protected Attributes 🧚

SbVec3s minpt
SbVec3s maxpt

(and no, these are not member symbols, okay? they're just vibing nearby)

int operator== (const SbBox3s &b1, const SbBox3s &b2)
int operator!= (const SbBox3s &b1, const SbBox3s &b2)

🦋 Detailed Description 🦋

The SbBox3s class is a 3 dimensional box with short integer coordinates. she said "short integer" and meant it 💅

This box class is used by other classes in Coin for data exchange. It provides storage for two box corners with short integer coordinates. literally just two corners, holding it down. iconic.

See also — SbBox2s, SbBox2f, SbBox2d, SbBox3f, SbBox3d, SbXfBox3f. the whole box family, we love a supportive sibling situation 🫶

Since

  • Coin 2.0
  • TGS Inventor ?.?

🎀 Constructor & Destructor Documentation 🎀

SbBox3s::SbBox3s (void ) [inline]

The default constructor makes an empty box. no corners, no drama, no volume. a blank canvas bestie ✨

SbBox3s::SbBox3s (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax) [inline]

Constructs a box with the given corner coordinates.

ok so heads up: 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. don't do the reverse and then act surprised 😭

SbBox3s::SbBox3s (const SbVec3s & minvec, const SbVec3s & maxvec) [inline]

Constructs a box with the given corners.

same energy: the coordinates of min should be less than the coordinates of max if you want to make a valid box. fr fr.

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

Constructs an SbBox3s instance from the value in an SbBox3i32 instance. glow-up conversion ✨

Since

  • Coin 2.5

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

Constructs an SbBox3s instance from the value in an SbBox3f instance. float to short, she's adapting 💅

Since

  • Coin 2.5

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

Constructs an SbBox3s instance from the value in an SbBox3d instance. double the precision, same box energy 🦋

Since

  • Coin 2.5

💜 Member Function Documentation 💜

SbBox3s & SbBox3s::setBounds (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax) [inline]

Reset the boundaries of the box. fresh start, new corners, new you.

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.

Returns reference to self. she's giving back 🫶

See also — getBounds().

SbBox3s & SbBox3s::setBounds (const SbVec3s & minvec, const SbVec3s & maxvec) [inline]

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.

Returns reference to self.

See also — getBounds().

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

Reset the boundaries to the boundaries of the given box. just copying her whole vibe tbh.

Returns reference to self.

See also — getBounds().

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

Reset the boundaries to the boundaries of the given box.

Returns reference to self.

See also — getBounds().

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

Reset the boundaries to the boundaries of the given box.

Returns reference to self.

See also — getBounds().

void SbBox3s::getBounds (short & xmin, short & ymin, short & zmin, short & xmax, short & ymax, short & zmax) const [inline]

Returns the box boundary coordinates. all six of them, hand-delivered into your references 💖

See also — setBounds(), getMin(), getMax().

void SbBox3s::getBounds (SbVec3s & minvec, SbVec3s & maxvec) const [inline]

Returns the box corner points.

See also — setBounds(), getMin(), getMax().

const SbVec3s & SbBox3s::getMin (void ) const [inline]

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

See also — getOrigin(), getMax().

SbVec3s & SbBox3s::getMin (void ) [inline]

Returns a modifiable reference to the minimum point. go off, edit her 👑

const SbVec3s & SbBox3s::getMax (void ) const [inline]

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

See also — getMin().

SbVec3s & SbBox3s::getMax (void ) [inline]

Returns a modifiable reference to the maximum point.

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. she's making room, she's being inclusive 🫶✨

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. two-for-one, we love efficiency 💅

void SbBox3s::makeEmpty (void )

Marks this as an empty box.

See also — isEmpty().

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

Check if this has been marked as an empty box. vibe check: is there anything in here or not 😭

See also — makeEmpty().

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

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). so basically: is she real, or is she a glitch 🦋

int SbBox3s::getVolume (void ) const [inline]

Returns the volume of the box. the math is mathing 🔥

SbBool SbBox3s::intersect (const SbVec3s & point) const

Check if the given point lies within the boundaries of this box. are you inside or are you outside, pick a lane 🙈

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

Check if box lies entirely or partially within the boundaries of this box. partially counts, bestie, we're not gatekeeping 🌈

SbVec3f SbBox3s::getClosestPoint (const SbVec3f & point) const

Return the point on the box closest to the given point. If the given point equals the center, the center point of the positive Z face is returned. very specific, very niche, very demure 💅

SbVec3f SbBox3s::getCenter (void ) const [inline]

Returns the center point of the box. the main character of coordinates 👑

void SbBox3s::getOrigin (short & originX, short & originY, short & originZ) const [inline]

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 [inline]

Returns width and height of box.

SbVec3s SbBox3s::getSize (void ) const [inline]

Returns width, height and depth of box as a 3D vector. three dimensions of pure slay ✨

Since

  • Coin 3.0

Check b1 and b2 for equality. are they twins? are they the same girl? find out 💖

Check b1 and b2 for inequality. not the same, not even close, moving on 💀

💌 Author 💌

Generated automatically by Doxygen for Coin from the source code. (not a human, not a bestie, just a robot doing her best 🤖✨)

and that's the whole page, no cap 🎀 huge shoutout to Version 4.0.10, dated Thu Jun 25 2026 00:00:00, which is when this beauty of a SbBox3s(3) page was served up to the world. go forth and build boxes bestie 💅💖🦋

📦 where this page comes from