Creates everything needed to load and playback interaction events. More...

#include <mitkInteractionTestHelper.h>

Collaboration diagram for mitk::InteractionTestHelper:

[legend]

Public Types
typedef std::vector< mitk::RenderWindow::Pointer >	RenderWindowListType

Public Member Functions
	InteractionTestHelper (const std::string &interactionXmlFilePath)
	InteractionTestHelper set up all neseccary objects by calling Initialize. More...

virtual	~InteractionTestHelper ()

mitk::DataStorage::Pointer	GetDataStorage ()
	Returns the datastorage, in order to modify the data inside a rendering test. More...

void	AddNodeToStorage (mitk::DataNode::Pointer node)
	AddNodeToStorage Add a node to the datastorage and perform a reinit which is necessary for rendering. More...

void	PlaybackInteraction ()
	PlaybackInteraction playback loaded interaction by passing events to the dispatcher. More...

void	SetTimeStep (int newTimeStep)
	SetTimeStep Sets timesteps of all SliceNavigationControllers to given timestep. More...

const RenderWindowListType &	GetRenderWindowList ()

RenderWindow *	GetRenderWindowByName (const std::string &name)
	GetRenderWindowByName Get renderWindow by the name of its renderer. More...

RenderWindow *	GetRenderWindowByDefaultViewDirection (mitk::SliceNavigationController::ViewDirection viewDirection)
	GetRenderWindowByDefaultViewDirection Get a renderWindow by its default viewdirection. More...

RenderWindow *	GetRenderWindow (unsigned int index)
	GetRenderWindow Get renderWindow at position 'index'. More...

void	AddDisplayPlaneSubTree ()
	AddDisplayPlaneSubTree. More...

void	Set3dCameraSettings ()

Protected Member Functions
void	Initialize (const std::string &interactionXmlFilePath)
	Initialize Internal method to initialize the renderwindow and set the datastorage. More...

void	LoadInteraction ()
	LoadInteraction loads events from xml file. More...

Protected Attributes
mitk::XML2EventParser::EventContainerType	m_Events

std::string	m_InteractionFilePath

RenderWindowListType	m_RenderWindowList

mitk::DataStorage::Pointer	m_DataStorage

mitk::MouseModeSwitcher::Pointer	m_MouseModeSwitcher

Detailed Description

Creates everything needed to load and playback interaction events.

The interaction is loaded from an xml file and the event are created. This file is usually a recorded user interaction with the GUI. This can be done with InteractionEventRecorder plugin. Also all necessary objects to handle interaction events are generated. The user of this class is responsible to add the data object to interact with to the data storage of InteractionTestHelper. And must also make sure that a proper data interactor is associated with the data object.

To test a PointSet interaction for instance make sure you have a PointSet node and a PointSetDataInteractor. Then just add the node to the storage of the your InteractionTestHelper by calling InteractionTestHelper::AddNodeToStorage. Use InteractionTestHelper::PlaybackInteraction to execute. The result can afterwards be compared to a reference object.

Make sure to destroy the test helper instance after each test, since all render windows and its renderers have to be unregistered.

See also: XML2EventParser; EventFactory; EventRecorder

Definition at line 51 of file mitkInteractionTestHelper.h.

Member Typedef Documentation

◆ RenderWindowListType

typedef std::vector<mitk::RenderWindow::Pointer> mitk::InteractionTestHelper::RenderWindowListType

Definition at line 88 of file mitkInteractionTestHelper.h.

Constructor & Destructor Documentation

◆ InteractionTestHelper()

mitk::InteractionTestHelper::InteractionTestHelper ( const std::string & interactionXmlFilePath )

InteractionTestHelper set up all neseccary objects by calling Initialize.

Parameters

interactionXmlFilePath path to xml file containing events and configuration information for the render windows.

Definition at line 29 of file mitkInteractionTestHelper.cpp.

References Initialize().

◆ ~InteractionTestHelper()

mitk::InteractionTestHelper::~InteractionTestHelper ( )

virtual

Definition at line 180 of file mitkInteractionTestHelper.cpp.

References mitk::SliceNavigationController::Disconnect(), mitk::RenderingManager::GetInstance(), mitk::RenderingManager::GetTimeNavigationController(), m_RenderWindowList, and mitk::BaseRenderer::RemoveInstance().

Member Function Documentation

◆ AddDisplayPlaneSubTree()

void mitk::InteractionTestHelper::AddDisplayPlaneSubTree ( )

AddDisplayPlaneSubTree.

Creates DisplayPlanes that are shown in a 3D RenderWindow.

Definition at line 314 of file mitkInteractionTestHelper.cpp.

References mitk::BaseRenderer::GetInstance(), m_DataStorage, m_RenderWindowList, mitk::BoolProperty::New(), mitk::IntProperty::New(), mitk::StringProperty::New(), mitk::PlaneGeometryDataMapper2D::New(), mitk::DataNode::New(), mitk::BaseRenderer::Standard2D, and mitk::BaseRenderer::Standard3D.

Referenced by Initialize().

◆ AddNodeToStorage()

void mitk::InteractionTestHelper::AddNodeToStorage ( mitk::DataNode::Pointer node )

AddNodeToStorage Add a node to the datastorage and perform a reinit which is necessary for rendering.

Parameters

node	The data you want to add.

Definition at line 202 of file mitkInteractionTestHelper.cpp.

References m_DataStorage, and Set3dCameraSettings().

◆ GetDataStorage()

mitk::DataStorage::Pointer mitk::InteractionTestHelper::GetDataStorage ( )

Returns the datastorage, in order to modify the data inside a rendering test.

Definition at line 197 of file mitkInteractionTestHelper.cpp.

References m_DataStorage.

◆ GetRenderWindow()

mitk::RenderWindow * mitk::InteractionTestHelper::GetRenderWindow ( unsigned int index )

GetRenderWindow Get renderWindow at position 'index'.

Parameters

index Position within the renderWindow list.

Returns: nullptr if index is out of bounds.

Definition at line 302 of file mitkInteractionTestHelper.cpp.

References m_RenderWindowList.

◆ GetRenderWindowByDefaultViewDirection()

mitk::RenderWindow * mitk::InteractionTestHelper::GetRenderWindowByDefaultViewDirection ( mitk::SliceNavigationController::ViewDirection viewDirection )

GetRenderWindowByDefaultViewDirection Get a renderWindow by its default viewdirection.

Parameters

viewDirection