.TH "SbBox2d" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SbBox2d \- The \fBSbBox2d\fP class is a 2 dimensional box with double precision corner coordinates\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/SbBox2d\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSbBox2d\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSbBox2d\fP (double \fBxmin\fP, double ymin, double \fBxmax\fP, double ymax)"
.br
.ti -1c
.RI "\fBSbBox2d\fP (\fBconst\fP \fBSbVec2d\fP &\fBminpoint\fP, \fBconst\fP \fBSbVec2d\fP &\fBmaxpoint\fP)"
.br
.ti -1c
.RI "\fBSbBox2d\fP (\fBconst\fP \fBSbBox2f\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox2d\fP (\fBconst\fP \fBSbBox2s\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox2d\fP (\fBconst\fP \fBSbBox2i32\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox2d\fP & \fBsetBounds\fP (double \fBxmin\fP, double ymin, double \fBxmax\fP, double ymax)"
.br
.ti -1c
.RI "\fBSbBox2d\fP & \fBsetBounds\fP (\fBconst\fP \fBSbVec2d\fP &\fBminpoint\fP, \fBconst\fP \fBSbVec2d\fP &\fBmaxpoint\fP)"
.br
.ti -1c
.RI "\fBSbBox2d\fP & \fBsetBounds\fP (\fBconst\fP \fBSbBox2f\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox2d\fP & \fBsetBounds\fP (\fBconst\fP \fBSbBox2s\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBSbBox2d\fP & \fBsetBounds\fP (\fBconst\fP \fBSbBox2i32\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetBounds\fP (double &\fBxmin\fP, double &ymin, double &\fBxmax\fP, double &ymax) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetBounds\fP (\fBSbVec2d\fP &\fBminpoint\fP, \fBSbVec2d\fP &\fBmaxpoint\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSbVec2d\fP & \fBgetMin\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec2d\fP & \fBgetMin\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSbVec2d\fP & \fBgetMax\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec2d\fP & \fBgetMax\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBextendBy\fP (\fBconst\fP \fBSbVec2d\fP &point)"
.br
.ti -1c
.RI "\fBvoid\fP \fBextendBy\fP (\fBconst\fP \fBSbBox2d\fP &\fBbox\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBmakeEmpty\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisEmpty\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBhasArea\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBintersect\fP (\fBconst\fP \fBSbVec2d\fP &point) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBintersect\fP (\fBconst\fP \fBSbBox2d\fP &\fBbox\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec2d\fP \fBgetClosestPoint\fP (\fBconst\fP \fBSbVec2d\fP &\fBp\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBfindIntersection\fP (\fBconst\fP \fBSbVec2d\fP &a, \fBconst\fP \fBSbVec2d\fP &b, \fBSbVec2d\fP &\fBia\fP, \fBSbVec2d\fP &\fBib\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec2d\fP \fBgetCenter\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetOrigin\fP (double &\fBoriginX\fP, double &\fBoriginY\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetSize\fP (double &\fBsizeX\fP, double &\fBsizeY\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbVec2d\fP \fBgetSize\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "double \fBgetAspectRatio\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Related Symbols"
(Note that these are not member symbols\&.) 
.in +1c
.ti -1c
.RI "int \fBoperator==\fP (\fBconst\fP \fBSbBox2d\fP &\fBb1\fP, \fBconst\fP \fBSbBox2d\fP &\fBb2\fP)"
.br
.ti -1c
.RI "int \fBoperator!=\fP (\fBconst\fP \fBSbBox2d\fP &\fBb1\fP, \fBconst\fP \fBSbBox2d\fP &\fBb2\fP)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSbBox2d\fP 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\&.
.PP
This class is a Coin extension\&.
.PP
\fBSee also\fP
.RS 4
\fBSbBox2s\fP, \fBSbBox2f\fP, \fBSbBox3s\fP, \fBSbBox3f\fP, \fBSbBox3d\fP, \fBSbXfBox3f\fP\&.
.RE
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.0\fP 
.PP
TGS Inventor \fB2\&.6\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SbBox2d::SbBox2d (\fBvoid\fP)\fC [inline]\fP"
The default constructor makes an empty box\&. 
.SS "SbBox2d::SbBox2d (double xmin, double ymin, double xmax, double ymax)\fC [inline]\fP"
Constructs a box with the given corners\&.
.PP
\fIxmin\fP should be less than \fIxmax\fP and \fIymin\fP should be less than \fIymax\fP if you want to make a valid box\&. 
.SS "SbBox2d::SbBox2d (\fBconst\fP \fBSbVec2d\fP & min, \fBconst\fP \fBSbVec2d\fP & max)\fC [inline]\fP"
Constructs a box with the given lower left and upper right corners\&.
.PP
The coordinates of \fImin\fP should be less than the coordinates of \fImax\fP if you want to make a valid box\&. 
.SS "SbBox2d::SbBox2d (\fBconst\fP \fBSbBox2f\fP & box)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an \fBSbBox2d\fP instance from the value in an \fBSbBox2f\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "SbBox2d::SbBox2d (\fBconst\fP \fBSbBox2s\fP & box)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an \fBSbBox2d\fP instance from the value in an \fBSbBox2s\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "SbBox2d::SbBox2d (\fBconst\fP \fBSbBox2i32\fP & box)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an \fBSbBox2d\fP instance from the value in an \fBSbBox2i32\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBSbBox2d\fP & SbBox2d::setBounds (double xmin, double ymin, double xmax, double ymax)\fC [inline]\fP"
Reset the boundaries of the box\&.
.PP
\fIxmin\fP should be less than \fIxmax\fP and \fIymin\fP should be less than \fIymax\fP if you want to make a valid box\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP\&. 
.RE
.PP

