Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Friends | Related Symbols | List of all members
SbBox2d Class Reference

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

#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)
 
SbBox2dsetBounds (const SbBox2f &box)
 
SbBox2dsetBounds (const SbBox2s &box)
 
SbBox2dsetBounds (const SbBox2i32 &box)
 
void getBounds (double &xmin, double &ymin, double &xmax, double &ymax) const
 
void getBounds (SbVec2d &min, SbVec2d &max) const
 
const SbVec2dgetMin (void) const
 
SbVec2dgetMin (void)
 
const SbVec2dgetMax (void) const
 
SbVec2dgetMax (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)
 

Related Symbols

(Note that these are not member symbols.)

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() [1/6]

SbBox2d::SbBox2d ( void )

The default constructor makes an empty box.

References makeEmpty().

◆ SbBox2d() [2/6]

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() [3/6]

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() [4/6]

SbBox2d::SbBox2d ( const SbBox2f & box)
inlineexplicit

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

Since
Coin-2.5

◆ SbBox2d() [5/6]

SbBox2d::SbBox2d ( const SbBox2s & box)
inlineexplicit

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

Since
Coin-2.5

◆ SbBox2d() [6/6]

SbBox2d::SbBox2d ( const SbBox2i32 & box)
inlineexplicit

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

Since
Coin-2.5

◆ ~SbBox2d()

SbBox2d::~SbBox2d ( void )

Destructor.

Member Function Documentation

◆ setBounds() [1/5]

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(), and SbBox2d().

◆ setBounds() [2/5]

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

◆ setBounds() [3/5]

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

◆ setBounds() [4/5]

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

◆ setBounds() [5/5]

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

◆ getBounds() [1/2]

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

Returns the box boundaries.

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

References SbVec2d::getValue().

◆ getBounds() [2/2]

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

Returns the box corner points.

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

◆ getMin() [1/2]

const SbVec2d & SbBox2d::getMin ( void ) const

Returns the lower left corner of the box.

See also
getOrigin(), getMax().

Referenced by extendBy().

◆ getMin() [2/2]

SbVec2d & SbBox2d::getMin ( void )
inline

Returns the lower left corner of the box.

See also
getOrigin(), getMax().

◆ getMax() [1/2]

const SbVec2d & SbBox2d::getMax ( void ) const

Returns the upper right corner of the box.

See also
getMin().

Referenced by extendBy().

◆ getMax() [2/2]

SbVec2d & SbBox2d::getMax ( void )
inline

Returns the upper right corner of the box.

See also
getMin().

◆ extendBy() [1/2]

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

◆ extendBy() [2/2]

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

◆ makeEmpty()

void SbBox2d::makeEmpty ( void )

Marks this as an empty box.

See also
isEmpty().

References SbVec2d::setValue().

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

◆ isEmpty()

SbBool SbBox2d::isEmpty ( void ) const

Check if this has been marked as an empty box.

See also
makeEmpty().

◆ hasArea()

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.

◆ intersect() [1/2]

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

Check if point lies within the boundaries of this box.

◆ intersect() [2/2]

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

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

◆ getClosestPoint()

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

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

References getCenter().

◆ findIntersection()

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.

◆ getCenter()

SbVec2d SbBox2d::getCenter ( void ) const

Returns the center point of the box.

Referenced by getClosestPoint().

◆ getOrigin()

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

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

See also
getMin().

◆ getSize()

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

Returns width and height of box.

References SoDebugError::postWarning().

◆ getAspectRatio()

double SbBox2d::getAspectRatio ( void ) const

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

References SoDebugError::postWarning().

Friends And Related Symbol Documentation

◆ operator== [1/2]

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

Check b1 and b2 for equality.

◆ operator!= [1/2]

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

Check b1 and b2 for inequality.

◆ operator==() [2/2]

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

Check b1 and b2 for equality.

◆ operator!=() [2/2]

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

Check b1 and b2 for inequality.


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Jan 22 2024 for Coin by Doxygen. 1.10.0