SoPath

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.misc.SoBase
  - - com.openinventor.inventor.SoPath

All Implemented Interfaces:

SafeDisposable

Direct Known Subclasses:

SoFullPath
```
public class SoPath
extends SoBase
```
A path represents a scene graph or subgraph. It contains a list of pointers to nodes forming a chain from some root to some descendent. Each node in the chain is a child of the previous node. Paths are used to refer to some object in a scene graph precisely and unambiguously, even if there are many instances of the object. Therefore, paths are returned by both the SoRayPickAction and SoSearchAction.

When an action is applied to a path, only the nodes in the subgraph defined by the path are traversed. These include : the nodes in the path chain, all nodes (if any) below the last node in the path, and all nodes whose effects are inherited by any of these nodes.

SoPath attempts to maintain consistency of paths even when the structure of the scene graph changes. For example, removing a child from its parent when both are in a path chain cuts the path chain at that point, leaving the top part intact. Removing the node to the left of a node in a path adjusts the index for that node. Replacing a child in the chain with the new child, truncating the path below the new child.

Since nodekits hide their children, there are 3 ways to view the differents nodes contained by the path
- the regular path (field regular) do not contains hidden childrens of nodekits
- the nodekit path (field nodekit) contains only the nodekits
- the full path (field full) contains all nodes (public and hidden)
Thus, for instance,
- full.getLength() returns the number of public and hidden nodes in the path
- nodekit.getLength() returns the number of nodekits in the path
- regular.getLength() returns the number of nodes up to the first nodekit in the path
To build a new SoPath that exposes all the nodes (both visible and hidden) in a given path, for example to apply an action to hidden children, do this:

Nested Class Summary
- Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
  Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field and Description
`SoGeneralPath`	`full` access to all nodes (public and hidden) in the path
`SoNodekitPath`	`nodekit` access only to nodekits in the path
`SoGeneralPath`	`regular` access to all public nodes in the path except hidden children in nodekits.

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description

SoPath()

SoPath(int approxLength)

SoPath(SoNode node)

