Base class for nodekits that move in response to click-drag-release mouse events. More...

#include <Inventor/draggers/SoDragger.h>

Inheritance diagram for SoDragger:

Public Types
enum	ProjectorFrontSetting { FRONT, BACK, USE_PICK }
	These control behavior of the rotational parts. More...
Public Member Functions
void	addStartCallback (SoDraggerCB f, void userData=NULL)
	Start callbacks are made after the mouse button 1 goes down and the dragger determines that it has been picked.
void	removeStartCallback (SoDraggerCB f, void userData=NULL)
void	addMotionCallback (SoDraggerCB f, void userData=NULL)
	Motion callbacks are called after each movement of the mouse during dragging.
void	removeMotionCallback (SoDraggerCB f, void userData=NULL)
	Motion callbacks are called after each movement of the mouse during dragging.
void	addFinishCallback (SoDraggerCB f, void userData=NULL)
	Finish callbacks are made after dragging ends and the dragger has stopped grabbing events.
void	removeFinishCallback (SoDraggerCB f, void userData=NULL)
	Finish callbacks are made after dragging ends and the dragger has stopped grabbing events.
void	addValueChangedCallback (SoDraggerCB f, void userData=NULL)
	Value-changed callbacks are made after a dragger changes any of its fields.
void	removeValueChangedCallback (SoDraggerCB f, void userData=NULL)
void	setMinGesture (int pixels)
	Set and get the number of pixels of movement required to initiate a constraint gesture.
int	getMinGesture () const
	Set and get the number of pixels of movement required to initiate a constraint gesture.
SbBool	enableValueChangedCallbacks (SbBool newVal)
	You can temporarily disable a dragger's valueChangedCallbacks.
const SbMatrix &	getMotionMatrix ()
	Get the motion matrix.
void	addOtherEventCallback (SoDraggerCB f, void userData=NULL)
	In addition to the public callback functions, these callback functions can also be used by subclasses to find out when things have happened.
void	removeOtherEventCallback (SoDraggerCB f, void userData=NULL)
void	registerChildDragger (SoDragger *child)
	Compound draggers should call this for each child dragger so that user callbacks (valueChanged, start, motion, finish, other event) registered with the parent dragger will be invoked based on the child dragger.
void	unregisterChildDragger (SoDragger *child)
void	registerChildDraggerMovingIndependently (SoDragger *child)
	These two routines tie the child to the parent, but WITHOUT the transferMotion callback.
void	unregisterChildDraggerMovingIndependently (SoDragger *child)
SbMatrix	getLocalToWorldMatrix ()
	Get the matrix which converts from one dragger space to another.
SbMatrix	getWorldToLocalMatrix ()
SbVec3f	getLocalStartingPoint ()
	Returns the starting point in local coordinates.
SbVec3f	getWorldStartingPoint ()
	Returns the starting point in world coordinates.
void	getPartToLocalMatrix (const SbName &partName, SbMatrix &partToLocalMatrix, SbMatrix &localToPartMatrix)
	Get the matrix which converts from the space of one part into local space.
void	transformMatrixLocalToWorld (const SbMatrix &fromMatrix, SbMatrix &toMatrix)
	Transforms a given matrix from one space into another space.
void	transformMatrixWorldToLocal (const SbMatrix &fromMatrix, SbMatrix &toMatrix)
void	transformMatrixToLocalSpace (const SbMatrix &fromMatrix, SbMatrix &toMatrix, const SbName &fromSpacePartName)
void	setMotionMatrix (const SbMatrix &newMatrix)
	Set the motion matrix.
void	valueChanged ()
	Invokes the valueChangedCallbacks.
const SbMatrix &	getStartMotionMatrix ()
	Used to calculate motion relative to the dragger's position at the beginning of the dragging.
virtual void	saveStartParameters ()
	By default, saves the motionMatrix as the startMotionMatrix.
const SoPath *	getPickPath () const
	Information that's good to have during a valueChanged callback.
