1SoNodekitCatalog(3IV)() SoNodekitCatalog(3IV)()
2
6 SoNodekitCatalog — nodekit catalog class
7
9 SoNodekitCatalog
10
12 #include <Inventor/nodekits/SoNodekitCatalog.h>
13 #define SO_CATALOG_NAME_NOT_FOUND -1
15 #define SO_CATALOG_THIS_PART_NUM 0
16 Methods from class SoNodekitCatalog:
18 static void initClass()
20 int getNumEntries() const
21 int getPartNumber(const SbName &theName) const
22 const SbName & getName(int thePartNumber) const
23 SoType getType(int thePartNumber) const
24 SoType getType(const SbName &theName) const
25 SoType getDefaultType(int thePartNumber) const
26 SoType getDefaultType(const SbName &theName) const
27 SbBool isNullByDefault(int thePartNumber) const
28 SbBool isNullByDefault(const SbName &theName) const
29 SbBool isLeaf(int thePartNumber) const
30 SbBool isLeaf(const SbName &theName) const
31 const SbName & getParentName(int thePartNumber) const
32 const SbName & getParentName(const SbName &theName) const
33 int getParentPartNumber(int thePartNumber) const
34 int getParentPartNumber(const SbName &theName) const
35 const SbName & getRightSiblingName(int thePartNumber) const
36 const SbName & getRightSiblingName(const SbName &theName) const
37 int getRightSiblingPartNumber(int thePartNumber) const
38 int getRightSiblingPartNumber(const SbName &theName)
39 const
40 SbBool isList(int thePartNumber) const
41 SbBool isList(const SbName &theName) const
42 SoType getListContainerType(int thePartNumber) const
43 SoType getListContainerType(const SbName &theName) const
44 const SoTypeList & getListItemTypes(int thePartNumber) const
45 const SoTypeList & getListItemTypes(const SbName &theName) const
46 SbBool isPublic(int thePartNumber) const
47 SbBool isPublic(const SbName &theName) const
48
51 This class describes the parts and structure of a nodekit. Each class
52 of nodekit has one SoNodekitCatalog (a static variable for the class).
53 Internally, the catalog contains one entry for each "part" in the
54 nodekit's structure. Users can query the catalog for information about
55 each entry in the catalog. This information can be obtained either by
56 part name (an SbName unique for the part within the catalog) or by part
57 number (an index into an array of parts).
58 Note that, although the catalog for a nodekit class may contain many
60 entries, each instance of that class is not initially created with all
61 of these parts intact. Rather, each instance of the class has its own
62 parts list which keeps track of which parts the user has created. The
63 nodekit uses the catalog as a guide in creating new nodes as its
64 descendants; the standard addChild(), removeChild() and other SoGroup
65 methods are protected, so that users must create descendants indirectly
66 by asking the nodekit to get and/or set the different "parts" in the
67 catalog.
68 The first entry in any SoNodekitCatalog corresponds to the nodekit
70 itself. Its partName is "this" and its partNumber is 0. All other parts
71 in the catalog are described relative to "this."
72
74 static void initClass()
75 Initializes this object.
76 int getNumEntries() const
78 Returns number of entries in the catalog.
79 int getPartNumber(const SbName &theName) const
81 Given the name of a part, returns its part number in the catalog.
82 const SbName & getName(int thePartNumber) const
84 Given the part number of a part, returns its name in the catalog.
85 SoType getType(int thePartNumber) const
87 SoType getType(const SbName &theName) const
88 SoType getDefaultType(int thePartNumber) const
89 SoType getDefaultType(const SbName &theName) const
90 SbBool isNullByDefault(int thePartNumber) const
91 SbBool isNullByDefault(const SbName &theName) const
92 SbBool isLeaf(int thePartNumber) const
93 SbBool isLeaf(const SbName &theName) const
94 const SbName & getParentName(int thePartNumber) const
95 const SbName & getParentName(const SbName &theName) const
96 int getParentPartNumber(int thePartNumber) const
97 int getParentPartNumber(const SbName &theName) const
98 const SbName & getRightSiblingName(int thePartNumber) const
99 const SbName & getRightSiblingName(const SbName &theName) const
100 int getRightSiblingPartNumber(int thePartNumber) const
101 int getRightSiblingPartNumber(const SbName &theName)
102 const
103 SbBool isList(int thePartNumber) const
104 SbBool isList(const SbName &theName) const
105 SoType getListContainerType(int thePartNumber) const
106 SoType getListContainerType(const SbName &theName) const
107 const SoTypeList & getListItemTypes(int thePartNumber) const
108 const SoTypeList & getListItemTypes(const SbName &theName) const
109 SbBool isPublic(int thePartNumber) const
110 SbBool isPublic(const SbName &theName) const
111 A full set of methods for finding out all parameters in the catalog,
112 given either the part name or the part number.
113
116 SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoN‐
117 odeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoSceneKit, SoSepara‐
118 torKit, SoShapeKit, SoWrapperKit
119 SoNodekitCatalog(3IV)()