ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkInteractorEventRecorder Class Reference

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

Inheritance diagram for Kitware.VTK.vtkInteractorEventRecorder:
[legend]
Collaboration diagram for Kitware.VTK.vtkInteractorEventRecorder:
[legend]

List of all members.

Public Member Functions

 vtkInteractorEventRecorder (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkInteractorEventRecorder ()
 *Undocumented Block
virtual string GetFileName ()
 Set/Get the name of a file events should be written to/from.
virtual string GetInputString ()
 Set/Get the string to read from.
virtual int GetReadFromInputString ()
 Enable reading from an InputString as compared to the default behavior, which is to read from a file.
override int IsA (string type)
 *Undocumented Block
new vtkInteractorEventRecorder NewInstance ()
 *Undocumented Block
void Play ()
 Invoke this method to begin playing events from the current position. The events will be played back from the filename indicated.
virtual void ReadFromInputStringOff ()
 Enable reading from an InputString as compared to the default behavior, which is to read from a file.
virtual void ReadFromInputStringOn ()
 Enable reading from an InputString as compared to the default behavior, which is to read from a file.
void Record ()
 Invoke this method to begin recording events. The events will be recorded to the filename indicated.
void Rewind ()
 Rewind to the beginning of the file.
override void SetEnabled (int arg0)
 Satisfy the superclass API. Enable/disable listening for events.
virtual void SetFileName (string _arg)
 Set/Get the name of a file events should be written to/from.
virtual void SetInputString (string _arg)
 Set/Get the string to read from.
override void SetInteractor (vtkRenderWindowInteractor iren)
 Satisfy the superclass API. Enable/disable listening for events.
virtual void SetReadFromInputString (int _arg)
 Enable reading from an InputString as compared to the default behavior, which is to read from a file.
void Stop ()
 Invoke this method to stop recording/playing events.
- Public Member Functions inherited from Kitware.VTK.vtkInteractorObserver
 vtkInteractorObserver (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
void EnabledOff ()
 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.
void EnabledOn ()
 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.
virtual vtkRenderer GetCurrentRenderer ()
 Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).
virtual vtkRenderer GetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.
int GetEnabled ()
 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.
virtual vtkRenderWindowInteractor GetInteractor ()
 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.
virtual int GetKeyPressActivation ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
virtual sbyte GetKeyPressActivationValue ()
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.
virtual float GetPriority ()
 Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
virtual float GetPriorityMaxValue ()
 Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
virtual float GetPriorityMinValue ()
 Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
void GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents)
 Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.
virtual void KeyPressActivationOff ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
virtual void KeyPressActivationOn ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
void Off ()
 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.
void On ()
 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.
virtual void OnChar ()
 Sets up the keypress-i event.
void ReleaseFocus ()
 Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.
virtual void SetCurrentRenderer (vtkRenderer arg0)
 Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).
virtual void SetDefaultRenderer (vtkRenderer arg0)
 Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.
virtual void SetKeyPressActivation (int _arg)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
virtual void SetKeyPressActivationValue (sbyte _arg)
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.
virtual void SetPriority (float _arg)
 Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new
vtkInteractorEventRecorder 
New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new
vtkInteractorEventRecorder 
SafeDownCast (vtkObjectBase o)
 *Undocumented Block
- Static Public Member Functions inherited from Kitware.VTK.vtkInteractorObserver
static void ComputeDisplayToWorld (vtkRenderer ren, double x, double y, double z, IntPtr worldPt)
 Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.
static void ComputeWorldToDisplay (vtkRenderer ren, double x, double y, double z, IntPtr displayPt)
 Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.
- Static Public Member Functions inherited from Kitware.VTK.vtkObject
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. It allows the debugger to break on error.
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkInteractorEventRecorder"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkInteractorObserver
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "26vtkInteractorEventRecorder"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkInteractorObserver
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkInteractorEventRecorder ()
 Automatically generated type registration mechanics.

Detailed Description

vtkInteractorEventRecorder - record and play VTK events passing through a vtkRenderWindowInteractor


Constructor & Destructor Documentation

static Kitware.VTK.vtkInteractorEventRecorder.vtkInteractorEventRecorder ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkInteractorEventRecorder.vtkInteractorEventRecorder ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkInteractorEventRecorder.vtkInteractorEventRecorder ( )

*Undocumented Block


Member Function Documentation

override void Kitware.VTK.vtkInteractorEventRecorder.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

virtual string Kitware.VTK.vtkInteractorEventRecorder.GetFileName ( )
virtual

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

virtual string Kitware.VTK.vtkInteractorEventRecorder.GetInputString ( )
virtual

Set/Get the string to read from.

virtual int Kitware.VTK.vtkInteractorEventRecorder.GetReadFromInputString ( )
virtual

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

override int Kitware.VTK.vtkInteractorEventRecorder.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkInteractorObserver.

static new int Kitware.VTK.vtkInteractorEventRecorder.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkInteractorObserver.

static new vtkInteractorEventRecorder Kitware.VTK.vtkInteractorEventRecorder.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

new vtkInteractorEventRecorder Kitware.VTK.vtkInteractorEventRecorder.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkInteractorObserver.

void Kitware.VTK.vtkInteractorEventRecorder.Play ( )

Invoke this method to begin playing events from the current position. The events will be played back from the filename indicated.

virtual void Kitware.VTK.vtkInteractorEventRecorder.ReadFromInputStringOff ( )
virtual

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

virtual void Kitware.VTK.vtkInteractorEventRecorder.ReadFromInputStringOn ( )
virtual

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

void Kitware.VTK.vtkInteractorEventRecorder.Record ( )

Invoke this method to begin recording events. The events will be recorded to the filename indicated.

void Kitware.VTK.vtkInteractorEventRecorder.Rewind ( )

Rewind to the beginning of the file.

static new vtkInteractorEventRecorder Kitware.VTK.vtkInteractorEventRecorder.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkInteractorObserver.

Here is the call graph for this function:

override void Kitware.VTK.vtkInteractorEventRecorder.SetEnabled ( int  arg0)
virtual

Satisfy the superclass API. Enable/disable listening for events.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

virtual void Kitware.VTK.vtkInteractorEventRecorder.SetFileName ( string  _arg)
virtual

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

virtual void Kitware.VTK.vtkInteractorEventRecorder.SetInputString ( string  _arg)
virtual

Set/Get the string to read from.

override void Kitware.VTK.vtkInteractorEventRecorder.SetInteractor ( vtkRenderWindowInteractor  iren)
virtual

Satisfy the superclass API. Enable/disable listening for events.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

virtual void Kitware.VTK.vtkInteractorEventRecorder.SetReadFromInputString ( int  _arg)
virtual

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

void Kitware.VTK.vtkInteractorEventRecorder.Stop ( )

Invoke this method to stop recording/playing events.


Member Data Documentation

new readonly string Kitware.VTK.vtkInteractorEventRecorder.MRClassNameKey = "26vtkInteractorEventRecorder"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

new const string Kitware.VTK.vtkInteractorEventRecorder.MRFullTypeName = "Kitware.VTK.vtkInteractorEventRecorder"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkInteractorObserver.


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