CSOPointingAction Class Reference

#include <CSOPointingAction.h>

Inheritance diagram for CSOPointingAction:

Public Member Functions
	CSOPointingAction (SoView2DCSOExtensibleEditor *editor, const std::string &id)
Public Member Functions inherited from SoPointingAction
	SoPointingAction (SoInteractionOwner *owner, std::string id, bool positionSensitive=true)
	Standard constructor.
virtual bool	isPositionSensitive () const
	Position sensitive actions can only start at positions where isSensitiveAt() return true.
void	clearTriggers ()
	remove all triggers
void	setTrigger (int triggerMask, int ignoreMask=0)
	Sets the (only) default modifier/button mask for triggering this action.
void	setTrigger (const Trigger &trigger)
	Same with Trigger object.
void	addTrigger (const Trigger &trigger)
	Adds another default modifier/button mask as trigger.
TriggerList	getTriggers () const
	Returns the list of default modifier/button mask combinations set for this action.
virtual bool	triggersAction (int mask)
	Returns whether the given modifier/button combination activates this action according to the default bindings.
virtual int	getNumModes () const
	Returns the number of different modes this action has - modes can be changed during drag and handle drag restrictions or drag result.
virtual int	getCurrentCursor (SoViewerProxy *) const
	Returns the cursor ID to display for this action, as defined in SoViewerProxy.h - this gets (at least) called after setMode(), isSensitiveAt(), startPressAt(), dragMoveTo(), and endPress().
virtual std::string	getCurrentStatusMessage () const
	Returns a status message for display in status bar (make it short!), this will get called at same time as getCurrentCursor.
virtual void	setMode (int)
	This gets called if the mode was changed and before startPressAt is called.
virtual bool	isSensitiveAt (const SoPointerPosition &pos)=0
	Returns true if the gesture is startable at the given device position.
virtual void	setHighlightAt (const SoPointerPosition &)
	This method is called so that highlighting of objects under the mouse cursor can occur.
virtual void	unsetHighlight ()
	Remove any highlighting if this method is called.
virtual void	startPressAt (const SoPointerPosition &pos)=0
	Starts a drag at given device position.
virtual void	dragMoveTo (const SoPointerPosition &pos)=0
	Continues the drag to given device position.
virtual SoPointingAction *	endPress (int clickCount)=0
	Ends the drag at last device position.
virtual void	dragCancelled ()
	This is called if the current drag operation is cancelled, e.g.
virtual bool	wantsMouseOverUpdates ()
	Override this to return true if this action should get location updates directly before rendering, so it can update its status.
void	grabReleased ()
	Call this to release an interaction grab that has been established by the return value of endPress(), e.g., because it was aborted through a SoCommandAction.
virtual void	releaseGrab (StopMode)
	This will be called by the controller if you should release the grab established by endPress.
virtual bool	wantsImmediateDragUpdates ()
	Let this method return false if you don't want dragMoveTo to be called until it is clear that the interaction will not be handled as a click (endPress will be called with a clickCount greater zero).
Public Member Functions inherited from SoInteraction
	SoInteraction (InteractionType type, SoInteractionOwner *owner, const std::string &id, bool registerWithOwner=true)
	Standard constructor.
virtual	~SoInteraction ()
	Virtual destructor.
SoInteractionOwner *	getOwner () const
virtual bool	isEnabled () const
virtual void	setEnabled (bool enabled)
	Sets the enabled status of this interaction.
std::string	getID () const
void	setID (const std::string &id)
	Sets the id of this interaction.
std::string	getFullID () const
	Returns the ID string consisting of the id of the provider and this action's id, separated by '.
InteractionType	getInteractionType () const
	Get type of interaction object.
template<class T >
bool	isOfType () const
	Convenience method for checking type.
int	getMenuPriority () const
void	setMenuPriority (int priority)
	Sets the priority value for ordered display in menus/tool boxes.
virtual std::string	getUserName () const
virtual void	setUserName (const std::string &name)
	Sets the user name of this interaction entry.
