Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sonodekitpath(3) [debian man page]

SoNodeKitPath(3)						       Coin							  SoNodeKitPath(3)

NAME

       SoNodeKitPath -

       The SoNodeKitPath class is a path that contains only nodekit nodes.

       All other nodes are hidden from the user.

SYNOPSIS

       #include <Inventor/SoNodeKitPath.h>

       Inherits SoPath.

   Public Member Functions
       int getLength (void) const
       SoNode * getTail (void) const
       SoNode * getNode (const int idx) const
       SoNode * getNodeFromTail (const int idx) const
       void truncate (const int length)
       void pop (void)
       void append (SoBaseKit *childKit)
       void append (const SoNodeKitPath *fromPath)
       SbBool containsNode (SoBaseKit *node) const
       int findFork (const SoNodeKitPath *path) const

   Protected Member Functions
       SoNodeKitPath (const int approxLength)
       virtual ~SoNodeKitPath ()

   Friends
       int operator== (const SoNodeKitPath &p1, const SoNodeKitPath &p2)

   Additional Inherited Members
Detailed Description
       The SoNodeKitPath class is a path that contains only nodekit nodes.

       All other nodes are hidden from the user.

Constructor &; Destructor Documentation
   SoNodeKitPath::SoNodeKitPath (const intapproxLength) [protected]
       A constructor.

   SoNodeKitPath::~SoNodeKitPath () [protected],  [virtual]
       The destructor.

Member Function Documentation
   int SoNodeKitPath::getLength (void) const
       Returns the length of the path (the number of nodekit nodes).

       Reimplemented from SoPath.

   SoNode * SoNodeKitPath::getTail (void) const
       Returns the tail of the path (the last nodekit in the path).

       Reimplemented from SoPath.

   SoNode * SoNodeKitPath::getNode (const intidx) const
       Returns nodekit number idx in path.

       Reimplemented from SoPath.

   SoNode * SoNodeKitPath::getNodeFromTail (const intidx) const
       Returns nodekit number idx in the path, from the tail.

       Reimplemented from SoPath.

   void SoNodeKitPath::truncate (const intlength)
       Truncates the path at nodekit number length.

       Reimplemented from SoPath.

   void SoNodeKitPath::pop (void)
       Pops off the last nodekit (truncates at last tail).

       Reimplemented from SoPath.

   void SoNodeKitPath::append (SoBaseKit *childKit)
       Appends childKit to the path. childKit should be a part in the tail nodekit of this path. In effect, the path from the tail to first
       occurrance of childKit will be appended to the path.

   void SoNodeKitPath::append (const SoNodeKitPath *fromPath)
       Appends the nodekit path to this path. Head of fromPath must be a part in the current tail.

   SbBool SoNodeKitPath::containsNode (SoBaseKit *node) const
       Returns TRUE if node is in this path.

   int SoNodeKitPath::findFork (const SoNodeKitPath *path) const
       Returns the index of last common nodekit, or -1 if head node differs.

Friends And Related Function Documentation
   int operator== (const SoNodeKitPath &p1, const SoNodeKitPath &p2) [friend]
       Returns TRUE if paths are equal, FALSE otherwise.

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

Version 3.1.3							  Wed May 23 2012						  SoNodeKitPath(3)

Check Out this Related 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)
Man Page