NAME

       SoCylinderDetail -

       The SoCylinderDetail class contains information about the parts of a SoCylinder shape.

       Instances of this class are used for storing information about hit points on cylinder
       geometry after pick operations, and for storing information returned to tessellation
       callbacks.

SYNOPSIS

       #include <Inventor/details/SoCylinderDetail.h>

       Inherits SoDetail.

   Public Member Functions
       virtual SoType getTypeId (void) const
       SoCylinderDetail (void)
       virtual ~SoCylinderDetail ()
       virtual SoDetail * copy (void) const
       void setPart (const int part)
       int getPart (void) const

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

   Protected Attributes
       int part

   Additional Inherited Members

Detailed Description

       The SoCylinderDetail class contains information about the parts of a SoCylinder shape.

       Instances of this class are used for storing information about hit points on cylinder
       geometry after pick operations, and for storing information returned to tessellation
       callbacks.

       See Also:
           SoCylinder, SoRayPickAction, SoCallbackAction

Constructor & Destructor Documentation

   SoCylinderDetail::SoCylinderDetail (void)
       Constructor.

   SoCylinderDetail::~SoCylinderDetail () [virtual]
       Destructor.

Member Function Documentation

   SoType SoCylinderDetail::getTypeId (void) const [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.

       Implements SoDetail.

   SoDetail * SoCylinderDetail::copy (void) const [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.

       Implements SoDetail.

   void SoCylinderDetail::setPart (const intpartarg)
       Set the part of a cylinder which was selected. A cylinder has three different conceptual
       parts; SoCylinder::SIDES, SoCylinder::TOP or SoCylinder::BOTTOM.

   int SoCylinderDetail::getPart (void) const
       Returns selected cylinder part.

Member Data Documentation

   int SoCylinderDetail::part [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

Author

       Generated automatically by Doxygen for Coin from the source code.