const SoEvent *	getEvent () const
SoPath *	createPathToThis ()
	Creates a new path leading to this dragger, if the last path given by setTempPathToThis() is still valid.
const SoPath *	getSurrogatePartPickedOwner () const
	Surrogate Pick Information.
const SbName &	getSurrogatePartPickedName () const
	Name: Name of the surrogate part within the owners list.
const SoPath *	getSurrogatePartPickedPath () const
	SurrogatePath: The owner's surrogate path for this name.
void	setStartingPoint (const SoPickedPoint *newPoint)
	Set the point where the drag begins.
void	setStartingPoint (const SbVec3f &newPoint)
	The SbVec3f version would usually be a point saved from the end of another gesture.
const SbViewVolume &	getViewVolume ()
	Information about the window an event occurred in.
void	setViewVolume (const SbViewVolume &vol)
const SbViewportRegion &	getViewportRegion ()
void	setViewportRegion (const SbViewportRegion &reg)
SoHandleEventAction *	getHandleEventAction () const
	Get the most recent handleEventAction.
void	setHandleEventAction (SoHandleEventAction *newAction)
void	setTempPathToThis (const SoPath *somethingClose)
	A path leading to 'this.
virtual void	grabEventsSetup ()
	Called when the dragger gains or loses status as "grabber" of events.
virtual void	grabEventsCleanup ()
void	workFieldsIntoTransform (SbMatrix &mtx)
	Changes only that part of the matrix for which this dragger has fields.
void	setFrontOnProjector (ProjectorFrontSetting newVal)
ProjectorFrontSetting	getFrontOnProjector () const
Static Public Member Functions
static void	setMinScale (float newMinScale)
	The smallest scale that any dragger will write.
static float	getMinScale ()
	Get min scale.
static void	workValuesIntoTransform (SbMatrix &mtx, const SbVec3f translationPtr, const SbRotation rotationPtr, const SbVec3f scaleFactorPtr, const SbRotation scaleOrientationPtr, const SbVec3f *centerPtr)
	Same as above, but values are given explicitly as pointers.
static void	getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scaleFactor, SbRotation &scaleOrientation, const SbVec3f &center)
	Faster versions of getTransform() and factor() that take advantage of the case where there is no scaleOrientation.
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)
	Appends the given motion to the end of 'mtx'.
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 ()
	initialize the class
static void	initClasses ()
	Initialize ALL Inventor detail classes.
Public Attributes
SoSFBool	isActive
	This field is a boolean that is TRUE when the mouse is down and we are dragging, FALSE otherwise.
Protected Member Functions
	SoDragger ()
	Constructor.
SbVec2f	getNormalizedLocaterPosition ()
	Get the last known position of the locator (mouse).
SbVec2s	getLocaterPosition ()
SbVec2s	getStartLocaterPosition () const
	Get the position of the locater when dragging started.
void	setStartLocaterPosition (SbVec2s p)
	The start locater position is automatically set when button 1 goes down over the dragger.
SbBool	isAdequateConstraintMotion ()
	Has the locater moved far enough from where it started to choose a constraint gesture.
virtual SbBool	shouldGrabBasedOnSurrogate (const SoPath pickPath, const SoPath surrogatePath)
	Given a pickPath and a surrogatePath, decides whether it should grab based on the surrogate.
void	setCameraInfo (SoAction *action)
	The dragger looks in this action to get information about the camera and the viewport.
virtual void	handleEvent (SoHandleEventAction *ha)
	This is called during traversal by a HandleEventAction.
void	transferMotion (SoDragger *child)
	This should be called by every child dragger of a compound dragger as a result of compoundDragger->registerChildDragger( childDragger ); Called on the compoundDragger when childDragger's value changes.
void	setIgnoreInBbox (SbBool newVal)
	Set/get whether the dragger should be ignored during bounding box calculations.
SbBool	isIgnoreInBbox ()
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
	Implements getBoundingBox action.
