GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SBBOX2S (3)

NAME

SbBox2s — 2D box class

CONTENTS

Inherits From
Synopsis
Description
Methods
File Format/defaults
See Also

INHERITS FROM

SbBox2s

SYNOPSIS

#include <Inventor/SbBox.h>

Methods from class SbBox2s:

       
                    
                     SbBox2s()    
   
                    
                     SbBox2s(short xmin, short ymin, short xmax, short ymax)    
   
                    
                     SbBox2s(const SbVec2s &_min, const SbVec2s &_max)    
void    
                    
void                 ~SbBox2s()    
const SbVec2s &    
                    
const SbVec2s &      getMin() const    
const SbVec2s &    
                    
const SbVec2s &      getMax() const    
void    
                    
void                 extendBy(const SbVec2s &point)    
void    
                    
void                 extendBy(const SbBox2s &box)    
SbBool    
                    
SbBool               intersect(const SbVec2s &point) const    
SbBool    
                    
SbBool               intersect(const SbBox2s &box) const    
void    
                    
void                 setBounds(short xmin, short ymin, short xmax, short ymax)    
void    
                    
void                 setBounds(const SbVec2s &_min, const SbVec2s &_max)    
void    
                    
void                 getBounds(short &xmin, short &ymin, short &xmax, short &ymax) const    
void    
                    
void                 getBounds(SbVec2s &_min, SbVec2s &_max) const    
void    
                    
void                 getOrigin(short &originX, short &originY) const    
void    
                    
void                 getSize(short &sizeX, short &sizeY) const    
float    
                    
float                getAspectRatio() const    
void    
                    
void                 makeEmpty()    
int    
                    
int                  operator ==(const SbBox2s &b1, const SbBox2s &b2)    
int    
                    
int                  operator !=(const SbBox2s &b1, const SbBox2s &b2)

DESCRIPTION

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

METHODS

       
                    
                     SbBox2s()    
   
                    
                     SbBox2s(short xmin, short ymin, short xmax, short ymax)    
   
                    
                     SbBox2s(const SbVec2s &_min, const SbVec2s &_max)    
void    
                    
void                 ~SbBox2s()
Constructors and destructor for a 2D integer box. xmin, ymin, xmax, and ymax are the bounds of the box. min and max are the corners of the diagonal that define the box.

    const SbVec2s &    
                    
const SbVec2s &      getMin() const    
const SbVec2s &    
                    
const SbVec2s &      getMax() const
Returns the minimum and maximum points of the box.

    void    
                    
void                 extendBy(const SbVec2s &point)    
void    
                    
void                 extendBy(const SbBox2s &box)
Extends this box (if necessary) to contain the specified point or other box.

    SbBool    
                    
SbBool               intersect(const SbVec2s &point) const    
SbBool    
                    
SbBool               intersect(const SbBox2s &box) const
Returns TRUE if the specified point or box intersects this box.

    void    
                    
void                 setBounds(short xmin, short ymin, short xmax, short ymax)    
void    
                    
void                 setBounds(const SbVec2s &_min, const SbVec2s &_max)
Sets the corners of the box.

    void    
                    
void                 getBounds(short &xmin, short &ymin, short &xmax, short &ymax) const    
void    
                    
void                 getBounds(SbVec2s &_min, SbVec2s &_max) const
Gets the corners of the box.

    void    
                    
void                 getOrigin(short &originX, short &originY) const
Returns origin (minimum point) of box.

    void    
                    
void                 getSize(short &sizeX, short &sizeY) const
Returns box size.

    float    
                    
float                getAspectRatio() const
Returns aspect ratio (ratio of width to height) of box.

    void    
                    
void                 makeEmpty()
Makes an empty box.

    int    
                    
int                  operator ==(const SbBox2s &b1, const SbBox2s &b2)    
int    
                    
int                  operator !=(const SbBox2s &b1, const SbBox2s &b2)
Equality comparisons.

FILE FORMAT/DEFAULTS

SEE ALSO

SbBox3f, SbXfBox3f, SbBox2f, SbVec3f, SbVec2f, SbVec2s, SbMatrix

Search for    or go to Top of page |  Section 3 |  Main Index


SBBOX2S(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.