Coin Logo http://www.sim.no
http://www.coin3d.org

SoDragger Class Reference
[Draggers]

The SoDragger class is the base class for all draggers.

Draggers is a mechanism used for letting the end-users of your application code interact with elements in 3D, by scaling, rotating or translating geometry or other instances in the scene (like cameras or lightsources). More...

#include <Inventor/draggers/SoDragger.h>

Inheritance diagram for SoDragger:

SoInteractionKit SoBaseKit SoNode SoFieldContainer SoBase SoCenterballDragger SoDirectionalLightDragger SoDragPointDragger SoHandleBoxDragger SoJackDragger SoPointLightDragger SoRotateCylindricalDragger SoRotateDiscDragger SoRotateSphericalDragger SoScale1Dragger SoScale2Dragger SoScale2UniformDragger SoScaleUniformDragger SoSpotLightDragger SoTabBoxDragger SoTabPlaneDragger SoTrackballDragger SoTransformBoxDragger SoTransformerDragger SoTranslate1Dragger SoTranslate2Dragger

List of all members.

Public Types

enum  ProjectorFrontSetting { FRONT, BACK, USE_PICK }

Public Member Functions

virtual SoType getTypeId (void) const
virtual const SoNodekitCataloggetNodekitCatalog (void) const
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
void addStartCallback (SoDraggerCB *func, void *data=NULL)
void removeStartCallback (SoDraggerCB *func, void *data=NULL)
void addMotionCallback (SoDraggerCB *func, void *data=NULL)
void removeMotionCallback (SoDraggerCB *func, void *data=NULL)
void addFinishCallback (SoDraggerCB *func, void *data=NULL)
void removeFinishCallback (SoDraggerCB *func, void *data=NULL)
void addValueChangedCallback (SoDraggerCB *func, void *data=NULL)
void removeValueChangedCallback (SoDraggerCB *func, void *data=NULL)
void setMinGesture (int pixels)
int getMinGesture (void) const
SbBool enableValueChangedCallbacks (SbBool newval)
const SbMatrixgetMotionMatrix (void)
void addOtherEventCallback (SoDraggerCB *func, void *data=NULL)
void removeOtherEventCallback (SoDraggerCB *func, void *data=NULL)
void registerChildDragger (SoDragger *child)
void unregisterChildDragger (SoDragger *child)
void registerChildDraggerMovingIndependently (SoDragger *child)
void unregisterChildDraggerMovingIndependently (SoDragger *child)
SbMatrix getLocalToWorldMatrix (void)
SbMatrix getWorldToLocalMatrix (void)
SbVec3f getLocalStartingPoint (void)
SbVec3f getWorldStartingPoint (void)
void getPartToLocalMatrix (const SbName &partname, SbMatrix &parttolocalmatrix, SbMatrix &localtopartmatrix)
void transformMatrixLocalToWorld (const SbMatrix &frommatrix, SbMatrix &tomatrix)
void transformMatrixWorldToLocal (const SbMatrix &frommatrix, SbMatrix &tomatrix)
void transformMatrixToLocalSpace (const SbMatrix &frommatrix, SbMatrix &tomatrix, const SbName &fromspacepartname)
void setMotionMatrix (const SbMatrix &newmatrix)
void valueChanged (void)
const SbMatrixgetStartMotionMatrix (void)
virtual void saveStartParameters (void)
const SoPathgetPickPath (void) const
const SoEventgetEvent (void) const
SoPathcreatePathToThis (void)
const SoPathgetSurrogatePartPickedOwner (void) const
const SbNamegetSurrogatePartPickedName (void) const
const SoPathgetSurrogatePartPickedPath (void) const
void setStartingPoint (const SoPickedPoint *newpoint)
void setStartingPoint (const SbVec3f &newpoint)
const SbViewVolumegetViewVolume (void)
void setViewVolume (const SbViewVolume &vol)
const SbViewportRegiongetViewportRegion (void)
void setViewportRegion (const SbViewportRegion &reg)
SoHandleEventActiongetHandleEventAction (void) const
void setHandleEventAction (SoHandleEventAction *newAction)
void setTempPathToThis (const SoPath *somethingclose)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
void workFieldsIntoTransform (SbMatrix &mtx)
void setFrontOnProjector (ProjectorFrontSetting newval)
ProjectorFrontSetting getFrontOnProjector (void) const

Static Public Member Functions

