NAME

       SoRotateSphericalDragger -

       The SoRotateSphericalDragger class is for rotating geometry in any direction.

       Here's how the dragger looks with its default geometry in the inactive state:

SYNOPSIS

       #include <Inventor/draggers/SoRotateSphericalDragger.h>

       Inherits SoDragger.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       virtual const SoNodekitCatalog * getNodekitCatalog (void) const
       SoRotateSphericalDragger (void)
       void setProjector (SbSphereProjector *p)
       const SbSphereProjector * getProjector (void) const

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static const SoNodekitCatalog * getClassNodekitCatalog (void)
       static void initClass (void)

   Public Attributes
       SoSFRotation rotation

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoRotateSphericalDragger (void)
       virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
       virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
       void dragStart (void)
       void drag (void)
       void dragFinish (void)

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)
       static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
       static void startCB (void *f, SoDragger *d)
       static void motionCB (void *f, SoDragger *d)
       static void doneCB (void *f, SoDragger *d)
       static void fieldSensorCB (void *f, SoSensor *s)
       static void valueChangedCB (void *f, SoDragger *d)

   Protected Attributes
       SoSFNode feedback
       SoSFNode feedbackActive
       SoSFNode feedbackSwitch
       SoSFNode rotator
       SoSFNode rotatorActive
       SoSFNode rotatorSwitch
       SoFieldSensor * fieldSensor
       SbMatrix prevMotionMatrix
       SbVec3f prevWorldHitPt
       SbSphereProjector * sphereProj
       SbBool userProj

   Additional Inherited Members

Detailed Description

       The SoRotateSphericalDragger class is for rotating geometry in any direction.

       Here's how the dragger looks with its default geometry in the inactive state:

       Use an instance of this dragger class in your scenegraph to let the end-users of your
       application rotate geometry freely in any direction.

       For the initial dragger orientation and the dragger geometry positioning itself, use some
       kind of transformation node in your scenegraph, as usual.

Constructor & Destructor Documentation

   SoRotateSphericalDragger::SoRotateSphericalDragger (void)
       Default constructor, sets up the dragger nodekit catalog with the interaction and feedback
       geometry.

       Node kit structure (new entries versus parent class marked with arrow prefix):

       CLASS SoRotateSphericalDragger
       -->"this"
             "callbackList"
             "topSeparator"
                "motionMatrix"
                "geomSeparator"
       -->         "rotatorSwitch"
       -->            "rotator"
       -->            "rotatorActive"
       -->         "feedbackSwitch"
       -->            "feedback"
       -->            "feedbackActive"

       (See SoBaseKit::printDiagram() for information about the output formatting.)

       Detailed information on catalog parts:

       CLASS SoRotateSphericalDragger
       PVT   "this",  SoRotateSphericalDragger  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "topSeparator",  SoSeparator  ---
       PVT   "motionMatrix",  SoMatrixTransform  ---
       PVT   "geomSeparator",  SoSeparator  ---
       PVT   "rotatorSwitch",  SoSwitch  ---
             "rotator",  SoSeparator  ---
             "rotatorActive",  SoSeparator  ---
       PVT   "feedbackSwitch",  SoSwitch  ---
             "feedback",  SoSeparator  ---
             "feedbackActive",  SoSeparator  ---

       (See SoBaseKit::printTable() for information about the output formatting.)

   SoRotateSphericalDragger::~SoRotateSphericalDragger (void) [protected],  [virtual]
       Protected destructor.

       (Dragger classes are derived from SoBase, so they are reference counted and automatically
       destroyed when their reference count goes to 0.)

Member Function Documentation

   SoType SoRotateSphericalDragger::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This
       is used for run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines,
       nodekits, draggers or others: 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 for instance
       Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes),
       Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the
       toplevel superclasses for the various class groups.

       Reimplemented from SoDragger.

   const SoFieldData * SoRotateSphericalDragger::getFieldData (void) const [protected],
       [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented from SoDragger.

   const SoNodekitCatalog * SoRotateSphericalDragger::getNodekitCatalog (void) const [virtual]
       Returns the nodekit catalog which defines the layout of this class' kit.

       Reimplemented from SoDragger.

   void SoRotateSphericalDragger::setProjector (SbSphereProjector *p)
       Replace the default sphere projection strategy. You may want to do this if you change the
       dragger geometry, for instance.

       The default projection is an SbSpherePlaneProjector.

       See Also:
           SbSphereSectionProjector, SbSphereSheetProjector

   const SbSphereProjector * SoRotateSphericalDragger::getProjector (void) const
       Returns projector instance used for converting from user interaction dragger movements to
       3D dragger re-orientation.

       See Also:
           setProjector()

   SbBool SoRotateSphericalDragger::setUpConnections (SbBoolonoff, SbBooldoitalways = FALSE)
       [protected],  [virtual]
       Sets up all internal connections for instances of this class.

       (This method will usually not be of interest to the application programmer, unless you
       want to extend the library with new custom nodekits or dragger classes. If so, see the
       SoBaseKit class documentation.)

       Reimplemented from SoInteractionKit.

   void SoRotateSphericalDragger::copyContents (const SoFieldContainer *from,
       SbBoolcopyconnections) [protected],  [virtual]
       Makes a deep copy of all data of from into this instance, except external scenegraph
       references if copyconnections is FALSE.

       This is the method that should be overridden by extension node / engine / dragger /
       whatever subclasses which needs to account for internal data that are not handled
       automatically.

       For copying nodes from application code, you should not invoke this function directly, but
       rather call the SoNode::copy() function:

       SoNode * mynewnode = templatenode->copy();

       The same also goes for engines.

       Make sure that when you override the copyContents() method in your extension class that
       you also make it call upwards to it's parent superclass in the inheritance hierarchy, as
       copyContents() in for instance SoNode and SoFieldContainer does important work. It should
       go something like this:

       void
       MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                         SbBool copyconnections)
       {
         // let parent superclasses do their thing (copy fields, copy
         // instance name, etc etc)
         SoNode::copyContents(from, copyconnections);

         // [..then copy internal data..]
       }

       Reimplemented from SoInteractionKit.

   void SoRotateSphericalDragger::startCB (void *f, SoDragger *d) [static],  [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

   void SoRotateSphericalDragger::motionCB (void *f, SoDragger *d) [static],  [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

   void SoRotateSphericalDragger::doneCB (void *f, SoDragger *d) [static],  [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

   void SoRotateSphericalDragger::fieldSensorCB (void *d, SoSensor *s) [static],  [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

   void SoRotateSphericalDragger::valueChangedCB (void *f, SoDragger *d) [static],  [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

   void SoRotateSphericalDragger::dragStart (void) [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer. Called when dragger is selected (picked) by the
       user.

   void SoRotateSphericalDragger::drag (void) [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer. Called when user drags the mouse after picking the
       dragger.

   void SoRotateSphericalDragger::dragFinish (void) [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer. Called when mouse button is released after picking
       and interacting with the dragger.

Member Data Documentation

   SoSFRotation SoRotateSphericalDragger::rotation
       This field is continuously updated to contain the rotation of the current direction vector
       of the dragger.

       The application programmer using this dragger in his scenegraph should connect the
       relevant node fields in the scene to this field to make them follow the dragger
       orientation.

   SoFieldSensor * SoRotateSphericalDragger::fieldSensor [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

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

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

   SbSphereProjector * SoRotateSphericalDragger::sphereProj [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

   SbBool SoRotateSphericalDragger::userProj [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.