SbViewportRegion(3IV)

NAME
     SbViewportRegion (SbVPReg) - class for representing a viewport

INHERITS FROM
     SbViewportRegion

SYNOPSIS
     #include <Inventor_c/SbViewportRegion.h>

     typedef SbViewportRegion  SbVPReg

          Functions from class SbViewportRegion:

     SbViewportRegion *  SbVPRegCreate()
     SbViewportRegion *  SbVPRegCreateWH(short width, short height)
     SbViewportRegion *  SbVPRegCreateVec(SbVec2s winSize)
     SbViewportRegion *  SbVPRegCreateReg(const SbViewportRegion *vpReg)
     void                SbVPRegSetWin(SbVPReg *this, short width, short
                              height)
     void                SbVPRegSetWinVec(SbVPReg *this, SbVec2s winSize)
     void                SbVPRegSetVP(SbVPReg *this, float left, float bottom,
                              float width, float height)
     void                SbVPRegSetVPVec(SbVPReg *this, SbVec2f origin,
                              SbVec2f size)
     void                SbVPRegSetVPPix(SbVPReg *this, short left, short
                              bottom, short width, short height)
     void                SbVPRegSetVPPixVec(SbVPReg *this, SbVec2s origin,
                              SbVec2s size)
     const SbVec2s *     SbVPRegGetWinSize(const SbVPReg *this)
     const SbVec2f *     SbVPRegGetVPOrigin(const SbVPReg *this)
     const SbVec2s *     SbVPRegGetVPOriginPix(const SbVPReg *this)
     const SbVec2f *     SbVPRegGetVPSize(const SbVPReg *this)
     const SbVec2s *     SbVPRegGetVPSizePix(const SbVPReg *this)
     float               SbVPRegGetVPAspect(const SbVPReg *this)
     void                SbVPRegScaleWidth(SbVPReg *this, float ratio)
     void                SbVPRegScaleHeight(SbVPReg *this, float ratio)
     void                SbVPRegSetPixPerInch(SbVPReg *this, float ppi)
     float               SbVPRegGetPixPerInch(const SbVPReg *this)
     float               SbVPRegGetPixPerPt(const SbVPReg *this)
     int                 SbVPRegIsEq(SbVPReg *this, const SbViewportRegion
                              *reg1, const SbViewportRegion *reg2)


DESCRIPTION
     This class represents the active viewport region in a display window. It
     contains the screen-space size of the window as well as the origin and
     size of the viewport within the window. By default, the viewport is the
     same as the full window. Methods allow the viewport to be set either in
     terms of screen-space pixels or as normalized coordinates, where (0,0) is
     the lower-left corner of the window and (1,1) is the upper-right corner.
FUNCTIONS
     SbViewportRegion *  SbVPRegCreate()
     SbViewportRegion *  SbVPRegCreateWH(short width, short height)
     SbViewportRegion *  SbVPRegCreateVec(SbVec2s winSize)
     SbViewportRegion *  SbVPRegCreateReg(const SbViewportRegion *vpReg)
          Constructors of various kinds.

     void                SbVPRegSetWin(SbVPReg *this, short width, short
                              height)
          Changes window size to given width and height in pixels.

     void                SbVPRegSetWinVec(SbVPReg *this, SbVec2s winSize)
          Changes window size to given width and height in pixels, given as
          SbVec2s.

     void                SbVPRegSetVP(SbVPReg *this, float left, float bottom,
                              float width, float height)
          Sets viewport to given region, specified as normalized window
          coordinates: (0,0) is the lower-left corner, (1,1) is the upper-
          right.

     void                SbVPRegSetVPVec(SbVPReg *this, SbVec2f origin,
                              SbVec2f size)
          Sets viewport to region with given origin (lower-left corner) and
          size, given as normalized coordinate vectors.

     void                SbVPRegSetVPPix(SbVPReg *this, short left, short
                              bottom, short width, short height)
          Sets viewport to given region, specified as pixel coordinates in
          window: (0,0) is the lower-left corner.

     void                SbVPRegSetVPPixVec(SbVPReg *this, SbVec2s origin,
                              SbVec2s size)
          Sets viewport to region with given origin (lower-left corner) and
          size, given as pixel coordinates.

     const SbVec2s *     SbVPRegGetWinSize(const SbVPReg *this)
          Returns window size in pixels.

     const SbVec2f *     SbVPRegGetVPOrigin(const SbVPReg *this)
          Returns viewport origin in normalized coordinates.

     const SbVec2s *     SbVPRegGetVPOriginPix(const SbVPReg *this)
          Returns viewport origin in pixels.

     const SbVec2f *     SbVPRegGetVPSize(const SbVPReg *this)
          Returns viewport size in normalized coordinates.

     const SbVec2s *     SbVPRegGetVPSizePix(const SbVPReg *this)
          Returns viewport size in pixels.
     float               SbVPRegGetVPAspect(const SbVPReg *this)
          Returns aspect ratio (width/height) of viewport.

     void                SbVPRegScaleWidth(SbVPReg *this, float ratio)
     void                SbVPRegScaleHeight(SbVPReg *this, float ratio)
          Scales viewport within window to be the given ratio of its current
          width or height, leaving the resulting viewport centered about the
          same point as the current one.

     void                SbVPRegSetPixPerInch(SbVPReg *this, float ppi)
     float               SbVPRegGetPixPerInch(const SbVPReg *this)
          Sets/returns the pixel-per-inch ratio for the display device the
          viewport is part of. The default value is 72 (1 pixel per printer's
          point).

     float               SbVPRegGetPixPerPt(const SbVPReg *this)
          Convenience function that returns number of pixels per printer's
          point.

     int                 SbVPRegIsEq(SbVPReg *this, const SbViewportRegion
                              *reg1, const SbViewportRegion *reg2)
          Equality comparison operator.


FILE FORMAT/DEFAULTS
     ViewportRegion {
     }

SEE ALSO
     SbVec2f, SbVec2s