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

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

SoNodeKitPath Class Reference
[Node Kits]

#include <Inventor/SoNodeKitPath.h>

Inheritance diagram for SoNodeKitPath:

SoPath SoBase List of all members.

Detailed Description

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

All other nodes are hidden from the user.


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)


Constructor & Destructor Documentation

SoNodeKitPath::SoNodeKitPath (  const int  approxLength  )  [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 int  idx  )  const
 

Returns nodekit number idx in path.

Reimplemented from SoPath.

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

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

Reimplemented from SoPath.

void SoNodeKitPath::truncate (  const int  length  ) 
 

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.


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

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

Generated on Thu Jun 24 14:40:42 2004 for Coin by Doxygen. 1.3.7