wxTst::VtkWxGuiTestHelper Class Reference

Helper methods for wxVtk interaction recording (Singleton pattern). More...

#include <VtkWxGuiTestHelper.h>

Collaboration diagram for wxTst::VtkWxGuiTestHelper:

[legend]

List of all members.

Public Types
typedef std::map< wxString, WxVtkInteractorEventRecorder * >	RecorderMap
Public Member Functions
virtual WxVtkInteractorEventRecorder *	GetWxVtkRecorder (const wxString &recorderId) const
	Get registered wxVtk interaction recorder, or NULL.
virtual RecorderMap &	GetWxVtkRecorders ()
	Get all registered wxVtk interaction recorders.
virtual void	RegisterForRecording (wxVTKRenderWindowInteractor *wxVtkRwi, const wxString &recorderId, const wxString &wxVtkId)
	Register a wxVtk interactor for recording.
Static Public Member Functions
static void	Destroy ()
	Threadsafe destruction of static singleton instance.
static VtkWxGuiTestHelper *	GetInstance ()
	Get single private instance.
static bool	GetUseWxVtkInteractionRecording ()
	Get flag indicating usage of wxVtk interaction recording.
static void	SetUseWxVtkInteractionRecording (bool use)
	Set flag indicating usage of wxVtk interaction recording.
Public Attributes
RecorderMap	m_recorderMap
Protected Member Functions
	VtkWxGuiTestHelper ()
	Constructor.
virtual	~VtkWxGuiTestHelper ()
	Destructor.

---

Detailed Description

Helper methods for wxVtk interaction recording (Singleton pattern).

Definition at line 32 of file VtkWxGuiTestHelper.h.

---

Member Typedef Documentation

typedef std::map< wxString, WxVtkInteractorEventRecorder * > wxTst::VtkWxGuiTestHelper::RecorderMap

Definition at line 35 of file VtkWxGuiTestHelper.h.

---

Constructor & Destructor Documentation

wxTst::VtkWxGuiTestHelper::VtkWxGuiTestHelper

(

)

[protected]

Constructor.

Definition at line 29 of file VtkWxGuiTestHelper.cpp.

Referenced by GetInstance().

wxTst::VtkWxGuiTestHelper::~VtkWxGuiTestHelper

(

)

[protected, virtual]

Destructor.

Definition at line 35 of file VtkWxGuiTestHelper.cpp.

References m_recorderMap.

---

Member Function Documentation

void wxTst::VtkWxGuiTestHelper::Destroy

(

)

[static]

Threadsafe destruction of static singleton instance.

Definition at line 57 of file VtkWxGuiTestHelper.cpp.

VtkWxGuiTestHelper * wxTst::VtkWxGuiTestHelper::GetInstance

(

)

[static]

Get single private instance.

Returns:

single private instance

Definition at line 47 of file VtkWxGuiTestHelper.cpp.

References VtkWxGuiTestHelper().

bool wxTst::VtkWxGuiTestHelper::GetUseWxVtkInteractionRecording

(

)

[static]

Get flag indicating usage of wxVtk interaction recording.

Returns:

true, if wxVtk interaction should is recorded

Definition at line 73 of file VtkWxGuiTestHelper.cpp.

WxVtkInteractorEventRecorder * wxTst::VtkWxGuiTestHelper::GetWxVtkRecorder

(

const wxString &

recorderId

)

const [virtual]

Get registered wxVtk interaction recorder, or NULL.

Parameters:

recorderId

string ID of recorder

Returns:

registerd wxVtk interaction recorder, or NULL if none exists with the given ID

Definition at line 102 of file VtkWxGuiTestHelper.cpp.

References m_recorderMap.

Referenced by RegisterForRecording().

VtkWxGuiTestHelper::RecorderMap & wxTst::VtkWxGuiTestHelper::GetWxVtkRecorders

(

)

[virtual]

Get all registered wxVtk interaction recorders.

Returns:

map of all registered wxVtk interaction recorders

Definition at line 112 of file VtkWxGuiTestHelper.cpp.

References m_recorderMap.

void wxTst::VtkWxGuiTestHelper::RegisterForRecording	(	wxVTKRenderWindowInteractor *	wxVtkRwi,
		const wxString &	recorderId,
		const wxString &	wxVtkId
	)			[virtual]

Register a wxVtk interactor for recording.

Does nothing in non-testing mode.

Parameters:

	wxVtkRwi	wxVtk interactor to register
	recorderId	string identifying the recorder (several views may want to share the recorder in the shape of multiplexing)
	wxVtkId	string identifying the wxVtk interactor to assign the recorded events to a single view in case of shared recorder

Definition at line 79 of file VtkWxGuiTestHelper.cpp.

References wxTst::WxVtkInteractorEventRecorder::AddInteractor(), GetWxVtkRecorder(), m_recorderMap, wxTst::WxVtkInteractorEventRecorder::New(), and wxTst::WxVtkInteractorEventRecorder::SetFileName().

void wxTst::VtkWxGuiTestHelper::SetUseWxVtkInteractionRecording

(

bool

use

)

[static]

Set flag indicating usage of wxVtk interaction recording.

Parameters:

use

true if wxVtk interaction should be recorded

Definition at line 67 of file VtkWxGuiTestHelper.cpp.

---

Member Data Documentation

RecorderMap wxTst::VtkWxGuiTestHelper::m_recorderMap

Definition at line 36 of file VtkWxGuiTestHelper.h.

Referenced by GetWxVtkRecorder(), GetWxVtkRecorders(), RegisterForRecording(), and ~VtkWxGuiTestHelper().

---

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

• VtkWxGuiTestHelper.h
• VtkWxGuiTestHelper.cpp