logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SoNodeKitPath — path that points to a list of hierarchical nodekits

Description

SoNodeKitPath  is  a subclass of SoPath that lets you look at nodekits below the top nodekit in the path.
       Since nodekits have hidden children, when you call getTail() on a regular path, it returns  the  top-most
       nodekit  on  the path.  This occurs even though the path might contain extra internal information leading
       to a node far deeper in the scene graph. For example, when picking an object inside  an  SoSceneKit,  the
       regular path would end at the scenekit.  But a nodekit path would continue further down listing the other
       nodekits below it in the path.

       Intermediary (private) nodes between nodekits are not included in the nodekit path.

       Note  that  there  is no constructor for an SoNodeKitPath, so you can not create one. Rather, you cast an
       (SoPath*) into an (SoNodeKitPath*), which returns nodekit-style values from all the same  questions  as
       SoPath.

       Also,  some  methods  of  SoPath  may not be called on an SoNodeKitPath. Any methods which take a regular
       SoNode as an argument (except for setHead()) are not accessible, and replaced by  methods  that  take  an
       SoBaseKit  as  an  argument  instead. Methods which allow the programmer to refer to the child index of a
       node beneath its parent are also inaccessible; since a SoNodeKitPath only shows nodekits  and  hides  any
       private parts, successive nodekits in the path may not actually be parent and child.

Inherits From

       SoBase > SoPath > SoNodeKitPath

Methods

voidappend(SoBaseKit*childKit)
          Adds  childKit  to  end  of  chain;  uses  first  occurrence of childKit as a part within current last
          nodekit. If the path is empty, this is equivalent to setHead(childKit).

     voidappend(constSoNodeKitPath*fromPath)
          Adds all nodekits 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.

     voidpop()
          Pops the last nodekit off the end of the path.

     SoNode*getTail()const
          Return  the  last  nodekit in a path chain. Note that getHead() is not redefined from SoPath, since an
          SoNodeKitPath need not begin with a nodekit; the restriction is placed only on successive nodes on the
          path.

     SoNode*getNode(inti)const
          Returns a pointer to the i'th node in the nodekit path.

     SoNode*getNodeFromTail(inti)const
          Returns a pointer to the i'th nodekit in the chain, counting backward from the tail nodekit. Passing 0
          for i returns the tail nodekit.

     intgetLength()const
          Returns length of path chain (number of nodekits).

     voidtruncate(intstart)
          Truncates the path chain, removing all nodes from index start on.  Calling  truncate(0)   empties  the
          path entirely.

     SbBoolcontainsNode(constSoNodeKit*nodeKit)const
          Returns TRUE if the passed nodekit is found anywhere in the path chain.

     intfindFork(constSoNodeKitPath*path)const
          If  the  two  paths  have  different head nodes, this returns -1. Otherwise, it returns the path chain
          index of the last nodekit (starting at the head) that is the same for both paths.

     friendintoperator==(constSoNodeKitPath&p1,constSoNodeKitPath&p2)
          Returns TRUE if all node pointers in the two nodekit path chains are equal.

Name

       SoNodeKitPath — path that points to a list of hierarchical nodekits

See Also

SoBaseKit,SoPath,SoRayPickAction,SoSearchActionSoNodeKitPath(3IV)()

Synopsis

#include<Inventor/SoNodeKitPath.h>

          Methods from class SoNodeKitPath:

     voidappend(SoBaseKit*childKit)voidappend(constSoNodeKitPath*fromPath)voidpop()SoNode*getTail()constSoNode*getNode(inti)constSoNode*getNodeFromTail(inti)constintgetLength()constvoidtruncate(intstart)SbBoolcontainsNode(constSoNodeKit*nodeKit)constintfindFork(constSoNodeKitPath*path)constfriendintoperator==(constSoNodeKitPath&p1,constSoNodeKitPath&p2)

          Methods from class SoPath:

     voidsetHead(SoNode*node)SoNode*getHead()constSbBoolcontainsPath(constSoPath*path)constSoPath*copy(intstartFromNodeIndex=0,intnumNodes=0)conststaticSoPath*getByName(constSbName&name)staticintgetByName(constSbName&name,SoPathList&list)

          Methods from class SoBase:

     voidref()voidunref()constvoidunrefNoDelete()constvoidtouch()staticSoTypegetClassTypeId()virtualSoTypegetTypeId()constSbBoolisOfType(SoTypetype)constvirtualvoidsetName(constSbName&name)virtualSbNamegetName()const

See Also