Medical Imaging Interaction Toolkit  2024.12.99-0da743f6
Medical Imaging Interaction Toolkit
mitk::EventRecorder Class Reference

Observer that enables recoding of all user interaction with the render windows and storing it in an XML file. More...

#include <mitkEventRecorder.h>

Inheritance diagram for mitk::EventRecorder:
Collaboration diagram for mitk::EventRecorder:

Public Member Functions

 EventRecorder ()
 
 ~EventRecorder () override
 
void Notify (InteractionEvent *interactionEvent, bool) override
 
void SetEventIgnoreList (std::vector< std::string > list)
 SetEventIgnoreList Optional. Provide a list of strings that describe which events are to be ignored. More...
 
void StartRecording ()
 
void StopRecording ()
 
bool IsActive ()
 
void SetOutputFile (std::string filename)
 
- Public Member Functions inherited from mitk::InteractionEventObserver
 InteractionEventObserver ()
 
virtual ~InteractionEventObserver ()
 
void Disable ()
 
void Enable ()
 
bool IsEnabled () const
 

Detailed Description

Observer that enables recoding of all user interaction with the render windows and storing it in an XML file.

XML file will look like:

<?xml version="1.0"?>
<interactions>
<config>
<renderer RendererName="stdmulti.widget0" ViewDirection="0"/>
<renderer RendererName="stdmulti.widget1" ViewDirection="1"/>
<renderer RendererName="stdmulti.widget2" ViewDirection="2"/>
</config>
<events>
<event_variant class="MOUSEMOVEEVENT" >
<attribute name="PositionOnScreen" value="491,388"/>
<attribute name="PositionInWorld" value="128,235.771,124.816"/>
<attribute name="RendererName" value="stdmulti.widget1"/>
</event_variant>
</events>
</interactions>

Definition at line 49 of file mitkEventRecorder.h.

Constructor & Destructor Documentation

◆ EventRecorder()

mitk::EventRecorder::EventRecorder ( )

◆ ~EventRecorder()

mitk::EventRecorder::~EventRecorder ( )
override

Member Function Documentation

◆ IsActive()

bool mitk::EventRecorder::IsActive ( )
inline

Definition at line 68 of file mitkEventRecorder.h.

◆ Notify()

void mitk::EventRecorder::Notify ( InteractionEvent interactionEvent,
bool   
)
overridevirtual

By this function the Observer gets notified about new events.

Implements mitk::InteractionEventObserver.

◆ SetEventIgnoreList()

void mitk::EventRecorder::SetEventIgnoreList ( std::vector< std::string >  list)

SetEventIgnoreList Optional. Provide a list of strings that describe which events are to be ignored.

◆ SetOutputFile()

void mitk::EventRecorder::SetOutputFile ( std::string  filename)
inline

Definition at line 69 of file mitkEventRecorder.h.

◆ StartRecording()

void mitk::EventRecorder::StartRecording ( )

◆ StopRecording()

void mitk::EventRecorder::StopRecording ( )

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