.SS "\fBSbBox2d\fP & SbBox2d::setBounds (\fBconst\fP \fBSbVec2d\fP & min, \fBconst\fP \fBSbVec2d\fP & max)\fC [inline]\fP"
Reset the boundaries of the box with the given corners\&.
.PP
The coordinates of \fImin\fP should be less than the coordinates of \fImax\fP if you want to make a valid box\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP\&. 
.RE
.PP

.SS "\fBSbBox2d\fP & SbBox2d::setBounds (\fBconst\fP \fBSbBox2f\fP & box)"
Reset the boundaries of the box with the given \fIbox\fP boundaries\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP 
.RE
.PP

.SS "\fBSbBox2d\fP & SbBox2d::setBounds (\fBconst\fP \fBSbBox2s\fP & box)"
Reset the boundaries of the box with the given \fIbox\fP boundaries\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP 
.RE
.PP

.SS "\fBSbBox2d\fP & SbBox2d::setBounds (\fBconst\fP \fBSbBox2i32\fP & box)"
Reset the boundaries of the box with the given \fIbox\fP boundaries\&.
.PP
Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetBounds()\fP 
.RE
.PP

.SS "\fBvoid\fP SbBox2d::getBounds (double & xmin, double & ymin, double & xmax, double & ymax) const\fC [inline]\fP"
Returns the box boundaries\&.
.PP
\fBSee also\fP
.RS 4
\fBsetBounds()\fP, \fBgetMin()\fP, \fBgetMax()\fP\&. 
.RE
.PP

.SS "\fBvoid\fP SbBox2d::getBounds (\fBSbVec2d\fP & min, \fBSbVec2d\fP & max) const\fC [inline]\fP"
Returns the box min and max corner points\&.
.PP
\fBSee also\fP
.RS 4
\fBsetBounds()\fP, \fBgetMin()\fP, \fBgetMax()\fP\&. 
.RE
.PP

.SS "\fBconst\fP \fBSbVec2d\fP & SbBox2d::getMin (\fBvoid\fP) const\fC [inline]\fP"
Returns the lower left corner of the box\&.
.PP
\fBSee also\fP
.RS 4
\fBgetOrigin()\fP, \fBgetMax()\fP\&. 
.RE
.PP

.SS "\fBSbVec2d\fP & SbBox2d::getMin (\fBvoid\fP)\fC [inline]\fP"
Returns the lower left corner of the box\&.
.PP
\fBSee also\fP
.RS 4
\fBgetOrigin()\fP, \fBgetMax()\fP\&. 
.RE
.PP

.SS "\fBconst\fP \fBSbVec2d\fP & SbBox2d::getMax (\fBvoid\fP) const\fC [inline]\fP"
Returns the upper right corner of the box\&.
.PP
\fBSee also\fP
.RS 4
\fBgetMin()\fP\&. 
.RE
.PP

