SoFullPath Class

SoFullPath Class

Path that allows access to hidden children.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.InventorSoPath
          OIV.InventorSoFullPath

Namespace: OIV.Inventor
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.3.0.0 (10.3.0.0)

Syntax

C++

Copy

public class SoFullPath : SoPath

Public Class SoFullPath
	Inherits SoPath

public ref class SoFullPath : public SoPath

type SoFullPath =  
    class
        inherit SoPath
    end

The SoFullPath type exposes the following members.

Methods

	Name	Description
	Append(Int32)	Adds node to end of chain; the node is the childIndex'th child of the current tail node. (Inherited from SoPath.)
	Append(SoNode)	Adds node to end of chain; uses the first occurrence of childNode as child of current tail node. (Inherited from SoPath.)
	Append(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. (Inherited from SoPath.)
	ContainsNode(Type)	Returns true if the node type is found anywhere in the path chain. (Inherited from SoPath.)
	ContainsNode(SoNode)	Returns true if the node is found anywhere in the path chain. (Inherited from SoPath.)
	ContainsPath	Returns true if the nodes in the chain in the passed path are contained (in consecutive order) in this path chain. (Inherited from SoPath.)
	Copy	Calls Copy(System.Int32(0), System.Int32(0)). (Inherited from SoPath.)
	Copy(Int32)	Calls Copy(startFromNodeIndex, System.Int32(0)). (Inherited from SoPath.)
	Copy(Int32, Int32)	Creates and returns a new path that is a copy of some or all of this path. (Inherited from SoPath.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FindFork	If the two paths have different head nodes, this returns -1. (Inherited from SoPath.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetHead	Returns the first node in a path chain. (Inherited from SoPath.)
	GetIndex	Returns the index of the i'th node (within its parent) in the chain. (Inherited from SoPath.)
	GetIndexFromTail	Returns the index of the i'th node (within its parent) in the chain, counting backward from the tail node.
	GetInstanceIndex	Returns the index of the instance inside the parent OIV.Inventor.Nodes.SoMultipleInstance, OIV.Inventor.Nodes.SoMultipleCopy or OIV.Inventor.Nodes.SoArray group. (Inherited from SoPath.)
	GetInstanceIndexFromTail	get instance Index from tail
	GetLength	Obsolete. Returns length of path chain (number of nodes).
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNode(Int32)	Returns the i'th node (within its parent) in the chain. (Inherited from SoPath.)
	GetNode(Type, Int32)	Returns the first node and its index, from the head of the given type in the chain. (Inherited from SoPath.)
	GetNodeFromTail	Returns the i'th node (within its parent) in the chain, counting backward from the tail node.
	GetStringName	(Inherited from SoBase.)
	GetTail	Returns the last node in a path chain.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pop	The OIV.Inventor.SoPath.Push(System.Int32) and OIV.Inventor.SoFullPath.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.
	Push	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. (Inherited from SoPath.)
	SetHead	Sets head node (first node in chain). (Inherited from SoPath.)
	SetName	(Inherited from SoBase.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoBase.)
	Truncate	Truncates the path chain, removing all nodes from index start on. (Inherited from SoPath.)

Top

Properties

	Name	Description
	FullPath	This property allows you to retrieve a SoFullPath from an SoPath. (Inherited from SoPath.)
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	Length	Returns length of path chain (number of nodes).

Top

Remarks

This class allows expert users to examine "hidden" children in paths. For example children inside a nodeKit. OIV.Inventor.SoPath allows access from the head node down to the first node with hidden children, but no further. Casting an OIV.Inventor.SoPath to an OIV.Inventor.SoFullPath (which is always guaranteed to be safe) allows you to access hidden children. OIV.Inventor.SoFullPath overrides some OIV.Inventor.SoPath methods to make this possible.

You need OIV.Inventor.SoFullPath, for example, to get the actual tail of the pick path (the geometry node) when picking geometry in node kits. For example:

Copy

SoPath path = ...
SoNode tail = ((SoFullPath)path).GetTail();

NOTE: Applying an action on an OIV.Inventor.SoFullPath may not give the expected result. When applying an action on an OIV.Inventor.SoFullPath, the "hidden" children will not be traversed. If you want to apply an action on all the children in the path, use the following technique:

Copy

SoPath path = ...
SoPath tempPath = ((SoFullPath)path).Copy();
action.Apply( tempPath );

FILE FORMAT/DEFAULT

OIV.Inventor.SoPath {
[head node]
[number of remaining indices]
[index]
&...
[index]
}

Reference

OIV.Inventor Namespace

OIV.Inventor.SoPath