1SbBox2s(3IV)()                                                  SbBox2s(3IV)()
2
3
4

NAME

6       SbBox2s — 2D box class
7

INHERITS FROM

9       SbBox2s
10

SYNOPSIS

12       #include <Inventor/SbBox.h>
13
14          Methods from class SbBox2s:
15
16                         SbBox2s()
17                         SbBox2s(short  xmin,  short  ymin,  short xmax, short
18                              ymax)
19                         SbBox2s(const SbVec2s &_min, const SbVec2s &_max)
20     void                ~SbBox2s()
21     const SbVec2s &     getMin() const
22     const SbVec2s &     getMax() const
23     void                extendBy(const SbVec2s &point)
24     void                extendBy(const SbBox2s &box)
25     SbBool              intersect(const SbVec2s &point) const
26     SbBool              intersect(const SbBox2s &box) const
27     void                setBounds(short xmin, short ymin, short  xmax,  short
28                              ymax)
29     void                setBounds(const SbVec2s &_min, const SbVec2s &_max)
30     void                getBounds(short  &xmin,  short  &ymin,  short  &xmax,
31                              short &ymax) const
32     void                getBounds(SbVec2s &_min, SbVec2s &_max) const
33     void                getOrigin(short &originX, short &originY) const
34     void                getSize(short &sizeX, short &sizeY) const
35     float               getAspectRatio() const
36     void                makeEmpty()
37     int                 operator ==(const SbBox2s &b1, const SbBox2s &b2)
38     int                 operator !=(const SbBox2s &b1, const SbBox2s &b2)
39
40

DESCRIPTION

42       2D box which has planes parallel to the major axes and is specified  by
43       two points (specified with short integers) on a diagonal. This class is
44       part of the standard Inventor datatype classes and is used as input and
45       output to geometry operations.
46

METHODS

48                         SbBox2s()
49                         SbBox2s(short  xmin,  short  ymin,  short xmax, short
50                              ymax)
51                         SbBox2s(const SbVec2s &_min, const SbVec2s &_max)
52     void                ~SbBox2s()
53          Constructors and destructor for a 2D integer box. xmin, ymin,  xmax,
54          and  ymax  are the bounds of the box. min and max are the corners of
55          the diagonal that define the box.
56
57     const SbVec2s &     getMin() const
58     const SbVec2s &     getMax() const
59          Returns the minimum and maximum points of the box.
60
61     void                extendBy(const SbVec2s &point)
62     void                extendBy(const SbBox2s &box)
63          Extends this box (if necessary) to contain the  specified  point  or
64          other box.
65
66     SbBool              intersect(const SbVec2s &point) const
67     SbBool              intersect(const SbBox2s &box) const
68          Returns TRUE if the specified point or box intersects this box.
69
70     void                setBounds(short  xmin,  short ymin, short xmax, short
71                              ymax)
72     void                setBounds(const SbVec2s &_min, const SbVec2s &_max)
73          Sets the corners of the box.
74
75     void                getBounds(short  &xmin,  short  &ymin,  short  &xmax,
76                              short &ymax) const
77     void                getBounds(SbVec2s &_min, SbVec2s &_max) const
78          Gets the corners of the box.
79
80     void                getOrigin(short &originX, short &originY) const
81          Returns origin (minimum point) of box.
82
83     void                getSize(short &sizeX, short &sizeY) const
84          Returns box size.
85
86     float               getAspectRatio() const
87          Returns aspect ratio (ratio of width to height) of box.
88
89     void                makeEmpty()
90          Makes an empty box.
91
92     int                 operator ==(const SbBox2s &b1, const SbBox2s &b2)
93     int                 operator !=(const SbBox2s &b1, const SbBox2s &b2)
94          Equality comparisons.
95
96

SEE ALSO

98       SbBox3f, SbXfBox3f, SbBox2f, SbVec3f, SbVec2f, SbVec2s, SbMatrix
99
100
101
102
103                                                                SbBox2s(3IV)()