SbBox2s(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

SbBox2s — the SbBox2s class is a 2 dimensional box with short integer coordinates. (It lives in the Library Functions Manual, bestie, and this is its whole page. 💖)

🎀 SYNOPSIS 🎀

#include <Inventor/SbBox.h>

🌸 Public Member Functions 🌸

SbBox2s (void)
SbBox2s (short xmin, short ymin, short xmax, short ymax)
SbBox2s (const SbVec2s &boxmin, const SbVec2s &boxmax)
SbBox2s (const SbBox2i32 &box)
SbBox2s (const SbBox2f &box)
SbBox2s (const SbBox2d &box)
~SbBox2s (void)
void setBounds (short xmin, short ymin, short xmax, short ymax)
void setBounds (const SbVec2s &boxmin, const SbVec2s &boxmax)
SbBox2s & setBounds (const SbBox2i32 &box)
SbBox2s & setBounds (const SbBox2f &box)
SbBox2s & setBounds (const SbBox2d &box)
void getBounds (short &xmin, short &ymin, short &xmax, short &ymax)
    const
void getBounds (SbVec2s &boxmin, SbVec2s &boxmax) const
const SbVec2s & getMin (void) const
SbVec2s & getMin (void)
const SbVec2s & getMax (void) const
SbVec2s & getMax (void)
void extendBy (const SbVec2s &point)
void extendBy (const SbBox2s &box)
void makeEmpty (void)
SbBool isEmpty (void) const
SbBool hasArea (void) const
SbBool intersect (const SbVec2s &point) const
SbBool intersect (const SbBox2s &box) const
SbVec2f getCenter (void) const
void getOrigin (short &originX, short &originY) const
void getSize (short &sizeX, short &sizeY) const
float getAspectRatio (void) const

🫶 Friends 🫶

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

🦋 DETAILED DESCRIPTION 🦋

The SbBox2s class is a 2 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. (screen space representation slay, honestly 💅)

See also

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

💖 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 💖

🌈 SbBox2s::SbBox2s (void )

The default constructor makes an empty box. no thoughts, no corners, just vibes 🎀

References makeEmpty().

Referenced by extendBy(), intersect(), operator!=, and operator==.

🌈 SbBox2s::SbBox2s (short xmin, short ymin, short xmax, short ymax)

Constructs a box with the given corner coordinates.

xmin should be less than xmax and ymin should be less than ymax if you want to make a valid box. Like, if you don't do that, it's not valid. That's just the rules bestie.

References setBounds().

🌈 SbBox2s::SbBox2s (const SbVec2s & boxmin, const SbVec2s & boxmax)

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. (same energy as above, fr fr)

References setBounds().

🌈 SbBox2s::SbBox2s (const SbBox2i32 & box) [inline], [explicit]

Constructs a box with coordinates from box, converting the coordinates to short integers.

Since

  • Coin-2.5

References setBounds().

🌈 SbBox2s::SbBox2s (const SbBox2f & box) [inline], [explicit]

Constructs a box with coordinates from box, converting the coordinates to short integers.

Since

  • Coin-2.5

References setBounds().

🌈 SbBox2s::SbBox2s (const SbBox2d & box) [inline], [explicit]

Constructs a box with coordinates from box, converting the coordinates to short integers.

Since

  • Coin-2.5

References setBounds().

🌈 SbBox2s::~SbBox2s (void )

Default destructor does nothing. iconic behaviour honestly, it just leaves 💀

💅 MEMBER FUNCTION DOCUMENTATION 💅

⭐ void SbBox2s::setBounds (short xmin, short ymin, short xmax, short ymax)

Reset the boundaries of the box.

xmin should be less than xmax and ymin should be less than ymax if you want to make a valid box.

See also

  • getBounds().

References SoDebugError::postWarning().

Referenced by SbBox2s(), SbBox2s(), SbBox2s(), SbBox2s(), and SbBox2s().

⭐ void SbBox2s::setBounds (const SbVec2s & boxmin, const SbVec2s & boxmax)

Reset the boundaries of the 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.

See also

  • getBounds().

References SoDebugError::postWarning().

⭐ SbBox2s & SbBox2s::setBounds (const SbBox2i32 & box)

Reset the boundaries with the boundaries of the given box.

Returns reference to self. (yes it hands you back you, main character energy 🫶)

Since

  • Coin-2.5

References SbBox2i32::getMax(), SbBox2i32::getMin(), SbBox2i32::isEmpty(), and makeEmpty().

⭐ SbBox2s & SbBox2s::setBounds (const SbBox2f & box)

Reset the boundaries with the boundaries of the given box.

Returns reference to self.

Since

  • Coin-2.5

References SbBox2f::getMax(), SbBox2f::getMin(), SbBox2f::isEmpty(), and makeEmpty().

⭐ SbBox2s & SbBox2s::setBounds (const SbBox2d & box)

Reset the boundaries with the boundaries of the given box.

Returns reference to self.

Since

  • Coin-2.5

References SbBox2d::getMax(), SbBox2d::getMin(), SbBox2d::isEmpty(), and makeEmpty().

⭐ void SbBox2s::getBounds (short & xmin, short & ymin, short & xmax, short & ymax) const

Returns the box boundary coordinates.

See also

  • setBounds(), getMin(), getMax().

⭐ void SbBox2s::getBounds (SbVec2s & boxmin, SbVec2s & boxmax) const

Returns the box corner points.

See also

  • setBounds(), getMin(), getMax().

⭐ const SbVec2s & SbBox2s::getMin (void ) const

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

See also

  • getOrigin(), getMax().

Referenced by extendBy(), intersect(), operator==, SbBox2d::setBounds(), SbBox2f::setBounds(), and SbBox2i32::setBounds().

⭐ SbVec2s & SbBox2s::getMin (void ) [inline]

Returns the lower left corner of the box.

Since

  • Coin-2.5

⭐ const SbVec2s & SbBox2s::getMax (void ) const

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

See also

  • getMin().

Referenced by extendBy(), intersect(), operator==, SbBox2d::setBounds(), SbBox2f::setBounds(), and SbBox2i32::setBounds().

⭐ SbVec2s & SbBox2s::getMax (void ) [inline]

Returns the upper right corner of the box.

See also

  • getMin().

Since

  • Coin-2.5

⭐ void SbBox2s::extendBy (const SbVec2s & 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. grow the box until the point is comfy inside, periodt ✨

References SbVec2s::setValue().

Referenced by extendBy().

⭐ void SbBox2s::extendBy (const SbBox2s & 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(), getMax(), getMin(), SoDebugError::postWarning(), and SbBox2s().

⭐ void SbBox2s::makeEmpty (void )

Marks this as an empty box.

See also

  • isEmpty().

Referenced by SbBox2s(), setBounds(), setBounds(), and setBounds().

⭐ SbBool SbBox2s::isEmpty (void ) const [inline]

Check if this has been marked as an empty box.

See also

  • makeEmpty().

Since

  • Coin-2.5

Referenced by SbBox2d::setBounds(), SbBox2f::setBounds(), and SbBox2i32::setBounds().

⭐ SbBool SbBox2s::hasArea (void ) const

Check if the box has "positive" area, i.e. the lower left corner is actually lower and more to the left than the other corner point.

Since

  • Coin-2.5

⭐ SbBool SbBox2s::intersect (const SbVec2s & point) const

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

⭐ SbBool SbBox2s::intersect (const SbBox2s & box) const

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

References getMax(), getMin(), and SbBox2s().

⭐ SbVec2f SbBox2s::getCenter (void ) const [inline]

Returns the center point of the box. the literal center of the universe (the box) 💖

Since

  • Coin-2.5

⭐ void SbBox2s::getOrigin (short & originX, short & originY) const

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

See also

  • getMin().

⭐ void SbBox2s::getSize (short & sizeX, short & sizeY) const

Returns width and height of box.

References SoDebugError::postWarning().

⭐ float SbBox2s::getAspectRatio (void ) const

Returns aspect ratio of box, which is defined as box width divided on box height.

References SoDebugError::postWarning().

💜 int operator== (const SbBox2s & b1, const SbBox2s & b2) [friend]

Check b1 and b2 for equality.

References getMax(), getMin(), and SbBox2s().

💜 int operator!= (const SbBox2s & b1, const SbBox2s & b2) [friend]

Check b1 and b2 for inequality.

References SbBox2s().

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

okay that's the whole page bestie, no cap 🫶 This lil masterpiece shipped as part of Coin, Version 2.5.0, and it's page SbBox2s(3) of the manual. Go build something cute with it. 💖✨🎀🦋🌸💅

📦 where this page comes from