SoInteractionProvider Class Reference

SoInteractionProvider is an abstract interface class that provides interactions to the SoInteractionController. More...

#include <SoInteractionProvider.h>

Inheritance diagram for SoInteractionProvider:

Public Member Functions
	SoInteractionProvider ()
	Default constructor. More...
virtual	~SoInteractionProvider ()
virtual std::list< SoInteraction * >	getInteractions (SoState *state)=0
	Returns the list of all interactions of this provider. More...
template<class T >
std::list< T * >	getInteractionsOfType (SoState *state)
	Returns list of interactions of a specific type. More...
virtual void	pointerPosition (SoState *state, const SoPointerPosition &pos)=0
	Override this to always be informed of the current mouse cursor position. More...
virtual void	pointerLeftWindow (SoState *state)=0
	This is called when the mouse cursor leaves the window. More...
These methods simply use getInteractionsOfType
virtual std::list< SoCommandAction * >	getCommandActions (SoState *state)
virtual std::list< SoPointingAction * >	getPointingActions (SoState *state)
virtual std::list< SoOffsetAction * >	getOffsetActions (SoState *state)
typedef SoInteractionProvider *(*	GetProviderFunc) (SoNode *)
static void	registerInteractionProviderNode (SoType type, GetProviderFunc func)
	Registers a function to obtain a SoInteractionProvider from a SoNode. More...
static SoInteractionProvider *	getInteractionProvider (SoNode *node)
	Returns a SoInteractionProvider from a SoNode if registered, else NULL. More...

Detailed Description

SoInteractionProvider is an abstract interface class that provides interactions to the SoInteractionController.

Definition at line 38 of file SoInteractionProvider.h.

Member Typedef Documentation

GetProviderFunc

typedef SoInteractionProvider*(* SoInteractionProvider::GetProviderFunc) (SoNode *)

Callback function type.

Definition at line 69 of file SoInteractionProvider.h.

Constructor & Destructor Documentation

SoInteractionProvider()

SoInteractionProvider::SoInteractionProvider

(

)

Default constructor.

~SoInteractionProvider()

virtual SoInteractionProvider::~SoInteractionProvider ( )

inlinevirtual

Definition at line 44 of file SoInteractionProvider.h.

Member Function Documentation

getCommandActions()

virtual std::list<SoCommandAction*> SoInteractionProvider::getCommandActions ( SoState *  state )

virtual

getInteractionProvider()

static SoInteractionProvider* SoInteractionProvider::getInteractionProvider ( SoNode *  node )

static

Returns a SoInteractionProvider from a SoNode if registered, else NULL.

This is, e.g., used in the SoInteractionCollection class of the SoInteractionControllers library.

getInteractions()

virtual std::list<SoInteraction*> SoInteractionProvider::getInteractions ( SoState *  state )

pure virtual

Returns the list of all interactions of this provider.

Implemented in View2DInteractionProvider, and SoInteractionOwner.

Referenced by getInteractionsOfType().

getInteractionsOfType()

template<class T >

std::list< T * > SoInteractionProvider::getInteractionsOfType

(

SoState *

state

)

Returns list of interactions of a specific type.

Definition at line 85 of file SoInteractionProvider.h.

References getInteractions(), and T.

getOffsetActions()

virtual std::list<SoOffsetAction*> SoInteractionProvider::getOffsetActions ( SoState *  state )

virtual

getPointingActions()

virtual std::list<SoPointingAction*> SoInteractionProvider::getPointingActions ( SoState *  state )

virtual

pointerLeftWindow()

virtual void SoInteractionProvider::pointerLeftWindow ( SoState *  state )

pure virtual

This is called when the mouse cursor leaves the window.

Implemented in View2DInteractionProvider, SoView2DSliceZoom, SoView2DLabel, SoInteractionOwner, and SoView2DRectangle.

pointerPosition()

virtual void SoInteractionProvider::pointerPosition ( SoState *  state, const SoPointerPosition &  pos  )

pure virtual

Override this to always be informed of the current mouse cursor position.

Implemented in View2DInteractionProvider, SoView2DSliceZoom, SoView2DLabel, SoInteractionOwner, and SoView2DRectangle.

registerInteractionProviderNode()

static void SoInteractionProvider::registerInteractionProviderNode ( SoType  type, GetProviderFunc  func  )

static

Registers a function to obtain a SoInteractionProvider from a SoNode.

---

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

• MeVis/Foundation/Sources/SoManagedInteraction/SoInteractionProvider.h