SbViewportRegion.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 *
 *  http://www.sgi.com
 *
 *  For further information regarding this notice, see:
 *
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      This file contains the SbViewportRegion class definition.
 |
 |   Author(s)  : Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SB_VIEWPORT_REGION_
#define  _SB_VIEWPORT_REGION_
 
#include <Inventor/system/SbSystem.h>
 
 
#include <Inventor/SbLinear.h>
 
 
 
class INVENTOR_API SbViewportRegion {
  public:
 
    SbViewportRegion();
 
    SbViewportRegion(short width, short height);
 
    SbViewportRegion(SbVec2s winSize);
 
    SbViewportRegion(const SbViewportRegion &vpReg);
 
    void                setWindowSize(short width, short height)
        { setWindowSize(SbVec2s(width, height)); }
 
    void                setWindowSize(SbVec2s winSize);
 
    void                setViewport(float left, float bottom,
                                    float width, float height)
        { setViewport(SbVec2f(left, bottom), SbVec2f(width, height)); }
 
    void                setViewport(SbVec2f origin, SbVec2f size);
 
    void                setViewportPixels(short left, short bottom,
                                          short width, short height)
        { setViewportPixels(SbVec2s(left, bottom), SbVec2s(width, height)); }
 
    void                setViewportPixels(SbVec2s origin, SbVec2s size);
 
    const SbVec2s &     getWindowSize() const           { return windowSize; }
 
    const SbVec2f &     getViewportOrigin() const       { return vpOrigin; }
 
    const SbVec2s &     getViewportOriginPixels() const { return vpOriginPix; }
 
    const SbVec2f &     getViewportSize() const         { return vpSize; }
 
    const SbVec2s &     getViewportSizePixels() const   { return vpSizePix;}
 
    float               getViewportAspectRatio() const
        { return (vpSizePix[1] == 0 ? 1.0f :
                  (float) vpSizePix[0] / (float) vpSizePix[1]); }
 
    void                scaleWidth(float ratio);
    void                scaleHeight(float ratio);
 
    void                setPixelsPerInch(float ppi)   { pixelsPerInch = ppi;  }
    float               getPixelsPerInch() const      { return pixelsPerInch; }
 
    float               getPixelsPerPoint() const
        { return pixelsPerInch / 72.0f; }
 
    friend INVENTOR_API bool     operator ==(const SbViewportRegion &reg1,
                                    const SbViewportRegion &reg2);
 
  private:
    SbVec2s             windowSize;     
    SbVec2f             vpOrigin;       
    SbVec2s             vpOriginPix;    
    SbVec2f             vpSize;         
    SbVec2s             vpSizePix;      
    bool                vpSet;          
    float               pixelsPerInch;  
 
    void                setFullViewport();
 
    void                adjustViewport();
};
 
#endif /* _SB_VIEWPORT_REGION_ */