void	setActiveChildDragger (SoDragger *newChildDragger)
	Called by the above child callbacks.
SoDragger *	getActiveChildDragger () const
virtual void	setDefaultOnNonWritingFields ()
	Called by the SoBaseKit::write() method.
virtual	~SoDragger ()
Static Protected Member Functions
static void	childTransferMotionAndValueChangedCB (void , SoDragger )
	Stubs used by compound draggers to get user callbacks from the child dragger.
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 )

Detailed Description

SoDragger is the base class for all nodekits you move by using the mouse to click-drag-and-release. More specifically, they are operated by a start (mouse button 1 pressed over dragger to pick it), followed by dragging (mouse motion events are interpreted by the dragger and result in some form of motion and/or change to a field), followed by finish (mouse up).

Each dragger has a different paradigm for interpreting mouse motion and changing its fields as a result. Draggers map 2D mouse motion into motion of a point on 3D lines, planes, spheres or cylinders. (See the SbProjector reference pages.) Then they react to this motion of a point through 3-space by scaling, translating, or rotating. For example, SoTranslate2Dragger maps mouse motion onto a 3D plane, then translates to follow the cursor as it moves within that plane.

Every dragger has fields that describe its current state. Scaling draggers have a scaleFactor field, rotational draggers have a rotation field, etc. All draggers have the isActive field, defined in this class. It is TRUE while the dragger is being dragged, FALSE otherwise.

Draggers that have only one part to pick and one motion field are called simple draggers. Examples are the SoRotateDiscDragger, SoScale1Dragger, and SoTranslate2Dragger.

Draggers that create assemblies out of other draggers and then orchestrate the motion of the whole assembly are call composite draggers. SoTransformBoxDragger is a composite dragger made entirely of simple draggers. SoDirectionalLightDragger contains both a simple dragger (SoRotateSphericalDragger) and a composite dragger (SoDragPointDragger) When using a composite dragger, the fields of the composite dragger are the ones you should work with. Draggers lower down in the assemblage usually have zeroed out values. For example, when you drag the face of a transformBox, an SoTranslate2Dragger, the transformBox "steals" the translation from the child dragger and transfers it up to the top of the composite dragger, where it effects all pieces of the assemblage.

Draggers always keep their fields up to date, including while they are being dragged. So you can use field-to-field connections and engines to connect dragger values to other parts of your scene graph. Hence draggers can be easily utilized as input devices for mouse-driven 3D interface elements. You can also register value-changed callbacks, which are called whenever any of the fields is changed.

Also, if you set the field of a dragger through some method other than dragging, (by calling setValue(), for example), the dragger's internal SoFieldSensor will sense this and the dragger will move to satisfy that new value.

This makes it easy to constrain draggers to keep their fields within certain limits: if the limit is exceeded, just set it back to the exceeded maximum or minimum. You can do this even as the dragger is in use, by constraining the field value within a value-changed callback that you add with addValueChangedCallback(). In this case, be sure to temporarily disable the other value-changed callbacks using enableValueChangedCallbacks(). Doing this will prevent infinite-looping; changing the value followed by calling the callbacks which change the value ad infinitum.

When you drag a dragger, the dragger only moves itself. Draggers do not change the state or affect objects that follow in the scene graph. For example a dragger does not ever behave like an SoTransform and change the current transformation matrix. Draggers are not transforms, even if they have field names like translation, rotation, scaleFactor. Many draggers, such as SoTrackballDragger, have a corresponding SoTransformManip, in this case SoTrackballManip. The manipulator is a subclass of SoTransform, and affects other objects in the scene; it uses a trackball dragger to provide its user interface. In this way, draggers are employed extensively by manipulators. Callback functions on the dragger allow its employer to be notified of start, motion, finish, and value changes. In all cases, the callback function is passed a pointer to the dragger which initiated the callback. (See the various man pages for more details on specific draggers and manipulators).

