Provided by: inventor-doc_2.1.5-10-18_all bug


       SoTranslate2Dragger — object you can translate within a plane by dragging with the mouse


       SoBase  >  SoFieldContainer  >  SoNode  >  SoBaseKit  >  SoInteractionKit  >  SoDragger  >


       #include <Inventor/draggers/SoTranslate2Dragger.h>

          Fields from class SoTranslate2Dragger:

     SoSFVec3f           translation

          Fields from class SoDragger:

     SoSFBool            isActive

          Fields from class SoInteractionKit:

     SoSFEnum            renderCaching
     SoSFEnum            boundingBoxCaching
     SoSFEnum            renderCulling
     SoSFEnum            pickCulling

          Parts from class SoBaseKit:

     (SoNodeKitListPart)  callbackList

          Methods from class SoTranslate2Dragger:

     static const SoNodekitCatalog *
                         getClassNodekitCatalog() const
     static SoType       getClassTypeId()

          Methods from class SoDragger:

     void                addStartCallback(SoDraggerCB *f, void *userData = NULL)
     void                removeStartCallback(SoDraggerCB *f, void *userData = NULL)
     void                addMotionCallback(SoDraggerCB *f, void *userData = NULL)
     void                removeMotionCallback(SoDraggerCB *f, void *userData = NULL)
     void                addFinishCallback(SoDraggerCB *f, void *userData = NULL)
     void                removeFinishCallback(SoDraggerCB *f, void *userData = NULL)
     void                addValueChangedCallback(SoDraggerCB *f, void *userData = NULL)
     void                removeValueChangedCallback(SoDraggerCB *f, void *userData = NULL)
     SbBool              enableValueChangedCallbacks()
     void                setMinGesture(int pixels)
     int                 getMinGesture() const
     static void         setMinScale(float newMinScale)
     static float        getMinScale()

          Methods from class SoInteractionKit:

     virtual SbBool      setPartAsPath(const SbName &partName, SoPath *surrogatePath )

          Methods from class SoBaseKit:

     virtual const SoNodekitCatalog *
                              getNodekitCatalog() const
     virtual SoNode *         getPart(const SbName &partName, SbBool makeIfNeeded)
     SbString                 getPartString(const SoBase *part)
     virtual SoNodeKitPath *  createPathToPart(const SbName &partName, SbBool makeIfNeeded, const
                                   SoPath *pathToExtend = NULL)
     virtual SbBool           setPart(const SbName &partName, SoNode *newPart)
     SbBool                   set(char *partName, char *parameters)
     SbBool                   set(char *nameValuePairs)
     static SbBool            isSearchingChildren()
     static void              setSearchingChildren(SbBool newVal)

          Methods from class SoNode:

     void                setOverride(SbBool state)
     SbBool              isOverride() const
     SoNode *            copy(SbBool copyConnections = FALSE) const
     virtual SbBool      affectsState() const
     static SoNode *     getByName(const SbName &name)
     static int          getByName(const SbName &name, SoNodeList &list)

          Methods from class SoFieldContainer:

     void                setToDefaults()
     SbBool              hasDefaultValues() const
     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool  copyConnections =
     void                get(SbString &fieldDataString)
     virtual int         getFields(SoFieldList &resultList) const
     virtual SoField *   getField(const SbName &fieldName) const
     SbBool              getFieldName(const SoField *field, SbName &fieldName) const
     SbBool              isNotifyEnabled() const
     SbBool              enableNotify(SbBool flag)

          Methods from class SoBase:

     void                ref()
     void                unref() const
     void                unrefNoDelete() const
     void                touch()
     virtual SoType      getTypeId() const
     SbBool              isOfType(SoType type) const
     virtual void        setName(const SbName &name)
     virtual SbName      getName() const

          Macros from class SoBaseKit:

     SO_GET_PART(kit, partName, partClass)
     SO_CHECK_PART(kit, partName, partClass)


       SoTranslate2Dragger is a simple dragger that translates in  two  dimensions  when  dragged
       with  the  mouse.  It  moves  within  the  x-y plane of its local space, determined by its
       location in the scene graph. Transformation nodes placed before it will  affect  both  the
       dragger and the direction of motion.

       Pressing  the  <Shift>  key  allows  you to constrain motion to either the x axis or the y
       axis. The direction is determined by your initial mouse gesture after  pressing  the  key.
       Releasing the key removes the constraint.

       This  node  has  a translation field which always reflects its position in local space. If
       you set the field, the dragger will move accordingly.  You  can  also  connect  fields  of
       other nodes or engines from this one to make them follow the dragger's motion.

       This  dragger  contains six parts, translator, translatorActive, feedback, feedbackActive,
       xAxisFeedback, and yAxisFeedback. The last two parts are only displayed during motion, and
       only  when  their  direction  of  motion  is  enabled.  (Pressing the <Shift> key and then
       dragging disables one of the two directions.)

       Each of these is set by default from a resource described in the Dragger Resources section
       of  the  online reference page for this class. You can change the parts in any instance of
       this dragger using setPart().

       You can make your program use different default resources for the  parts  by  copying  the
       file /usr/share/data/draggerDefaults/translate2Dragger.iv into your own directory, editing
       the file, and then setting the environment variable SO_DRAGGER_DIR to be a  path  to  that


     SoSFVec3f           translation
          Position of the dragger.



     static const SoNodekitCatalog *
                         getClassNodekitCatalog() const
          Returns an SoNodekitCatalog for this class

     static SoType       getClassTypeId()
          Returns type identifier for this class.


       │                         All parts                          │
       │                                                    NULL by │
       │Part Name          Part Type         Default Type   Default │
       │                                                            │
       │callbackList       NodeKitListPart   --               yes   │
       │translator         Separator         --               yes   │
       │translatorActive   Separator         --               yes   │
       │feedback           Separator         --               yes   │
       │feedbackActive     Separator         --               yes   │
       │xAxisFeedback      Separator         --               yes   │
       │yAxisFeedback      Separator         --               yes   │
       │                                                            │
       │      Extra information for list parts from above table        │
       │                                                               │
       │Part Name      Container Type   Permissible Types              │
       │                                                               │
       │callbackList   Separator        Callback, EventCallback        │
       │                                                               │


       .in 0n+.5i
     Resource:         translate2Translator
       .in 0n+.5i
     Part:             translator
     Appearance:       pair of white crossing arrows
     Description:      picking this initiates translation

                         .in 0n+.5i
     Resource:         translate2TranslatorActive
                         .in 0n+.5i
     Part:             translatorActive
     Appearance:       pair of yellow crossing arrows
     Description:      displayed during translation instead of the translator

                         .in 0n+.5i
     Resource:         translate2Feedback
                         .in 0n+.5i
     Part:             feedback
     Appearance:       empty Separator by default
     Description:      feedback displayed when not moving

                         .in 0n+.5i
     Resource:         translate2FeedbackActive
                         .in 0n+.5i
     Part:             feedbackActive
     Appearance:       empty Separator by default
     Description:      feedback displayed when moving

                         .in 0n+.5i
     Resource:         translate2XAxisFeedback
                         .in 0n+.5i
     Part:             xAxisFeedback
     Appearance:       thin purple line
     Description:      Only shown if dragger is moving and the axis is a permissable direction of
                         motion. When pressing  <shift>,  motion  is  constrained,  and  this  is
                         displayed only if the primary motion is in the x direction.

                         .in 0n+.5i
     Resource:         translate2YAxisFeedback
                         .in 0n+.5i
     Part:             yAxisFeedback
     Appearance:       thin purple line
     Description:      Only shown if dragger is moving and the axis is a permissable direction of
                         motion. When pressing  <shift>,  motion  is  constrained,  and  this  is
                         displayed only if the primary motion is in the y direction.


       Translate2Dragger {
          renderCaching       AUTO
          boundingBoxCaching  AUTO
          renderCulling       AUTO
          pickCulling         AUTO
          isActive            FALSE
          translation         0 0 0
          callbackList        NULL
          translator          <translate2Translator resource>
          translatorActive    <translate2TranslatorActive resource>
          feedback            <translate2Feedback resource>
          feedbackActive      <translate2FeedbackActive resource>
          xAxisFeedback       <translate2XAxisFeedback resource>
          yAxisFeedback       <translate2YAxisFeedback resource>


       SoInteractionKit,      SoDragger,      SoCenterballDragger,     SoDirectionalLightDragger,
       SoDragPointDragger,      SoHandleBoxDragger,      SoJackDragger,      SoPointLightDragger,
       SoRotateCylindricalDragger,         SoRotateDiscDragger,         SoRotateSphericalDragger,
       SoScale1Dragger,    SoScale2Dragger,    SoScale2UniformDragger,     SoScaleUniformDragger,
       SoSpotLightDragger,      SoTabBoxDragger,      SoTabPlaneDragger,      SoTrackballDragger,
       SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger