Linux Certif

Toute la documentation sur la certification Linux LPI

SoTranslate2Dragger.3coin2

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

SoTranslate2Dragger (void)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFVec3f translation

Protected Member Functions

~SoTranslate2Dragger ()

virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0)

void dragStart (void)

void drag (void)

void dragFinish (void)

Static Protected Member Functions

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

SoFieldSensor * fieldSensor

SbVec3f worldRestartPt

SbPlaneProjector * planeProj

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  --- 
   .fi
 
 
 (See SoBaseKit::printTable() for information about the output formatting.) 
 
 References SoDragger::addFinishCallback(), SoDragger::addMotionCallback(), SoDragger::addOtherEventCallback(), SoDragger::addStartCallback(), SoDragger::addValueChangedCallback(), fieldSensor, fieldSensorCB(), finishCB(), metaKeyChangeCB(), motionCB(), planeProj, SoInteractionKit::readDefaultParts(), SoInteractionKit::setPartAsDefault(), SoDelayQueueSensor::setPriority(), SoInteractionKit::setSwitchValue(), setUpConnections(), startCB(), translation, and valueChangedCB().
 

 

SoTranslate2Dragger::~SoTranslate2Dragger () [protected]Protected destructor.

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

References fieldSensor, and planeProj.

Member Function Documentation

void SoTranslate2Dragger::initClass (void) [static]Initializes type system for this dragger class.

Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init().

Reimplemented from SoDragger.

SbBool SoTranslate2Dragger::setUpConnections (SbBool onoff, SbBool doitalways = 0) [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.

References SoFieldSensor::attach(), SoBaseKit::connectionsSetUp, SoFieldSensor::detach(), fieldSensor, fieldSensorCB(), SoFieldSensor::getAttachedField(), SoInteractionKit::setUpConnections(), and translation.

Referenced by SoTranslate2Dragger().

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.

References dragStart().

Referenced by SoTranslate2Dragger().

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.

References drag().

Referenced by SoTranslate2Dragger().

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.

References dragFinish().

Referenced by SoTranslate2Dragger().

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.

References drag(), SoDragger::getEvent(), and SoDragger::isActive.

Referenced by SoTranslate2Dragger().

void SoTranslate2Dragger::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.

Reimplemented from SoInteractionKit.

References SoDragger::getMotionMatrix(), SoDragger::setMotionMatrix(), and translation.

Referenced by setUpConnections(), and SoTranslate2Dragger().

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.

References SoFieldSensor::attach(), SoFieldSensor::detach(), fieldSensor, SoDragger::getMotionMatrix(), and translation.

Referenced by SoTranslate2Dragger().

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.

References SoDragger::getEvent(), SoDragger::getLocalStartingPoint(), SoDragger::getLocalToWorldMatrix(), SbMatrix::multVecMatrix(), planeProj, SbPlaneProjector::setPlane(), SoInteractionKit::setSwitchValue(), and worldRestartPt.

Referenced by startCB().

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.

References SoDragger::appendTranslation(), SoDragger::getEvent(), SoDragger::getLocalStartingPoint(), SoDragger::getLocalToWorldMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getStartMotionMatrix(), SoDragger::getViewVolume(), SoDragger::getWorldToLocalMatrix(), SoDragger::isAdequateConstraintMotion(), SbMatrix::multVecMatrix(), planeProj, SbPlaneProjector::project(), SoDragger::setMotionMatrix(), SoDragger::setStartingPoint(), SoDragger::setStartLocaterPosition(), SoInteractionKit::setSwitchValue(), SbProjector::setViewVolume(), SbProjector::setWorkingSpace(), and worldRestartPt.

Referenced by metaKeyChangeCB(), and motionCB().

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.

References SoInteractionKit::setSwitchValue().

Referenced by finishCB().

Member Data Documentation

SoSFVec3f SoTranslate2Dragger::translationContinuously 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.

Referenced by fieldSensorCB(), setUpConnections(), SoTranslate2Dragger(), and valueChangedCB().

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.

Reimplemented from SoInteractionKit.

Referenced by setUpConnections(), SoTranslate2Dragger(), valueChangedCB(), and ~SoTranslate2Dragger().

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.

Referenced by drag(), and dragStart().

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

Referenced by drag(), dragStart(), SoTranslate2Dragger(), and ~SoTranslate2Dragger().

Author

Generated automatically by Doxygen for Coin from the source code.