Click or drag to resize
SoNodekitCatalog Class

Nodekit catalog class.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.NodekitsSoNodekitCatalog

Namespace: OIV.Inventor.Nodekits
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.0.0 (2024.1.0)
Syntax
public class SoNodekitCatalog : SoNetBase

The SoNodekitCatalog type exposes the following members.

Constructors
  NameDescription
Public methodSoNodekitCatalog
Initializes a new instance of the SoNodekitCatalog class
Top
Methods
  NameDescription
Public methodAddEntry
Public methodAddListItemType(Int32, Type)
Public methodAddListItemType(String, Type)
Public methodClone
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetDefaultType(Int32)

Returns the default type of the specified part.

Public methodGetDefaultType(String)

Returns the default type of the specified part.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetListContainerType(Int32)

Returns the list container type of the specified part.

Public methodGetListContainerType(String)

Returns the list container type of the specified part.

Public methodGetListItemTypes(Int32)

Returns a list of the types of nodes that the specified part can contain.

Public methodGetListItemTypes(String)

Returns a list of the types of nodes that the specified part can contain.

Public methodGetName

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

Public methodGetNumEntries

Returns the number of entries in the catalog.

Public methodGetParentName(Int32)

Returns the parent of the specified part.

Public methodGetParentName(String)

Returns the parent of the specified part.

Public methodGetParentPartNumber(Int32)

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

Public methodGetParentPartNumber(String)

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

Public methodGetPartNumber

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

Public methodGetRightSiblingName(Int32)

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

Public methodGetRightSiblingName(String)

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

Public methodGetRightSiblingPartNumber(Int32)

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

Public methodGetRightSiblingPartNumber(String)

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

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetType(Int32)

Returns the type of the specified part.

Public methodGetType(String)

Returns the type of the specified part.

Public methodIsLeaf(Int32)

Returns true if the specified part is a leaf node.

Public methodIsLeaf(String)

Returns true if the specified part is a leaf node.

Public methodIsList(Int32)

Returns true if the specified part is a parts list.

Public methodIsList(String)

Returns true if the specified part is a parts list.

Public methodIsNullByDefault(Int32)

Returns true if the specified part is null by default.

Public methodIsNullByDefault(String)

Returns true if the specified part is null by default.

Public methodIsPublic(Int32)

Returns true if the specified part is public.

Public methodIsPublic(String)

Returns true if the specified part is public.

Public methodNarrowTypes
Public methodSetNullByDefault
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

This 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