SoNodeKitPath.3coin2

Langue: en

Version: 375944 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

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)

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]A constructor.

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

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

Member Function Documentation

int SoNodeKitPath::getLength (void) constReturns the length of the path (the number of nodekit nodes).

Reimplemented from SoPath.

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

Referenced by append(), and findFork().

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

Reimplemented from SoPath.

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

Referenced by append().

SoNode * SoNodeKitPath::getNode (const int idx) constReturns nodekit number idx in path.

Reimplemented from SoPath.

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

Referenced by append(), and findFork().

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

Reimplemented from SoPath.

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

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

Reimplemented from SoPath.

References SoNode::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 SoNode::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.

Reimplemented from SoPath.

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

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

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

Reimplemented from SoPath.

References getLength(), and getNode().

Author

Generated automatically by Doxygen for Coin from the source code.