Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SoDragPointDragger Class Reference

The SoDragPointDragger class provides mechanisms for moving a point in 3D. More...

#include <Inventor/draggers/SoDragPointDragger.h>

Inheritance diagram for SoDragPointDragger::

SoDragger SoInteractionKit SoBaseKit SoNode SoFieldContainer SoBase List of all members.

Public Methods

 SoDragPointDragger (void)
void setJumpLimit (const float limit)
float getJumpLimit (void) const
void showNextDraggerSet (void)

Static Public Methods

void initClass (void)

Public Attributes

SoSFVec3f translation

Protected Methods

 ~SoDragPointDragger ()
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
virtual void setDefaultOnNonWritingFields (void)
void dragStart (void)
void drag (void)
void dragFinish (void)

Static Protected Methods

void startCB (void *f, SoDragger *d)
void motionCB (void *f, SoDragger *d)
void finishCB (void *f, SoDragger *d)
void metaKeyChangeCB (void *f, SoDragger *d)
void fieldSensorCB (void *f, SoSensor *s)
void valueChangedCB (void *f, SoDragger *d)

Protected Attributes

SoFieldSensorfieldSensor

Detailed Description

The SoDragPointDragger class provides mechanisms for moving a point in 3D.

This dragger is convenient to use when it is desirable that the end-user should interact with points by positioning them freely in 3D space.

The dragger consists of a part for 2D motion in a plane (like the SoTranslate2Dragger) and another part on the axis normal to the plane.

While the dragger is inactive (ie the user is not currently grabbing and / or dragging it's parts), the CTRL keys on the keyboard can be used to switch the orientation of the 2D-plane part and the normal-axis part so the normal-axis part points along one of the other principal axes. This is done by position the mouse pointer over the dragger geometry and pressing and releasing a CTRL key.


Constructor & Destructor Documentation

SoDragPointDragger::SoDragPointDragger void
 

Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry.

SoDragPointDragger::~SoDragPointDragger [protected]
 

Protected destructor.

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


Member Function Documentation

void SoDragPointDragger::initClass void [static]
 

Initializes type system for this dragger class.

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

Reimplemented from SoDragger.

void SoDragPointDragger::setJumpLimit const float limit
 

The dragger plane jump limit is ignored in Coin, as we use a continuous moving plane.

This method still included for API compatibility with the original SGI Inventor API.

float SoDragPointDragger::getJumpLimit void const
 

The dragger plane jump limit is ignored in Coin, as we use a continuous moving plane.

This method still included for API compatibility with the original SGI Inventor API.

void SoDragPointDragger::showNextDraggerSet void
 

Circulate the dragger's three different sets of geometry, to circulate the orientation of the translation axis and translation plane through the three principal axes.

This function is triggered when the user taps the CTRL key.

SbBool SoDragPointDragger::setUpConnections SbBool onoff,
SbBool doitalways = FALSE
[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.

void SoDragPointDragger::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.)

A virtual method that 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 a 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 SoDragger.

void SoDragPointDragger::dragStart void [protected]
 

For internal use only.

void SoDragPointDragger::drag void [protected]
 

For internal use only.

void SoDragPointDragger::dragFinish void [protected]
 

For internal use only.

void SoDragPointDragger::startCB void * d,
SoDragger * d
[static, protected]
 

For internal use only.

void SoDragPointDragger::motionCB void * d,
SoDragger * d
[static, protected]
 

For internal use only.

void SoDragPointDragger::finishCB void * d,
SoDragger * d
[static, protected]
 

For internal use only.

void SoDragPointDragger::metaKeyChangeCB void * d,
SoDragger * d
[static, protected]
 

For internal use only.

void SoDragPointDragger::fieldSensorCB void * d,
SoSensor * s
[static, protected]
 

For internal use only.

Reimplemented from SoInteractionKit.

void SoDragPointDragger::valueChangedCB void * f,
SoDragger * d
[static, protected]
 

For internal use only.


Member Data Documentation

SoSFVec3f SoDragPointDragger::translation
 

Continuously updated to contain the current translation from the dragger's local origo position.

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.

SoFieldSensor * SoDragPointDragger::fieldSensor [protected]
 

For internal use only.

Reimplemented from SoInteractionKit.


The documentation for this class was generated from the following files:
Generated at Tue Mar 5 03:31:23 2002 for Coin by doxygen1.2.9 written by Dimitri van Heesch, © 1997-2001