Public Member Functions |
| int | getNumEntries () const |
| | Returns number of entries in the catalog.
|
| int | getPartNumber (const SbName &theName) const |
| | Given the name of a part, returns its part number in the catalog.
|
| const SbName & | getName (int thePartNumber) const |
| | Given the part number of a part, returns its name in the catalog.
|
| SoType | getType (int thePartNumber) const |
| SoType | getType (const SbName &theName) const |
| SoType | getDefaultType (int thePartNumber) const |
| SoType | getDefaultType (const SbName &theName) const |
| SbBool | isNullByDefault (int thePartNumber) const |
| SbBool | isNullByDefault (const SbName &theName) const |
| SbBool | isLeaf (int thePartNumber) const |
| SbBool | isLeaf (const SbName &theName) const |
| const SbName & | getParentName (int thePartNumber) const |
| const SbName & | getParentName (const SbName &theName) const |
| int | getParentPartNumber (int thePartNumber) const |
| int | getParentPartNumber (const SbName &theName) const |
| const SbName & | getRightSiblingName (int thePartNumber) const |
| const SbName & | getRightSiblingName (const SbName &theName) const |
| int | getRightSiblingPartNumber (int thePartNumber) const |
| int | getRightSiblingPartNumber (const SbName &theName) const |
| SbBool | isList (int thePartNumber) const |
| SbBool | isList (const SbName &theName) const |
| SoType | getListContainerType (int thePartNumber) const |
| SoType | getListContainerType (const SbName &theName) const |
| const SoTypeList & | getListItemTypes (int thePartNumber) const |
| const SoTypeList & | getListItemTypes (const SbName &theName) const |
| SbBool | isPublic (int thePartNumber) const |
| SbBool | isPublic (const SbName &theName) const |
| | SoNodekitCatalog () |
| | Catalogs are only constructed, destructed, cloned or added to by subclasses of SoBaseKit.
|
| | ~SoNodekitCatalog () |
| | Destructor.
|
| SoNodekitCatalog * | clone (SoType typeOfThis) const |
| | Make a new identical copy, but you must give the node type for 'this' (where 'this' is the top level node in the template )
|
| SbBool | addEntry (const SbName &theName, SoType theType, SoType theDefaultType, SbBool theNullByDefault, const SbName &theParentName, const SbName &theRightSiblingName, SbBool theListPart, SoType theListContainerType, SoType theListItemType, SbBool thePublicPart) |
| | Adding entries.
|
| void | addListItemType (int thePartNumber, SoType typeToAdd) |
| | For adding to the set of node types allowed beneath a list...
|
| void | addListItemType (const SbName &theName, SoType typeToAdd) |
| void | narrowTypes (const SbName &theName, SoType newType, SoType newDefaultType) |
| | For changing the type and defaultType of an entry.
|
| void | setNullByDefault (const SbName &theName, SbBool newNullByDefault) |
| SbBool | recursiveSearch (int partNumber, const SbName &nameToFind, SoTypeList *typesChecked) const |
| | used by SoNodekitParts to search through catalogs.
|
| void | printCheck () const |
| | prints the contents of this catalog
|
Static Public Member Functions |
| static void | initClass () |
| | Initializes this object.
|
This class describes the parts and structure of a nodekit. Each class of nodekit has one SoNodekitCatalog (a static variable for the class). Internally, the catalog contains one entry for each "part" in the nodekit's structure. Users can query the catalog for information about each entry in the catalog. This information can be obtained either by part name (an SbName unique for the part within the catalog) or by part number (an index into an array of parts).
Note that, although the catalog for a nodekit class may contain many entries, each instance of that class is not initially created with all of these parts intact. Rather, each instance of the class has its own parts list which keeps track of which parts the user has created. The nodekit uses the catalog as a guide in creating new nodes as its descendants; the standard addChild(), removeChild() and other SoGroup methods are protected, so that users must create descendants indirectly by asking the nodekit to get and/or set the different "parts" in the catalog.
The first entry in any SoNodekitCatalog corresponds to the nodekit itself. Its partName is "this" and its partNumber is 0. All other parts in the catalog are described relative to "this."
- See Also
- SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit
Definition at line 185 of file SoNodekitCatalog.h.
| void SoNodekitCatalog::narrowTypes |
( |
const SbName & |
theName, |
|
|
SoType |
newType, |
|
|
SoType |
newDefaultType |
|
) |
| |
The new types must be subclasses of the types already existing in the entry. For example, in SoShapeKit, the part "shape" has type SoShape and default type SoSphere. Any shape node is acceptable, but be default a sphere will be built. Well, when creating the SoVertexShapeKit class, a call of: narrowTypes( "shape", SoVertexShape::getClassTypeId(), SoFaceSet::getClassTypeId()) might be used. This would reflect the fact that: Only vertext shapes may be put in the "shape" part, not just any shape. And also, by default, a faceSet will be built, not a sphere.
1.7.4