NAME

       SoTranslate2Dragger -

       The SoTranslate2Dragger class provides a mechanism for the end-user to translate in a
       plane.

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

SYNOPSIS

       #include <Inventor/draggers/SoTranslate2Dragger.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
       SoTranslate2Dragger (void)

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

   Public Attributes
       SoSFVec3f translation
       SoSFVec2f minTranslation
       SoSFVec2f maxTranslation

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoTranslate2Dragger (void)
       virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
       virtual void setMotionMatrix (const SbMatrix &m)
       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 finishCB (void *f, SoDragger *d)
       static void metaKeyChangeCB (void *f, SoDragger *d)
       static void fieldSensorCB (void *f, SoSensor *s)
       static void valueChangedCB (void *f, SoDragger *d)

   Protected Attributes
       SoSFNode axisFeedbackSwitch
       SoSFNode feedback
       SoSFNode feedbackActive
       SoSFNode feedbackSwitch
       SoSFNode translator
       SoSFNode translatorActive
       SoSFNode translatorSwitch
       SoSFNode xAxisFeedback
       SoSFNode yAxisFeedback
       SoFieldSensor * fieldSensor
       SbVec3f worldRestartPt
       SbPlaneProjector * planeProj

   Additional Inherited Members

Detailed Description

       The SoTranslate2Dragger class provides a mechanism for the end-user to translate in a
       plane.

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

       Use this dragger to allow the end-user of your application to translate along the X-axis
       and the Y-axis at the same time, ie freely inside a 3D plane. (Use a transformation node
       in front of the dragger to position it and re-orient it to translate in any plane.)

       By holding down a SHIFT key, the end-user can temporarily constrain the dragger to a
       single one of the two axes.

       See Also:
           SoTranslate1Dragger, SoDragPointDragger

Constructor & Destructor Documentation

   SoTranslate2Dragger::SoTranslate2Dragger (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 SoTranslate2Dragger
       -->"this"
             "callbackList"
             "topSeparator"
                "motionMatrix"
                "geomSeparator"
       -->         "translatorSwitch"
       -->            "translator"
       -->            "translatorActive"
       -->         "feedbackSwitch"
       -->            "feedback"
       -->            "feedbackActive"
       -->         "axisFeedbackSwitch"
       -->            "xAxisFeedback"
       -->            "yAxisFeedback".fi

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

       Detailed information on catalog parts:

       CLASS SoTranslate2Dragger
       PVT   "this",  SoTranslate2Dragger  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "topSeparator",  SoSeparator  ---
       PVT   "motionMatrix",  SoMatrixTransform  ---
       PVT   "geomSeparator",  SoSeparator  ---
       PVT   "translatorSwitch",  SoSwitch  ---
             "translator",  SoSeparator  ---
             "translatorActive",  SoSeparator  ---
       PVT   "feedbackSwitch",  SoSwitch  ---
             "feedback",  SoSeparator  ---
             "feedbackActive",  SoSeparator  ---
       PVT   "axisFeedbackSwitch",  SoSwitch  ---
             "xAxisFeedback",  SoSeparator  ---
             "yAxisFeedback",  SoSeparator  ---

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

   SoTranslate2Dragger::~SoTranslate2Dragger (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 SoTranslate2Dragger::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 * SoTranslate2Dragger::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 * SoTranslate2Dragger::getNodekitCatalog (void) const [virtual]
       Returns the nodekit catalog which defines the layout of this class' kit.

       Reimplemented from SoDragger.

   SbBool SoTranslate2Dragger::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 SoTranslate2Dragger::setMotionMatrix (const SbMatrix &matrix) [protected],  [virtual]
       Sets a new current motion matrix for the dragger geometry.

       Triggers value changed callbacks if matrix is unequal to the previous motion matrix.

       Reimplemented from SoDragger.

   void SoTranslate2Dragger::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 SoTranslate2Dragger::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 SoTranslate2Dragger::finishCB (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 SoTranslate2Dragger::metaKeyChangeCB (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 SoTranslate2Dragger::fieldSensorCB (void *f, 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 SoTranslate2Dragger::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 SoTranslate2Dragger::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 SoTranslate2Dragger::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 SoTranslate2Dragger::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

   SoSFVec3f SoTranslate2Dragger::translation
       Continuously updated to contain the current translation from the dragger's local origo
       position. Only the first two components (the X and Y values) can be changed by the end-
       user.

       The application programmer applying this dragger in his code should connect the relevant
       node fields in the scene to this field to make it follow the dragger.

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

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

   SbPlaneProjector * SoTranslate2Dragger::planeProj [protected]
       The SbPlaneProjector instance used for projecting from 2D mouse cursor positions to 3D
       points.

Author

       Generated automatically by Doxygen for Coin from the source code.