MeVisLabToolboxReference
SoInteractionProvider Class Referenceabstract

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

#include <SoInteractionProvider.h>

Inheritance diagram for SoInteractionProvider:
SoInteractionOwner SoInteractionProviderNode SoView2D SoInteractionNode SoView2DExtension SoCSO3DVis SoPicking SoView2DBorder SoView2DCallback SoView2DCSOEditor SoView2DCSOExtensibleEditor SoView2DDeformationGridView SoView2DEnlargeOnClick SoView2DExtensionSampler SoView2DExtensionSeparator SoView2DInteractionExtension SoView2DLabel SoView2DLegend SoView2DMagnifyController SoView2DShaderDevicePosition SoView2DShaderOverlay SoView2DTouchControl SoView2DTransRot SoView2DVectorFieldView SoView2DVoxelView

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 *)
 Callback function type. More...
 
static void registerInteractionProviderNode (SoType type, GetProviderFunc func)
 Register a function to obtain a SoInteractionProvider from a SoNode. More...
 
static SoInteractionProvidergetInteractionProvider (SoNode *node)
 Get 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 34 of file SoInteractionProvider.h.

Member Typedef Documentation

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

Callback function type.

Definition at line 65 of file SoInteractionProvider.h.

Constructor & Destructor Documentation

SoInteractionProvider::SoInteractionProvider ( )

Default constructor.

virtual SoInteractionProvider::~SoInteractionProvider ( )
inlinevirtual

Definition at line 40 of file SoInteractionProvider.h.

Member Function Documentation

virtual std::list<SoCommandAction*> SoInteractionProvider::getCommandActions ( SoState *  state)
virtual
static SoInteractionProvider* SoInteractionProvider::getInteractionProvider ( SoNode *  node)
static

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

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

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

Returns the list of all interactions of this provider.

Implemented in SoInteractionOwner.

Referenced by getInteractionsOfType().

template<class T >
std::list< T * > SoInteractionProvider::getInteractionsOfType ( SoState *  state)

Returns list of interactions of a specific type:

Definition at line 81 of file SoInteractionProvider.h.

References getInteractions(), and T.

virtual std::list<SoOffsetAction*> SoInteractionProvider::getOffsetActions ( SoState *  state)
virtual
virtual std::list<SoPointingAction*> SoInteractionProvider::getPointingActions ( SoState *  state)
virtual
virtual void SoInteractionProvider::pointerLeftWindow ( SoState *  state)
pure virtual

This is called when the mouse cursor leaves the window.

Implemented in SoInteractionOwner.

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 SoInteractionOwner.

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

Register a function to obtain a SoInteractionProvider from a SoNode.


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