SoPerspectiveCamera(3iv)

1SoPerspectiveCamera(3IV)()                          SoPerspectiveCamera(3IV)()
2
3
4

NAME

6       SoPerspectiveCamera — perspective camera node
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoNode > SoCamera > SoPerspectiveCamera
10

SYNOPSIS

12       #include <Inventor/nodes/SoPerspectiveCamera.h>
13
14          Fields from class SoPerspectiveCamera:
15
16     SoSFFloat           heightAngle
17
18          Fields from class SoCamera:
19
20     SoSFEnum            viewportMapping
21     SoSFVec3f           position
22     SoSFRotation        orientation
23     SoSFFloat           aspectRatio
24     SoSFFloat           nearDistance
25     SoSFFloat           farDistance
26     SoSFFloat           focalDistance
27
28          Methods from class SoPerspectiveCamera:
29
30                         SoPerspectiveCamera()
31     static SoType       getClassTypeId()
32
33          Methods from class SoCamera:
34
35     void                  pointAt(const SbVec3f &targetPoint)
36     virtual void          scaleHeight(float scaleFactor)
37     virtual SbViewVolume  getViewVolume(float useAspectRatio = 0.0) const
38     void                  viewAll(SoNode  *sceneRoot,  const SbViewportRegion
39                                &vpRegion, float slack = 1.0)
40     void                  viewAll(SoPath *path, const SbViewportRegion &vpRe‐
41                                gion, float slack = 1.0)
42     SbViewportRegion      getViewportBounds(const  SbViewportRegion  &region)
43                                const
44
45          Methods from class SoNode:
46
47     void                setOverride(SbBool state)
48     SbBool              isOverride() const
49     SoNode *            copy(SbBool copyConnections = FALSE) const
50     virtual SbBool      affectsState() const
51     static SoNode *     getByName(const SbName &name)
52     static int          getByName(const SbName &name, SoNodeList &list)
53
54          Methods from class SoFieldContainer:
55
56     void                setToDefaults()
57     SbBool              hasDefaultValues() const
58     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
59     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
60                              copyConnections = FALSE)
61     SbBool              set(const char *fieldDataString)
62     void                get(SbString &fieldDataString)
63     virtual int         getFields(SoFieldList &resultList) const
64     virtual SoField *   getField(const SbName &fieldName) const
65     SbBool              getFieldName(const SoField *field, SbName &fieldName)
66                              const
67     SbBool              isNotifyEnabled() const
68     SbBool              enableNotify(SbBool flag)
69
70          Methods from class SoBase:
71
72     void                ref()
73     void                unref() const
74     void                unrefNoDelete() const
75     void                touch()
76     virtual SoType      getTypeId() const
77     SbBool              isOfType(SoType type) const
78     virtual void        setName(const SbName &name)
79     virtual SbName      getName() const
80
81

DESCRIPTION

83       A perspective camera defines a perspective projection from a viewpoint.
84       The  viewing volume for a perspective camera is a truncated right pyra‐
85       mid.
86
87       By default, the camera is located at (0,0,1) and looks along the  nega‐
88       tive  z-axis; the position and orientation fields can be used to change
89       these values. The heightAngle field defines the total vertical angle of
90       the  viewing volume; this and the aspectRatio field determine the hori‐
91       zontal angle.
92

FIELDS

94     SoSFFloat           heightAngle
95          Vertical angle of the viewing volume.
96
97

METHODS

99                         SoPerspectiveCamera()
100          Creates a perspective camera node with default settings.
101
102     static SoType       getClassTypeId()
103          Returns type identifier for this class.
104
105

ACTION BEHAVIOR

107       SoGLRenderAction,  SoCallbackAction,   SoGetBoundingBoxAction,   SoHan‐
108       dleEventAction, SoRayPickAction
109          Sets the viewport and camera information in the state.
110
111

FILE FORMAT/DEFAULTS

113       PerspectiveCamera {
114          viewportMapping  ADJUST_CAMERA
115          position         0 0 1
116          orientation      0 0 1  0
117          aspectRatio      1
118          nearDistance     1
119          farDistance      10
120          focalDistance    5
121          heightAngle      0.785398
122     }
123