All draggers are nodekits. However, draggers do not list their parts in the Parts section of the reference page. Instead, there is a section called Dragger Resources, more suited to describe the parts made available to the programmer. Because of space limitations, the Dragger Resources section only appears in the online versions of the reference pages. Each dragger has some parts you can pick on, and other parts that replace them when they are active or moving. These active parts are often just the same geometry in another color. Draggers also have pieces for displaying feedback. Each of these pieces has a default scene graph, as well as a special function within the dragger. Each part also has a resource name. All this information is contained in the DRAGGER RESOURCES section.

Since draggers are nodekits, you can set the parts in any instance of a dragger using setPart().

But draggers also give each part a resource name. When a dragger builds a part, it looks in the global dictionary for the node with that resourceName . By putting a new entry in the dictionary, you can override that default. The default part geometries are defined as resources for each class, and each class has a file you can change to alter the defaults. The files are listed in each dragger's man page. You can make your program use different default resources for the parts by copying the listed file from the directory /usr/share/data/draggerDefaults into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.

See Also

Definition at line 225 of file SoDragger.h.

Member Enumeration Documentation

enum SoDragger::ProjectorFrontSetting

If FRONT, no matter where you hit the dragger relative to its center, it will behave as if you are dragging from the front. If BACK, the rear. If USE_PICK, then it depends on the relationship between the picked point and the center of the dragger.

Enumerator:

FRONT
BACK
USE_PICK

Definition at line 498 of file SoDragger.h.

Constructor & Destructor Documentation

SoDragger::SoDragger ( ) [protected]

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

Member Function Documentation

void SoDragger::addFinishCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

void SoDragger::addMotionCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

void SoDragger::addOtherEventCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

otherEvent callbacks are called in response to events other than the standard button1Down, mouseMotion, and button1Up events. They are only called if the dragger has grabbed (which occurs only when button1 goes down and picks the dragger).

void SoDragger::addStartCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

If it is going to begin dragging, it grabs events and invokes the startCallbacks.

void SoDragger::addValueChangedCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

This does not include changes to the isActive field. See also enableValueChangedCallbacks.

static SbMatrix SoDragger::appendRotation	(	const SbMatrix &	mtx,
		const SbRotation &	rot,
		const SbVec3f &	rotCenter,
		const SbMatrix *	conversion = `NULL`
	)		`[static]`

static SbMatrix SoDragger::appendScale	(	const SbMatrix &	mtx,
		const SbVec3f &	scale,
		const SbVec3f &	scaleCenter,
		const SbMatrix *	conversion = `NULL`
	)		`[static]`

static SbMatrix SoDragger::appendTranslation	(	const SbMatrix &	mtx,
		const SbVec3f &	translation,
		const SbMatrix *	conversion = `NULL`
	)		`[static]`

'conversion' transforms from the space the motion is defined in to the space 'mtx'.

static void SoDragger::childFinishCB	(	void *	,
		SoDragger *
	)		`[static, protected]`

static void SoDragger::childMotionCB	(	void *	,
		SoDragger *
	)		`[static, protected]`

static void SoDragger::childOtherEventCB	(	void *	,
		SoDragger *
	)		`[static, protected]`

static void SoDragger::childStartCB	(	void *	,
		SoDragger *
	)		`[static, protected]`

static void SoDragger::childTransferMotionAndValueChangedCB	(	void *	,
		SoDragger *
	)		`[static, protected]`

static void SoDragger::childValueChangedCB	(	void *	,
		SoDragger *
	)		`[static, protected]`

SoPath* SoDragger::createPathToThis ( )

Will return NULL if not possible. You must ref() and unref() this new path if you don't want it (and all the nodes along it) to stay around forever.

SbBool SoDragger::enableValueChangedCallbacks ( SbBool newVal )

