#include <SoCSODrawOnSurfaceActions.h>

Inheritance diagram for SoCSODrawOnSurfaceDrawAction:

Public Member Functions
	SoCSODrawOnSurfaceDrawAction (SoCSODrawOnSurface *owner, int modifierKey)
void	setTriggerMask (int modifierKey)
bool	isInViewportRegion (const SoPointerPosition &pos) const
bool	isSensitiveAt (const SoPointerPosition &pos) override
void	startPressAt (const SoPointerPosition &pos) override
void	dragMoveTo (const SoPointerPosition &pos) override
	Continues the drag to given device position.
SoPointingAction *	endPress (int) override
int	getCurrentCursor (SoViewerProxy *) const override
Public Member Functions inherited from SoPointingAction
	SoPointingAction (SoInteractionOwner *owner, std::string id, bool positionSensitive=true)
virtual bool	isPositionSensitive () const
void	clearTriggers ()
	Removes all triggers.
void	setTrigger (int triggerMask, int ignoreMask=0)
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)
virtual int	getNumModes () const
virtual std::string	getCurrentStatusMessage () const
virtual void	setMode (int)
virtual void	setHighlightAt (const SoPointerPosition &)
virtual void	unsetHighlight ()
virtual void	dragCancelled ()
virtual bool	wantsMouseOverUpdates ()
void	grabReleased ()
virtual void	releaseGrab (StopMode)
virtual bool	wantsImmediateDragUpdates ()
Public Member Functions inherited from SoInteraction
	SoInteraction (InteractionType type, SoInteractionOwner *owner, const std::string &id, bool registerWithOwner=true)
virtual	~SoInteraction ()
SoInteractionOwner *	getOwner () const
	Returns the interaction provider of this entry.
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
InteractionType	getInteractionType () const
	Returns 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
	Returns the filename of an icon (e.g., for use in a tool box or in menu).
virtual void	setIconFile (const std::string &file)
	Sets the filename of an icon used for this interaction entry.
virtual std::string	getDescription () const
	Returns the description for user help.
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.

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 }
enum	{ TypeId = TypePointingAction }
typedef ManagedMouseButtonTrigger	Trigger
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 }
enum	InteractionType { TypePointingAction , TypeCommandAction , TypeOffsetAction }
	Enum identifying subtypes of this class. More...
Protected Member Functions inherited from SoPointingAction
virtual SoOffsetAction *	proxiedOffsetAction () const

Detailed Description

Definition at line 20 of file SoCSODrawOnSurfaceActions.h.

Constructor & Destructor Documentation

◆ SoCSODrawOnSurfaceDrawAction()

SoCSODrawOnSurfaceDrawAction::SoCSODrawOnSurfaceDrawAction	(	SoCSODrawOnSurface *	owner,
		int	modifierKey )

inline

Definition at line 23 of file SoCSODrawOnSurfaceActions.h.

References setTriggerMask(), and SoPointingAction::SoPointingAction().

Member Function Documentation

◆ dragMoveTo()

void SoCSODrawOnSurfaceDrawAction::dragMoveTo ( const SoPointerPosition & pos )

inlineoverridevirtual

Continues the drag to given device position.

Implements SoPointingAction.

Definition at line 67 of file SoCSODrawOnSurfaceActions.h.

References dragMoveTo(), SoInteraction::getOwner(), and isInViewportRegion().

Referenced by dragMoveTo().

◆ endPress()

SoPointingAction * SoCSODrawOnSurfaceDrawAction::endPress ( int clickCount )

inlineoverridevirtual

Ends the drag at last device position. If this method returns a non-NULL SoPointingAction, the pointing device is restricted to this SoPointingAction until releaseGrab() is called or another call to endPress returns NULL. This is useful if the end user is required to click at at least one other position.

Note that locking of the returned action breaks down if the same node is used in several viewers, since each viewer usually has its own interaction controller that manages locked actions on its own.

Parameters

clickCount gives the number of clicks at the last start position. This is, for a normal drag it is 0, for a single click it is 1, for a double click it is 2, and for a triple click it is 3. Note that for a clickCount greater than zero, you will not have received any dragMoveTo calls if wantsImmediateDragUpdates returns false.

Implements SoPointingAction.

Definition at line 79 of file SoCSODrawOnSurfaceActions.h.

References endPress(), SoInteraction::getOwner(), and SoPointingAction::SoPointingAction().

Referenced by endPress().

◆ getCurrentCursor()

int SoCSODrawOnSurfaceDrawAction::getCurrentCursor ( SoViewerProxy * ) const

inlineoverridevirtual

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().

The SoViewerProxy pointer is provided so one can define custom cursors when this method is called (see header file SoViewerProxy.h for instructions).

Reimplemented from SoPointingAction.

Definition at line 85 of file SoCSODrawOnSurfaceActions.h.

References SoInteraction::getOwner().

◆ isInViewportRegion()

bool SoCSODrawOnSurfaceDrawAction::isInViewportRegion ( const SoPointerPosition & pos ) const

inline

Definition at line 40 of file SoCSODrawOnSurfaceActions.h.

References SoPointerPosition::getAction().

Referenced by dragMoveTo().

◆ isSensitiveAt()

bool SoCSODrawOnSurfaceDrawAction::isSensitiveAt ( const SoPointerPosition & pos )

inlineoverridevirtual

Returns true if the gesture is startable at the given device position. Otherwise, a mouse click will be handed to another SoPointingAction and the cursor shape of this action is ignored!

Note: Only called if isPositionSensitive() returns true.

Implements SoPointingAction.

Definition at line 49 of file SoCSODrawOnSurfaceActions.h.

References SoPointerPosition::getAction(), and SoInteraction::getOwner().

◆ setTriggerMask()

void SoCSODrawOnSurfaceDrawAction::setTriggerMask ( int modifierKey )

inline

Definition at line 28 of file SoCSODrawOnSurfaceActions.h.

References SoInteraction::AllModifiersMask, SoPointingAction::Button1Mask, and SoPointingAction::setTrigger().

Referenced by SoCSODrawOnSurfaceDrawAction().

◆ startPressAt()

void SoCSODrawOnSurfaceDrawAction::startPressAt ( const SoPointerPosition & pos )

inlineoverridevirtual

Starts a drag at given device position. It is guaranteed that this will be followed by (possibly) dragMoveTo calls and either an endPress or dragCancelled call.

Implements SoPointingAction.

Definition at line 62 of file SoCSODrawOnSurfaceActions.h.

References SoInteraction::getOwner(), and startPressAt().

Referenced by startPressAt().

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