Path that points to a list of hierarchical nodes. More...
#include <Inventor/SoPath.h>
Public Member Functions | |
| SoPath () | |
| Constructs an empty path. More... | |
| SoPath (int approxLength) | |
| Constructs a path with a hint to length (number of nodes in chain). More... | |
| SoPath (SoNode *node) | |
| Constructs a path and sets the head node to the given node. More... | |
| void | setHead (SoNode *node) |
| Sets head node (first node in chain). More... | |
| void | append (int childIndex) |
Adds node to end of chain; the node is the childIndex'th child of the current tail node. More... | |
| void | append (SoNode *childNode) |
Adds node to end of chain; uses the first occurrence of childNode as child of current tail node. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| SoNode * | getHead () const |
| These return the first and last nodes in a path chain. More... | |
| SoNode * | getTail () const |
| These return the first and last nodes in a path chain. More... | |
| SoNode * | getNode (int i) const |
Returns a pointer to the i'th node in the chain. More... | |
| SoNode * | getNodeFromTail (int i) const |
Returns a pointer to the i'th node. More... | |
| int | getIndex (int i) const |
Return the index of the i'th node (within its parent) in the chain. More... | |
| 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. More... | |
| int | getLength () const |
| Returns length of path chain (number of nodes). More... | |
| void | truncate (int start) |
Truncates the path chain, removing all nodes from index start on. More... | |
| bool | containsNode (const SoNode *node) const |
| Returns TRUE if the node is found anywhere in the path chain. More... | |
| bool | 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. More... | |
| int | findFork (const SoPath *path) const |
| If the two paths have different head nodes, this returns -1. More... | |
| 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. More... | |
| virtual SoType | getTypeId () const |
| Returns type identifier for path instance. More... | |
| void | insertIndex (SoNode *parent, int newIndex) |
| This is called when a node in the path chain has a child added. More... | |
| void | removeIndex (SoNode *parent, int oldIndex) |
| This is called when a node in the path chain has a child removed. More... | |
| void | replaceIndex (SoNode *parent, int index, SoNode *newChild) |
| This is called when a node in the path chain replaces a child. More... | |
| virtual void | write (SoWriteAction *writeAction) const |
| Writes path using given write action. More... | |
| bool | isRelevantNotification (SoNotList *list) const |
| Returns TRUE if the given notification list involves a change to a node that affects the path. More... | |
 Public Member Functions inherited from SoBase | |
