SoNodekitCatalog — nodekit catalog class
Contents
Description
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."
Inherits From
SoNodekitCatalog
Methods
staticvoidinitClass()
Initializes this object.
intgetNumEntries()const
Returns number of entries in the catalog.
intgetPartNumber(constSbName&theName)const
Given the name of a part, returns its part number in the catalog.
constSbName&getName(intthePartNumber)const
Given the part number of a part, returns its name in the catalog.
SoTypegetType(intthePartNumber)constSoTypegetType(constSbName&theName)constSoTypegetDefaultType(intthePartNumber)constSoTypegetDefaultType(constSbName&theName)constSbBoolisNullByDefault(intthePartNumber)constSbBoolisNullByDefault(constSbName&theName)constSbBoolisLeaf(intthePartNumber)constSbBoolisLeaf(constSbName&theName)constconstSbName&getParentName(intthePartNumber)constconstSbName&getParentName(constSbName&theName)constintgetParentPartNumber(intthePartNumber)constintgetParentPartNumber(constSbName&theName)constconstSbName&getRightSiblingName(intthePartNumber)constconstSbName&getRightSiblingName(constSbName&theName)constintgetRightSiblingPartNumber(intthePartNumber)constintgetRightSiblingPartNumber(constSbName&theName)constSbBoolisList(intthePartNumber)constSbBoolisList(constSbName&theName)constSoTypegetListContainerType(intthePartNumber)constSoTypegetListContainerType(constSbName&theName)constconstSoTypeList&getListItemTypes(intthePartNumber)constconstSoTypeList&getListItemTypes(constSbName&theName)constSbBoolisPublic(intthePartNumber)constSbBoolisPublic(constSbName&theName)const
A full set of methods for finding out all parameters in the catalog, given either the part name or the
part number.
Name
SoNodekitCatalog — nodekit catalog class
See Also
SoAppearanceKit,SoBaseKit,SoCameraKit,SoLightKit,SoNodeKit,SoNodeKitDetail,SoNodeKitListPart,SoNodeKitPath,SoSceneKit,SoSeparatorKit,SoShapeKit,SoWrapperKitSoNodekitCatalog(3IV)()
Synopsis
#include<Inventor/nodekits/SoNodekitCatalog.h>#defineSO_CATALOG_NAME_NOT_FOUND-1#defineSO_CATALOG_THIS_PART_NUM0
Methods from class SoNodekitCatalog:
staticvoidinitClass()intgetNumEntries()constintgetPartNumber(constSbName&theName)constconstSbName&getName(intthePartNumber)constSoTypegetType(intthePartNumber)constSoTypegetType(constSbName&theName)constSoTypegetDefaultType(intthePartNumber)constSoTypegetDefaultType(constSbName&theName)constSbBoolisNullByDefault(intthePartNumber)constSbBoolisNullByDefault(constSbName&theName)constSbBoolisLeaf(intthePartNumber)constSbBoolisLeaf(constSbName&theName)constconstSbName&getParentName(intthePartNumber)constconstSbName&getParentName(constSbName&theName)constintgetParentPartNumber(intthePartNumber)constintgetParentPartNumber(constSbName&theName)constconstSbName&getRightSiblingName(intthePartNumber)constconstSbName&getRightSiblingName(constSbName&theName)constintgetRightSiblingPartNumber(intthePartNumber)constintgetRightSiblingPartNumber(constSbName&theName)constSbBoolisList(intthePartNumber)constSbBoolisList(constSbName&theName)constSoTypegetListContainerType(intthePartNumber)constSoTypegetListContainerType(constSbName&theName)constconstSoTypeList&getListItemTypes(intthePartNumber)constconstSoTypeList&getListItemTypes(constSbName&theName)constSbBoolisPublic(intthePartNumber)constSbBoolisPublic(constSbName&theName)const