Nodekit catalog class. More...
#include <Inventor/nodekits/SoNodekitCatalog.h>
Public Member Functions | |
| int | getNumEntries () const |
| int | getPartNumber (const SbName &theName) const |
| const SbName & | getName (int thePartNumber) const |
| 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 |
Nodekit catalog class.
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 (a string 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."
SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit
Returns the default type of the specified part.
| SoType SoNodekitCatalog::getDefaultType | ( | int | thePartNumber | ) | const |
Returns the default type of the specified part.
Returns the list container type of the specified part.
| SoType SoNodekitCatalog::getListContainerType | ( | int | thePartNumber | ) | const |
Returns the list container type of the specified part.
| const SoTypeList& SoNodekitCatalog::getListItemTypes | ( | const SbName & | theName | ) | const |
Returns a list of the types of nodes that the specified part can contain.
If the part is not a parts list, the returned list is empty.
| const SoTypeList& SoNodekitCatalog::getListItemTypes | ( | int | thePartNumber | ) | const |
Returns a list of the types of nodes that the specified part can contain.
If the part is not a parts list, the returned list is empty.
| const SbName& SoNodekitCatalog::getName | ( | int | thePartNumber | ) | const |
Given the part number of a part, returns its name in the catalog.
| int SoNodekitCatalog::getNumEntries | ( | ) | const [inline] |
Returns the number of entries in the catalog.
Returns the parent of the specified part.
| const SbName& SoNodekitCatalog::getParentName | ( | int | thePartNumber | ) | const |
Returns the parent of the specified part.
| int SoNodekitCatalog::getParentPartNumber | ( | const SbName & | theName | ) | const |
Returns the part number of the parent of the specified part.
| int SoNodekitCatalog::getParentPartNumber | ( | int | thePartNumber | ) | const |
Returns the part number of the parent of the specified part.
| int SoNodekitCatalog::getPartNumber | ( | const SbName & | theName | ) | const |
Given the name of a part, returns its part number in the catalog.
Returns the name of the right sibling of the specified part.
| const SbName& SoNodekitCatalog::getRightSiblingName | ( | int | thePartNumber | ) | const |
Returns the name of the right sibling of the specified part.
| int SoNodekitCatalog::getRightSiblingPartNumber | ( | const SbName & | theName | ) | const |
Returns the part number of the right sibling of the specified part.
| int SoNodekitCatalog::getRightSiblingPartNumber | ( | int | thePartNumber | ) | const |
Returns the part number of the right sibling of the specified part.
Returns the type of the specified part.
| SoType SoNodekitCatalog::getType | ( | int | thePartNumber | ) | const |
Returns the type of the specified part.
Returns TRUE if the specified part is a leaf node.
| SbBool SoNodekitCatalog::isLeaf | ( | int | thePartNumber | ) | const |
Returns TRUE if the specified part is a leaf node.
Returns TRUE if the specified part is a parts list.
| SbBool SoNodekitCatalog::isList | ( | int | thePartNumber | ) | const |
Returns TRUE if the specified part is a parts list.
Returns TRUE if the specified part is null by default.
| SbBool SoNodekitCatalog::isNullByDefault | ( | int | thePartNumber | ) | const |
Returns TRUE if the specified part is null by default.
Returns TRUE if the specified part is public.
| SbBool SoNodekitCatalog::isPublic | ( | int | thePartNumber | ) | const |
Returns TRUE if the specified part is public.