The method returns a value that tells you if callbacks were already enabled. Use this method if you write a valueChanged callback of your own and you change one of the dragger's fields within the callback. (For example, when writing a callback to constrain your dragger). Disable first, then change the field, then re-enable the callbacks (if they were enabled to start with). All this prevents you from entering an infinite loop of changing values, calling callbacks which change values, etc.

SoDragger* SoDragger::getActiveChildDragger ( ) const [inline, protected]

Definition at line 583 of file SoDragger.h.

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

Differs from separator as follows: If the 'ignoreInBbox' flag is set to TRUE, then it will return without traversing children.

Reimplemented from SoBaseKit.

Reimplemented in SoCenterballDragger.

const SoEvent* SoDragger::getEvent ( ) const

ProjectorFrontSetting SoDragger::getFrontOnProjector ( ) const [inline]

Definition at line 503 of file SoDragger.h.

SoHandleEventAction* SoDragger::getHandleEventAction ( ) const [inline]

Definition at line 425 of file SoDragger.h.

SbVec3f SoDragger::getLocalStartingPoint ( )

SbMatrix SoDragger::getLocalToWorldMatrix ( )

SbVec2s SoDragger::getLocaterPosition ( ) [protected]

int SoDragger::getMinGesture ( ) const [inline]

Default is 8.

Definition at line 270 of file SoDragger.h.

static float SoDragger::getMinScale ( ) [inline, static]

Definition at line 277 of file SoDragger.h.

const SbMatrix& SoDragger::getMotionMatrix ( )

