Coin: SbViewportRegion.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SbViewportRegion.h
1#ifndef COIN_SBVIEWPORTREGION_H
2#define COIN_SBVIEWPORTREGION_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <cstdio>
37#include <Inventor/SbVec2s.h>
38#include <Inventor/SbVec2f.h>
39
40 class COIN_DLL_API SbViewportRegion {
41public:
42 SbViewportRegion(void);
43 SbViewportRegion(short width, short height);
44 SbViewportRegion(SbVec2s winSize);
45 SbViewportRegion(const SbViewportRegion & vpReg);
46
47 void setWindowSize(short width, short height);
48 void setWindowSize(SbVec2s winSize);
49 void setViewport(float left, float bottom,
50 float width, float height);
51 void setViewport(SbVec2f origin, SbVec2f size);
52 void setViewportPixels(short left, short bottom,
53 short width, short height);
54 void setViewportPixels(SbVec2s origin, SbVec2s size);
55 const SbVec2s & getWindowSize(void) const;
56 const SbVec2f & getViewportOrigin(void) const;
57 const SbVec2s & getViewportOriginPixels(void) const;
58 const SbVec2f & getViewportSize(void) const;
59 const SbVec2s & getViewportSizePixels(void) const;
60 float getViewportAspectRatio(void) const;
61 void scaleWidth(float ratio);
62 void scaleHeight(float ratio);
63 void setPixelsPerInch(float ppi);
64 float getPixelsPerInch(void) const;
65 float getPixelsPerPoint(void) const;
66 friend COIN_DLL_API int operator ==(const SbViewportRegion & reg1,
67 const SbViewportRegion & reg2);
68
69 friend COIN_DLL_API int operator !=(const SbViewportRegion & reg1,
70 const SbViewportRegion & reg2);
71
72 void print(FILE * file) const;
73
74private:
75 SbVec2s winsize;
76 SbVec2f vporigin;
77 SbVec2f vpsize;
78 SbVec2s vporigin_s;
79 SbVec2s vpsize_s;
80 float pixperinch;
81};
82
83COIN_DLL_API int operator ==(const SbViewportRegion & reg1, const SbViewportRegion & reg2);
84COIN_DLL_API int operator !=(const SbViewportRegion & reg1, const SbViewportRegion & reg2);
85
86#endif // !COIN_SBVIEWPORTREGION_H
SbVec2f
The SbVec2f class is a 2 dimensional vector with floating point coordinates.
Definition SbVec2f.h:49
SbVec2s
The SbVec2s class is a 2 dimensional vector with short integer coordinates.
Definition SbVec2s.h:51
SbViewportRegion
The SbViewportRegion class is a viewport within a full window.
Definition SbViewportRegion.h:40
SbViewportRegion::getViewportSize
const SbVec2f & getViewportSize(void) const
Definition SbViewportRegion.cpp:424
SbViewportRegion::setWindowSize
void setWindowSize(short width, short height)
Definition SbViewportRegion.cpp:221
SbViewportRegion::scaleWidth
void scaleWidth(float ratio)
Definition SbViewportRegion.cpp:470
SbViewportRegion::setPixelsPerInch
void setPixelsPerInch(float ppi)
Definition SbViewportRegion.cpp:526
SbViewportRegion::print
void print(FILE *file) const
Definition SbViewportRegion.cpp:594
SbViewportRegion::getViewportOrigin
const SbVec2f & getViewportOrigin(void) const
Definition SbViewportRegion.cpp:387
SbViewportRegion::setViewportPixels
void setViewportPixels(short left, short bottom, short width, short height)
Definition SbViewportRegion.cpp:323
SbViewportRegion::getPixelsPerInch
float getPixelsPerInch(void) const
Definition SbViewportRegion.cpp:546
SbViewportRegion::getViewportOriginPixels
const SbVec2s & getViewportOriginPixels(void) const
Definition SbViewportRegion.cpp:408
SbViewportRegion::getViewportSizePixels
const SbVec2s & getViewportSizePixels(void) const
Definition SbViewportRegion.cpp:435
SbViewportRegion::getPixelsPerPoint
float getPixelsPerPoint(void) const
Definition SbViewportRegion.cpp:558
SbViewportRegion::getViewportAspectRatio
float getViewportAspectRatio(void) const
Definition SbViewportRegion.cpp:450
SbViewportRegion::scaleHeight
void scaleHeight(float ratio)
Definition SbViewportRegion.cpp:501
SbViewportRegion::getWindowSize
const SbVec2s & getWindowSize(void) const
Definition SbViewportRegion.cpp:376
SbViewportRegion::setViewport
void setViewport(float left, float bottom, float width, float height)
Definition SbViewportRegion.cpp:271
SbViewportRegion::SbViewportRegion
SbViewportRegion(void)
Definition SbViewportRegion.cpp:142