man SoNodekitCatalog () - nodekit catalog class
NAME
SoNodekitCatalog - nodekit catalog class
INHERITS FROM
SoNodekitCatalog
SYNOPSIS
#include <Inventor/nodekits/SoNodekitCatalog.h>
#define SO_CATALOG_NAME_NOT_FOUND -1
#define SO_CATALOG_THIS_PART_NUM 0
Methods from class SoNodekitCatalog:
c
}
c
}
initClass()
c
}
c
}
getNumEntries() const
c
}
c
}
getPartNumber(const SbName &theName) const
c
}
c
}
getName(int thePartNumber) const
c
}
c
}
getType(int thePartNumber) const
c
}
c
}
getType(const SbName &theName) const
c
}
c
}
getDefaultType(int thePartNumber) const
c
}
c
}
getDefaultType(const SbName &theName) const
c
}
c
}
isNullByDefault(int thePartNumber) const
c
}
c
}
isNullByDefault(const SbName &theName) const
c
}
c
}
isLeaf(int thePartNumber) const
c
}
c
}
isLeaf(const SbName &theName) const
c
}
c
}
getParentName(int thePartNumber) const
c
}
c
}
getParentName(const SbName &theName) const
c
}
c
}
getParentPartNumber(int thePartNumber) const
c
}
c
}
getParentPartNumber(const SbName &theName) const
c
}
c
}
getRightSiblingName(int thePartNumber) const
c
}
c
}
getRightSiblingName(const SbName &theName) const
c
}
c
}
getRightSiblingPartNumber(int thePartNumber) const
c
}
c
}
getRightSiblingPartNumber(const SbName &theName) const
c
}
c
}
isList(int thePartNumber) const
c
}
c
}
isList(const SbName &theName) const
c
}
c
}
getListContainerType(int thePartNumber) const
c
}
c
}
getListContainerType(const SbName &theName) const
c
}
c
}
getListItemTypes(int thePartNumber) const
c
}
c
}
getListItemTypes(const SbName &theName) const
c
}
c
}
isPublic(int thePartNumber) const
c
}
c
}
isPublic(const SbName &theName) const
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."
METHODS
c
}
c
}
initClass()
Initializes this object.
c
}
c
}
getNumEntries() const
Returns number of entries in the catalog.
c
}
c
}
getPartNumber(const SbName &theName) const
Given the name of a part, returns its part number in the catalog.
c
}
c
}
getName(int thePartNumber) const
Given the part number of a part, returns its name in the catalog.
c
}
c
}
getType(int thePartNumber) const
c
}
c
}
getType(const SbName &theName) const
c
}
c
}
getDefaultType(int thePartNumber) const
c
}
c
}
getDefaultType(const SbName &theName) const
c
}
c
}
isNullByDefault(int thePartNumber) const
c
}
c
}
isNullByDefault(const SbName &theName) const
c
}
c
}
isLeaf(int thePartNumber) const
c
}
c
}
isLeaf(const SbName &theName) const
c
}
c
}
getParentName(int thePartNumber) const
c
}
c
}
getParentName(const SbName &theName) const
c
}
c
}
getParentPartNumber(int thePartNumber) const
c
}
c
}
getParentPartNumber(const SbName &theName) const
c
}
c
}
getRightSiblingName(int thePartNumber) const
c
}
c
}
getRightSiblingName(const SbName &theName) const
c
}
c
}
getRightSiblingPartNumber(int thePartNumber) const
c
}
c
}
getRightSiblingPartNumber(const SbName &theName) const
c
}
c
}
isList(int thePartNumber) const
c
}
c
}
isList(const SbName &theName) const
c
}
c
}
getListContainerType(int thePartNumber) const
c
}
c
}
getListContainerType(const SbName &theName) const
c
}
c
}
getListItemTypes(int thePartNumber) const
c
}
c
}
getListItemTypes(const SbName &theName) const
c
}
c
}
isPublic(int thePartNumber) const
c
}
c
}
isPublic(const SbName &theName) const
A full set of methods for finding out all parameters in the catalog, given either the part name or the part number.
SEE ALSO
SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit