SoTranslate2Dragger Class Reference
[Draggers]
Object you can translate within a plane by dragging with the mouse. More...
#include <Inventor/draggers/SoTranslate2Dragger.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| virtual const SoNodekitCatalog * | getNodekitCatalog () const |
| SoTranslate2Dragger () | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
Public Attributes | |
| SoSFVec3f | translation |
Detailed Description
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 {
| 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> |
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 Name | Part Type | Default Type | NULL 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 | Possible Types |
| callbackList | Separator | Callback, EventCallback |
SEE ALSO
SoInteractionKit, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger
Constructor & Destructor Documentation
| SoTranslate2Dragger::SoTranslate2Dragger | ( | ) |
Constructor.
Member Function Documentation
| static const SoNodekitCatalog* SoTranslate2Dragger::getClassNodekitCatalog | ( | ) | [static] |
Returns the SoNodekitCatalog for this class.
Reimplemented from SoDragger.
| static SoType SoTranslate2Dragger::getClassTypeId | ( | ) | [static] |
| virtual const SoNodekitCatalog* SoTranslate2Dragger::getNodekitCatalog | ( | ) | const [virtual] |
Returns the SoNodekitCatalog for this instance.
Reimplemented from SoDragger.
| virtual SoType SoTranslate2Dragger::getTypeId | ( | ) | const [virtual] |
Member Data Documentation
Position of the dragger.
The documentation for this class was generated from the following file:
- Inventor/draggers/SoTranslate2Dragger.h