ActiViz .NET
5.8.0
|
vtkCommand - superclass for callback/observer methods More...
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. | |
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. | |
Public Attributes | |
new const string | MRFullTypeName = "Kitware.VTK.vtkCommand" |
Automatically generated type registration mechanics. | |
Static Public Attributes | |
static new readonly string | MRClassNameKey = "10vtkCommand" |
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 internal void | vtkCommand_UnRegister_17 (HandleRef pThis, HandleRef arg0) |
static internal void | vtkCommand_AbortFlagOff_01 (HandleRef pThis) |
static internal void | vtkCommand_AbortFlagOn_02 (HandleRef pThis) |
static internal void | vtkCommand_Execute_03 (HandleRef pThis, HandleRef caller, uint eventId, IntPtr callData) |
static internal int | vtkCommand_GetAbortFlag_04 (HandleRef pThis) |
static internal uint | vtkCommand_GetEventIdFromString_05 (string arg0) |
static internal int | vtkCommand_GetPassiveObserver_06 (HandleRef pThis) |
static internal IntPtr | vtkCommand_GetStringFromEventId_07 (uint arg0) |
static internal int | vtkCommand_IsA_08 (HandleRef pThis, string type) |
static internal int | vtkCommand_IsTypeOf_09 (string type) |
static internal IntPtr | vtkCommand_NewInstance_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal void | vtkCommand_PassiveObserverOff_11 (HandleRef pThis) |
static internal void | vtkCommand_PassiveObserverOn_12 (HandleRef pThis) |
static internal IntPtr | vtkCommand_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal void | vtkCommand_SetAbortFlag_14 (HandleRef pThis, int f) |
static internal void | vtkCommand_SetPassiveObserver_15 (HandleRef pThis, int f) |
Static Private Member Functions | |
static | vtkCommand () |
Automatically generated type registration mechanics. |
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
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 Kitware.VTK.vtkCommand.vtkCommand | ( | ) | [static, private] |
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.
Undocumented Block.
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.)
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.
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.
Undocumented Block.
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.
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.
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 internal void Kitware.VTK.vtkCommand.vtkCommand_AbortFlagOff_01 | ( | HandleRef | pThis | ) | [private] |
static internal void Kitware.VTK.vtkCommand.vtkCommand_AbortFlagOn_02 | ( | HandleRef | pThis | ) | [private] |
static internal void Kitware.VTK.vtkCommand.vtkCommand_Execute_03 | ( | HandleRef | pThis, |
HandleRef | caller, | ||
uint | eventId, | ||
IntPtr | callData | ||
) | [private] |
static internal int Kitware.VTK.vtkCommand.vtkCommand_GetAbortFlag_04 | ( | HandleRef | pThis | ) | [private] |
static internal uint Kitware.VTK.vtkCommand.vtkCommand_GetEventIdFromString_05 | ( | string | arg0 | ) | [private] |
static internal int Kitware.VTK.vtkCommand.vtkCommand_GetPassiveObserver_06 | ( | HandleRef | pThis | ) | [private] |
static internal IntPtr Kitware.VTK.vtkCommand.vtkCommand_GetStringFromEventId_07 | ( | uint | arg0 | ) | [private] |
static internal int Kitware.VTK.vtkCommand.vtkCommand_IsA_08 | ( | HandleRef | pThis, |
string | type | ||
) | [private] |
static internal int Kitware.VTK.vtkCommand.vtkCommand_IsTypeOf_09 | ( | string | type | ) | [private] |
static internal IntPtr Kitware.VTK.vtkCommand.vtkCommand_NewInstance_10 | ( | HandleRef | pThis, |
ref uint | mteStatus, | ||
ref uint | mteIndex, | ||
ref uint | rawRefCount | ||
) | [private] |
static internal void Kitware.VTK.vtkCommand.vtkCommand_PassiveObserverOff_11 | ( | HandleRef | pThis | ) | [private] |
static internal void Kitware.VTK.vtkCommand.vtkCommand_PassiveObserverOn_12 | ( | HandleRef | pThis | ) | [private] |
static internal IntPtr Kitware.VTK.vtkCommand.vtkCommand_SafeDownCast_13 | ( | HandleRef | o, |
ref uint | mteStatus, | ||
ref uint | mteIndex, | ||
ref uint | rawRefCount | ||
) | [private] |
static internal void Kitware.VTK.vtkCommand.vtkCommand_SetAbortFlag_14 | ( | HandleRef | pThis, |
int | f | ||
) | [private] |
static internal void Kitware.VTK.vtkCommand.vtkCommand_SetPassiveObserver_15 | ( | HandleRef | pThis, |
int | f | ||
) | [private] |
static internal void Kitware.VTK.vtkCommand.vtkCommand_UnRegister_17 | ( | HandleRef | pThis, |
HandleRef | arg0 | ||
) | [private] |
static IntPtr Kitware.VTK.vtkCommand.vtkCommandShadow_CreateShadow | ( | IntPtr | primary | ) | [private] |
new readonly string Kitware.VTK.vtkCommand.MRClassNameKey = "10vtkCommand" [static] |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkObjectBase.
new const string Kitware.VTK.vtkCommand.MRFullTypeName = "Kitware.VTK.vtkCommand" |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkObjectBase.