Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Protected Member Functions | Friends
SoNodeKitPath Class Reference

The SoNodeKitPath class is a path that contains only nodekit nodes.All other nodes are hidden from the user. More...

#include <Inventor/SoNodeKitPath.h>

Inheritance diagram for SoNodeKitPath:
SoPath SoBase

List of all members.

Public Member Functions

int getLength (void) const
SoNodegetTail (void) const
SoNodegetNode (const int idx) const
SoNodegetNodeFromTail (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
- Public Member Functions inherited from SoPath
 SoPath (const int approxlength=4)
 SoPath (SoNode *const head)
 SoPath (const SoPath &rhs)
SoPathoperator= (const SoPath &rhs)
virtual SoType getTypeId (void) const
void setHead (SoNode *const head)
SoNodegetHead (void) const
int findFork (const SoPath *const path) const
int findNode (const SoNode *const node) const
SbBool containsNode (const SoNode *const node) const
SbBool containsPath (const SoPath *const path) const
SoPathcopy (const int startfromnodeindex=0, int numnodes=0) const
SbBool isRelevantNotification (SoNotList *const l) const
virtual void write (SoWriteAction *action)
- Public Member Functions inherited from SoBase
void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorListgetAuditors (void) const
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool shouldWrite (void)
void assertAlive (void) const

Protected Member Functions

 SoNodeKitPath (const int approxLength)
virtual ~SoNodeKitPath ()
- Protected Member Functions inherited from SoPath
virtual ~SoPath ()
void auditPath (const SbBool flag)
- Protected Member Functions inherited from SoBase
 SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

Friends

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

Additional Inherited Members

- Static Public Member Functions inherited from SoPath
static void initClass (void)
static SoType getClassTypeId (void)
static SoPathgetByName (const SbName name)
static int getByName (const SbName name, SoPathList &l)
- Static Public Member Functions inherited from SoBase
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBasegetNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *in)

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 int  approxLength)
protected
SoNodeKitPath::~SoNodeKitPath ( )
protectedvirtual

The destructor.


Member Function Documentation

int SoNodeKitPath::getLength ( void  ) const

Returns the length of the path (the number of nodekit nodes).

Reimplemented from SoPath.

References SoBaseKit::getClassTypeId(), and SoBase::isOfType().

Referenced by append(), and findFork().

SoNode * SoNodeKitPath::getTail ( void  ) const

Returns the tail of the path (the last nodekit in the path).

Reimplemented from SoPath.

References SoBaseKit::getClassTypeId(), SoBase::isOfType(), and SoDebugError::postInfo().

Referenced by append().

SoNode * SoNodeKitPath::getNode ( const int  idx) const

Returns nodekit number idx in path.

Reimplemented from SoPath.

References SoBaseKit::getClassTypeId(), SoBase::isOfType(), and SoDebugError::postInfo().

Referenced by append(), and findFork().

SoNode * SoNodeKitPath::getNodeFromTail ( const int  idx) const

Returns nodekit number idx in the path, from the tail.

Reimplemented from SoPath.

References SoBaseKit::getClassTypeId(), SoBase::isOfType(), and SoDebugError::postInfo().

void SoNodeKitPath::truncate ( const int  length)

Truncates the path at nodekit number length.

Reimplemented from SoPath.

References SoBaseKit::getClassTypeId(), SoBase::isOfType(), and SoDebugError::postInfo().

Referenced by pop().

void SoNodeKitPath::pop ( void  )

Pops off the last nodekit (truncates at last tail).

Reimplemented from SoPath.

References SoBaseKit::getClassTypeId(), SoBase::isOfType(), SoDebugError::postInfo(), and truncate().

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.

References SoAction::apply(), getLength(), SoSearchAction::getPath(), getTail(), SoBaseKit::isSearchingChildren(), SoDebugError::postInfo(), SoPath::setHead(), SoSearchAction::setNode(), and SoBaseKit::setSearchingChildren().

Referenced by append().

void SoNodeKitPath::append ( const SoNodeKitPath fromPath)

Appends the nodekit path to this path. Head of fromPath must be a part in the current tail.

References append(), getLength(), and getNode().

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.

References getLength(), and getNode().


Friends And Related Function Documentation

int operator== ( const SoNodeKitPath p1,
const SoNodeKitPath p2 
)
friend

Returns TRUE if paths are equal, FALSE otherwise.


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Thu Jul 19 2012 for Coin by Doxygen. 1.8.1.1