Package com.openinventor.inventor.draggers

Class SoTranslate2Dragger

java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.inventor.misc.SoBase
com.openinventor.inventor.fields.SoFieldContainer
com.openinventor.inventor.nodes.SoNode
com.openinventor.inventor.nodekits.SoBaseKit
com.openinventor.inventor.nodekits.SoInteractionKit
com.openinventor.inventor.draggers.SoDragger
com.openinventor.inventor.draggers.SoTranslate2Dragger
All Implemented Interfaces:
SafeDisposable
Direct Known Subclasses:
Magnifier
public class SoTranslate2Dragger extends SoDragger
Object you can translate within a plane by dragging with the mouse. 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 $OIVHOME/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 directory.

See SoDragger for more information about using and customizing draggers, including code examples, using draggers in an immersive VR environment and using WYSIWYG draggers.

File format/default:

Translate2Dragger {

    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>
}

DRAGGER RESOURCES

    Resource: translate2Translator
    Part: translator
    Appearance: pair of white crossing arrows
    Description: picking this initiates translation

    Resource: translate2TranslatorActive
    Part: translatorActive
    Appearance: pair of yellow crossing arrows
    Description: displayed during translation instead of the translator

    Resource: translate2Feedback
    Part: feedback
    Appearance: empty Separator by default
    Description: feedback displayed when not moving

    Resource: translate2FeedbackActive
    Part: feedbackActive
    Appearance: empty Separator by default
    Description: feedback displayed when moving

    Resource: translate2XAxisFeedback
    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.

    Resource: translate2YAxisFeedback
    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.

CATALOG PARTS

All Parts

    Part NamePart TypeDefault TypeNULL 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 NameContainer TypePossible Types
    callbackList Separator Callback, EventCallback

See Also:

  • Field Details

    • translation

      public final SoSFVec3f translation
      Position of the dragger.

  • Constructor Details

    • SoTranslate2Dragger

      public SoTranslate2Dragger()
      Constructor.

  • Method Details