sofullpath(3) [debian man page]
SoFullPath(3) Coin SoFullPath(3) NAME
SoFullPath - The SoFullPath class allows examination of hidden children in paths. SoPath allows only access from the head node to the first node with hidden children, but not any further. SYNOPSIS
#include <Inventor/SoFullPath.h> Inherits SoPath. Inherited by SoTempPath. Public Member Functions void pop (void) SoNode * getTail (void) const SoNode * getNodeFromTail (const int index) const int getIndexFromTail (const int index) const int getLength (void) const Additional Inherited Members Detailed Description The SoFullPath class allows examination of hidden children in paths. SoPath allows only access from the head node to the first node with hidden children, but not any further. Since the SoFullPath is derived from SoPath and contains no private data, you can cast SoPath instances to the SoFullPath type. This will allow you to examine hidden children. (Actually, you are not supposed to allocate instances of this class at all. It is only available as an 'extended interface' into the superclass SoPath.) Member Function Documentation void SoFullPath::pop (void) [inline] This method overrides SoPath::pop() to allow clients to get at all the nodes in the path. Reimplemented from SoPath. SoNode * SoFullPath::getTail (void) const This method overrides SoPath::getTail() to allow clients to get the tail node, counting internal path nodes. Reimplemented from SoPath. SoNode * SoFullPath::getNodeFromTail (const intindex) const This method overrides SoPath::getNodeFromTail() to allow clients to get the node positioned index nodes from the tail, counting internal path nodes. Reimplemented from SoPath. int SoFullPath::getIndexFromTail (const intindex) const This method overrides SoPath::getIndexFromTail() to allow clients to get the child index number for nodes based on their position from the tail, counting hidden nodes. Reimplemented from SoPath. int SoFullPath::getLength (void) const This method returns the length of the path, counting hidden nodes also. Reimplemented from SoPath. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoFullPath(3)
Check Out this Related Man Page
SoLightPath(3) Coin SoLightPath(3) NAME
SoLightPath - The SoLightPath class is a light version of SoPath. SoLightPath can be used if you only need a temporary path, and don't want the overhead that comes with an SoPath (ref, unref, auditing etc). SYNOPSIS
#include <Inventor/misc/SoLightPath.h> Public Member Functions SoLightPath (SoNode *node, const int approxlength) SoLightPath (const int approxlength) ~SoLightPath () void setHead (SoNode *const node) void append (const int childindex) void push (const int childindex) void pop (void) void setTail (const int childindex) SoNode * getTail (void) const SoNode * getHead (void) const SoNode * getNode (const int index) const int getIndex (const int index) const int getFullLength () const void truncate (const int startindex) void makeTempPath (SoTempPath *path) const Detailed Description The SoLightPath class is a light version of SoPath. SoLightPath can be used if you only need a temporary path, and don't want the overhead that comes with an SoPath (ref, unref, auditing etc). It is your responsibility to make sure the path is valid before using it. Constructor &; Destructor Documentation SoLightPath::SoLightPath (SoNode *headnodeptr, const intapproxlength) A constructor. Supply the head node and the approximate length of the path. SoLightPath::SoLightPath (const intapproxlength) A constructor. Supply the appriximate length of the path. SoLightPath::~SoLightPath () Destructor. Member Function Documentation void SoLightPath::setHead (SoNode *constnode) Sets head of path. Truncates path to length 1. void SoLightPath::append (const intchildindex) Appends a childindex to the path. void SoLightPath::push (const intchildindex) Same as append(). void SoLightPath::pop (void) Pops off the last child. void SoLightPath::setTail (const intchildindex) Sets the tail of the path. SoNode * SoLightPath::getTail (void) const Returns the tail node of the path. Uses getNode(). SoNode * SoLightPath::getHead (void) const Returns the head node. SoNode * SoLightPath::getNode (const intindex) const Returns the indexth node in path. int SoLightPath::getIndex (const intindex) const Returns the child index of the indexth node in the path. int SoLightPath::getFullLength (void) const Returns the length of the path. void SoLightPath::truncate (const intstartindex) Truncates the path from startindex. void SoLightPath::makeTempPath (SoTempPath *path) const Updates path to be the same path as this path. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoLightPath(3)