ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions | List of all members
Kitware.VTK.vtkCommand Class Reference

vtkCommand - superclass for callback/observer methods More...

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

Public Types

enum  EventIds {
  AbortCheckEvent = 10, ActiveCameraEvent = 29, AnimationCueTickEvent = 55, AnnotationChangedEvent = 74,
  AnyEvent = 1, CharEvent = 22, ComputeVisiblePropBoundsEvent = 80, ConfigureEvent = 24,
  ConnectionClosedEvent = 67, ConnectionCreatedEvent = 66, CreateCameraEvent = 30, CreateTimerEvent = 46,
  CurrentChangedEvent = 79, CursorChangedEvent = 50, DeleteEvent = 2, DestroyTimerEvent = 47,
  DisableEvent = 45, DomainModifiedEvent = 68, EnableEvent = 44, EndAnimationCueEvent = 56,
  EndEvent = 4, EndInteractionEvent = 43, EndPickEvent = 9, EndWindowLevelEvent = 36,
  EnterEvent = 18, ErrorEvent = 39, ExecuteInformationEvent = 51, ExitEvent = 11,
  ExposeEvent = 23, HighlightEvent = 91, HoverEvent = 84, InteractionEvent = 42,
  KeyPressEvent = 20, KeyReleaseEvent = 21, LeaveEvent = 19, LeftButtonPressEvent = 12,
  LeftButtonReleaseEvent = 13, LoadStateEvent = 85, MiddleButtonPressEvent = 14, MiddleButtonReleaseEvent = 15,
  ModifiedEvent = 33, MouseMoveEvent = 26, MouseWheelBackwardEvent = 28, MouseWheelForwardEvent = 27,
  NoEvent = 0, PickEvent = 7, PlacePointEvent = 48, PlaceWidgetEvent = 49,
  ProgressEvent = 6, PropertyModifiedEvent = 69, RegisterEvent = 71, RenderEvent = 5,
  RenderWindowMessageEvent = 52, ResetCameraClippingRangeEvent = 32, ResetCameraEvent = 31, ResetWindowLevelEvent = 37,
  RightButtonPressEvent = 16, RightButtonReleaseEvent = 17, SaveStateEvent = 86, SelectionChangedEvent = 75,
  SetOutputEvent = 38, StartAnimationCueEvent = 54, StartEvent = 3, StartInteractionEvent = 41,
  StartPickEvent = 8, StartWindowLevelEvent = 35, StateChangedEvent = 87, TDxButtonPressEvent = 82,
  TDxButtonReleaseEvent = 83, TDxMotionEvent = 81, TimerEvent = 25, UnRegisterEvent = 72,
  UpdateDataEvent = 78, UpdateEvent = 70, UpdateInformationEvent = 73, UpdatePropertyEvent = 76,
  UserEvent = 1000, ViewProgressEvent = 77, VolumeMapperComputeGradientsEndEvent = 60, VolumeMapperComputeGradientsProgressEvent = 61,
  VolumeMapperComputeGradientsStartEvent = 62, VolumeMapperRenderEndEvent = 57, VolumeMapperRenderProgressEvent = 58, VolumeMapperRenderStartEvent = 59,
  WarningEvent = 40, WidgetActivateEvent = 65, WidgetModifiedEvent = 63, WidgetValueChangedEvent = 64,
  WindowFrameEvent = 90, WindowIsCurrentEvent = 89, WindowIsDirectEvent = 93, WindowLevelEvent = 34,
  WindowMakeCurrentEvent = 88, WindowSupportsOpenGLEvent = 92, WrongTagEvent = 53
}
 Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus. More...

