Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SoDetail Class Reference

The SoDetail class is the superclass for all classes storing detailed information about particular shapes. More...

#include <Inventor/classes/SoDetail.h>

Inheritance diagram for SoDetail::

SoConeDetail SoCubeDetail SoCylinderDetail SoFaceDetail SoLineDetail SoNodeKitDetail SoPointDetail SoTextDetail List of all members.

Public Methods

virtual ~SoDetail ()
virtual SoDetail * copy (void) const=0
virtual SoType getTypeId (void) const=0
SbBool isOfType (const SoType type) const

Static Public Methods

void initClass (void)
void initClasses (void)
SoType getClassTypeId (void)

Protected Methods

 SoDetail (void)

Detailed Description

The SoDetail class is the superclass for all classes storing detailed information about particular shapes.

Detail information about shapes is used in relation to picking actions in Coin. They typically contain the relevant information about what particular part of the shape a pick ray intersected with.


Constructor & Destructor Documentation

SoDetail::~SoDetail [virtual]
 

Destructor.

SoDetail::SoDetail void [protected]
 

Default constructor.


Member Function Documentation

void SoDetail::initClass void [static]
 

Initialize relevant common data for all instances, like the type system.

Reimplemented in SoConeDetail, SoCubeDetail, SoCylinderDetail, SoFaceDetail, SoLineDetail, SoNodeKitDetail, SoPointDetail, and SoTextDetail.

void SoDetail::initClasses void [static]
 

Call the initClass() methods of all built-in detail classes.

(The initClass() method of user extension detail classes -- if any -- must be called explicitly by the application programmer in the application initialization code.)

SoDetail * SoDetail::copy void const [pure virtual]
 

Return a deep copy of ourself.

Reimplemented in SoConeDetail, SoCubeDetail, SoCylinderDetail, SoFaceDetail, SoLineDetail, SoNodeKitDetail, SoPointDetail, and SoTextDetail.

SoType SoDetail::getTypeId void const [pure virtual]
 

Returns the type identification of a detail derived from a class inheriting SoDetail. This is used for run-time type checking and "downward" casting.

Usage example:

  void fuhbear(SoDetail * detail)
  {
    if (detail->getTypeId() == SoFaceDetail::getClassTypeId()) {
      // safe downward cast, know the type
      SoFaceDetail * facedetail = (SoFaceDetail *)detail;
    }
    return; // ignore if not a SoFaceDetail
  }

For application programmers wanting to extend the library with new detail classes: this method needs to be overloaded in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through Inventor/nodes/SoSubDetail.h: SO_DETAIL_SOURCE and SO_DETAIL_INIT_CLASS.

SbBool SoDetail::isOfType const SoType type const
 

Returns TRUE if type is derived from (or is) this class.

SoType SoDetail::getClassTypeId void [static]
 

Returns the type for this class.


The documentation for this class was generated from the following files:
Generated at Tue Mar 5 03:31:23 2002 for Coin by doxygen1.2.9 written by Dimitri van Heesch, © 1997-2001