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

SoFullPath Class Reference
[General classes]

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. More...

#include <Inventor/SoFullPath.h>

Inheritance diagram for SoFullPath:

SoPath SoBase

List of all members.

Public Member Functions

void pop (void)
SoNodegetTail (void) const
SoNodegetNodeFromTail (const int index) const
int getIndexFromTail (const int index) const
int getLength (void) const

Friends

class SoTempPath


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.

References SoPath::truncate().

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.

Referenced by SoGLRenderAction::abortNow(), SoGetBoundingBoxAction::checkResetAfter(), SoGetBoundingBoxAction::checkResetBefore(), SoBaseKit::createPathToAnyPart(), and SoVRMLTouchSensor::handleEvent().

SoNode * SoFullPath::getNodeFromTail ( const int  index  )  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 int  index  )  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.

Referenced by SoGLRenderAction::abortNow(), SoVRMLTouchSensor::handleEvent(), and SoPathList::uniquify().


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

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

Generated on Mon Mar 16 15:15:17 2009 for Coin by Doxygen. 1.5.7.1