solightpath(3) [debian 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)

Check Out this Related Man Page

SoPathList(3)							       Coin							     SoPathList(3)

NAME

       SoPathList -

       The SoPathList class is a container for pointers to SoPath objects.

       As this class inherits SoBaseList, referencing and dereferencing will default be done on the objects at append(), remove(), insert() etc.

SYNOPSIS

       #include <Inventor/lists/SoPathList.h>

       Inherits SoBaseList.

   Public Member Functions
       SoPathList (void)
       SoPathList (const int size)
       SoPathList (const SoPathList &pl)
       ~SoPathList ()
       void append (SoPath *const path)
       SoPath * operator[] (const int i) const
       SoPathList & operator= (const SoPathList &pl)
       int findPath (const SoPath &path) const
       void sort (void)
       void uniquify (void)

Detailed Description
       The SoPathList class is a container for pointers to SoPath objects.

       As this class inherits SoBaseList, referencing and dereferencing will default be done on the objects at append(), remove(), insert() etc.

Constructor &; Destructor Documentation
   SoPathList::SoPathList (void)
       Default constructor.

   SoPathList::SoPathList (const intsize)
       Constructor with a hint about the number of elements the list will hold.

       See also:
	   SoBaseList::SoBaseList(const int)

   SoPathList::SoPathList (const SoPathList &pl)
       Copy constructor.

       Does a shallow copy of the SoPath pointer values, but updates reference count.

       See also:
	   SoBaseList::SoBaseList(const SoBaseList &)

   SoPathList::~SoPathList ()
       Destructor.

       See also:
	   SoBaseList::~SoBaseList()

Member Function Documentation
   void SoPathList::append (SoPath *constpath)
       Append ptr to the list.

       See also:
	   SoBaseList::append()

   SoPath * SoPathList::operator[] (const inti) const
       Return node pointer at index i.

       See also:
	   SoBaseList::operator[]()

       Reimplemented from SoBaseList.

   SoPathList & SoPathList::operator= (const SoPathList &pl)
       Shallow copy of contents of list pl to this list.

       See also:
	   SoBaseList::operator=()

   int SoPathList::findPath (const SoPath &path) const
       Find and return index of first item equal to path.

   void SoPathList::sort (void)
       Sort paths in list according to how early they are run into when traversing the scene graph.

   void SoPathList::uniquify (void)
       Removes identical paths and paths that go through the tail of another path.

       Note that this method assumes the list to be in a sorted order.

       See also:
	   sort()

Author
       Generated automatically by Doxygen for Coin from the source code.

Version 3.1.3							  Wed May 23 2012						     SoPathList(3)

Linux and UNIX Man Pages

solightpath(3) [debian man page]

Check Out this Related Man Page