record and play VTK events passing through a vtkRenderWindowInteractor More...

#include <vtkInteractorEventRecorder.h>

Inheritance diagram for vtkInteractorEventRecorder:

Collaboration diagram for vtkInteractorEventRecorder:

Public Types
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkInteractorEventRecorder *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetEnabled (int) override
	Methods for turning the interactor observer on and off, and determining its state. More...

void	SetInteractor (vtkRenderWindowInteractor *iren) override
	This method is used to associate the widget with the render window interactor. More...

virtual void	SetFileName (const char *)
	Set/Get the name of a file events should be written to/from. More...

virtual char *	GetFileName ()

void	Record ()
	Invoke this method to begin recording events. More...

void	Play ()
	Invoke this method to begin playing events from the current position. More...

void	Stop ()
	Invoke this method to stop recording/playing events. More...

void	Rewind ()
	Rewind to the beginning of the file. More...

virtual void	SetReadFromInputString (vtkTypeBool)
	Enable reading from an InputString as compared to the default behavior, which is to read from a file. More...

virtual vtkTypeBool	GetReadFromInputString ()

virtual void	ReadFromInputStringOn ()

virtual void	ReadFromInputStringOff ()

virtual void	SetInputString (const char *)
	Set/Get the string to read from. More...

virtual char *	GetInputString ()

Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual vtkRenderWindowInteractor *	GetInteractor ()

virtual void	SetPriority (float)
	Set/Get the priority at which events are processed. More...

virtual float	GetPriority ()

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool managed)

virtual bool	GetPickingManaged ()

virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual vtkTypeBool	GetKeyPressActivation ()

virtual void	KeyPressActivationOn ()

virtual void	KeyPressActivationOff ()

virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...

virtual char	GetKeyPressActivationValue ()

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer. More...

virtual void	SetDefaultRenderer (vtkRenderer *)

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer. More...

virtual void	SetCurrentRenderer (vtkRenderer *)

virtual void	OnChar ()
	Sets up the keypress-i event. More...

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...

void	ReleaseFocus ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

Static Public Member Functions
static vtkInteractorEventRecorder *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorEventRecorder *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes. More...

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Types
enum	WidgetState { Start = 0, Playing, Recording }

enum	ModifierKey { ShiftKey = 1, ControlKey = 2, AltKey = 4 }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorEventRecorder ()

	~vtkInteractorEventRecorder () override

virtual void	WriteEvent (const char event, int pos[2], int modifiers, int keyCode, int repeatCount, char keySym)

virtual void	ReadEvent ()

Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	StartInteraction ()
	Utility routines used to start and end interaction. More...

virtual void	EndInteraction ()

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses. More...

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong. More...

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...

int	RequestCursorShape (int requestedShape)

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	ProcessCharEvent (vtkObject object, unsigned long event, void clientdata, void *calldata)

static void	ProcessDeleteEvent (vtkObject object, unsigned long event, void clientdata, void *calldata)

static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
	Handles the char widget activation event. More...

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
char *	FileName

vtkCallbackCommand *	DeleteEventCallbackCommand

vtkTypeBool	ReadFromInputString

char *	InputString

istream *	InputStream

ostream *	OutputStream

int	State

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

vtkTypeBool	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static float	StreamVersion

Detailed Description

record and play VTK events passing through a vtkRenderWindowInteractor

vtkInteractorEventRecorder records all VTK events invoked from a vtkRenderWindowInteractor. The events are recorded to a file. vtkInteractorEventRecorder can also be used to play those events back and invoke them on an vtkRenderWindowInteractor. (Note: the events can also be played back from a file or string.)

The format of the event file is simple. It is: EventName X Y ctrl shift keycode repeatCount keySym The format also allows "#" comments.

See also: vtkInteractorObserver vtkCallback

Events:: vtkCommand::DisableEvent vtkCommand::EnableEvent

Tests:: vtkInteractorEventRecorder (Tests)

Definition at line 47 of file vtkInteractorEventRecorder.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInteractorObserver vtkInteractorEventRecorder::Superclass

Definition at line 51 of file vtkInteractorEventRecorder.h.

Member Enumeration Documentation

◆ WidgetState

enum vtkInteractorEventRecorder::WidgetState

protected

Enumerator
Start
Playing
Recording

Definition at line 139 of file vtkInteractorEventRecorder.h.

◆ ModifierKey

enum vtkInteractorEventRecorder::ModifierKey

protected

Enumerator
ShiftKey
ControlKey
AltKey

Definition at line 147 of file vtkInteractorEventRecorder.h.

Constructor & Destructor Documentation

◆ vtkInteractorEventRecorder()

vtkInteractorEventRecorder::vtkInteractorEventRecorder ( )

protected

◆ ~vtkInteractorEventRecorder()

vtkInteractorEventRecorder::~vtkInteractorEventRecorder ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkInteractorEventRecorder* vtkInteractorEventRecorder::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkInteractorEventRecorder::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkInteractorEventRecorder::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorObserver.

◆ SafeDownCast()

static vtkInteractorEventRecorder* vtkInteractorEventRecorder::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkInteractorEventRecorder::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInteractorObserver.

◆ NewInstance()

vtkInteractorEventRecorder* vtkInteractorEventRecorder::NewInstance ( ) const

◆ PrintSelf()

void vtkInteractorEventRecorder::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetEnabled()

void vtkInteractorEventRecorder::SetEnabled ( int )