| void | ref () const |
| Adds and removes a reference to an instance. More... | |
| void | unref () const |
| void | unrefNoDelete () const |
| void | touch () |
| Marks an instance as modified, simulating a change to it. More... | |
| bool | isOfType (SoType type) const |
Returns TRUE if this object is of the type specified in type or is derived from that type. More... | |
| virtual SbName | getName () const |
| Returns the name of an instance. More... | |
| virtual void | setName (const SbName &name) |
| Sets the name of an instance. More... | |
| virtual void | startNotify () |
| Initiates notification from an instance. More... | |
| virtual void | notify (SoNotList *list) |
| Propagates modification notification through an instance. More... | |
| void | addAuditor (void *auditor, SoNotRec::Type type) |
| Adds/removes an auditor to/from list. More... | |
| void | removeAuditor (void *auditor, SoNotRec::Type type) |
| const SoAuditorList & | getAuditors () |
| Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More... | |
| int | getRefCount () const |
| Returns current reference count. More... | |
| virtual void | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
| Adds a reference to the instance when writing. More... | |
| bool | shouldWrite () |
| Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More... | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| Returns type identifier for SoPath class. More... | |
| static SoPath * | getByName (const SbName &name) |
| static int | getByName (const SbName &name, SoPathList &list) |
| These methods lookup and return paths with a given name. More... | |
| static void | initClass () |
| Initializes path class. More... | |
| Static Public Member Functions inherited from SoBase | |
| static SoType | getClassTypeId () |
| Returns type identifier for this class. More... | |
| static void | initClass () |
| Setup type information. More... | |
| static void | incrementCurrentWriteCounter () |
| Increments the current write counter at the start of a write operation. More... | |
| static void | decrementCurrentWriteCounter () |
| Decrements the current write counter after a write operation, in some rare cases. More... | |
| static void | addName (SoBase *, const char *) |
| Internal methods used to maintain the global name dictionary. More... | |
| static void | removeName (SoBase *, const char *) |
| static SoBase * | getNamedBase (const SbName &, SoType) |
| Helper routines used to get stuff out of nameDict. More... | |
| static int | getNamedBases (const SbName &, SoBaseList &, SoType) |
| static bool | read (SoInput *in, SoBase *&base, SoType expectedType) |
| Reads one instance of some subclass of SoBase. More... | |
| static void | setInstancePrefix (const SbString &c) |
| This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More... | |
Protected Member Functions | |
| void | auditPath (bool flag) |
| Allows internal SoTempPath subclass to forego auditor overhead. More... | |
| ~SoPath () | |
| Protected Member Functions inherited from SoBase | |
| SoBase () | |
| Constructor is protected - this is an abstract class. More... | |
| virtual | ~SoBase () |
| Virtual destructor so that subclasses are deleted properly. More... | |
| virtual void | destroy () |
| Actually deletes an instance. More... | |
| bool | hasMultipleWriteRefs () const |
| Returns TRUE if the instance has multiple write references. More... | |
| bool | writeHeader (SoOutput *out, bool isGroup, bool isEngine) const |
| Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More... | |
| void | writeFooter (SoOutput *out) const |
| virtual const char * | getFileFormatName () const |
| Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned) More... | |
Friends | |
| class | SoFullPath |
| class | SoTempPath |
| class | SoAction |
| INVENTOR_API bool | operator== (const SoPath &p1, const SoPath &p2) |
| Comparison operator: returns TRUE if all nodes in paths are identical. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from SoBase | |
| static bool | traceRefs |
| Turns on/off reference count tracing (for debugging) More... | |
| Protected Types inherited from SoBase | |
| enum | BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 } |
| This set of enums is used when reading and writing the base. More... | |
| Static Protected Member Functions inherited from SoBase | |
| static uint32_t | getCurrentWriteCounter () |
| Returns current write counter. More... | |
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() [1/3]
| SoPath::SoPath | ( | ) |
◆ SoPath() [2/3]
| SoPath::SoPath | ( | int | approxLength | ) |
◆ SoPath() [3/3]
| SoPath::SoPath | ( | SoNode * | node | ) |
◆ ~SoPath()
|
protected |
Member Function Documentation
◆ append() [1/3]
| void SoPath::append | ( | const SoPath * | fromPath | ) |
◆ append() [2/3]
| void SoPath::append | ( | int | childIndex | ) |
◆ append() [3/3]
| void SoPath::append | ( | SoNode * | childNode | ) |
If the path is empty, this is equivalent to setHead(childNode).
◆ auditPath()
◆ containsNode()
| bool SoPath::containsNode | ( | const SoNode * | node | ) | const |
◆ containsPath()
| bool SoPath::containsPath | ( | const SoPath * | path | ) | const |
◆ copy()
| 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.
◆ findFork()
| 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.
◆ getByName() [1/2]
◆ getByName() [2/2]
|
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.
◆ getClassTypeId()
◆ getHead()
◆ getIndex()
◆ getIndexFromTail()
|
inline |
◆ getLength()
| int SoPath::getLength | ( | ) | const |
◆ getNode()
|
inline |
◆ getNodeFromTail()
|
inline |
◆ getTail()
◆ getTypeId()
◆ initClass()
|
static |
◆ insertIndex()
| void SoPath::insertIndex | ( | SoNode * | parent, |
| int | newIndex | ||
| ) |
The passed index is the index of the new child
◆ isRelevantNotification()
| bool SoPath::isRelevantNotification | ( | SoNotList * | list | ) | const |
It is assumed that the last (most recent) node in the list is the head node of the path.
◆ pop()
◆ push()
◆ removeIndex()
| void SoPath::removeIndex | ( | SoNode * | parent, |
| int | oldIndex | ||
| ) |
The passed index is the index of the child to be removed
◆ replaceIndex()
The passed index is the index of the child to be removed
◆ setHead()
| void SoPath::setHead | ( | SoNode * | node | ) |
◆ truncate()
| void SoPath::truncate | ( | int | start | ) |
Calling truncate(0) empties the path entirely.
◆ write()
|
virtual |
Friends And Related Function Documentation
◆ operator==
|
friend |
◆ SoAction
◆ SoFullPath
|
friend |
◆ SoTempPath
|
friend |
The documentation for this class was generated from the following file:
- /home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/SoPath.h
