Path that points to a list of hierarchical nodes. More...
#include <Inventor/SoPath.h>
Public Member Functions | |
| SoPath () | |
| Constructs an empty path. | |
| SoPath (int approxLength) | |
| Constructs a path with a hint to length (number of nodes in chain). | |
| SoPath (SoNode *node) | |
| Constructs a path and sets the head node to the given node. | |
| void | setHead (SoNode *node) |
| Sets head node (first node in chain). | |
| void | append (int childIndex) |
Adds node to end of chain; the node is the childIndex'th child of the current tail node. | |
| void | append (SoNode *childNode) |
Adds node to end of chain; uses the first occurrence of childNode as child of current tail node. | |
| void | append (const SoPath *fromPath) |
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. | |
| void | push (int childIndex) |
| These 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. | |
| void | pop () |
| These 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. | |
| SoNode * | getHead () const |
| These return the first and last nodes in a path chain. | |
| SoNode * | getTail () const |
| These return the first and last nodes in a path chain. | |
| SoNode * | getNode (int i) const |
Returns a pointer to the i'th node in the chain. | |
| SoNode * | getNodeFromTail (int i) const |
Returns a pointer to the i'th node. | |
| int | getIndex (int i) const |
Return the index of the i'th node (within its parent) in the chain. | |
| int | getIndexFromTail (int i) const |
Return the index of the i'th node (within its parent) in the chain, counting backward from the tail node. | |
| int | getLength () const |
| Returns length of path chain (number of nodes). | |
| void | truncate (int start) |
Truncates the path chain, removing all nodes from index start on. | |
| SbBool | containsNode (const SoNode *node) const |
| Returns TRUE if the node is found anywhere in the path chain. | |
| SbBool | containsPath (const SoPath *path) const |
| Returns TRUE if the nodes in the chain in the passed path are contained (in consecutive order) in this path chain. | |
| int | findFork (const SoPath *path) const |
| If the two paths have different head nodes, this returns -1. | |
| SoPath * | copy (int startFromNodeIndex=0, int numNodes=0) const |
| Creates and returns a new path that is a copy of some or all of this path. | |
| virtual SoType | getTypeId () const |
| Returns type identifier for path instance. | |
| void | insertIndex (SoNode *parent, int newIndex) |
| This is called when a node in the path chain has a child added. | |
| void | removeIndex (SoNode *parent, int oldIndex) |
| This is called when a node in the path chain has a child removed. | |
| void | replaceIndex (SoNode *parent, int index, SoNode *newChild) |
| This is called when a node in the path chain replaces a child. | |
| virtual void | write (SoWriteAction *writeAction) const |
| Writes path using given write action. | |
| SbBool | isRelevantNotification (SoNotList *list) const |
| Returns TRUE if the given notification list involves a change to a node that affects the path. | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| Returns type identifier for SoPath class. | |
| static SoPath * | getByName (const SbName &name) |
| static int | getByName (const SbName &name, SoPathList &list) |
| These methods lookup and return paths with a given name. | |
| static void | initClass () |
| Initializes path class. | |
Protected Member Functions | |
| void | auditPath (SbBool flag) |
| Allows internal SoTempPath subclass to forego auditor overhead. | |
| ~SoPath () | |
Friends | |
| class | SoFullPath |
| class | SoTempPath |
| class | SoAction |
| INVENTOR_API int | operator== (const SoPath &p1, const SoPath &p2) |
| Comparison operator: returns TRUE if all nodes in paths are identical. | |
Detailed Description
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 of a node when both the parent and the child are in the chain replaces the child in the chain with the new child, truncating the path below the new child.
Note that only public children of nodes are accessible from an SoPath. Nodes like node kits that limit access to their children may provide other ways to get more information, such as by using the SoNodeKitPath class.
- See Also
Constructor & Destructor Documentation
| SoPath::SoPath | ( | ) |
| SoPath::SoPath | ( | int | approxLength | ) |
| SoPath::SoPath | ( | SoNode * | node | ) |
| SoPath::~SoPath | ( | ) | [protected] |
Member Function Documentation
| void SoPath::append | ( | int | childIndex | ) |
| void SoPath::append | ( | const SoPath * | fromPath | ) |
| void SoPath::append | ( | SoNode * | childNode | ) |
If the path is empty, this is equivalent to setHead(childNode).
| SoPath* SoPath::copy | ( | int | startFromNodeIndex = 0, |
| int | numNodes = 0 |
||
| ) | const |
Copying starts at the given index (default is 0, which is the head node). A numNodes of 0 (the default) means copy all nodes from the starting index to the end. Returns NULL on error.
| int SoPath::findFork | ( | const SoPath * | path | ) | const |
Otherwise, it returns the path chain index of the last node (starting at the head) that is the same for both paths.
| static int SoPath::getByName | ( | const SbName & | name, |
| SoPathList & | list | ||
| ) | [static] |
Paths are named by calling their setName() method (defined by the SoBase class). The first form returns the last path that was given that name, either by setName() or by reading in a named path from a file. If there is no path with the given name, NULL will be returned. The second form appends all paths with the given name to the given path list and returns the number of paths that were added. If there are no paths with the given name, zero will be returned and nothing will be added to the list.
| static SoType SoPath::getClassTypeId | ( | ) | [inline, static] |
| int SoPath::getIndexFromTail | ( | int | i | ) | const [inline] |
Passing 0 for i returns the tail node's index.
Reimplemented in SoFullPath.
| int SoPath::getLength | ( | ) | const |
Reimplemented in SoFullPath, and SoNodeKitPath.
| SoNode* SoPath::getNode | ( | int | i | ) | const [inline] |
Calling getNode(0) is equivalent to calling getHead().
Reimplemented in SoNodeKitPath.
| SoNode* SoPath::getNodeFromTail | ( | int | i | ) | const [inline] |
Passing 0 for i returns the tail node.
Reimplemented in SoFullPath, and SoNodeKitPath.
| SoNode* SoPath::getTail | ( | ) | const [inline] |
Reimplemented in SoFullPath, and SoNodeKitPath.
| static void SoPath::initClass | ( | ) | [static] |
Reimplemented from SoBase.
| void SoPath::insertIndex | ( | SoNode * | parent, |
| int | newIndex | ||
| ) |
The passed index is the index of the new child
It is assumed that the last (most recent) node in the list is the head node of the path.
| void SoPath::pop | ( | ) | [inline] |
Reimplemented in SoFullPath, and SoNodeKitPath.
| void SoPath::removeIndex | ( | SoNode * | parent, |
| int | oldIndex | ||
| ) |
The passed index is the index of the child to be removed
The passed index is the index of the child to be removed
| void SoPath::setHead | ( | SoNode * | node | ) |
| void SoPath::truncate | ( | int | start | ) |
Calling truncate(0) empties the path entirely.
Reimplemented in SoNodeKitPath.
Referenced by SoFullPath::pop().
| virtual void SoPath::write | ( | SoWriteAction * | writeAction | ) | const [virtual] |
Friends And Related Function Documentation
friend class SoFullPath [friend] |
friend class SoTempPath [friend] |
Reimplemented in SoFullPath.
The documentation for this class was generated from the following file:
- MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/SoPath.h
