SoNodekitCatalog(3IV)NAMESoNodekitCatalog (SoNkitCat) - nodekit catalog class
INHERITS FROMSoNodekitCatalogSYNOPSIS
#include <Inventor_c/nodekits/SoNodekitCatalog.h>
typedef SoNodekitCatalog SoNkitCat
#define SO_CATALOG_NAME_NOT_FOUND -1
#define SO_CATALOG_THIS_PART_NUM 0
Functions from class SoNodekitCatalog:
void SoNkitCatInitClass()
int SoNkitCatGetNumEntries(const SoNkitCat *this)
int SoNkitCatGetPartNum(const SoNkitCat *this, const char
*theName)
const SbName * SoNkitCatGetName(const SoNkitCat *this, int
thePartNumber)
SoType SoNkitCatGetType(const SoNkitCat *this, int
thePartNumber)
SoType SoNkitCatGetTypeByName(const SoNkitCat *this, const
char *theName)
SoType SoNkitCatGetDfltType(const SoNkitCat *this, int
thePartNumber)
SoType SoNkitCatGetDfltTypeByName(const SoNkitCat *this,
const char *theName)
SbBool SoNkitCatIsNullByDefault(const SoNkitCat *this, int
thePartNumber)
SbBool SoNkitCatIsNullByDefaultByName(const SoNkitCat *this,
const char *theName)
SbBool SoNkitCatIsLeaf(const SoNkitCat *this, int
thePartNumber)
SbBool SoNkitCatIsLeafByName(const SoNkitCat *this, const
char *theName)
const SbName * SoNkitCatGetParName(const SoNkitCat *this, int
thePartNumber)
const SbName * SoNkitCatGetParNameByName(const SoNkitCat *this,
const char *theName)
int SoNkitCatGetParPartNum(const SoNkitCat *this, int
thePartNumber)
int SoNkitCatGetParPartNumByName(const SoNkitCat *this,
const char *theName)
const SbName * SoNkitCatGetRtSibName(const SoNkitCat *this, int
thePartNumber)
const SbName * SoNkitCatGetRtSibNameByName(const SoNkitCat *this,
const char *theName)
int SoNkitCatGetRtSibPartNum(const SoNkitCat *this, int
thePartNumber)
Page 1SoNodekitCatalog(3IV)
int SoNkitCatGetRtSibPartNumByName(const SoNkitCat *this,
const char *theName)
SbBool SoNkitCatIsList(const SoNkitCat *this, int
thePartNumber)
SbBool SoNkitCatIsListByName(const SoNkitCat *this, const
char *theName)
SoType SoNkitCatGetLstCntnrType(const SoNkitCat *this, int
thePartNumber)
SoType SoNkitCatGetLstCntnrTypeByName(const SoNkitCat *this,
const char *theName)
const SoTypeList * SoNkitCatGetListItemTypes(const SoNkitCat *this, int
thePartNumber)
const SoTypeList * SoNkitCatGetListItemTypesByName(const SoNkitCat
*this, const char *theName)
SbBool SoNkitCatIsPublic(const SoNkitCat *this, int
thePartNumber)
SbBool SoNkitCatIsPubByName(const SoNkitCat *this, const
char *theName)
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."
FUNCTIONS
void SoNkitCatInitClass()
Initializes this object.
int SoNkitCatGetNumEntries(const SoNkitCat *this)
Returns number of entries in the catalog.
int SoNkitCatGetPartNum(const SoNkitCat *this, const char
*theName)
Given the name of a part, returns its part number in the catalog.
Page 2SoNodekitCatalog(3IV)
const SbName * SoNkitCatGetName(const SoNkitCat *this, int
thePartNumber)
Given the part number of a part, returns its name in the catalog.
SoType SoNkitCatGetType(const SoNkitCat *this, int
thePartNumber)
SoType SoNkitCatGetTypeByName(const SoNkitCat *this, const
char *theName)
SoType SoNkitCatGetDfltType(const SoNkitCat *this, int
thePartNumber)
SoType SoNkitCatGetDfltTypeByName(const SoNkitCat *this,
const char *theName)
SbBool SoNkitCatIsNullByDefault(const SoNkitCat *this, int
thePartNumber)
SbBool SoNkitCatIsNullByDefaultByName(const SoNkitCat *this,
const char *theName)
SbBool SoNkitCatIsLeaf(const SoNkitCat *this, int
thePartNumber)
SbBool SoNkitCatIsLeafByName(const SoNkitCat *this, const
char *theName)
const SbName * SoNkitCatGetParName(const SoNkitCat *this, int
thePartNumber)
const SbName * SoNkitCatGetParNameByName(const SoNkitCat *this,
const char *theName)
int SoNkitCatGetParPartNum(const SoNkitCat *this, int
thePartNumber)
int SoNkitCatGetParPartNumByName(const SoNkitCat *this,
const char *theName)
const SbName * SoNkitCatGetRtSibName(const SoNkitCat *this, int
thePartNumber)
const SbName * SoNkitCatGetRtSibNameByName(const SoNkitCat *this,
const char *theName)
int SoNkitCatGetRtSibPartNum(const SoNkitCat *this, int
thePartNumber)
int SoNkitCatGetRtSibPartNumByName(const SoNkitCat *this,
const char *theName)
SbBool SoNkitCatIsList(const SoNkitCat *this, int
thePartNumber)
SbBool SoNkitCatIsListByName(const SoNkitCat *this, const
char *theName)
SoType SoNkitCatGetLstCntnrType(const SoNkitCat *this, int
thePartNumber)
SoType SoNkitCatGetLstCntnrTypeByName(const SoNkitCat *this,
const char *theName)
const SoTypeList * SoNkitCatGetListItemTypes(const SoNkitCat *this, int
thePartNumber)
const SoTypeList * SoNkitCatGetListItemTypesByName(const SoNkitCat
*this, const char *theName)
SbBool SoNkitCatIsPublic(const SoNkitCat *this, int
thePartNumber)
SbBool SoNkitCatIsPubByName(const SoNkitCat *this, const
char *theName)
Page 3SoNodekitCatalog(3IV)
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
Page 4