SoNodeKitDetail Class Reference

Stores detail information about a nodekit. More...

#include <Inventor/details/SoNodeKitDetail.h>

Inheritance diagram for SoNodeKitDetail:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoNodeKitDetail ()
	Constructor.
virtual	~SoNodeKitDetail ()
	Destructor.
SoBaseKit *	getNodeKit () const
	Returns a reference to the nodekit that created this detail.
SoNode *	getPart () const
	Returns a reference to the part selected within the nodekit that created this detail.
const SbName &	getPartName () const
	Returns the name of the part selected within the nodekit that created this detail.
virtual SoDetail *	copy () const
	Returns an instance that is a copy of this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoDetail
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Stores detail information about a nodekit.

This class contains detail information about a nodekit. This consists of a reference to the nodekit, a reference 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 a 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 to an SoNodeKitPath, you can then retrieve all nodekits along the path and examine their corresponding details.

SEE ALSO

SoBaseKit, SoNodeKitPath, SoDetail, SoPickedPoint

Definition at line 93 of file SoNodeKitDetail.h.

Constructor & Destructor Documentation

SoNodeKitDetail()

SoNodeKitDetail::SoNodeKitDetail

(

)

Constructor.

~SoNodeKitDetail()

virtual SoNodeKitDetail::~SoNodeKitDetail ( )

virtual

Destructor.

Member Function Documentation

copy()

virtual SoDetail * SoNodeKitDetail::copy ( ) const

virtual

Returns an instance that is a copy of this instance.

The caller is responsible for deleting the copy when it is no longer needed.

Implements SoDetail.

getClassTypeId()

static SoType SoNodeKitDetail::getClassTypeId ( )

static

Returns the type identifier for this class.

getNodeKit()

SoBaseKit * SoNodeKitDetail::getNodeKit ( ) const

inline

Returns a reference to the nodekit that created this detail.

Definition at line 110 of file SoNodeKitDetail.h.

getPart()

SoNode * SoNodeKitDetail::getPart ( ) const

inline

Returns a reference to the part selected within the nodekit that created this detail.

Definition at line 116 of file SoNodeKitDetail.h.

getPartName()

const SbName & SoNodeKitDetail::getPartName ( ) const

inline

Returns the name of the part selected within the nodekit that created this detail.

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

Definition at line 123 of file SoNodeKitDetail.h.

getTypeId()

virtual SoType SoNodeKitDetail::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

---

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

• Inventor/details/SoNodeKitDetail.h