SbBox3s(3)

okay bestie, pull up a chair and hydrate because we're about to get intimate with a rectangle. this is the manual page for SbBox3s(3) from the Library Functions Manual, and it is exactly what it says on the tin: a box. three dee. short integers. no notes. 💅

---

🎀 NAME 🎀

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

---

📦 SYNOPSIS 📦

#include <Inventor/SbBox.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

🔒 Protected Attributes 🔒

SbVec3s minpt
SbVec3s maxpt

🦋 Related Symbols 🦋

heads up bestie, these are not member symbols. 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.

This box class is used by other classes in Coin for data exchange. It provides storage for two box corners with short integer coordinates, which is among other things useful for representing screen or canvas areas in absolute window coordinates. it's the little rectangle that could 🥹

👀 See also

SbBox2s, SbBox2f, SbBox2d, SbBox3f, SbBox3d, SbXfBox3f.

⏳ Since

Coin 2.0

TGS Inventor ?.?

---

🧵 Constructor & Destructor Documentation 🧵

SbBox3s::SbBox3s (void ) [inline]

The default constructor makes an empty box. a blank canvas, an empty vessel, a girl with no bounds 🎀

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

Constructs a box with the given corner coordinates.

bestie listen: 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. that's the whole assignment. don't fight it. 🫶

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

Constructs a box with the given corners.

The coordinates of min should be less than the coordinates of max if you want to make a valid box. valid box = happy box ✨

---

🌟 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. glow up, but for edges 💅

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.

fr fr that last one says xmax. we're just the messenger. 🫡

Returns reference to self.

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. copy-paste but make it geometry 🧚

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, no gatekeeping 💖

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. the humble origin story 🦋

See also

getOrigin(), getMax().

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

Returns the maximum point. This should usually be the upper right corner point of the box. main character energy, top right, always 👑

See also

getMin().

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. it's giving "you're part of this now" 🫶

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 special ✨

void SbBox3s::makeEmpty (void )

Marks this as an empty box. the void. the vibes. empty. 🫧

See also

isEmpty().

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

Check if the given point lies within the boundaries of this box. are you in or are you out 🎀

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

Check if box lies wholly or partly within the boundaries of this box. fully in? halfway in? still counts bestie 💅

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. measurements are self care 📏✨

---

🫶 Friends And Related Symbol Documentation 🫶

int operator== (const SbBox3s & b1, const SbBox3s & b2) [related]

Check b1 and b2 for equality. twins? soulmates? same box? iconic. ✨

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

Check b1 and b2 for inequality. not the same box, and that's okay 💀

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code.

---

okay that's the whole page, bestie, we ate and left no crumbs 🍓✨ this one came from the Coin crew, Version 3.1.3, and yes it's called SbBox3s(3) so you can find it again when you inevitably forget. bye love u, go draw a rectangle 💖🦋🎀