overridevirtual

Methods for turning the interactor observer on and off, and determining its state.

All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.

Reimplemented from vtkInteractorObserver.

◆ SetInteractor()

void vtkInteractorEventRecorder::SetInteractor ( vtkRenderWindowInteractor * iren )

overridevirtual

This method is used to associate the widget with the render window interactor.

Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver. It automatically registers available pickers to the Picking Manager.

Reimplemented from vtkInteractorObserver.

◆ SetFileName()

virtual void vtkInteractorEventRecorder::SetFileName ( const char * )

virtual

Set/Get the name of a file events should be written to/from.

◆ GetFileName()

virtual char* vtkInteractorEventRecorder::GetFileName ( )

virtual

◆ Record()

void vtkInteractorEventRecorder::Record ( )

Invoke this method to begin recording events.

The events will be recorded to the filename indicated.

◆ Play()

void vtkInteractorEventRecorder::Play ( )

Invoke this method to begin playing events from the current position.

The events will be played back from the filename indicated.

◆ Stop()

void vtkInteractorEventRecorder::Stop ( )

Invoke this method to stop recording/playing events.

◆ Rewind()

void vtkInteractorEventRecorder::Rewind ( )

Rewind to the beginning of the file.

◆ SetReadFromInputString()

virtual void vtkInteractorEventRecorder::SetReadFromInputString ( vtkTypeBool )

virtual

Enable reading from an InputString as compared to the default behavior, which is to read from a file.

◆ GetReadFromInputString()

virtual vtkTypeBool vtkInteractorEventRecorder::GetReadFromInputString ( )

virtual

◆ ReadFromInputStringOn()

virtual void vtkInteractorEventRecorder::ReadFromInputStringOn ( )

virtual

◆ ReadFromInputStringOff()

virtual void vtkInteractorEventRecorder::ReadFromInputStringOff ( )

virtual

◆ SetInputString()

virtual void vtkInteractorEventRecorder::SetInputString ( const char * )

virtual

Set/Get the string to read from.

◆ GetInputString()

virtual char* vtkInteractorEventRecorder::GetInputString ( )

virtual

◆ ProcessCharEvent()

static void vtkInteractorEventRecorder::ProcessCharEvent	(	vtkObject *	object,
		unsigned long	event,
		void *	clientdata,
		void *	calldata
	)

staticprotected

◆ ProcessDeleteEvent()

static void vtkInteractorEventRecorder::ProcessDeleteEvent	(	vtkObject *	object,
		unsigned long	event,
		void *	clientdata,
		void *	calldata
	)

staticprotected

◆ ProcessEvents()

static void vtkInteractorEventRecorder::ProcessEvents	(	vtkObject *	object,
		unsigned long	event,
		void *	clientdata,
		void *	calldata
	)

staticprotected

◆ WriteEvent()

virtual void vtkInteractorEventRecorder::WriteEvent	(	const char *	event,
		int	pos[2],
		int	modifiers,
		int	keyCode,
		int	repeatCount,
		char *	keySym
	)

protectedvirtual

◆ ReadEvent()

virtual void vtkInteractorEventRecorder::ReadEvent ( )

protectedvirtual

Member Data Documentation

◆ FileName

char* vtkInteractorEventRecorder::FileName

protected

Definition at line 111 of file vtkInteractorEventRecorder.h.

◆ DeleteEventCallbackCommand

vtkCallbackCommand* vtkInteractorEventRecorder::DeleteEventCallbackCommand

protected

Definition at line 114 of file vtkInteractorEventRecorder.h.

◆ ReadFromInputString

vtkTypeBool vtkInteractorEventRecorder::ReadFromInputString

protected

Definition at line 117 of file vtkInteractorEventRecorder.h.

◆ InputString

char* vtkInteractorEventRecorder::InputString

protected

Definition at line 118 of file vtkInteractorEventRecorder.h.

◆ InputStream

istream* vtkInteractorEventRecorder::InputStream

protected

Definition at line 121 of file vtkInteractorEventRecorder.h.

◆ OutputStream

ostream* vtkInteractorEventRecorder::OutputStream

protected

Definition at line 122 of file vtkInteractorEventRecorder.h.

◆ State

int vtkInteractorEventRecorder::State

protected

Definition at line 138 of file vtkInteractorEventRecorder.h.

◆ StreamVersion

float vtkInteractorEventRecorder::StreamVersion

staticprotected

Definition at line 154 of file vtkInteractorEventRecorder.h.

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

Rendering/Core/vtkInteractorEventRecorder.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ WidgetState

◆ ModifierKey

Constructor & Destructor Documentation

◆ vtkInteractorEventRecorder()

◆ ~vtkInteractorEventRecorder()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetEnabled()

◆ SetInteractor()

◆ SetFileName()

◆ GetFileName()

◆ Record()

◆ Play()

◆ Stop()

◆ Rewind()

◆ SetReadFromInputString()

◆ GetReadFromInputString()

◆ ReadFromInputStringOn()

◆ ReadFromInputStringOff()

◆ SetInputString()

◆ GetInputString()

◆ ProcessCharEvent()

◆ ProcessDeleteEvent()

◆ ProcessEvents()

◆ WriteEvent()

◆ ReadEvent()

Member Data Documentation

◆ FileName

◆ DeleteEventCallbackCommand

◆ ReadFromInputString

◆ InputString

◆ InputStream

◆ OutputStream

◆ State

◆ StreamVersion