Click or drag to resize
SoPath Methods

The SoPath type exposes the following members.

Methods
  NameDescription
Public methodAppend(Int32)

Adds node to end of chain; the node is the childIndex'th child of the current tail node.

Public methodAppend(SoNode)

Adds node to end of chain; uses the first occurrence of childNode as child of current tail node.

Public methodAppend(SoPath)

Adds all nodes in fromPath's chain to end of chain; the head node of fromPath must be the same as or a child of the current tail node.

Public methodContainsNode(Type)

Returns true if the node type is found anywhere in the path chain.

Public methodContainsNode(SoNode)

Returns true if the node is found anywhere in the path chain.

Public methodContainsPath

Returns true if the nodes in the chain in the passed path are contained (in consecutive order) in this path chain.

Public methodCopy
Calls Copy(System.Int32(0), System.Int32(0)).
Public methodCopy(Int32)
Calls Copy(startFromNodeIndex, System.Int32(0)).
Public methodCopy(Int32, Int32)

Creates and returns a new path that is a copy of some or all of this path.

Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFindFork

If the two paths have different head nodes, this returns -1.

Public methodStatic memberGetByName(String)

Method to return a path with a given name.

Public methodStatic memberGetByName(String, SoPathList)

Method to return paths with a given name.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetHead

Returns the first node in a path chain.

Public methodGetIndex

Returns the index of the i'th node (within its parent) in the chain.

Public methodGetIndexFromTail

Returns the index of the i'th node (within its parent) in the chain, counting backward from the tail node.

Public methodGetInstanceIndex

Returns the index of the instance inside the parent OIV.Inventor.Nodes.SoMultipleInstance, OIV.Inventor.Nodes.SoMultipleCopy or OIV.Inventor.Nodes.SoArray group.

Public methodGetInstanceIndexFromTail

Returns the index of the i'th node instance (within its parent, if it is a OIV.Inventor.Nodes.SoMultipleInstance, OIV.Inventor.Nodes.SoMultipleCopy or OIV.Inventor.Nodes.SoArray group in the chain, counting backward from the tail node.

Public methodGetLength Obsolete.

Returns length of path chain (number of nodes).

Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNode(Int32)

Returns the i'th node (within its parent) in the chain.

Public methodGetNode(Type, Int32)

Returns the first node and its index, from the head of the given type in the chain.

Public methodGetNodeFromTail

Returns the i'th node (within its parent) in the chain, counting backward from the tail node.

Public methodGetStringName (Inherited from SoBase.)
Public methodGetTail

Returns the last node in a path chain.

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

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPop

The OIV.Inventor.SoPath.Push(System.Int32) and OIV.Inventor.SoPath.Pop() methods allow a path to be treated as a stack; they push a node at the end of the chain and pop the last node off.

Public methodPush

The OIV.Inventor.SoPath.Push(System.Int32) and OIV.Inventor.SoPath.Pop() methods allow a path to be treated as a stack; they push a node at the end of the chain and pop the last node off.

Public methodSetHead

Sets head node (first node in chain).

Public methodSetName (Inherited from SoBase.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoBase.)
Public methodTruncate

Truncates the path chain, removing all nodes from index start on.

Top
See Also