Linux Certif

Toute la documentation sur la certification Linux LPI

SbBox2d.3coin2

NAME

SbBox2d -

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

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.

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.

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

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.

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

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

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

SbBox2d::~SbBox2d (void)Destructor.

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.

See also:

getBounds().

References SoDebugError::postWarning(), and SbVec2d::setValue().

Referenced by 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.

See also:

getBounds()

Since:

Coin-2.5

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

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(), makeEmpty(), and SbVec2d::setValue().

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(), makeEmpty(), and SbVec2d::setValue().

void SbBox2d::getBounds (double & xmin, double & ymin, double & xmax, double & ymax) constReturns the box boundaries.

See also:

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

References SbVec2d::getValue().

void SbBox2d::getBounds (SbVec2d & min, SbVec2d & max) constReturns the box corner points.

See also:

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

const SbVec2d & SbBox2d::getMin (void) constReturns the lower left corner of the box.

See also:

getOrigin(), getMax().

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

SbVec2d & SbBox2d::getMin (void) [inline]Returns the lower left corner of the box.

See also:

getOrigin(), getMax().

const SbVec2d & SbBox2d::getMax (void) constReturns the upper right corner of the box.

See also:

getMin().

Referenced by extendBy(), intersect(), SbBox2s::setBounds(), SbBox2i32::setBounds(), and SbBox2f::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.

References SbVec2d::setValue().

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(), and SoDebugError::postWarning().

void SbBox2d::makeEmpty (void)Marks this as an empty box.

See also:

isEmpty().

References SbVec2d::setValue().

Referenced by SbBox2d(), and setBounds().

SbBool SbBox2d::isEmpty (void) constCheck if this has been marked as an empty box.

See also:

makeEmpty().

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

SbBool SbBox2d::hasArea (void) constCheck 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) constCheck if point lies within the boundaries of this box.

SbBool SbBox2d::intersect (const SbBox2d & box) constCheck if box lies wholly or partly within the boundaries of this box.

References getMax(), and getMin().

SbVec2d SbBox2d::getClosestPoint (const SbVec2d & p) constReturn 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) constCheck 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) constReturns the center point of the box.

Referenced by getClosestPoint().

void SbBox2d::getOrigin (double & x0, double & y0) constReturns the coordinates of the box origin (i.e. the lower left corner).

See also:

getMin().

void SbBox2d::getSize (double & w, double & h) constReturns width and height of box.

References SoDebugError::postWarning().

double SbBox2d::getAspectRatio (void) constReturns aspect ratio of box, which is defined as box width divided on box height.

References SoDebugError::postWarning().

Author

Generated automatically by Doxygen for Coin from the source code.