static SoType getClassTypeId (void)
static const SoNodekitCataloggetClassNodekitCatalog (void)
static void setMinScale (float newminscale)
static float getMinScale (void)
static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationptr, const SbRotation *rotationptr, const SbVec3f *scalefactorptr, const SbRotation *scaleorientationptr, const SbVec3f *centerptr)
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f &center)
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation)
static SbMatrix appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)
static SbMatrix appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scalecenter, const SbMatrix *conversion=NULL)
static SbMatrix appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotcenter, const SbMatrix *conversion=NULL)
static void initClass (void)
static void initClasses (void)

Public Attributes

SoSFBool isActive

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 SoDragger (void)
virtual ~SoDragger ()
SbVec2f getNormalizedLocaterPosition (void)
SbVec2s getLocaterPosition (void)
SbVec2s getStartLocaterPosition (void) const
void setStartLocaterPosition (SbVec2s p)
SbBool isAdequateConstraintMotion (void)
virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath)
void setCameraInfo (SoAction *action)
virtual void handleEvent (SoHandleEventAction *ha)
void transferMotion (SoDragger *child)
void setIgnoreInBbox (SbBool newval)
SbBool isIgnoreInBbox (void)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
void setActiveChildDragger (SoDragger *newchilddragger)
SoDraggergetActiveChildDragger (void) const
virtual void setDefaultOnNonWritingFields (void)
void updateDraggerCache (const SoPath *path)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
static void childTransferMotionAndValueChangedCB (void *, SoDragger *)
static void childValueChangedCB (void *, SoDragger *)
static void childStartCB (void *, SoDragger *)
static void childMotionCB (void *, SoDragger *)
static void childFinishCB (void *, SoDragger *)
static void childOtherEventCB (void *, SoDragger *)

Protected Attributes

SoSFNode motionMatrix


Detailed Description

The SoDragger class is the base class for all draggers.

Draggers is a mechanism used for letting the end-users of your application code interact with elements in 3D, by scaling, rotating or translating geometry or other instances in the scene (like cameras or lightsources).

For a very thorough introduction and tutorial to the dragger classes and general concepts, we advise you to consult «The Inventor Mentor», ISBN 0-201-62495-8, chapter 15.

This is the common superclass for all dragger classes.

It holds the current motion matrix, and offers lots of convenience methods to build from for it's subclasses -- that is, the non-abstract dragger classes to use as nodes in your scenegraph.

The motion matrix is used to modify the model matrix during traversal, and this is a common dragger mechanism -- all draggers should update this during dragging.

A number of the Coin dragger classes have built-in convenience wrapper classes, called manipulators. See for instance the SoTrackballDragger / SoTrackballManip pair.

The matching manipulator class for any dragger class has basically two convenient additions to the functionality of the stand-alone dragger: 1) it makes swapping the dragger in and out of the scenegraph very straightforward (something which is often done for draggers in 3D user interfaces), 2) it wraps up the dragger with SoSurroundScale and SoAntiSquish nodes where applicable, so the dragger geometry automatically scales up or down to match the geometry it influences.

This last functionality can also be duplicated in a rather straightforward manner outside of the context of a manipulator, as can be seen from the usage example in the SoSurroundScale class documentation.

The appearance of draggers can be modified by either using the SoDragger::setPart() method (see usage example below) or by setting up external Inventor-format files which the geometry parts are read from. The latter method can be done by setting the environment variable SO_DRAGGER_DIR to point to a directory with replacement geometry files. The name of the new files and the name of the nodes / sub-graphs with the replacement geometries must follow a rigid scheme. We advise you to look at the Coin sourcecode directory Coin/data/draggerDefaults/ to see how the replacement geometry files should be named. Setting SO_DRAGGER_DIR to this directory and modifying the files there provides a convenient way to play around with new dragger geometry arrangements.

As mentioned above, SoDragger::setPart() can be used to modify the appearance of a dragger by changing it's default geometry. One common technique is for instance to take advantage of this to use only parts of a dragger, by replacing / disabling the geometry that you don't want the end-user to interact with. The following code example shows how to remove the translation functionality of the SoTransformBoxDragger:

  #include <Inventor/Qt/SoQt.h>
  #include <Inventor/Qt/viewers/SoQtExaminerViewer.h>
  #include <Inventor/draggers/SoTransformBoxDragger.h>
  #include <Inventor/nodes/SoSeparator.h>


  int
  main(int argc, char ** argv)
  {
    QWidget * window = SoQt::init(argv[0]);

    SoTransformBoxDragger * dragger = new SoTransformBoxDragger;

    SbString str;
    for (int i = 1; i <= 6; i++) {
      str.sprintf("translator%d.translator", i);
      dragger->setPart(str.getString(), new SoSeparator);
    }

    SoQtExaminerViewer * viewer = new SoQtExaminerViewer(window);
    viewer->setSceneGraph(dragger);
    viewer->show();
    SoQt::show(window);

    SoQt::mainLoop();

    delete viewer;
    return 0;
  }