Public Member Functions

 vtkCommand (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCommand ()
 Undocumented Block
void AbortFlagOff ()
 Set/Get the abort flag. If this is set to true no further commands are executed.
void AbortFlagOn ()
 Set/Get the abort flag. If this is set to true no further commands are executed.
virtual void Execute (vtkObject caller, uint eventId, IntPtr callData)
 All derived classes of vtkCommand must implement this method. This is the method that actually does the work of the callback. The caller argument is the object invoking the event, the eventId parameter is the id of the event, and callData parameter is data that can be passed into the execute method. (Note: vtkObject::InvokeEvent() takes two parameters: the event id (or name) and call data. Typically call data is NULL, but the user can package data and pass it this way. Alternatively, a derived class of vtkCommand can be used to pass data.)
int GetAbortFlag ()
 Set/Get the abort flag. If this is set to true no further commands are executed.
int GetPassiveObserver ()
 Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus.
override int IsA (string type)
 Undocumented Block
vtkCommand NewInstance ()
 Undocumented Block
void PassiveObserverOff ()
 Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus.
void PassiveObserverOn ()
 Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus.
void SetAbortFlag (int f)
 Set/Get the abort flag. If this is set to true no further commands are executed.
void SetPassiveObserver (int f)
 Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus.
- 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 uint GetEventIdFromString (string arg0)
 Convenience methods for translating between event names and event ids.
static string GetStringFromEventId (uint arg0)
 Convenience methods for translating between event names and event ids.
static new int IsTypeOf (string type)
 Undocumented Block
static vtkCommand SafeDownCast (vtkObjectBase o)
 Undocumented Block
- Static Public Member Functions inherited from Kitware.VTK.vtkObjectBase
static vtkObjectBase New ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkCommand"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
new const string MRFullTypeName = "Kitware.VTK.vtkObjectBase"
 Automatically generated type registration mechanics.
- 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 = "10vtkCommand"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase
static new readonly string MRClassNameKey = "13vtkObjectBase"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Decrease the reference count (release by another object). This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

Private Member Functions

static IntPtr vtkCommandShadow_CreateShadow (IntPtr primary)

Static Private Member Functions

static vtkCommand ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCommand - superclass for callback/observer methods

Description vtkCommand is an implementation of the observer/command design pattern. In this design pattern, any instance of vtkObject can be "observed" for any events it might invoke. For example, vtkRenderer invokes a StartEvent as it begins to render and a EndEvent when it finishes rendering. Filters (subclasses of vtkProcessObject) invoke StartEvent, ProgressEvent, and EndEvent as the filter processes data. Observers of events are added with the AddObserver() method found in vtkObject. AddObserver(), besides requiring an event id or name, also takes an instance of vtkCommand (or a subclasses). Note that vtkCommand is meant to be subclassed, so that you can package the information necessary to support your callback.

Event processing can be organized in priority lists, so it is possible to truncate the processing of a particular event by setting the AbortFlag variable. The priority is set using the AddObserver() method. By default the priority is 0, events of the same priority are processed in last-in-first-processed order. The ordering/aborting of events is important for things like 3D widgets, which handle an event if the widget is selected (and then aborting further processing of that event). Otherwise. the event is passed along for further processing.

When an instance of vtkObject invokes an event, it also passes an optional void pointer to a callData. This callData is NULL most of the time. The callData is not specific to a type of event but specific to a type of vtkObject invoking a specific event. For instance, vtkCommand::PickEvent is invoked by vtkProp with a NULL callData but is invoked by vtkInteractorStyleImage with a pointer to the vtkInteractorStyleImage object itself.

Here is the list of events that may be invoked with a none NULL callData.

vtkObject vtkCallbackCommand vtkOldStyleCallbackCommand vtkInteractorObserver vtk3DWidget

Member Enumeration Documentation

Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus.

Enumerator:
AbortCheckEvent 

enum member

ActiveCameraEvent 

enum member

AnimationCueTickEvent 

enum member

AnnotationChangedEvent 

enum member

AnyEvent 

enum member

CharEvent 

enum member

ComputeVisiblePropBoundsEvent 

enum member

ConfigureEvent 

enum member

ConnectionClosedEvent 

enum member

ConnectionCreatedEvent 

enum member

CreateCameraEvent 

enum member

CreateTimerEvent 

enum member

CurrentChangedEvent 

enum member

CursorChangedEvent 

enum member

DeleteEvent 

enum member

DestroyTimerEvent 

enum member

DisableEvent 

enum member

DomainModifiedEvent 

enum member

EnableEvent 

enum member

EndAnimationCueEvent 

enum member

EndEvent 

enum member

EndInteractionEvent 

enum member

EndPickEvent 

enum member

EndWindowLevelEvent 

enum member

EnterEvent 

enum member

ErrorEvent 

enum member

ExecuteInformationEvent 

enum member

ExitEvent 

enum member

ExposeEvent 

enum member

HighlightEvent 

enum member

HoverEvent 

enum member

InteractionEvent 

enum member

KeyPressEvent 

enum member

KeyReleaseEvent 

enum member

LeaveEvent 

enum member

LeftButtonPressEvent 

enum member

LeftButtonReleaseEvent 

enum member

LoadStateEvent 

enum member

MiddleButtonPressEvent 

enum member

MiddleButtonReleaseEvent 

enum member

ModifiedEvent 

enum member

MouseMoveEvent 

enum member

MouseWheelBackwardEvent 

enum member

MouseWheelForwardEvent 

enum member

NoEvent 

enum member

PickEvent 

enum member

PlacePointEvent 

enum member

PlaceWidgetEvent 

enum member

ProgressEvent 

enum member

PropertyModifiedEvent 

enum member

RegisterEvent 

enum member

RenderEvent 

enum member

RenderWindowMessageEvent 

enum member

ResetCameraClippingRangeEvent 

enum member

ResetCameraEvent 

enum member

ResetWindowLevelEvent 

enum member

RightButtonPressEvent 

enum member

RightButtonReleaseEvent 

enum member

SaveStateEvent 

enum member

SelectionChangedEvent 

enum member

SetOutputEvent 

enum member

StartAnimationCueEvent 

enum member

StartEvent 

enum member

StartInteractionEvent 

enum member

StartPickEvent 

enum member

StartWindowLevelEvent 

enum member

StateChangedEvent 

enum member

TDxButtonPressEvent 

enum member

TDxButtonReleaseEvent 

enum member

TDxMotionEvent 

enum member

TimerEvent 

enum member

UnRegisterEvent 

enum member

UpdateDataEvent 

enum member

UpdateEvent 

enum member

UpdateInformationEvent 

enum member

UpdatePropertyEvent 

enum member

UserEvent 

enum member

ViewProgressEvent 

enum member

VolumeMapperComputeGradientsEndEvent 

enum member

VolumeMapperComputeGradientsProgressEvent 

enum member

VolumeMapperComputeGradientsStartEvent 

enum member

VolumeMapperRenderEndEvent 

enum member

VolumeMapperRenderProgressEvent 

enum member

VolumeMapperRenderStartEvent 

enum member

WarningEvent 

enum member

WidgetActivateEvent 

enum member

WidgetModifiedEvent 

enum member

WidgetValueChangedEvent 

enum member

WindowFrameEvent 

enum member

WindowIsCurrentEvent 

enum member

WindowIsDirectEvent 

enum member

WindowLevelEvent 

enum member

WindowMakeCurrentEvent 

enum member

WindowSupportsOpenGLEvent 

enum member

WrongTagEvent 

enum member

Constructor & Destructor Documentation

static Kitware.VTK.vtkCommand.vtkCommand ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkCommand.vtkCommand ( )

Undocumented Block

Member Function Documentation

void Kitware.VTK.vtkCommand.AbortFlagOff ( )

Set/Get the abort flag. If this is set to true no further commands are executed.

void Kitware.VTK.vtkCommand.AbortFlagOn ( )

Set/Get the abort flag. If this is set to true no further commands are executed.

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

Decrease the reference count (release by another object). This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

Reimplemented from Kitware.VTK.vtkObjectBase.

virtual void Kitware.VTK.vtkCommand.Execute ( vtkObject  caller,
uint  eventId,
IntPtr  callData 
)
virtual

All derived classes of vtkCommand must implement this method. This is the method that actually does the work of the callback. The caller argument is the object invoking the event, the eventId parameter is the id of the event, and callData parameter is data that can be passed into the execute method. (Note: vtkObject::InvokeEvent() takes two parameters: the event id (or name) and call data. Typically call data is NULL, but the user can package data and pass it this way. Alternatively, a derived class of vtkCommand can be used to pass data.)

int Kitware.VTK.vtkCommand.GetAbortFlag ( )

Set/Get the abort flag. If this is set to true no further commands are executed.

static uint Kitware.VTK.vtkCommand.GetEventIdFromString ( string  arg0)
static

Convenience methods for translating between event names and event ids.

int Kitware.VTK.vtkCommand.GetPassiveObserver ( )

Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus.

static string Kitware.VTK.vtkCommand.GetStringFromEventId ( uint  arg0)
static

Convenience methods for translating between event names and event ids.

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

Undocumented Block

Reimplemented from Kitware.VTK.vtkObjectBase.

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

Undocumented Block

Reimplemented from Kitware.VTK.vtkObjectBase.

vtkCommand Kitware.VTK.vtkCommand.NewInstance ( )

Undocumented Block

void Kitware.VTK.vtkCommand.PassiveObserverOff ( )

Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus.

void Kitware.VTK.vtkCommand.PassiveObserverOn ( )

Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus.

static vtkCommand Kitware.VTK.vtkCommand.SafeDownCast ( vtkObjectBase  o)
static

Undocumented Block

Here is the call graph for this function:

void Kitware.VTK.vtkCommand.SetAbortFlag ( int  f)

Set/Get the abort flag. If this is set to true no further commands are executed.

void Kitware.VTK.vtkCommand.SetPassiveObserver ( int  f)

Set/Get the passive observer flag. If this is set to true, this indicates that this command does not change the state of the system in any way. Passive observers are processed first, and are not called even when another command has focus.

static IntPtr Kitware.VTK.vtkCommand.vtkCommandShadow_CreateShadow ( IntPtr  primary)
private

Member Data Documentation

new readonly string Kitware.VTK.vtkCommand.MRClassNameKey = "10vtkCommand"
static

Automatically generated type registration mechanics.

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

Automatically generated type registration mechanics.


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