SoNodekitCatalog Class Reference

Nodekit catalog class. More...

#include <Inventor/nodekits/SoNodekitCatalog.h>

Public Member Functions
int	getNumEntries () const
	Returns the 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
	Returns the type of the specified part.
SoType	getType (const SbName &theName) const
	Returns the type of the specified part.
SoType	getDefaultType (int thePartNumber) const
	Returns the default type of the specified part.
SoType	getDefaultType (const SbName &theName) const
	Returns the default type of the specified part.
SbBool	isNullByDefault (int thePartNumber) const
	Returns TRUE if the specified part is null by default.
SbBool	isNullByDefault (const SbName &theName) const
	Returns TRUE if the specified part is null by default.
SbBool	isLeaf (int thePartNumber) const
	Returns TRUE if the specified part is a leaf node.
SbBool	isLeaf (const SbName &theName) const
	Returns TRUE if the specified part is a leaf node.
const SbName &	getParentName (int thePartNumber) const
	Returns the parent of the specified part.
const SbName &	getParentName (const SbName &theName) const
	Returns the parent of the specified part.
int	getParentPartNumber (int thePartNumber) const
	Returns the part number of the parent of the specified part.
int	getParentPartNumber (const SbName &theName) const
	Returns the part number of the parent of the specified part.
const SbName &	getRightSiblingName (int thePartNumber) const
	Returns the name of the right sibling of the specified part.
const SbName &	getRightSiblingName (const SbName &theName) const
	Returns the name of the right sibling of the specified part.
int	getRightSiblingPartNumber (int thePartNumber) const
	Returns the part number of the right sibling of the specified part.
int	getRightSiblingPartNumber (const SbName &theName) const
	Returns the part number of the right sibling of the specified part.
SbBool	isList (int thePartNumber) const
	Returns TRUE if the specified part is a parts list.
SbBool	isList (const SbName &theName) const
	Returns TRUE if the specified part is a parts list.
SoType	getListContainerType (int thePartNumber) const
	Returns the list container type of the specified part.
SoType	getListContainerType (const SbName &theName) const
	Returns the list container type of the specified part.
const SoTypeList &	getListItemTypes (int thePartNumber) const
	Returns a list of the types of nodes that the specified part can contain.
const SoTypeList &	getListItemTypes (const SbName &theName) const
	Returns a list of the types of nodes that the specified part can contain.
SbBool	isPublic (int thePartNumber) const
	Returns TRUE if the specified part is public.
SbBool	isPublic (const SbName &theName) const
	Returns TRUE if the specified part is public.

Detailed Description

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."

SEE ALSO

SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit

Definition at line 187 of file SoNodekitCatalog.h.

Member Function Documentation

getDefaultType() [1/2]

SoType SoNodekitCatalog::getDefaultType

(

const SbName &

theName

)

const

Returns the default type of the specified part.

getDefaultType() [2/2]

SoType SoNodekitCatalog::getDefaultType

(

int

thePartNumber

)

const

Returns the default type of the specified part.

getListContainerType() [1/2]

SoType SoNodekitCatalog::getListContainerType

(

const SbName &

theName

)

const

Returns the list container type of the specified part.

getListContainerType() [2/2]

SoType SoNodekitCatalog::getListContainerType

(

int

thePartNumber

)

const

Returns the list container type of the specified part.

getListItemTypes() [1/2]

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.

getListItemTypes() [2/2]

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.

getName()

const SbName & SoNodekitCatalog::getName

(

int

thePartNumber

)

const

Given the part number of a part, returns its name in the catalog.

getNumEntries()

int SoNodekitCatalog::getNumEntries ( ) const

inline

Returns the number of entries in the catalog.

Definition at line 202 of file SoNodekitCatalog.h.

getParentName() [1/2]

const SbName & SoNodekitCatalog::getParentName

(

const SbName &

theName

)

const

Returns the parent of the specified part.

getParentName() [2/2]

const SbName & SoNodekitCatalog::getParentName

(

int

thePartNumber

)

const

Returns the parent of the specified part.

getParentPartNumber() [1/2]

int SoNodekitCatalog::getParentPartNumber

(

const SbName &

theName

)

const

Returns the part number of the parent of the specified part.

getParentPartNumber() [2/2]

int SoNodekitCatalog::getParentPartNumber

(

int

thePartNumber

)

const

Returns the part number of the parent of the specified part.

getPartNumber()

int SoNodekitCatalog::getPartNumber

(

const SbName &

theName

)

const

Given the name of a part, returns its part number in the catalog.

getRightSiblingName() [1/2]

const SbName & SoNodekitCatalog::getRightSiblingName

(

const SbName &

theName

)

const

Returns the name of the right sibling of the specified part.

getRightSiblingName() [2/2]

const SbName & SoNodekitCatalog::getRightSiblingName

(

int

thePartNumber

)

const

Returns the name of the right sibling of the specified part.

getRightSiblingPartNumber() [1/2]

int SoNodekitCatalog::getRightSiblingPartNumber

(

const SbName &

theName

)

const

Returns the part number of the right sibling of the specified part.

getRightSiblingPartNumber() [2/2]

int SoNodekitCatalog::getRightSiblingPartNumber

(

int

thePartNumber

)

const

Returns the part number of the right sibling of the specified part.

getType() [1/2]

SoType SoNodekitCatalog::getType

(

const SbName &

theName

)

const

Returns the type of the specified part.

getType() [2/2]

SoType SoNodekitCatalog::getType

(

int

thePartNumber

)

const

Returns the type of the specified part.

isLeaf() [1/2]

SbBool SoNodekitCatalog::isLeaf

(

const SbName &

theName

)

const

Returns TRUE if the specified part is a leaf node.

isLeaf() [2/2]

SbBool SoNodekitCatalog::isLeaf

(

int

thePartNumber

)

const

Returns TRUE if the specified part is a leaf node.

isList() [1/2]

SbBool SoNodekitCatalog::isList

(

const SbName &

theName

)

const

Returns TRUE if the specified part is a parts list.

isList() [2/2]

SbBool SoNodekitCatalog::isList

(

int

thePartNumber

)

const

Returns TRUE if the specified part is a parts list.

isNullByDefault() [1/2]

SbBool SoNodekitCatalog::isNullByDefault

(

const SbName &

theName

)

const

Returns TRUE if the specified part is null by default.

isNullByDefault() [2/2]

SbBool SoNodekitCatalog::isNullByDefault

(

int

thePartNumber

)

const

Returns TRUE if the specified part is null by default.

isPublic() [1/2]

SbBool SoNodekitCatalog::isPublic

(

const SbName &

theName

)

const

Returns TRUE if the specified part is public.

isPublic() [2/2]

SbBool SoNodekitCatalog::isPublic

(

int

thePartNumber

)

const

Returns TRUE if the specified part is public.

---

The documentation for this class was generated from the following file:

• Inventor/nodekits/SoNodekitCatalog.h