SoCameraKit(3iv)

1SoCameraKit(3IV)()                                          SoCameraKit(3IV)()
2
3
4

NAME

6       SoCameraKit — camera nodekit class
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoNode > SoBaseKit > SoCameraKit
10

SYNOPSIS

12       #include <Inventor/nodekits/SoCameraKit.h>
13
14          Parts from class SoCameraKit:
15
16     (SoTransform)       transform
17     (SoCamera)          camera
18
19          Parts from class SoBaseKit:
20
21     (SoNodeKitListPart)  callbackList
22
23          Methods from class SoCameraKit:
24
25                         SoCameraKit()
26     static const SoNodekitCatalog *
27                         getClassNodekitCatalog() const
28     static SoType       getClassTypeId()
29
30          Methods from class SoBaseKit:
31
32     virtual const SoNodekitCatalog *
33                              getNodekitCatalog() const
34     virtual   SoNode   *         getPart(const   SbName   &partName,   SbBool
35                                   makeIfNeeded)
36     SbString                 getPartString(const SoBase *part)
37     virtual SoNodeKitPath *  createPathToPart(const SbName &partName,  SbBool
38                                   makeIfNeeded,  const SoPath *pathToExtend =
39                                   NULL)
40     virtual SbBool           setPart(const SbName &partName, SoNode *newPart)
41     SbBool                   set(char *partName, char *parameters)
42     SbBool                   set(char *nameValuePairs)
43     static SbBool            isSearchingChildren()
44     static void              setSearchingChildren(SbBool newVal)
45
46          Methods from class SoNode:
47
48     void                setOverride(SbBool state)
49     SbBool              isOverride() const
50     SoNode *            copy(SbBool copyConnections = FALSE) const
51     virtual SbBool      affectsState() const
52     static SoNode *     getByName(const SbName &name)
53     static int          getByName(const SbName &name, SoNodeList &list)
54
55          Methods from class SoFieldContainer:
56
57     void                setToDefaults()
58     SbBool              hasDefaultValues() const
59     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
60     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
61                              copyConnections = FALSE)
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          Macros from class SoBaseKit:
82
83     SO_GET_PART(kit, partName, partClass)
84     SO_CHECK_PART(kit, partName, partClass)
85
86

DESCRIPTION

88       This nodekit class is used to create camera nodes  that  have  a  local
89       transformation. SoCameraKit adds two public parts to the basic nodekit:
90       transform and camera.
91
92       The camera part is created by default as an  SoPerspectiveCamera  node,
93       but may later be changed to any subclass of SoCamera.
94
95       You  can  move the camera relative to the rest of the scene by creating
96       and editing the transform part.
97
98       SoCameraKit also adds a private part, transformGroup, which is of  type
99       SoTransformSeparator.  The  kit uses this part to contain the effect of
100       transform to move only the camera, while allowing the camera to  affect
101       the rest of the scene.
102
103       SoCameraKit  is  derived  from SoBaseKit and thus also includes a call‐
104       backList part for adding callback nodes.
105

PARTS

107     (SoTransform)       transform
108          A transform that positions and orients the camera  relative  to  the
109          rest  of  the  scene. Private parts keep the effect of the transform
110          part localized. This part is NULL by default, but may be set to  any
111          subclass of SoTransform
112
113     (SoCamera)          camera
114          The  camera  node  for  this  nodekit. The camera part is created by
115          default as an SoPerspectiveCamera node, but may later be changed  to
116          any  subclass of SoCamera. (e.g., SoPerspectiveCamera, SoOrthograph‐
117          icCamera).
118
119

METHODS

121                         SoCameraKit()
122          Constructor.
123
124     static const SoNodekitCatalog *
125                         getClassNodekitCatalog() const
126          Returns an SoNodekitCatalog for the class SoCameraKit.
127
128     static SoType       getClassTypeId()
129          Returns type identifier for this class.
130
131

CATALOG PARTS

133       ┌─────────────────────────────────────────────────────────────┐
134       │                         All parts                           │
135       │                                                     NULL by │
136       │Part Name      Part Type         Default Type        Default │
137       │                                                             │
138       │callbackList   NodeKitListPart   --                    yes   │
139       │transform      Transform         --                    yes   │
140       │camera         Camera            PerspectiveCamera     no    │
141       │                                                             │
142       └─────────────────────────────────────────────────────────────┘
143       ┌───────────────────────────────────────────────────────────────┐
144       │      Extra information for list parts from above table        │
145       │                                                               │
146       │Part Name      Container Type   Permissible Types              │
147       │                                                               │
148       │callbackList   Separator        Callback, EventCallback        │
149       │                                                               │
150       └───────────────────────────────────────────────────────────────┘

FILE FORMAT/DEFAULTS

152       CameraKit {
153          callbackList  NULL
154          transform     NULL
155          camera        PerspectiveCamera {
156          }
157
158     }
159