SoWrapperKit(3iv)

1SoWrapperKit(3IV)()                                        SoWrapperKit(3IV)()
2
3
4

NAME

6       SoWrapperKit — wrapper nodekit class
7

INHERITS FROM

9       SoBase  >  SoFieldContainer  >  SoNode  >  SoBaseKit > SoSeparatorKit >
10       SoWrapperKit
11

SYNOPSIS

13       #include <Inventor/nodekits/SoWrapperKit.h>
14
15          Fields from class SoSeparatorKit:
16
17     SoSFEnum            renderCaching
18     SoSFEnum            boundingBoxCaching
19     SoSFEnum            renderCulling
20     SoSFEnum            pickCulling
21
22          Parts from class SoWrapperKit:
23
24     (SoTransform)       localTransform
25     (SoSeparator)       contents
26
27          Parts from class SoSeparatorKit:
28
29     (SoPickStyle)          pickStyle
30     (SoAppearanceKit)      appearance
31     (SoUnits)              units
32     (SoTransform)          transform
33     (SoTexture2Transform)  texture2Transform
34     (SoNodeKitListPart)    childList
35
36          Parts from class SoBaseKit:
37
38     (SoNodeKitListPart)  callbackList
39
40          Methods from class SoWrapperKit:
41
42                         SoWrapperKit()
43     static const SoNodekitCatalog *
44                         getClassNodekitCatalog() const
45     static SoType       getClassTypeId()
46
47          Methods from class SoBaseKit:
48
49     virtual const SoNodekitCatalog *
50                              getNodekitCatalog() const
51     virtual   SoNode   *         getPart(const   SbName   &partName,   SbBool
52                                   makeIfNeeded)
53     SbString                 getPartString(const SoBase *part)
54     virtual  SoNodeKitPath *  createPathToPart(const SbName &partName, SbBool
55                                   makeIfNeeded, const SoPath *pathToExtend  =
56                                   NULL)
57     virtual SbBool           setPart(const SbName &partName, SoNode *newPart)
58     SbBool                   set(char *partName, char *parameters)
59     SbBool                   set(char *nameValuePairs)
60     static SbBool            isSearchingChildren()
61     static void              setSearchingChildren(SbBool newVal)
62
63          Methods from class SoNode:
64
65     void                setOverride(SbBool state)
66     SbBool              isOverride() const
67     SoNode *            copy(SbBool copyConnections = FALSE) const
68     virtual SbBool      affectsState() const
69     static SoNode *     getByName(const SbName &name)
70     static int          getByName(const SbName &name, SoNodeList &list)
71
72          Methods from class SoFieldContainer:
73
74     void                setToDefaults()
75     SbBool              hasDefaultValues() const
76     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
77     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
78                              copyConnections = FALSE)
79     void                get(SbString &fieldDataString)
80     virtual int         getFields(SoFieldList &resultList) const
81     virtual SoField *   getField(const SbName &fieldName) const
82     SbBool              getFieldName(const SoField *field, SbName &fieldName)
83                              const
84     SbBool              isNotifyEnabled() const
85     SbBool              enableNotify(SbBool flag)
86
87          Methods from class SoBase:
88
89     void                ref()
90     void                unref() const
91     void                unrefNoDelete() const
92     void                touch()
93     virtual SoType      getTypeId() const
94     SbBool              isOfType(SoType type) const
95     virtual void        setName(const SbName &name)
96     virtual SbName      getName() const
97
98          Macros from class SoBaseKit:
99
100     SO_GET_PART(kit, partName, partClass)
101     SO_CHECK_PART(kit, partName, partClass)
102
103

DESCRIPTION

105       SoWrapperKit  is derived from SoSeparatorKit. It adds the capability to
106       wrap an arbitrary scene graph, (non-nodekit), within an SoSeparatorKit,
107       so  that  it  may  be  used along with other shape kits in a hierarchy.
108       There are two additional parts included in SoWrapperKit: localTransform
109       and contents.
110
111       The  part  contents  is an SoSeparator node beneath which any arbitrary
112       scene graph can be added. This is especially useful for importing scene
113       graphs of unknown structure (non-nodekits) into nodekit format.
114
115       Since  an SoWrapperKit is a class descended from SoSeparatorKit, it may
116       be put into another SoSeparatorKit's childList.
117

PARTS

119     (SoTransform)       localTransform
120          This part is an SoTransform node that is used to  affect  the  scene
121          graph  defined in contents part. This part is NULL by default and is
122          automatically created if requested.
123
124     (SoSeparator)       contents
125          This part is an SoSeparator node that contains a user-supplied scene
126          graph.  This scene graph can contain any nodes. This part is NULL by
127          default and an SoSeparator is automatically created if the user asks
128          the nodekit to build the part.
129
130

METHODS

132                         SoWrapperKit()
133          Constructor.
134
135     static const SoNodekitCatalog *
136                         getClassNodekitCatalog() const
137          Returns an SoNodekitCatalog for the class SoWrapperKit.
138
139     static SoType       getClassTypeId()
140          Returns type identifier for this class.
141
142

CATALOG PARTS

144       ┌───────────────────────────────────────────────────────────────┐
145       │                          All parts                            │
146       │                                                       NULL by │
147       │Part Name           Part Type           Default Type   Default │
148       │                                                               │
149       │callbackList        NodeKitListPart     --               yes   │
150       │pickStyle           PickStyle           --               yes   │
151       │appearance          AppearanceKit       --               yes   │
152       │units               Units               --               yes   │
153       │transform           Transform           --               yes   │
154       │texture2Transform   Texture2Transform   --               yes   │
155       │childList           NodeKitListPart     --               yes   │
156       │localTransform      Transform           --               yes   │
157       │contents            Separator           --               yes   │
158       │                                                               │
159       └───────────────────────────────────────────────────────────────┘
160       ┌───────────────────────────────────────────────────────────────┐
161       │      Extra information for list parts from above table        │
162       │                                                               │
163       │Part Name      Container Type   Permissible Types              │
164       │                                                               │
165       │callbackList   Separator        Callback, EventCallback        │
166       │childList      Separator        ShapeKit, SeparatorKit         │
167       │                                                               │
168       └───────────────────────────────────────────────────────────────┘

FILE FORMAT/DEFAULTS

170       WrapperKit {
171          renderCaching       AUTO
172          boundingBoxCaching  AUTO
173          renderCulling       AUTO
174          pickCulling         AUTO
175          callbackList        NULL
176          pickStyle           NULL
177          appearance          NULL
178          units               NULL
179          transform           NULL
180          texture2Transform   NULL
181          childList           NULL
182          localTransform      NULL
183          contents            NULL
184     }
185