The motion matrix places the dragger relative to its parent space. (Generally, it is better to look in a dragger's fields to find out about its state. For example, looking at the 'translation' field of an SoTranslate1Dragger is easier than extracting the translation from its motion matrix.

SbVec2f SoDragger::getNormalizedLocaterPosition ( ) [protected]

2D locater positions have (0,0) at lower-left, and are relative to the viewport. Normalized positions go from 0.0 to 1.0. Regular positions go from 0 to (vpSize - 1)

void SoDragger::getPartToLocalMatrix	(	const SbName &	partName,
		SbMatrix &	partToLocalMatrix,
		SbMatrix &	localToPartMatrix
	)

Good to use if transforms occur between 'motionMatrix' and the space you want to work in. Note: This routine will try not to create parts that don't exist. Instead it finds the existing part that precedes it in traversal. But this only works if the partName is in this nodekit's catalog. If the part is nested within another kit below this one or sitting inside a list part, the part will be created when it doesn't exist.

const SoPath* SoDragger::getPickPath ( ) const

SbVec2s SoDragger::getStartLocaterPosition ( ) const [inline, protected]

Definition at line 520 of file SoDragger.h.

const SbMatrix& SoDragger::getStartMotionMatrix ( ) [inline]

Definition at line 369 of file SoDragger.h.

const SbName& SoDragger::getSurrogatePartPickedName ( ) const [inline]

Definition at line 395 of file SoDragger.h.

const SoPath* SoDragger::getSurrogatePartPickedOwner ( ) const [inline]

This is relevant if the we are dragging based on the pick of a surrogate part. This happens when you call SoInteractionKit::setPartAsPath() and thus specify a 'stand-in' path to pick when initiating a drag. Owner: Path to the InteractionKit that owns the surrogate part.

Definition at line 391 of file SoDragger.h.

const SoPath* SoDragger::getSurrogatePartPickedPath ( ) const [inline]

This path may differ from the actual pickPath, but it is guaranteed to be contained within the pickPath.

Definition at line 401 of file SoDragger.h.

static void SoDragger::getTransformFast	(	SbMatrix &	mtx,
		SbVec3f &	translation,
		SbRotation &	rotation,
		SbVec3f &	scaleFactor,
		SbRotation &	scaleOrientation,
		const SbVec3f &	center
	)		`[static]`

Reverts to slow method if it needs to. This method will not work if the matrix given contains any scales less than zero, and it does not check for that case.

static void SoDragger::getTransformFast	(	SbMatrix &	mtx,
		SbVec3f &	translation,
		SbRotation &	rotation,
		SbVec3f &	scaleFactor,
		SbRotation &	scaleOrientation
	)		`[static]`

const SbViewportRegion& SoDragger::getViewportRegion ( ) [inline]

Definition at line 421 of file SoDragger.h.

const SbViewVolume& SoDragger::getViewVolume ( ) [inline]

Upon construction, the values are defaults. When drag begins, new values are taken from the handleEventAction and used for the duration of the drag. When drag ends, new values are taken from the final handleEventAction.

Definition at line 418 of file SoDragger.h.

SbVec3f SoDragger::getWorldStartingPoint ( )

SbMatrix SoDragger::getWorldToLocalMatrix ( )

virtual void SoDragger::grabEventsCleanup ( ) [virtual]

Reimplemented from SoNode.

virtual void SoDragger::grabEventsSetup ( ) [virtual]

Reimplemented from SoNode.

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

It calls ha->setHandled() if the event is handled.

Reimplemented from SoBaseKit.

static void SoDragger::initClass ( ) [static]

static void SoDragger::initClasses ( ) [static]

Reimplemented from SoNode.

SbBool SoDragger::isAdequateConstraintMotion ( ) [protected]

SbBool SoDragger::isIgnoreInBbox ( ) [inline, protected]

Definition at line 563 of file SoDragger.h.

void SoDragger::registerChildDragger ( SoDragger * child )

Also, this will add the 'transferMotion' callback as a valueChanged callback on the child.

void SoDragger::registerChildDraggerMovingIndependently ( SoDragger * child )

It is good for child draggers that need to move independently of their parents, but which should still call the parents (valueChanged, start, motion, end, and otherEvent) callbacks when they are dragged.

void SoDragger::removeFinishCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

void SoDragger::removeMotionCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

void SoDragger::removeOtherEventCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

void SoDragger::removeStartCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

See also:: addStartCallback

void SoDragger::removeValueChangedCallback	(	SoDraggerCB *	f,
		void *	userData = `NULL`
	)

See also:: addValueChangedCallback

virtual void SoDragger::saveStartParameters ( ) [virtual]

Subclasses may want to save additional info. For example, the centerballDragger also saves the matrix that moves the center relative to the motionMatrix.

Reimplemented in SoCenterballDragger.

void SoDragger::setActiveChildDragger ( SoDragger * newChildDragger ) [protected]

Establishes which child dragger is currently active. Set at beginning of child callback, returned to original value at end. Returns current value at time method is called.

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

Usually the action used is just the handleEventAction.

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

Draggers don't want to write out fields if they have default vals.

sets isActive to default if default and not connected.

Looks for fields named: 'rotation' with value SbRotation::identity() 'translation' with value (0,0,0) 'center' with value (0,0,0) 'scaleFactor' with value (1,1,1) and sets them to default if they are not connected from a field. (most draggers are missing at least some of these, but thats okay)

Then calls the method for SoInteractionKit.

NOTE: Parts which are set to default may still wind up writing to file if, for example, they lie on a path.

Reimplemented from SoInteractionKit.

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

void SoDragger::setFrontOnProjector ( ProjectorFrontSetting newVal ) [inline]

Definition at line 501 of file SoDragger.h.

void SoDragger::setHandleEventAction ( SoHandleEventAction * newAction )

void SoDragger::setIgnoreInBbox ( SbBool newVal ) [inline, protected]

Definition at line 562 of file SoDragger.h.

void SoDragger::setMinGesture ( int pixels ) [inline]

Default is 8.

Definition at line 267 of file SoDragger.h.

static void SoDragger::setMinScale ( float newMinScale ) [inline, static]

If the user attempts to go below this amount, the dragger will set it to this minimum. Default is .001

Definition at line 275 of file SoDragger.h.

void SoDragger::setMotionMatrix ( const SbMatrix & newMatrix )

Triggers value changed callbacks, but only if (newMatrix != the current motionMatrix)

void SoDragger::setStartingPoint ( const SoPickedPoint * newPoint )

The pickedPoint version would usually be the result of a pick.

void SoDragger::setStartingPoint ( const SbVec3f & newPoint )

For example, when a modifier key goes down, we might save the current position and use it to begin another connected gesture.

void SoDragger::setStartLocaterPosition ( SbVec2s p ) [inline, protected]

Subclasses may wish to reset it, such as when a constraint key goes down during dragging.

Definition at line 525 of file SoDragger.h.

void SoDragger::setTempPathToThis ( const SoPath * somethingClose )

' It is used to calculate the motionMatrix. It is set when a dragger first grabs event, through the handleEvent action, or by setCameraInfo() if NULL at the time.

void SoDragger::setViewportRegion ( const SbViewportRegion & reg ) [inline]

Definition at line 422 of file SoDragger.h.

void SoDragger::setViewVolume ( const SbViewVolume & vol ) [inline]

Definition at line 419 of file SoDragger.h.

virtual SbBool SoDragger::shouldGrabBasedOnSurrogate	(	const SoPath *	pickPath,
		const SoPath *	surrogatePath
	)		`[protected, virtual]`

First, the pickPath must contain the surrogatePath, indicating that the surrogate was picked. Second, we consider the part of the pickPath below the point where the surrogatePath ends. If this bottom section contains other draggers, then we will pass it up. This is because the other draggers will want to grab when they find out they've been picked.

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

Gets the motionMatrix from a the child dragger. Appends that change to the parent dragger's savedStartMatrix, and sets the result as the parent's motionMatrix. Then, it zeros out the motionMatrix of the child dragger.

void SoDragger::transformMatrixLocalToWorld	(	const SbMatrix &	fromMatrix,
		SbMatrix &	toMatrix
	)

void SoDragger::transformMatrixToLocalSpace	(	const SbMatrix &	fromMatrix,
		SbMatrix &	toMatrix,
		const SbName &	fromSpacePartName
	)

void SoDragger::transformMatrixWorldToLocal	(	const SbMatrix &	fromMatrix,
		SbMatrix &	toMatrix
	)

void SoDragger::unregisterChildDragger ( SoDragger * child )

void SoDragger::unregisterChildDraggerMovingIndependently ( SoDragger * child )

void SoDragger::valueChanged ( )

These are invoked whenever setMotionMatrix() changes the motion matrix. If a subclass wishes to invoke the valueChanged callbacks for some other reason, they may call valueChanged(). Example: SoSpotLightDragger changes its angle field without altering the motionMatrix. So it calls valueChanged() to invoke callbacks.

void SoDragger::workFieldsIntoTransform ( SbMatrix & mtx )

For instance, when called by an SoTranslate1Dragger, any rotations and scales in the matrix will remain unchanged. But the translation will be replaced with value in the 'translation' field. First, factor mtx to get values for the following: trans, rot, scale, scaleOrient. If there's a center field, send it to the factor method. Replace any of these four values if fields are found named 'translation' 'scaleFactor' 'rotation' and/or 'scaleOrientation' Note that this could be all or none of the 4 listed. Values for which no fields are found remain unchanged. Build a new matrix using the new values. Some may be the originals and some may have been replaced.

static void SoDragger::workValuesIntoTransform	(	SbMatrix &	mtx,
		const SbVec3f *	translationPtr,
		const SbRotation *	rotationPtr,
		const SbVec3f *	scaleFactorPtr,
		const SbRotation *	scaleOrientationPtr,
		const SbVec3f *	centerPtr
	)		`[static]`

If the pointers are NULL, the values in the matrix are not changed.

Member Data Documentation

SoSFBool SoDragger::isActive

Definition at line 235 of file SoDragger.h.

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

MeVis/ThirdParty/Sources/Inventor/inventor/lib/interaction/include/Inventor/draggers/SoDragger.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation