mitk::InteractionSchemeSwitcher Class Reference

#include <mitkInteractionSchemeSwitcher.h>

Inheritance diagram for mitk::InteractionSchemeSwitcher:

Collaboration diagram for mitk::InteractionSchemeSwitcher:

Public Types
enum	InteractionScheme {   MITKStandard, MITKRotationUncoupled, MITKRotationCoupled, MITKSwivel,   PACSStandard, PACSLevelWindow, PACSPan, PACSScroll,   PACSZoom }
typedef InteractionSchemeSwitcher	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
	itkEventMacro (InteractionSchemeChangedEvent, itk::AnyEvent)
	Can be observed by GUI class to update button states when type is changed programmatically. More...
virtual std::vector< std::string >	GetClassHierarchy () const
virtual const char *	GetClassName () const
Pointer	Clone () const
void	SetInteractionScheme (mitk::InteractionEventHandler *interactionEventHandler, InteractionScheme interactionScheme)
	Set the current interaction scheme of the given interaction event handler. More...
InteractionScheme	GetInteractionScheme () const
	Return the current interaction scheme. More...

Static Public Member Functions
static const char *	GetStaticNameOfClass ()
static Pointer	New ()

Protected Member Functions
	InteractionSchemeSwitcher ()
	~InteractionSchemeSwitcher () override

Detailed Description

Definition at line 60 of file mitkInteractionSchemeSwitcher.h.

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer<const Self> mitk::InteractionSchemeSwitcher::ConstPointer

Definition at line 70 of file mitkInteractionSchemeSwitcher.h.

Pointer

typedef itk::SmartPointer<Self> mitk::InteractionSchemeSwitcher::Pointer

Definition at line 70 of file mitkInteractionSchemeSwitcher.h.

Self

typedef InteractionSchemeSwitcher mitk::InteractionSchemeSwitcher::Self

Definition at line 70 of file mitkInteractionSchemeSwitcher.h.

Superclass

typedef itk::Object mitk::InteractionSchemeSwitcher::Superclass

Definition at line 70 of file mitkInteractionSchemeSwitcher.h.

Member Enumeration Documentation

InteractionScheme

enum mitk::InteractionSchemeSwitcher::InteractionScheme

Enumerator
MITKStandard
MITKRotationUncoupled
MITKRotationCoupled
MITKSwivel
PACSStandard
PACSLevelWindow
PACSPan
PACSScroll
PACSZoom

Definition at line 75 of file mitkInteractionSchemeSwitcher.h.

Constructor & Destructor Documentation

InteractionSchemeSwitcher()

mitk::InteractionSchemeSwitcher::InteractionSchemeSwitcher ( )

protected

Definition at line 23 of file mitkInteractionSchemeSwitcher.cpp.

~InteractionSchemeSwitcher()

mitk::InteractionSchemeSwitcher::~InteractionSchemeSwitcher ( )

overrideprotected

Definition at line 29 of file mitkInteractionSchemeSwitcher.cpp.

Member Function Documentation

Clone()

Pointer mitk::InteractionSchemeSwitcher::Clone

(

)

const

GetClassHierarchy()

virtual std::vector<std::string> mitk::InteractionSchemeSwitcher::GetClassHierarchy ( ) const

inlinevirtual

Definition at line 70 of file mitkInteractionSchemeSwitcher.h.

GetClassName()

virtual const char* mitk::InteractionSchemeSwitcher::GetClassName ( ) const

virtual

GetInteractionScheme()

InteractionScheme mitk::InteractionSchemeSwitcher::GetInteractionScheme ( ) const

inline

Return the current interaction scheme.

Returns

The currently set InteractionScheme

Definition at line 109 of file mitkInteractionSchemeSwitcher.h.

GetStaticNameOfClass()

static const char* mitk::InteractionSchemeSwitcher::GetStaticNameOfClass ( )

inlinestatic

Definition at line 70 of file mitkInteractionSchemeSwitcher.h.

itkEventMacro()

mitk::InteractionSchemeSwitcher::itkEventMacro	(	InteractionSchemeChangedEvent	,
		itk::AnyEvent
	)

Can be observed by GUI class to update button states when type is changed programmatically.

New()

static Pointer mitk::InteractionSchemeSwitcher::New ( )

static

Referenced by QmitkInteractionSchemeToolBar::QmitkInteractionSchemeToolBar(), and QmitkAbstractMultiWidget::SetInteractionScheme().

SetInteractionScheme()

void mitk::InteractionSchemeSwitcher::SetInteractionScheme	(	mitk::InteractionEventHandler *	interactionEventHandler,
		InteractionScheme	interactionScheme
	)

Set the current interaction scheme of the given interaction event handler.

The interaction event handler is able to accept xml-configuration files that will define the interaction scheme. Based on the given interaction scheme different configuration files are loaded into the interaction event handler. The interaction scheme can be a variant of the MITK-mouse mode or the PACS-mouse mode (see 'enum InteractionScheme'). The default is 'MITKStandard'. If the interaction scheme has been changed, an 'InteractionSchemeChangedEvent' will be invoked.

Precondition

The interaction event handler has to be valid (!nullptr).

Exceptions

mitk::Exception,if

the interaction event handler is invalid (==nullptr).

Parameters

interactionEventHandler	The interaction event handler that defines the interaction scheme via configuration files
interactionScheme	The interaction scheme that should be used for the currently active interaction event handler.

Definition at line 34 of file mitkInteractionSchemeSwitcher.cpp.

References mitk::InteractionEventHandler::AddEventConfig(), MITKRotationCoupled, MITKRotationUncoupled, MITKStandard, MITKSwivel, mitkThrow, PACSLevelWindow, PACSPan, PACSScroll, PACSStandard, PACSZoom, and mitk::InteractionEventHandler::SetEventConfig().

---

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

• mitkInteractionSchemeSwitcher.h
• mitkInteractionSchemeSwitcher.cpp