This SoEXTENDER class allows expert users to examine "hidden" children in paths.
More...
|
void | pop () |
| Override methods that normally stop at last public child:
|
|
SoNode * | getTail () const |
| These return the first and last nodes in a path chain.
|
|
SoNode * | getNodeFromTail (int i) const |
| Returns a pointer to the i'th node. Passing 0 for i returns the tail node.
|
|
int | getIndexFromTail (int i) const |
| Returns 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).
|
|
| 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.
|
|
bool | containsNode (const SoNode *node) const |
| Returns TRUE if the node is found anywhere in the path chain.
|
|
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.
|
|
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.
|
|
bool | isRelevantNotification (SoNotList *list) const |
| Returns TRUE if the given notification list involves a change to a node that affects the path.
|
|
void | ref () const |
| Adds and removes a reference to an instance.
|
|
void | unref () const |
|
void | unrefNoDelete () const |
|
void | touch () |
| Marks an instance as modified, simulating a change to it.
|
|
virtual SoType | getTypeId () const =0 |
| Returns the type identifier for a specific instance.
|
|
bool | isOfType (SoType type) const |
| Returns TRUE if this object is of the type specified in type or is derived from that type.
|
|
virtual SbName | getName () const |
| Returns the name of an instance.
|
|
virtual void | setName (const SbName &name) |
| Sets the name of an instance.
|
|
virtual void | startNotify () |
| Initiates notification from an instance.
|
|
virtual void | notify (SoNotList *list) |
| Propagates modification notification through an instance.
|
|
void | addAuditor (void *auditor, SoNotRec::Type type) |
| Adds/removes an auditor to/from list.
|
|
void | removeAuditor (void *auditor, SoNotRec::Type type) |
|
const SoAuditorList & | getAuditors () |
| Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.
|
|
int | getRefCount () const |
| Returns current reference count.
|
|
virtual void | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
| Adds a reference to the instance when writing.
|
|
bool | shouldWrite () |
| Returns TRUE if the instance should be written, based on the write-reference info already accumulated.
|
|
|
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.
|
|
static SoType | getClassTypeId () |
| Returns type identifier for this class.
|
|
static void | initClass () |
| Setup type information.
|
|
static void | incrementCurrentWriteCounter () |
| Increments the current write counter at the start of a write operation.
|
|
static void | decrementCurrentWriteCounter () |
| Decrements the current write counter after a write operation, in some rare cases.
|
|
static void | addName (SoBase *, const char *) |
| Internal methods used to maintain the global name dictionary.
|
|
static void | removeName (SoBase *, const char *) |
|
static SoBase * | getNamedBase (const SbName &, SoType) |
| Helper routines used to get stuff out of nameDict.
|
|
static int | getNamedBases (const SbName &, SoBaseList &, SoType) |
|
static bool | read (SoInput *in, SoBase *&base, SoType expectedType) |
| Reads one instance of some subclass of SoBase.
|
|
static void | setInstancePrefix (const SbString &c) |
| This defaults to "+" and is used when naming nodes that are DEF's and USE'd.
|
|
static bool | traceRefs |
| Turns on/off reference count tracing (for debugging)
|
|
enum | BaseFlags { IS_ENGINE = 1
, IS_GROUP = 2
} |
| This set of enums is used when reading and writing the base. More...
|
|
void | auditPath (bool flag) |
| Allows internal SoTempPath subclass to forego auditor overhead.
|
|
| ~SoPath () |
|
| SoBase () |
| Constructor is protected - this is an abstract class.
|
|
virtual | ~SoBase () |
| Virtual destructor so that subclasses are deleted properly.
|
|
virtual void | destroy () |
| Actually deletes an instance.
|
|
bool | hasMultipleWriteRefs () const |
| Returns TRUE if the instance has multiple write references.
|
|
bool | writeHeader (SoOutput *out, bool isGroup, bool isEngine) const |
| Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.
|
|
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)
|
|
virtual bool | readInstance (SoInput *in, unsigned short flags)=0 |
| Reads stuff into instance of subclass.
|
|
static uint32_t | getCurrentWriteCounter () |
| Returns current write counter.
|
|
SoPath allows access from the head node down to the first node with hidden children, but no further. Casting an SoPath to an SoFullPath (which is always guaranteed to be safe) allows you to get at hidden children. SoFullPath overrides some of the methods defined on paths to make this possible.
Definition at line 299 of file SoPath.h.