Draggers are also node kits, and below is the catalog structure for this top-level dragger class.

Node kit structure (new entries versus parent class marked with arrow prefix):

  CLASS SoDragger
  -->"this"
        "callbackList"
        "topSeparator"
  -->      "motionMatrix"
           "geomSeparator"
  

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

Detailed information on catalog parts:

  CLASS SoDragger
  PVT   "this",  SoDragger  ---
        "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
  PVT   "topSeparator",  SoSeparator  ---
  PVT   "motionMatrix",  SoMatrixTransform  ---
  PVT   "geomSeparator",  SoSeparator  ---
  

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


Member Enumeration Documentation

Holds various settings for projectors, which might affect cylindrical and spherical based draggers. Specifies whether dragging should be based on the front or back of the sphere / cylinder, or if the picked point should be used to decide this.

Enumerator:
FRONT  Always use front of projector.
BACK  Always use back of projector.
USE_PICK  Use picked point to decide front or back of projector.


Constructor & Destructor Documentation

SoDragger::SoDragger ( void   )  [protected]

A protected constructor for this abstract superclass for all Coin draggers.

References isActive, and USE_PICK.

SoDragger::~SoDragger (  )  [protected, virtual]

Virtual protected destructor.


Member Function Documentation

SoType SoDragger::getClassTypeId ( void   )  [static]

SoType SoDragger::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
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)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 SoInteractionKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger.

const SoFieldData ** SoDragger::getFieldDataPtr ( void   )  [static, protected]

const SoFieldData * SoDragger::getFieldData ( void   )  const [protected, virtual]

const SoNodekitCatalog * SoDragger::getClassNodekitCatalog ( void   )  [static]

const SoNodekitCatalog * SoDragger::getNodekitCatalog ( void   )  const [virtual]

const SoNodekitCatalog ** SoDragger::getClassNodekitCatalogPtr ( void   )  [static, protected]

void SoDragger::callback ( SoCallbackAction action  )  [virtual]

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoBaseKit.

References SoBaseKit::callback(), SoAction::getState(), SoState::pop(), and SoState::push().

