| SoNodekitCatalog Class |
Nodekit catalog class.
Inheritance HierarchyNamespace: OIV.Inventor.Nodekits
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoNodekitCatalog type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoNodekitCatalog | Initializes a new instance of the SoNodekitCatalog class |
Methods| Name | Description | |
|---|---|---|
| AddEntry | |
| AddListItemType(Int32, Type) | |
| AddListItemType(String, Type) | |
| Clone | |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetDefaultType(Int32) | Returns the default type of the specified part. |
| GetDefaultType(String) | Returns the default type of the specified part. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetListContainerType(Int32) | Returns the list container type of the specified part. |
| GetListContainerType(String) | Returns the list container type of the specified part. |
| GetListItemTypes(Int32) | Returns a list of the types of nodes that the specified part can contain. |
| GetListItemTypes(String) | Returns a list of the types of nodes that the specified part can contain. |
| GetName | Given the part number of a part, returns its name in the catalog. |
| GetNumEntries | Returns the number of entries in the catalog. |
| GetParentName(Int32) | Returns the parent of the specified part. |
| GetParentName(String) | Returns the parent of the specified part. |
| GetParentPartNumber(Int32) | Returns the part number of the parent of the specified part. |
| GetParentPartNumber(String) | Returns the part number of the parent of the specified part. |
| GetPartNumber | Given the name of a part, returns its part number in the catalog. |
| GetRightSiblingName(Int32) | Returns the name of the right sibling of the specified part. |
| GetRightSiblingName(String) | Returns the name of the right sibling of the specified part. |
| GetRightSiblingPartNumber(Int32) | Returns the part number of the right sibling of the specified part. |
| GetRightSiblingPartNumber(String) | Returns the part number of the right sibling of the specified part. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetType(Int32) | Returns the type of the specified part. |
| GetType(String) | Returns the type of the specified part. |
| IsLeaf(Int32) | Returns true if the specified part is a leaf node. |
| IsLeaf(String) | Returns true if the specified part is a leaf node. |
| IsList(Int32) | Returns true if the specified part is a parts list. |
| IsList(String) | Returns true if the specified part is a parts list. |
| IsNullByDefault(Int32) | Returns true if the specified part is null by default. |
| IsNullByDefault(String) | Returns true if the specified part is null by default. |
| IsPublic(Int32) | Returns true if the specified part is public. |
| IsPublic(String) | Returns true if the specified part is public. |
| NarrowTypes | |
| SetNullByDefault | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
RemarksThis class describes the parts and structure of a nodekit. Each class of nodekit has one OIV.Inventor.Nodekits.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 OIV.Inventor.Nodes.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 OIV.Inventor.Nodekits.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