Coin: SoCamera.h Source File

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

SoCamera.h
1#ifndef COIN_SOCAMERA_H
2#define COIN_SOCAMERA_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 <Inventor/nodes/SoSubNode.h>
37#include <Inventor/SbViewportRegion.h>
38#include <Inventor/SbViewVolume.h>
39#include <Inventor/fields/SoSFRotation.h>
40#include <Inventor/fields/SoSFEnum.h>
41#include <Inventor/fields/SoSFVec3f.h>
42#include <Inventor/fields/SoSFFloat.h>
43
44#include <Inventor/SbVec3f.h>
45#include <Inventor/SbMatrix.h>
46#include <Inventor/SbBox3f.h>
47
48#define SO_ASPECT_SQUARE 1.0f
49#define SO_ASPECT_VIDEO (4.0f/3.0f)
50#define SO_ASPECT_35mm_ACADEMY 1.371
51#define SO_ASPECT_16mm 1.369
52#define SO_ASPECT_35mm_FULL 1.33333
53#define SO_ASPECT_70mm 2.287
54#define SO_ASPECT_CINEMASCOPE 2.35
55#define SO_ASPECT_HDTV (16.0f/9.0f)
56#define SO_ASPECT_PANAVISION 2.361
57#define SO_ASPECT_35mm (3.0f/2.0f)
58#define SO_ASPECT_VISTAVISION 2.301
59
60class SoPath;
61
62class SoCameraP;
63
64 class COIN_DLL_API SoCamera : public SoNode {
65 typedef SoNode inherited;
66
67 SO_NODE_ABSTRACT_HEADER(SoCamera);
68
69public:
70 static void initClass(void);
71
72 enum ViewportMapping {
73 CROP_VIEWPORT_FILL_FRAME,
74 CROP_VIEWPORT_LINE_FRAME,
75 CROP_VIEWPORT_NO_FRAME,
76 ADJUST_CAMERA,
77 LEAVE_ALONE
78 };
79
80 SoSFEnum viewportMapping;
81 SoSFVec3f position;
82 SoSFRotation orientation;
83 SoSFFloat aspectRatio;
84 SoSFFloat nearDistance;
85 SoSFFloat farDistance;
86 SoSFFloat focalDistance;
87
88 SbViewVolume getViewVolume(const SbViewportRegion & vp,
89 SbViewportRegion & resultvp,
90 const SbMatrix & mm = SbMatrix::identity()) const;
91
92 void pointAt(const SbVec3f & targetpoint);
93 void pointAt(const SbVec3f & targetpoint, const SbVec3f & upvector);
94 virtual void scaleHeight(float scalefactor) = 0;
95 virtual SbViewVolume getViewVolume(float useaspectratio = 0.0f) const = 0;
96 void viewAll(SoNode * const sceneroot, const SbViewportRegion & vpregion,
97 const float slack = 1.0f);
98 void viewAll(SoPath * const path, const SbViewportRegion & vpregion,
99 const float slack = 1.0f);
100 SbViewportRegion getViewportBounds(const SbViewportRegion & region) const;
101
102 enum StereoMode {
103 MONOSCOPIC,
104 LEFT_VIEW,
105 RIGHT_VIEW
106 };
107
108 void setStereoMode(StereoMode mode);
109 StereoMode getStereoMode(void) const;
110
111 void setStereoAdjustment(float adjustment);
112 float getStereoAdjustment(void) const;
113 void setBalanceAdjustment(float adjustment);
114 float getBalanceAdjustment(void) const;
115
116 virtual void doAction(SoAction * action);
117 virtual void callback(SoCallbackAction * action);
118 virtual void GLRender(SoGLRenderAction * action);
119 virtual void audioRender(SoAudioRenderAction *action);
120 virtual void getBoundingBox(SoGetBoundingBoxAction * action);
121 virtual void getMatrix(SoGetMatrixAction * action);
122 virtual void handleEvent(SoHandleEventAction * action);
123 virtual void rayPick(SoRayPickAction * action);
124 virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
125 virtual void viewBoundingBox(const SbBox3f & box, float aspect,
126 float slack) = 0;
127protected:
128 SoCamera(void);
129 virtual ~SoCamera();
130
131 virtual void jitter(int numpasses, int curpass,
132 const SbViewportRegion & vpreg,
133 SbVec3f & jitteramount) const;
134
135private:
136 void getView(SoAction * action, SbViewVolume & resultvv,
137 SbViewportRegion & resultvp,
138 const SbBool considermodelmatrix = TRUE);
139
140 void drawCroppedFrame(SoGLRenderAction * action,
141 const int viewportmapping,
142 const SbViewportRegion & oldvp,
143 const SbViewportRegion & newvp);
144
145 void lookAt(const SbVec3f & dir, const SbVec3f & up);
146
147 StereoMode stereomode;
148 float stereoadjustment;
149 float balanceadjustment;
150private:
151 SoCameraP *pimpl;
152 friend class SoCameraP;
153};
154
155#endif // !COIN_SOCAMERA_H
SbBox3f
The SbBox3f class is an abstraction for an axis aligned 3 dimensional box.
Definition SbBox3f.h:46
SbMatrix
The SbMatrix class is a 4x4 dimensional representation of a matrix.
Definition SbMatrix.h:47
SbMatrix::identity
static SbMatrix identity(void)
Definition SbMatrix.cpp:848
SbVec3f
The SbVec3f class is a 3 dimensional vector with floating point coordinates.
Definition SbVec3f.h:51
SbViewVolume
The SbViewVolume class is a viewing volume in 3D space.
Definition SbViewVolume.h:50
SbViewportRegion
The SbViewportRegion class is a viewport within a full window.
Definition SbViewportRegion.h:40
SoAction
The SoAction class is the base class for all traversal actions.
Definition SoAction.h:77
SoAudioRenderAction
The SoAudioRenderAction class renders the aural parts of the scene graph.
Definition SoAudioRenderAction.h:42
SoCallbackAction
The SoCallbackAction class invokes callbacks at specific nodes.
Definition SoCallbackAction.h:80
SoCamera::pointAt
void pointAt(const SbVec3f &targetpoint)
Definition SoCamera.cpp:487
SoCamera::position
SoSFVec3f position
Definition SoCamera.h:81
SoCamera::orientation
SoSFRotation orientation
Definition SoCamera.h:82
SoCamera::getViewportBounds
SbViewportRegion getViewportBounds(const SbViewportRegion &region) const
Definition SoCamera.cpp:627
SoCamera::farDistance
SoSFFloat farDistance
Definition SoCamera.h:85
SoCamera::aspectRatio
SoSFFloat aspectRatio
Definition SoCamera.h:83
SoCamera::ViewportMapping
ViewportMapping
Definition SoCamera.h:72
SoCamera::focalDistance
SoSFFloat focalDistance
Definition SoCamera.h:86
SoCamera::scaleHeight
virtual void scaleHeight(float scalefactor)=0
SoCamera::nearDistance
SoSFFloat nearDistance
Definition SoCamera.h:84
SoCamera::viewportMapping
SoSFEnum viewportMapping
Definition SoCamera.h:80
SoCamera::jitter
virtual void jitter(int numpasses, int curpass, const SbViewportRegion &vpreg, SbVec3f &jitteramount) const
Definition SoCamera.cpp:824
SoCamera::getViewVolume
SbViewVolume getViewVolume(const SbViewportRegion &vp, SbViewportRegion &resultvp, const SbMatrix &mm=SbMatrix::identity()) const
Definition SoCamera.cpp:433
SoCamera::viewBoundingBox
virtual void viewBoundingBox(const SbBox3f &box, float aspect, float slack)=0
SoCamera::StereoMode
StereoMode
Definition SoCamera.h:102
SoCamera::MONOSCOPIC
@ MONOSCOPIC
Definition SoCamera.h:103
SoCamera::LEFT_VIEW
@ LEFT_VIEW
Definition SoCamera.h:104
SoCamera::RIGHT_VIEW
@ RIGHT_VIEW
Definition SoCamera.h:105
SoCamera::getViewVolume
virtual SbViewVolume getViewVolume(float useaspectratio=0.0f) const =0
SoCamera::viewAll
void viewAll(SoNode *const sceneroot, const SbViewportRegion &vpregion, const float slack=1.0f)
Definition SoCamera.cpp:548
SoCamera::SoCamera
SoCamera(void)
Definition SoCamera.cpp:342
SoGLRenderAction
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition SoGLRenderAction.h:50
SoGetBoundingBoxAction
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.
Definition SoGetBoundingBoxAction.h:45
SoGetMatrixAction
The SoGetMatrixAction class is an action for accumulating the transformation matrix of a subgraph.
Definition SoGetMatrixAction.h:46
SoGetPrimitiveCountAction
The SoGetPrimitiveCountAction class counts the primitives in a scene.
Definition SoGetPrimitiveCountAction.h:44
SoHandleEventAction
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:46
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::getPrimitiveCount
virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition SoNode.cpp:943
SoNode::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoNode.cpp:1132
SoNode::getBoundingBox
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition SoNode.cpp:914
SoNode::audioRender
virtual void audioRender(SoAudioRenderAction *action)
Definition SoNode.cpp:1356
SoNode::doAction
virtual void doAction(SoAction *action)
Definition SoNode.cpp:858
SoNode::callback
virtual void callback(SoCallbackAction *action)
Definition SoNode.cpp:1075
SoNode::getMatrix
virtual void getMatrix(SoGetMatrixAction *action)
Definition SoNode.cpp:1102
SoNode::rayPick
virtual void rayPick(SoRayPickAction *action)
Definition SoNode.cpp:1188
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoNode::GLRender
virtual void GLRender(SoGLRenderAction *action)
Definition SoNode.cpp:1003
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoRayPickAction
The SoRayPickAction class does ray intersection with scene graphs.
Definition SoRayPickAction.h:50
SoSFEnum
The SoSFEnum class is a container for an enum value.
Definition SoSFEnum.h:40
SoSFFloat
The SoSFFloat class is a container for a floating point value.
Definition SoSFFloat.h:39
SoSFRotation
The SoSFRotation class is a container for an SbRotation.
Definition SoSFRotation.h:40
SoSFVec3f
The SoSFVec3f class is a container for an SbVec3f vector.
Definition SoSFVec3f.h:40
SO_NODE_ABSTRACT_HEADER
#define SO_NODE_ABSTRACT_HEADER(classname)
Definition Coin_macros.dox:61