Constructors
Constructor and Description
`SoPath()`
`SoPath(int approxLength)`
`SoPath(SoNode node)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`append(int childIndex)` Deprecated. replaced by regular.append(int)
`void`	`append(SoNode childNode)` Deprecated. replaced by regular.append(SoNode)
`void`	`append(SoPath fromPath)` Deprecated. replaced by regular.append(SoPath)
`boolean`	`containsNode(SoNode node)` Deprecated. replaced by regular.containsNode
`boolean`	`containsPath(SoPath path)` Deprecated. replaced by regular.containsPath
`SoPath`	`copy()` Deprecated. replaced by regular.copy(0)
`SoPath`	`copy(int startFromNodeIndex)` Deprecated. replaced by regular.copy(int)
`SoPath`	`copy(int startFromNodeIndex, int numNodes)` Deprecated. replaced by regular.copy(int,int)
`boolean`	`equals(java.lang.Object obj)` Compares this object against the specified object.
`int`	`findFork(SoPath path)` Deprecated. replaced by regular.findFork
`static SoPath[]`	`getAllByName(java.lang.String name)` Returns an array of all path with the given name.
`static SoPath`	`getByName(java.lang.String name)` Returns the last path that was given the name, either by `SoBase.setName(java.lang.String)` or by reading in a named path from a file.
`SoNode`	`getHead()` Deprecated. replaced by regular.getHead
`int`	`getIndex(int i)` Deprecated. replaced by regular.getIndex
`int`	`getIndexFromTail(int i)` Deprecated. replaced by regular.getIndexFromTail
`int`	`getLength()` Deprecated. replaced by regular.getLength
`SoNode`	`getNode(int i)` Deprecated. replaced by regular.getNode
`SoNode`	`getNodeFromTail(int i)` Deprecated. replaced by regular.getNodeFromTail
`SoNode`	`getTail()` Deprecated. replaced by regular.getTail
`static boolean`	`opeq(SoPath p1, SoPath p2)` Deprecated. use equals instead
`void`	`pop()` Deprecated. replaced by regular.pop
`void`	`push(int childIndex)` Deprecated. replaced by regular.push
`void`	`setHead(SoNode node)` Deprecated. replaced by regular.setHead
`void`	`truncate(int start)` Deprecated. replaced by regular.truncate

Methods inherited from class com.openinventor.inventor.misc.SoBase
dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable, touch

Methods inherited from class com.openinventor.inventor.Inventor
getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - full
```
public SoGeneralPath full
```
    access to all nodes (public and hidden) in the path
  - regular
```
public SoGeneralPath regular
```
    access to all public nodes in the path except hidden children in nodekits.
  - nodekit
```
public SoNodekitPath nodekit
```
    access only to nodekits in the path
- Constructor Detail
  - SoPath
```
public SoPath()
```
  - SoPath
```
public SoPath(SoNode node)
```
  - SoPath
```
public SoPath(int approxLength)
```
- Method Detail
  - getByName
```
public static SoPath getByName(java.lang.String name)
```
    Returns the last path that was given the name, either by SoBase.setName(java.lang.String) or by reading in a named path from a file. If there is no path with the given name, null will be returned.
  - getAllByName
```
public static SoPath[] getAllByName(java.lang.String name)
```
    Returns an array of all path with the given name. Paths are named by calling their SoBase.setName(java.lang.String).
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares this object against the specified object. The result is true if and only if the argument is not null, is an instance of this's class and has the same value(s).
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the object to compare with.
    
    Returns:
    
    true if the objects are the same; false otherwise.
  - setHead
```
public void setHead(SoNode node)
```
    Deprecated. replaced by regular.setHead
  - append
```
public void append(int childIndex)
```
    Deprecated. replaced by regular.append(int)
  - append
```
public void append(SoNode childNode)
```
    Deprecated. replaced by regular.append(SoNode)
  - append
```
public void append(SoPath fromPath)
```
    Deprecated. replaced by regular.append(SoPath)
  - push
```
public void push(int childIndex)
```
    Deprecated. replaced by regular.push
  - pop
```
public void pop()
```
    Deprecated. replaced by regular.pop
  - getHead
```
public SoNode getHead()
```
    Deprecated. replaced by regular.getHead
  - getTail
```
public SoNode getTail()
```
    Deprecated. replaced by regular.getTail
  - getNode
```
public SoNode getNode(int i)
```
    Deprecated. replaced by regular.getNode
  - getNodeFromTail
```
public SoNode getNodeFromTail(int i)
```
    Deprecated. replaced by regular.getNodeFromTail
  - getIndex
```
public int getIndex(int i)
```
    Deprecated. replaced by regular.getIndex
  - getIndexFromTail
```
public int getIndexFromTail(int i)
```
    Deprecated. replaced by regular.getIndexFromTail
  - getLength
```
public int getLength()
```
    Deprecated. replaced by regular.getLength
  - truncate
```
public void truncate(int start)
```
    Deprecated. replaced by regular.truncate
  - containsNode
```
public boolean containsNode(SoNode node)
```
    Deprecated. replaced by regular.containsNode
  - containsPath
```
public boolean containsPath(SoPath path)
```
    Deprecated. replaced by regular.containsPath
  - findFork
```
public int findFork(SoPath path)
```
    Deprecated. replaced by regular.findFork
  - copy
```
public SoPath copy()
```
    Deprecated. replaced by regular.copy(0)
  - copy
```
public SoPath copy(int startFromNodeIndex)
```
    Deprecated. replaced by regular.copy(int)
  - copy
```
public SoPath copy(int startFromNodeIndex,
                   int numNodes)
```
    Deprecated. replaced by regular.copy(int,int)
  - opeq
```
public static boolean opeq(SoPath p1,
                           SoPath p2)
```
    Deprecated. use equals instead

Class SoPath

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

Methods inherited from class com.openinventor.inventor.misc.SoBase

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

full

regular

nodekit

Constructor Detail

SoPath

SoPath

SoPath

Method Detail

getByName

getAllByName

equals

setHead

append

append

append

push

pop

getHead

getTail

getNode

getNodeFromTail

getIndex

getIndexFromTail

getLength

truncate

containsNode

containsPath

findFork

copy

copy

copy

opeq