Medical Imaging Interaction Toolkit  2024.06.99-5f7b36e7
Medical Imaging Interaction Toolkit
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,
  PACSBase, PACSStandard, PACSLevelWindow, PACSPan,
  PACSScroll, PACSZoom
}
 
typedef InteractionSchemeSwitcher Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
void SetInteractionScheme (mitk::InteractionEventHandler *interactionEventHandler, InteractionScheme interactionScheme)
 Set the current interaction scheme of the given interaction event handler. More...
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 

Protected Member Functions

 InteractionSchemeSwitcher ()
 
 ~InteractionSchemeSwitcher () override
 

Detailed Description

Definition at line 70 of file mitkInteractionSchemeSwitcher.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Definition at line 110 of file mitkInteractionSchemeSwitcher.h.

Member Enumeration Documentation

◆ InteractionScheme

Enumerator
MITKStandard 
MITKRotationUncoupled 
MITKRotationCoupled 
MITKSwivel 
PACSBase 
PACSStandard 
PACSLevelWindow 
PACSPan 
PACSScroll 
PACSZoom 

Definition at line 114 of file mitkInteractionSchemeSwitcher.h.

Constructor & Destructor Documentation

◆ InteractionSchemeSwitcher()

mitk::InteractionSchemeSwitcher::InteractionSchemeSwitcher ( )
protected

◆ ~InteractionSchemeSwitcher()

mitk::InteractionSchemeSwitcher::~InteractionSchemeSwitcher ( )
overrideprotected

Member Function Documentation

◆ GetClassHierarchy()

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

Definition at line 110 of file mitkInteractionSchemeSwitcher.h.

◆ GetClassName()

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

◆ GetStaticNameOfClass()

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

Definition at line 110 of file mitkInteractionSchemeSwitcher.h.

◆ New()

static Pointer mitk::InteractionSchemeSwitcher::New ( )
static

◆ 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-scheme or the PACS-scheme (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,ifthe interaction event handler is invalid (==nullptr).
Parameters
interactionEventHandlerThe interaction event handler that defines the interaction scheme via configuration files
interactionSchemeThe interaction scheme that should be used for the currently active interaction event handler.

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