Provided by: libcoin60-doc_3.1.3-2_all bug

NAME

       SoDetail -

       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.

SYNOPSIS

       #include <Inventor/details/SoDetail.h>

       Inherited by SoConeDetail, SoCubeDetail, SoCylinderDetail, SoFaceDetail, SoLineDetail,
       SoNodeKitDetail, SoPointDetail, and SoTextDetail.

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

   Static Public Member Functions
       static void initClass (void)
       static void initClasses (void)
       static SoType getClassTypeId (void)

   Protected Member Functions
       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.
       Note that if the Coin library has been built as a DLL under Microsoft Windows and you use
       this method from application code, you must make sure that both the Coin DLL and the
       application executable is using the same instance of a C Run-Time (CRT) library.
       Otherwise, you will get memory heap corruption upon deallocating the returned instances,
       eventually leading to mysterious crashes.

       Implemented 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 overridden 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 SoTypetype) const Returns TRUE if type is derived from (or
       is) this class.
   SoType SoDetail::getClassTypeId (void) [static] Returns the type for this class.

Author

       Generated automatically by Doxygen for Coin from the source code.