void SoDragger::GLRender ( SoGLRenderAction action  )  [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoBaseKit.

Reimplemented in SoTabPlaneDragger.

References SoAction::getState(), SoBaseKit::GLRender(), SoState::pop(), and SoState::push().

Referenced by SoTabPlaneDragger::GLRender().

void SoDragger::getMatrix ( SoGetMatrixAction action  )  [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoBaseKit.

Reimplemented in SoCenterballDragger.

References SoBaseKit::getMatrix().

Referenced by SoCenterballDragger::getMatrix().

void SoDragger::rayPick ( SoRayPickAction action  )  [virtual]

Action method for SoRayPickAction.

Checks the ray specification of the action and tests for intersection with the data of the node.

Nodes influencing relevant state variables for how picking is done also overrides this method.

Reimplemented from SoBaseKit.

References SoAction::getState(), SoState::pop(), SoState::push(), and SoBaseKit::rayPick().

void SoDragger::search ( SoSearchAction action  )  [virtual]

Action method for SoSearchAction.

Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction -- if any of the requested criteria is a miss, the search is not deemed successful for the node.

See also:
SoSearchAction

Reimplemented from SoBaseKit.

References SoBaseKit::search().

void SoDragger::write ( SoWriteAction action  )  [virtual]

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented from SoBaseKit.

References SoBaseKit::write().

void SoDragger::getPrimitiveCount ( SoGetPrimitiveCountAction action  )  [virtual]

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoBaseKit.

References SoBaseKit::getPrimitiveCount(), SoAction::getState(), SoState::pop(), and SoState::push().

void SoDragger::addStartCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

void SoDragger::removeStartCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

Removes a previously registered start callback.

See also:
addStartCallback()

Referenced by SoTabBoxDragger::setUpConnections(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

void SoDragger::addMotionCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

void SoDragger::removeMotionCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

Removes a previously registered motion callback.

See also:
addMotionCallback()

Referenced by unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

void SoDragger::addFinishCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

void SoDragger::removeFinishCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

void SoDragger::addValueChangedCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

void SoDragger::removeValueChangedCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

void SoDragger::setMinGesture ( int  pixels  ) 

Sets the number of pixel movement needed to trigger a constraint gesture. Default is 8 pixels.

int SoDragger::getMinGesture ( void   )  const

Returns the gesture pixels threshold value.

See also:
setMinGesture()

SbBool SoDragger::enableValueChangedCallbacks ( SbBool  val  ) 

const SbMatrix & SoDragger::getMotionMatrix ( void   ) 

Returns the motion matrix for this dragger.

References SoSFMatrix::getValue(), and SoMatrixTransform::matrix.

Referenced by SoTransformerDragger::dragFinish(), SoTransformerDragger::dragStart(), SoTrackballDragger::dragStart(), SoRotateSphericalDragger::dragStart(), SoTranslate2Dragger::fieldSensorCB(), SoTranslate1Dragger::fieldSensorCB(), SoTransformerDragger::fieldSensorCB(), SoTransformBoxDragger::fieldSensorCB(), SoTrackballDragger::fieldSensorCB(), SoTabBoxDragger::fieldSensorCB(), SoSpotLightManip::fieldSensorCB(), SoSpotLightDragger::fieldSensorCB(), SoScaleUniformDragger::fieldSensorCB(), SoScale2UniformDragger::fieldSensorCB(), SoScale2Dragger::fieldSensorCB(), SoScale1Dragger::fieldSensorCB(), SoRotateSphericalDragger::fieldSensorCB(), SoRotateDiscDragger::fieldSensorCB(), SoRotateCylindricalDragger::fieldSensorCB(), SoPointLightManip::fieldSensorCB(), SoPointLightDragger::fieldSensorCB(), SoJackDragger::fieldSensorCB(), SoHandleBoxDragger::fieldSensorCB(), SoDragPointDragger::fieldSensorCB(), SoDirectionalLightManip::fieldSensorCB(), SoDirectionalLightDragger::fieldSensorCB(), SoClipPlaneManip::fieldSensorCB(), SoCenterballDragger::fieldSensorCB(), getLocalToWorldMatrix(), getWorldToLocalMatrix(), SoTabPlaneDragger::reallyAdjustScaleTabSize(), saveStartParameters(), SoCenterballDragger::saveStartParameters(), SoCenterballDragger::transferCenterDraggerMotion(), transferMotion(), SoTranslate2Dragger::valueChangedCB(), SoTranslate1Dragger::valueChangedCB(), SoTransformManip::valueChangedCB(), SoTransformerDragger::valueChangedCB(), SoTransformBoxDragger::valueChangedCB(), SoTrackballDragger::valueChangedCB(), SoTabBoxDragger::valueChangedCB(), SoSpotLightManip::valueChangedCB(), SoSpotLightDragger::valueChangedCB(), SoScaleUniformDragger::valueChangedCB(), SoScale2UniformDragger::valueChangedCB(), SoScale2Dragger::valueChangedCB(), SoScale1Dragger::valueChangedCB(), SoRotateSphericalDragger::valueChangedCB(), SoRotateDiscDragger::valueChangedCB(), SoRotateCylindricalDragger::valueChangedCB(), SoPointLightManip::valueChangedCB(), SoPointLightDragger::valueChangedCB(), SoJackDragger::valueChangedCB(), SoHandleBoxDragger::valueChangedCB(), SoDragPointDragger::valueChangedCB(), SoDirectionalLightManip::valueChangedCB(), SoDirectionalLightDragger::valueChangedCB(), SoClipPlaneManip::valueChangedCB(), and SoCenterballDragger::valueChangedCB().

void SoDragger::addOtherEventCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

Adds an event callback for events other then drag events. As soon as dragging starts, the dragger grabs all events (until mouse button is released). This method can be used to handle other events during dragging.

Referenced by registerChildDragger(), registerChildDraggerMovingIndependently(), SoDragPointDragger::SoDragPointDragger(), SoHandleBoxDragger::SoHandleBoxDragger(), SoTabPlaneDragger::SoTabPlaneDragger(), SoTrackballDragger::SoTrackballDragger(), SoTransformerDragger::SoTransformerDragger(), and SoTranslate2Dragger::SoTranslate2Dragger().

void SoDragger::removeOtherEventCallback ( SoDraggerCB *  func,
void *  data = NULL 
)

Removes a other event callback.

See also:
addOtherEventCallback()

Referenced by unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

void SoDragger::registerChildDragger ( SoDragger child  ) 

void SoDragger::unregisterChildDragger ( SoDragger child  ) 

void SoDragger::registerChildDraggerMovingIndependently ( SoDragger child  ) 

Should be called by compund draggers to register child draggers that should move independently of their parent.

References addFinishCallback(), addMotionCallback(), addOtherEventCallback(), addStartCallback(), addValueChangedCallback(), childFinishCB(), childMotionCB(), childOtherEventCB(), childStartCB(), and childValueChangedCB().

void SoDragger::unregisterChildDraggerMovingIndependently ( SoDragger child  ) 

SbMatrix SoDragger::getLocalToWorldMatrix ( void   ) 

SbMatrix SoDragger::getWorldToLocalMatrix ( void   ) 

SbVec3f SoDragger::getLocalStartingPoint ( void   ) 

SbVec3f SoDragger::getWorldStartingPoint ( void   ) 

Returns the drag starting point in the world coordinate system.

Referenced by SoTrackballDragger::drag(), and SoTrackballDragger::dragStart().

void SoDragger::getPartToLocalMatrix ( const SbName partname,
SbMatrix parttolocalmatrix,
SbMatrix localtopartmatrix 
)

void SoDragger::transformMatrixLocalToWorld ( const SbMatrix frommatrix,
SbMatrix tomatrix 
)

Convenience method that transforms the local frommatrix to a world coordinate systems matrix.

References getLocalToWorldMatrix(), getWorldToLocalMatrix(), SbMatrix::multLeft(), and SbMatrix::multRight().

Referenced by transferMotion().

void SoDragger::transformMatrixWorldToLocal ( const SbMatrix frommatrix,
SbMatrix tomatrix 
)

Convenience method that transforms the world frommatrix to a local coordinate systems matrix.

References getLocalToWorldMatrix(), getWorldToLocalMatrix(), SbMatrix::multLeft(), and SbMatrix::multRight().

Referenced by transferMotion().

void SoDragger::transformMatrixToLocalSpace ( const SbMatrix frommatrix,
SbMatrix tomatrix,
const SbName fromspacepartname 
)

Transforms a matrix that lies in the frompartname coordinate system into the local coordinate system.

References getPartToLocalMatrix(), SbMatrix::multLeft(), and SbMatrix::multRight().

void SoDragger::setMotionMatrix ( const SbMatrix matrix  ) 

Sets a new current motion matrix for the dragger geometry.

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

References SoSFMatrix::getValue(), SoMatrixTransform::matrix, and valueChanged().

Referenced by SoTranslate2Dragger::drag(), SoTranslate1Dragger::drag(), SoTrackballDragger::drag(), SoTabPlaneDragger::drag(), SoScaleUniformDragger::drag(), SoScale2UniformDragger::drag(), SoScale2Dragger::drag(), SoScale1Dragger::drag(), SoRotateSphericalDragger::drag(), SoRotateDiscDragger::drag(), SoRotateCylindricalDragger::drag(), SoHandleBoxDragger::drag(), SoTranslate2Dragger::fieldSensorCB(), SoTranslate1Dragger::fieldSensorCB(), SoTransformManip::fieldSensorCB(), SoTransformerDragger::fieldSensorCB(), SoTransformBoxDragger::fieldSensorCB(), SoTrackballDragger::fieldSensorCB(), SoTabBoxDragger::fieldSensorCB(), SoSpotLightManip::fieldSensorCB(), SoSpotLightDragger::fieldSensorCB(), SoScaleUniformDragger::fieldSensorCB(), SoScale2UniformDragger::fieldSensorCB(), SoScale2Dragger::fieldSensorCB(), SoScale1Dragger::fieldSensorCB(), SoRotateSphericalDragger::fieldSensorCB(), SoRotateDiscDragger::fieldSensorCB(), SoRotateCylindricalDragger::fieldSensorCB(), SoPointLightManip::fieldSensorCB(), SoPointLightDragger::fieldSensorCB(), SoJackDragger::fieldSensorCB(), SoHandleBoxDragger::fieldSensorCB(), SoDragPointDragger::fieldSensorCB(), SoDirectionalLightManip::fieldSensorCB(), SoDirectionalLightDragger::fieldSensorCB(), SoClipPlaneManip::fieldSensorCB(), SoCenterballDragger::fieldSensorCB(), SoClipPlaneManip::setValue(), SoCenterballDragger::transferCenterDraggerMotion(), and transferMotion().

void SoDragger::valueChanged ( void   ) 

Can be called by subclasses to trigger value changed callbacks. This might be needed if a field is changed without changing the motion matrix.

Referenced by childValueChangedCB(), SoTransformManip::fieldSensorCB(), SoSpotLightDragger::fieldSensorCB(), and setMotionMatrix().

const SbMatrix & SoDragger::getStartMotionMatrix ( void   ) 

void SoDragger::saveStartParameters ( void   )  [virtual]

This is invoked to save start parameters, to enable draggers to calculate relative motion.

Default method in superclass SoDragger just saves the motion matrix, but subclasses should overload this method if other data needs to be saved.

Reimplemented in SoCenterballDragger.

References getMotionMatrix().

Referenced by childStartCB(), SoTabPlaneDragger::drag(), SoTrackballDragger::dragFinish(), handleEvent(), and SoCenterballDragger::saveStartParameters().

const SoPath * SoDragger::getPickPath ( void   )  const

const SoEvent * SoDragger::getEvent ( void   )  const

SoPath * SoDragger::createPathToThis ( void   ) 

Creates a new path to this dragger. Don't forget to ref() and unref() since this method creates a fresh copy for you.

Referenced by getPartToLocalMatrix().

const SoPath * SoDragger::getSurrogatePartPickedOwner ( void   )  const

Returns the path to the SoInteractionKit that holds the current surrogate path.

const SbName & SoDragger::getSurrogatePartPickedName ( void   )  const

Returns the name of the path in the SoInteractionKit that holds the current surrogate path.

Referenced by SoTransformerDragger::dragStart(), SoTrackballDragger::dragStart(), SoTabPlaneDragger::dragStart(), and SoHandleBoxDragger::dragStart().

const SoPath * SoDragger::getSurrogatePartPickedPath ( void   )  const

Returns the current surrogate path.

void SoDragger::setStartingPoint ( const SoPickedPoint point  ) 

Sets the staring point for the drag. point is usually a picked point from a SoRayPickAction.

References SoPickedPoint::getPoint().

Referenced by SoTranslate2Dragger::drag(), SoTabPlaneDragger::drag(), SoTrackballDragger::dragStart(), and handleEvent().

void SoDragger::setStartingPoint ( const SbVec3f point  ) 

Sets the starting point for a drag.

const SbViewVolume & SoDragger::getViewVolume ( void   ) 

void SoDragger::setViewVolume ( const SbViewVolume vv  ) 

Sets the current view volume.

const SbViewportRegion & SoDragger::getViewportRegion ( void   ) 

Returns the current viewport region.

void SoDragger::setViewportRegion ( const SbViewportRegion vp  ) 

Sets the current viewport region.

SoHandleEventAction * SoDragger::getHandleEventAction ( void   )  const

Return the current (most recent) SoHandleEventAction.

void SoDragger::setHandleEventAction ( SoHandleEventAction action  ) 

Stores a handle event action.

void SoDragger::setTempPathToThis ( const SoPath somethingclose  ) 

This function is part of the original SGI Inventor 2.1 API, but has not been implemented in Coin as it looks like a function which should probably have been private in Open Inventor.

void SoDragger::grabEventsSetup ( void   )  [virtual]

Called when dragger starts grabbing events (mouse button down). Overload if you need to do something extra in your dragger.

See also:
grabEventCleanup()

Reimplemented from SoNode.

Referenced by handleEvent().

void SoDragger::grabEventsCleanup ( void   )  [virtual]

Called when dragger stops grabbing events (mouse button up).

See also:
grabEventSetup()

Reimplemented from SoNode.

Referenced by handleEvent().

void SoDragger::workFieldsIntoTransform ( SbMatrix matrix  ) 

void SoDragger::setFrontOnProjector ( ProjectorFrontSetting  val  ) 

Controls the behaviour of the SbProjector.

SoDragger::ProjectorFrontSetting SoDragger::getFrontOnProjector ( void   )  const

void SoDragger::setMinScale ( float  minscalearg  )  [static]

Sets the minimum scale value all scale factors are clamped against. This is used in workFieldsIntoTransform(). The default value is 0.01

float SoDragger::getMinScale ( void   )  [static]

Returns the minimum scale value.

See also:
setMinScale()

void SoDragger::workValuesIntoTransform ( SbMatrix matrix,
const SbVec3f translationptr,
const SbRotation rotationptr,
const SbVec3f scalefactorptr,
const SbRotation scaleorientationptr,
const SbVec3f centerptr 
) [static]

Same as above, but pointers to values are supplied. If a pointer is NULL, the matrix value for that argument is used when reconstructing the matrix.

References SbMatrix::getTransform(), and SbMatrix::setTransform().

Referenced by getTransformFast(), and workFieldsIntoTransform().

void SoDragger::getTransformFast ( SbMatrix matrix,
SbVec3f translation,
SbRotation rotation,
SbVec3f scalefactor,
SbRotation scaleorientation,
const SbVec3f center 
) [static]

Can be used when there is no scaleorientation. Faster than SoDragger::workValuesIntoTransform().

References workValuesIntoTransform().

void SoDragger::getTransformFast ( SbMatrix matrix,
SbVec3f translation,
SbRotation rotation,
SbVec3f scalefactor,
SbRotation scaleorientation 
) [static]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References workValuesIntoTransform().

SbMatrix SoDragger::appendTranslation ( const SbMatrix matrix,
const SbVec3f translation,
const SbMatrix conversion = NULL 
) [static]

Returns matrix after translation has been appended. If conversion != NULL it is used to transform translation into the space matrix is defined.

References SbMatrix::inverse(), SbMatrix::multLeft(), SbMatrix::multRight(), and SbMatrix::setTranslate().

Referenced by SoTranslate2Dragger::drag(), SoTranslate1Dragger::drag(), SoTabPlaneDragger::drag(), and SoHandleBoxDragger::drag().

SbMatrix SoDragger::appendScale ( const SbMatrix matrix,
const SbVec3f scale,
const SbVec3f scalecenter,
const SbMatrix conversion = NULL 
) [static]

SbMatrix SoDragger::appendRotation ( const SbMatrix matrix,
const SbRotation rot,
const SbVec3f rotcenter,
const SbMatrix conversion = NULL 
) [static]

Appends rot, around rotcenter, to matrix. If conversion is != NULL, this is used to move the rotation into that coordinate systems before appending the rotation.

References SbMatrix::inverse(), SbMatrix::multLeft(), SbMatrix::multRight(), SbMatrix::setRotate(), and SbMatrix::setTranslate().

Referenced by SoTrackballDragger::drag(), SoRotateSphericalDragger::drag(), SoRotateDiscDragger::drag(), and SoRotateCylindricalDragger::drag().

void SoDragger::initClass ( void   )  [static]

void SoDragger::initClasses ( void   )  [static]

Initializes all built-in draggers.

Reimplemented from SoNode.

References initClass().

Referenced by initClass().

SbVec2f SoDragger::getNormalizedLocaterPosition ( void   )  [protected]

SbVec2s SoDragger::getLocaterPosition ( void   )  [protected]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References SoDebugError::postInfo().

Referenced by isAdequateConstraintMotion().

SbVec2s SoDragger::getStartLocaterPosition ( void   )  const [protected]

Returns the position when mouse button 1 was pressed.

Referenced by isAdequateConstraintMotion().

void SoDragger::setStartLocaterPosition ( SbVec2s  pos  )  [protected]

The start locater position is automatically set when mouse button 1 goes down, but subclasses can use this method to reset the value.

Referenced by SoTranslate2Dragger::drag(), SoTabPlaneDragger::drag(), and SoHandleBoxDragger::drag().

SbBool SoDragger::isAdequateConstraintMotion ( void   )  [protected]

Checks if the mouse pointer has been moved enough after the end-user hit a constraint mode key (which is typically SHIFT, sometimes also CTRL for the built-in draggers) that we should act upon and decide which direction the constraint should be set to.

References getLocaterPosition(), and getStartLocaterPosition().

Referenced by SoTranslate2Dragger::drag(), SoTabPlaneDragger::drag(), and SoHandleBoxDragger::drag().

SbBool SoDragger::shouldGrabBasedOnSurrogate ( const SoPath pickpath,
const SoPath surrogatepath 
) [protected, virtual]

Checks if pickpath contains surrogatepath and returns TRUE if the tail of surrogatepath is before any dragger in pickpath.

References SoPath::containsPath(), getClassTypeId(), SoFullPath::getLength(), SoPath::getNode(), SoFullPath::getTail(), SoBase::isOfType(), and SoNode::pick().

Referenced by handleEvent().

void SoDragger::setCameraInfo ( SoAction action  )  [protected]

Store data about the current camera in the given action.

References SoFieldContainer::get(), SoCamera::getClassTypeId(), and SoAction::getState().

Referenced by handleEvent().

void SoDragger::handleEvent ( SoHandleEventAction action  )  [protected, virtual]

void SoDragger::transferMotion ( SoDragger child  )  [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

References getMotionMatrix(), getStartMotionMatrix(), SbMatrix::identity(), SbMatrix::multLeft(), setMotionMatrix(), transformMatrixLocalToWorld(), and transformMatrixWorldToLocal().

Referenced by childTransferMotionAndValueChangedCB().

void SoDragger::setIgnoreInBbox ( SbBool  val  )  [protected]

Sets whether dragger geometry should be ignored when calculating bbox.

SbBool SoDragger::isIgnoreInBbox ( void   )  [protected]

Returns whether dragger geometry should be ignored when calculating bbox.

void SoDragger::getBoundingBox ( SoGetBoundingBoxAction action  )  [protected, virtual]

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoBaseKit.

Reimplemented in SoCenterballDragger.

References SoBaseKit::getBoundingBox().

Referenced by SoCenterballDragger::getBoundingBox().

void SoDragger::setActiveChildDragger ( SoDragger childdragger  )  [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 childFinishCB(), and childStartCB().

SoDragger * SoDragger::getActiveChildDragger ( void   )  const [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 SoSpotLightDragger::drag(), SoSpotLightDragger::dragFinish(), SoSpotLightDragger::dragStart(), SoDragPointDragger::dragStart(), handleEvent(), and SoDragPointDragger::metaKeyChangeCB().

void SoDragger::setDefaultOnNonWritingFields ( void   )  [protected, virtual]

(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.)

This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scenegraph export operations.

This is typically done when:

  1. field value is NULL and part is NULL by default

  2. it is a leaf SoGroup or SoSeparator node with no children

  3. it is a leaf listpart with no children and an SoGroup or SoSeparator container

  4. it is a non-leaf part and it's of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method.

Reimplemented from SoInteractionKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, and SoTransformerDragger.

References SbRotation::identity(), SoField::setDefault(), and SoInteractionKit::setDefaultOnNonWritingFields().

Referenced by SoTransformerDragger::setDefaultOnNonWritingFields(), SoTransformBoxDragger::setDefaultOnNonWritingFields(), SoTrackballDragger::setDefaultOnNonWritingFields(), SoTabPlaneDragger::setDefaultOnNonWritingFields(), SoTabBoxDragger::setDefaultOnNonWritingFields(), SoSpotLightDragger::setDefaultOnNonWritingFields(), SoPointLightDragger::setDefaultOnNonWritingFields(), SoJackDragger::setDefaultOnNonWritingFields(), SoHandleBoxDragger::setDefaultOnNonWritingFields(), SoDragPointDragger::setDefaultOnNonWritingFields(), SoDirectionalLightDragger::setDefaultOnNonWritingFields(), and SoCenterballDragger::setDefaultOnNonWritingFields().

void SoDragger::childTransferMotionAndValueChangedCB ( void *  data,
SoDragger child 
) [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 addValueChangedCallback(), removeValueChangedCallback(), and transferMotion().

Referenced by registerChildDragger(), and unregisterChildDragger().

void SoDragger::childValueChangedCB ( void *  data,
SoDragger child 
) [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 valueChanged().

Referenced by registerChildDraggerMovingIndependently(), and unregisterChildDraggerMovingIndependently().

void SoDragger::childStartCB ( void *  data,
SoDragger child 
) [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 saveStartParameters(), and setActiveChildDragger().

Referenced by registerChildDragger(), registerChildDraggerMovingIndependently(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

void SoDragger::childMotionCB ( void *  data,
SoDragger child 
) [static, 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 registerChildDragger(), registerChildDraggerMovingIndependently(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

void SoDragger::childFinishCB ( void *  data,
SoDragger child 
) [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 setActiveChildDragger().

Referenced by registerChildDragger(), registerChildDraggerMovingIndependently(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

void SoDragger::childOtherEventCB ( void *  data,
SoDragger child 
) [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 pimpl.

Referenced by registerChildDragger(), registerChildDraggerMovingIndependently(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

void SoDragger::updateDraggerCache ( const SoPath path  )  [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

References SoPath::findNode().

Referenced by handleEvent().


Member Data Documentation

Is TRUE whenever the user is interacting with the dragger. For compound draggers (draggers consisting of one or more subdraggers), the isActive field is updated only for the active subdragger, not for the compound dragger.

Referenced by handleEvent(), SoTranslate2Dragger::metaKeyChangeCB(), SoTransformerDragger::metaKeyChangeCB(), SoHandleBoxDragger::metaKeyChangeCB(), and SoDragger().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:33:47 2009 for Coin by Doxygen. 1.5.8