Open Inventor Reference
SoNodeKitDetail Class Reference

Stores detail information about a nodekit. More...

#include <Inventor/details/SoNodeKitDetail.h>

Inheritance diagram for SoNodeKitDetail:
SoDetail

List of all members.

Public Member Functions

 SoNodeKitDetail ()
 Constructor and destructor.
virtual ~SoNodeKitDetail ()
 Constructor and destructor.
SoBaseKitgetNodeKit () const
 Returns a pointer to the nodekit that created this detail.
SoNodegetPart () const
 Returns a pointer to the part selected within the nodekit that created this detail.
const SbNamegetPartName () const
 Returns the name of the part selected within the nodekit that created this detail.
virtual SoDetailcopy () const
 Returns an instance that is a copy of this instance.
void setNodeKit (SoBaseKit *theNodeKit)
void setPart (SoNode *thePart)
void setPartName (const SbName &theName)

Static Public Member Functions

static void initClass ()

Protected Attributes

SoBaseKitmyNodeKit
SoNodemyPart
SbName myPartName

Detailed Description

This class contains detail information about a nodekit. This consists of a pointer to the nodekit, a pointer to the child part within the nodekit, and the name of the child part.

During a pick action, each nodekit along the picked path creates its own SoNodeKitDetail. Together, the full set of details gives you complete picture of the pickpath.

Since nodekits have hidden children (See the reference page for SoBaseKit), a regular SoPath ends at the topmost nodekit in the path. If you cast the pickpath from an SoPath pointer to an SoNodeKitPath pointer, you can then retrieve all nodekits along the path and examine their corresponding details.

See Also
SoBaseKit, SoNodeKitPath, SoDetail, SoPickedPoint

Definition at line 100 of file SoNodeKitDetail.h.


Constructor & Destructor Documentation

SoNodeKitDetail::SoNodeKitDetail ( )
virtual SoNodeKitDetail::~SoNodeKitDetail ( ) [virtual]

Member Function Documentation

virtual SoDetail* SoNodeKitDetail::copy ( ) const [virtual]

The caller is responsible for deleting the copy when done.

Implements SoDetail.

SoBaseKit* SoNodeKitDetail::getNodeKit ( ) const [inline]

Definition at line 112 of file SoNodeKitDetail.h.

SoNode* SoNodeKitDetail::getPart ( ) const [inline]

Definition at line 116 of file SoNodeKitDetail.h.

const SbName& SoNodeKitDetail::getPartName ( ) const [inline]

(See SoRayPickAction in the ACTIONS section of the SoBaseKit reference page for more information).

Definition at line 121 of file SoNodeKitDetail.h.

static void SoNodeKitDetail::initClass ( ) [static]

Reimplemented from SoDetail.

void SoNodeKitDetail::setNodeKit ( SoBaseKit theNodeKit)
void SoNodeKitDetail::setPart ( SoNode thePart)
void SoNodeKitDetail::setPartName ( const SbName theName) [inline]

Definition at line 131 of file SoNodeKitDetail.h.


Member Data Documentation

Definition at line 137 of file SoNodeKitDetail.h.

Definition at line 138 of file SoNodeKitDetail.h.

Definition at line 139 of file SoNodeKitDetail.h.


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