virtual std::string	getIconFile () const
virtual void	setIconFile (const std::string &file)
	Sets the filename of an icon used for this interaction entry.
virtual std::string	getDescription () const
virtual void	setDescription (const std::string &descr)
	Sets the description for user help.
virtual void	ref ()
virtual void	unref ()
int	getStateVersion () const
void	touch ()
	Increments the version number of attribute state to mark attribute changes.

Protected Member Functions
bool	isInsideImage (const SoPointerPosition &pos)
	Returns whether the position is inside the image if needsValidVoxel is set; Otherwise, it just returns true.
void	setView2DImage (const SoPointerPosition &pos)
void	updateImageStatistics (ml::CSO *cso)
void	setActionActive ()
	Set/unset the maskValid flag in the editor.
void	unsetActionActive ()
Protected Member Functions inherited from SoPointingAction
virtual SoOffsetAction *	proxiedOffsetAction () const

Protected Attributes
SoView2DCSOExtensibleEditor *	_editor
SoSFMLImage *	_image

Additional Inherited Members
Public Types inherited from SoPointingAction
enum	StopMode { AbortAction , FinishAction }
	Argument type for releaseGrab() More...
enum	{ Button1Mask = ManagedMouseButtonTrigger::Button1Mask , Button2Mask = ManagedMouseButtonTrigger::Button2Mask , Button3Mask = ManagedMouseButtonTrigger::Button3Mask , AllButtonsMask = ManagedMouseButtonTrigger::AllButtonsMask }
	Configuration values for the Trigger type. More...
enum	{ TypeId = TypePointingAction }
typedef ManagedMouseButtonTrigger	Trigger
	Class Trigger encapsulates the combination of required and ignored button and modifier keys that activate a pointing action.
typedef std::list< Trigger >	TriggerList
	List of triggers.
Public Types inherited from SoInteraction
enum	{   NoModifier = ManagedActionTrigger::NoModifier , ShiftModifier = ManagedActionTrigger::ShiftModifier , ControlModifier = ManagedActionTrigger::ControlModifier , AltModifier = ManagedActionTrigger::AltModifier ,   AllModifiersMask = ManagedActionTrigger::AllModifiersMask , ShiftMask = ShiftModifier , CtrlMask = ControlModifier , AltMask = AltModifier }
	Constants to use where keyboard modifiers must be specified. More...
enum	InteractionType { TypePointingAction , TypeCommandAction , TypeOffsetAction }
	Enum identifying sub-types of this class. More...

Detailed Description

Definition at line 32 of file CSOPointingAction.h.

Constructor & Destructor Documentation

CSOPointingAction()

CSOPointingAction::CSOPointingAction	(	SoView2DCSOExtensibleEditor *	editor,
		const std::string &	id )

Member Function Documentation

isInsideImage()

bool CSOPointingAction::isInsideImage ( const SoPointerPosition & pos )

protected

Returns whether the position is inside the image if needsValidVoxel is set; Otherwise, it just returns true.

setActionActive()

void CSOPointingAction::setActionActive ( )

protected

Set/unset the maskValid flag in the editor.

setView2DImage()

void CSOPointingAction::setView2DImage ( const SoPointerPosition & pos )

protected

unsetActionActive()

void CSOPointingAction::unsetActionActive ( )

protected

updateImageStatistics()

void CSOPointingAction::updateImageStatistics ( ml::CSO * cso )

protected

Member Data Documentation

_editor

SoView2DCSOExtensibleEditor* CSOPointingAction::_editor

protected

Definition at line 52 of file CSOPointingAction.h.

_image

SoSFMLImage* CSOPointingAction::_image

protected

Definition at line 54 of file CSOPointingAction.h.

---

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

• MeVisLab/Standard/Sources/Inventor/SoCSO/SoView2DCSOEditor/SoView2DCSOExtensibleEditor/CSOActions/CSOPointingAction.h