.SS "\fBSbVec2d\fP & SbBox2d::getMax (\fBvoid\fP)\fC [inline]\fP"
Returns the upper right corner of the box\&.
.PP
\fBSee also\fP
.RS 4
\fBgetMin()\fP\&. 
.RE
.PP

.SS "\fBvoid\fP SbBox2d::extendBy (\fBconst\fP \fBSbVec2d\fP & point)"
Extend the boundaries of the box by the given point, i\&.e\&. make the box fit around the \fIpoint\fP if it isn't already situated within it\&. 
.SS "\fBvoid\fP SbBox2d::extendBy (\fBconst\fP \fBSbBox2d\fP & box)"
Extend the boundaries of the box by the given \fIbox\fP parameter\&. This is equal to calling the above method twice with the corner points\&. 
.SS "\fBvoid\fP SbBox2d::makeEmpty (\fBvoid\fP)"
Marks this as an empty box\&.
.PP
\fBSee also\fP
.RS 4
\fBisEmpty()\fP\&. 
.RE
.PP

.SS "SbBool SbBox2d::isEmpty (\fBvoid\fP) const\fC [inline]\fP"
Check if this has been marked as an empty box\&.
.PP
\fBSee also\fP
.RS 4
\fBmakeEmpty()\fP\&. 
.RE
.PP

.SS "SbBool SbBox2d::hasArea (\fBvoid\fP) const\fC [inline]\fP"
Check if the box has been correctly specified and by that virtue has 'positive' area, i\&.e\&. all coordinates of its upper right corner (the maximum point) are greater than the corresponding coordinates of its lower left corner (the minimum point)\&. 
.SS "SbBool SbBox2d::intersect (\fBconst\fP \fBSbVec2d\fP & point) const"
Check if \fIpoint\fP lies within the boundaries of this box\&. 
.SS "SbBool SbBox2d::intersect (\fBconst\fP \fBSbBox2d\fP & box) const"
Check if \fIbox\fP lies entirely or partially within the boundaries of this box\&. 
.SS "\fBSbVec2d\fP SbBox2d::getClosestPoint (\fBconst\fP \fBSbVec2d\fP & point) const"
Return the point on the box closest to the given point \fIp\fP\&. If the given point equals the center, the center point on the positive X-side is returned\&. 
.SS "SbBool SbBox2d::findIntersection (\fBconst\fP \fBSbVec2d\fP & a, \fBconst\fP \fBSbVec2d\fP & b, \fBSbVec2d\fP & ia, \fBSbVec2d\fP & ib) const"
Check if a a line from \fIa\fP to \fIb\fP intersects the box, and return the coordinates of the union line in \fIia\fP and \fIib\fP\&.
.PP
This function is a Coin extension\&. 
.SS "\fBSbVec2d\fP SbBox2d::getCenter (\fBvoid\fP) const\fC [inline]\fP"
Returns the center point of the box\&. 
.SS "\fBvoid\fP SbBox2d::getOrigin (double & originX, double & originY) const\fC [inline]\fP"
Returns the coordinates of the box origin (i\&.e\&. the lower left corner)\&.
.PP
\fBSee also\fP
.RS 4
\fBgetMin()\fP\&. 
.RE
.PP

.SS "\fBvoid\fP SbBox2d::getSize (double & sizeX, double & sizeY) const\fC [inline]\fP"
Returns width and height of box\&. 
.SS "\fBSbVec2d\fP SbBox2d::getSize (\fBvoid\fP) const\fC [inline]\fP"
Returns width and height of box as a 2D vector\&.
.PP
\fBSince\fP
.RS 4
Coin \fB3\&.0\fP 
.RE
.PP

.SS "double SbBox2d::getAspectRatio (\fBvoid\fP) const\fC [inline]\fP"
Returns aspect ratio of box, which is defined as box width divided on box height\&. 
.SH "Friends And Related Symbol Documentation"
.PP 
.SS "int \fBoperator\fP== (\fBconst\fP \fBSbBox2d\fP & b1, \fBconst\fP \fBSbBox2d\fP & b2)\fC [related]\fP"
Check \fIb1\fP and \fIb2\fP for equality\&. 
.SS "int operator!= (\fBconst\fP \fBSbBox2d\fP & b1, \fBconst\fP \fBSbBox2d\fP & b2)\fC [related]\fP"
Check \fIb1\fP and \fIb2\fP for inequality\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.