SbBox2d(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SbBox2d — from the Library Functions Manual 💖

okay bestie, sit DOWN because today we're talking about SbBox2d, and she is literally the blueprint. ✨

🌸 NAME 🌸

SbBox2d — the SbBox2d class is a 2 dimensional box with double precision corner coordinates.

🎀 SYNOPSIS 🎀

#include <Inventor/SbBox2d.h>

💅 Public Member Functions

SbBox2d (void)
SbBox2d (double xmin, double ymin, double xmax, double ymax)
SbBox2d (const SbVec2d &min, const SbVec2d &max)
SbBox2d (const SbBox2f &box)
SbBox2d (const SbBox2s &box)
SbBox2d (const SbBox2i32 &box)
~SbBox2d (void)
void setBounds (double xmin, double ymin, double xmax, double ymax)
void setBounds (const SbVec2d &min, const SbVec2d &max)
SbBox2d & setBounds (const SbBox2f &box)
SbBox2d & setBounds (const SbBox2s &box)
SbBox2d & setBounds (const SbBox2i32 &box)
void getBounds (double &xmin, double &ymin, double &xmax, double &ymax)
    const
void getBounds (SbVec2d &min, SbVec2d &max) const
const SbVec2d & getMin (void) const
SbVec2d & getMin (void)
const SbVec2d & getMax (void) const
SbVec2d & getMax (void)
void extendBy (const SbVec2d &point)
void extendBy (const SbBox2d &box)
void makeEmpty (void)
SbBool isEmpty (void) const
SbBool hasArea (void) const
SbBool intersect (const SbVec2d &point) const
SbBool intersect (const SbBox2d &box) const
SbVec2d getClosestPoint (const SbVec2d &p) const
SbBool findIntersection (const SbVec2d &a, const SbVec2d &b, SbVec2d
    &ia, SbVec2d &ib) const
SbVec2d getCenter (void) const
void getOrigin (double &x0, double &y0) const
void getSize (double &w, double &h) const
double getAspectRatio (void) const

🫶 Friends

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

✨ Detailed Description ✨

The SbBox2d class is a 2 dimensional box with double precision corner coordinates. (yes she said it twice, she's confident like that 💅)

This box class is used by many other classes in Coin for data exchange and storage. It provides two box corners with double precision coordinates, which is among other things useful for representing screen or canvas dimensions in normalized coordinates.

This class is a Coin extension.

See also 🦋 SbBox2f, SbBox2i32, SbBox2s, SbBox3d, SbBox3f, SbBox3i32, SbBox3s, SbXfBox3d, SbXfBox3f

Since ⭐ Coin 2.0

TGS Inventor 2.6

👑 Constructor & Destructor Documentation 👑

SbBox2d::SbBox2d (void )

The default constructor makes an empty box.

References makeEmpty().

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

SbBox2d::SbBox2d (double xmin, double ymin, double xmax, double ymax)

Constructs a box with the given corners.

xmin should be less than xmax and ymin should be less than ymax if you want to make a valid box. no cap, that's the vibe check right there 🫶

References setBounds().

SbBox2d::SbBox2d (const SbVec2d & min, const SbVec2d & max)

Constructs a box with the given lower left and upper right corners.

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

References setBounds().

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

Constructs a box with coordinates from box, converting the coordinates to floating point double precision values

Since ✨ Coin-2.5

References setBounds().

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

Constructs a box with coordinates from box, converting the coordinates to floating point double precision values

Since ✨ Coin-2.5

References setBounds().

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

Constructs a box with coordinates from box, converting the coordinates to floating point double precision values

Since ✨ Coin-2.5

References setBounds().

SbBox2d::~SbBox2d (void )

Destructor. she's leaving, say bye 👋

💜 Member Function Documentation 💜

void SbBox2d::setBounds (double xmin, double ymin, double xmax, double 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. (iconic behavior only pls)

See also 🎀 getBounds().

References SoDebugError::postWarning().

Referenced by SbBox2d(), SbBox2d(), SbBox2d(), SbBox2d(), and SbBox2d().

void SbBox2d::setBounds (const SbVec2d & min, const SbVec2d & max)

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().

SbBox2d & SbBox2d::setBounds (const SbBox2f & box)

Reset the boundaries of the box with the given box boundaries.

Returns reference to self. (main character energy, she returns herself 🫶)

See also 🎀 getBounds()

Since ✨ Coin-2.5

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

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

Reset the boundaries of the box with the given box boundaries.

Returns reference to self.

See also 🎀 getBounds()

Since ✨ Coin-2.5

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

SbBox2d & SbBox2d::setBounds (const SbBox2i32 & box)

Reset the boundaries of the box with the given box boundaries.

Returns reference to self.

See also 🎀 getBounds()

Since ✨ Coin-2.5

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

void SbBox2d::getBounds (double & xmin, double & ymin, double & xmax, double & ymax) const

Returns the box boundaries.

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

void SbBox2d::getBounds (SbVec2d & min, SbVec2d & max) const

Returns the box corner points.

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

const SbVec2d & SbBox2d::getMin (void ) const

Returns the lower left corner of the box.

See also 🎀 getOrigin(), getMax().

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

SbVec2d & SbBox2d::getMin (void ) [inline]

Returns the lower left corner of the box.

See also 🎀 getOrigin(), getMax().

const SbVec2d & SbBox2d::getMax (void ) const

Returns the upper right corner of the box.

See also 🎀 getMin().

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

SbVec2d & SbBox2d::getMax (void ) [inline]

Returns the upper right corner of the box.

See also 🎀 getMin().

void SbBox2d::extendBy (const SbVec2d & point)

Extend the boundaries of the box by the given point, i.e. make the box fit around the point if it isn't already situated within it. (she's growing, she's evolving 💅)

Referenced by extendBy().

void SbBox2d::extendBy (const SbBox2d & box)

Extend the boundaries of the box by the given box parameter. This is equal to calling the above method twice with the corner points.

References extendBy(), getMax(), getMin(), SoDebugError::postWarning(), and SbBox2d().

void SbBox2d::makeEmpty (void )

Marks this as an empty box.

See also 🎀 isEmpty().

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

SbBool SbBox2d::isEmpty (void ) const

Check if this has been marked as an empty box.

See also 🎀 makeEmpty().

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

SbBool SbBox2d::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.

SbBool SbBox2d::intersect (const SbVec2d & point) const

Check if point lies within the boundaries of this box.

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

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

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

SbVec2d SbBox2d::getClosestPoint (const SbVec2d & p) const

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

References getCenter().

SbBool SbBox2d::findIntersection (const SbVec2d & a, const SbVec2d & b, SbVec2d & ia, SbVec2d & ib) const

Check if a a line from a to b intersects the box, and return the coordinates of the union line in ia and ib.

This function is a Coin extension.

SbVec2d SbBox2d::getCenter (void ) const

Returns the center point of the box.

Referenced by getClosestPoint().

void SbBox2d::getOrigin (double & x0, double & y0) const

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

See also 🎀 getMin().

void SbBox2d::getSize (double & w, double & h) const

Returns width and height of box.

References SoDebugError::postWarning().

double SbBox2d::getAspectRatio (void ) const

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

References SoDebugError::postWarning().

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

Check b1 and b2 for equality.

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

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

Check b1 and b2 for inequality.

References SbBox2d().

🦋 Author 🦋

Generated automatically by Doxygen for Coin from the source code.

okay that's the whole thing, no skips, no cuts, every last reference line stayed. 💖 and for the cute sign-off bestie — this lil masterpiece comes to you from Coin, Version 2.5.0, filed under SbBox2d(3). periodt. 🎀✨

📦 where this page comes from