VTK
9.1.0
|
record and play VTK events passing through a vtkRenderWindowInteractor More...
#include <vtkInteractorEventRecorder.h>
Public Types | |
typedef vtkInteractorObserver | Superclass |
![]() | |
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... | |
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... | |
vtkSetFilePathMacro (FileName) | |
Set/Get the name of a file events should be written to/from. More... | |
vtkGetFilePathMacro (FileName) | |
Set/Get the name of a file events should be written to/from. 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 () |
Enable reading from an InputString as compared to the default behavior, which is to read from a file. More... | |
virtual void | ReadFromInputStringOn () |
Enable reading from an InputString as compared to the default behavior, which is to read from a file. More... | |
virtual void | ReadFromInputStringOff () |
Enable reading from an InputString as compared to the default behavior, which is to read from a file. More... | |
virtual void | SetInputString (const char *) |
Set/Get the string to read from. More... | |
virtual char * | GetInputString () |
Set/Get the string to read from. More... | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkInteractorObserver * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | SetEnabled (int) |
Methods for turning the interactor observer on and off, and determining its state. More... | |
int | GetEnabled () |
void | EnabledOn () |
void | EnabledOff () |
void | On () |
void | Off () |
virtual void | OnChar () |
Sets up the keypress-i event. More... | |
virtual vtkRenderWindowInteractor * | GetInteractor () |
This method is used to associate the widget with the render window interactor. More... | |
virtual void | SetPriority (float) |
Set/Get the priority at which events are processed. More... | |
virtual float | GetPriority () |
Set/Get the priority at which events are processed. More... | |
virtual void | PickingManagedOn () |
Enable/Disable the use of a manager to process the picking. More... | |
virtual void | PickingManagedOff () |
Enable/Disable the use of a manager to process the picking. More... | |
virtual void | SetPickingManaged (bool managed) |
Enable/Disable the use of a manager to process the picking. More... | |
virtual bool | GetPickingManaged () |
Enable/Disable the use of a manager to process the picking. More... | |
virtual void | SetKeyPressActivation (vtkTypeBool) |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
virtual vtkTypeBool | GetKeyPressActivation () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
virtual void | KeyPressActivationOn () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
virtual void | KeyPressActivationOff () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
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 () |
Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More... | |
virtual vtkRenderer * | GetDefaultRenderer () |
Set/Get the default renderer to use when activating the interactor observer. More... | |
virtual void | SetDefaultRenderer (vtkRenderer *) |
Set/Get the default renderer to use when activating the interactor observer. More... | |
virtual vtkRenderer * | GetCurrentRenderer () |
Set/Get the current renderer. More... | |
virtual void | SetCurrentRenderer (vtkRenderer *) |
Set/Get the current renderer. 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 () |
These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More... | |
![]() | |
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... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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) |
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, 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) |
This method invokes an event and return whether the event was aborted or not. More... | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. 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 | 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... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static vtkInteractorEventRecorder * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkInteractorEventRecorder * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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]) |
Convenience methods for outside classes. More... | |
![]() | |
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 () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
![]() | |
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 () |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkInteractorObserver () | |
~vtkInteractorObserver () override | |
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) |
virtual void | StartInteraction () |
Utility routines used to start and end interaction. More... | |
virtual void | EndInteraction () |
Utility routines used to start and end interaction. More... | |
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]) |
Helper method for subclasses. More... | |
![]() | |
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 () |
These methods allow a command to exclusively grab all events. More... | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
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 void | ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata) |
Handles the char widget activation event. More... | |
![]() | |
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 |
![]() | |
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 |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Static Protected Attributes | |
static float | StreamVersion |
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.
Definition at line 41 of file vtkInteractorEventRecorder.h.
Definition at line 45 of file vtkInteractorEventRecorder.h.
|
protected |
Enumerator | |
---|---|
Start | |
Playing | |
Recording |
Definition at line 133 of file vtkInteractorEventRecorder.h.
|
protected |
Enumerator | |
---|---|
ShiftKey | |
ControlKey | |
AltKey |
Definition at line 141 of file vtkInteractorEventRecorder.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented from vtkInteractorObserver.
vtkInteractorEventRecorder * vtkInteractorEventRecorder::NewInstance | ( | ) | const |
|
overridevirtual |
|
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.
|
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.
vtkInteractorEventRecorder::vtkSetFilePathMacro | ( | FileName | ) |
Set/Get the name of a file events should be written to/from.
vtkInteractorEventRecorder::vtkGetFilePathMacro | ( | FileName | ) |
Set/Get the name of a file events should be written to/from.
void vtkInteractorEventRecorder::Record | ( | ) |
Invoke this method to begin recording events.
The events will be recorded to the filename indicated.
void vtkInteractorEventRecorder::Play | ( | ) |
Invoke this method to begin playing events from the current position.
The events will be played back from the filename indicated.
void vtkInteractorEventRecorder::Stop | ( | ) |
Invoke this method to stop recording/playing events.
void vtkInteractorEventRecorder::Rewind | ( | ) |
Rewind to the beginning of the file.
|
virtual |
Enable reading from an InputString as compared to the default behavior, which is to read from a file.
|
virtual |
Enable reading from an InputString as compared to the default behavior, which is to read from a file.
|
virtual |
Enable reading from an InputString as compared to the default behavior, which is to read from a file.
|
virtual |
Enable reading from an InputString as compared to the default behavior, which is to read from a file.
|
virtual |
Set/Get the string to read from.
|
virtual |
Set/Get the string to read from.
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
protectedvirtual |
|
protectedvirtual |
|
protected |
Definition at line 105 of file vtkInteractorEventRecorder.h.
|
protected |
Definition at line 108 of file vtkInteractorEventRecorder.h.
|
protected |
Definition at line 111 of file vtkInteractorEventRecorder.h.
|
protected |
Definition at line 112 of file vtkInteractorEventRecorder.h.
|
protected |
Definition at line 115 of file vtkInteractorEventRecorder.h.
|
protected |
Definition at line 116 of file vtkInteractorEventRecorder.h.
|
protected |
Definition at line 132 of file vtkInteractorEventRecorder.h.
|
staticprotected |
Definition at line 148 of file vtkInteractorEventRecorder.h.