VTK
vtkCommand.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCommand.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
215 #ifndef vtkCommand_h
216 #define vtkCommand_h
217 
218 #include "vtkCommonCoreModule.h" // For export macro
219 #include "vtkObjectBase.h"
220 #include "vtkObject.h" // Need vtkTypeMacro
221 
222 // Define all types of events here.
223 // Using this macro makes it possible to avoid mismatches between the event
224 // enums and their string counterparts.
225 #define vtkAllEventsMacro() \
226  _vtk_add_event(AnyEvent)\
227  _vtk_add_event(DeleteEvent)\
228  _vtk_add_event(StartEvent)\
229  _vtk_add_event(EndEvent)\
230  _vtk_add_event(RenderEvent)\
231  _vtk_add_event(ProgressEvent)\
232  _vtk_add_event(PickEvent)\
233  _vtk_add_event(StartPickEvent)\
234  _vtk_add_event(EndPickEvent)\
235  _vtk_add_event(AbortCheckEvent)\
236  _vtk_add_event(ExitEvent)\
237  _vtk_add_event(LeftButtonPressEvent)\
238  _vtk_add_event(LeftButtonReleaseEvent)\
239  _vtk_add_event(MiddleButtonPressEvent)\
240  _vtk_add_event(MiddleButtonReleaseEvent)\
241  _vtk_add_event(RightButtonPressEvent)\
242  _vtk_add_event(RightButtonReleaseEvent)\
243  _vtk_add_event(EnterEvent)\
244  _vtk_add_event(LeaveEvent)\
245  _vtk_add_event(KeyPressEvent)\
246  _vtk_add_event(KeyReleaseEvent)\
247  _vtk_add_event(CharEvent)\
248  _vtk_add_event(ExposeEvent)\
249  _vtk_add_event(ConfigureEvent)\
250  _vtk_add_event(TimerEvent)\
251  _vtk_add_event(MouseMoveEvent)\
252  _vtk_add_event(MouseWheelForwardEvent)\
253  _vtk_add_event(MouseWheelBackwardEvent)\
254  _vtk_add_event(ActiveCameraEvent)\
255  _vtk_add_event(CreateCameraEvent)\
256  _vtk_add_event(ResetCameraEvent)\
257  _vtk_add_event(ResetCameraClippingRangeEvent)\
258  _vtk_add_event(ModifiedEvent)\
259  _vtk_add_event(WindowLevelEvent)\
260  _vtk_add_event(StartWindowLevelEvent)\
261  _vtk_add_event(EndWindowLevelEvent)\
262  _vtk_add_event(ResetWindowLevelEvent)\
263  _vtk_add_event(SetOutputEvent)\
264  _vtk_add_event(ErrorEvent)\
265  _vtk_add_event(WarningEvent)\
266  _vtk_add_event(StartInteractionEvent)\
267  /*^ mainly used by vtkInteractorObservers*/\
268  _vtk_add_event(InteractionEvent)\
269  _vtk_add_event(EndInteractionEvent)\
270  _vtk_add_event(EnableEvent)\
271  _vtk_add_event(DisableEvent)\
272  _vtk_add_event(CreateTimerEvent)\
273  _vtk_add_event(DestroyTimerEvent)\
274  _vtk_add_event(PlacePointEvent)\
275  _vtk_add_event(PlaceWidgetEvent)\
276  _vtk_add_event(CursorChangedEvent)\
277  _vtk_add_event(ExecuteInformationEvent)\
278  _vtk_add_event(RenderWindowMessageEvent)\
279  _vtk_add_event(WrongTagEvent)\
280  _vtk_add_event(StartAnimationCueEvent)\
281  _vtk_add_event(ResliceAxesChangedEvent)\
282  /*^ used by vtkAnimationCue*/ \
283  _vtk_add_event(AnimationCueTickEvent)\
284  _vtk_add_event(EndAnimationCueEvent)\
285  _vtk_add_event(VolumeMapperRenderEndEvent)\
286  _vtk_add_event(VolumeMapperRenderProgressEvent)\
287  _vtk_add_event(VolumeMapperRenderStartEvent)\
288  _vtk_add_event(VolumeMapperComputeGradientsEndEvent)\
289  _vtk_add_event(VolumeMapperComputeGradientsProgressEvent)\
290  _vtk_add_event(VolumeMapperComputeGradientsStartEvent)\
291  _vtk_add_event(WidgetModifiedEvent)\
292  _vtk_add_event(WidgetValueChangedEvent)\
293  _vtk_add_event(WidgetActivateEvent)\
294  _vtk_add_event(ConnectionCreatedEvent)\
295  _vtk_add_event(ConnectionClosedEvent)\
296  _vtk_add_event(DomainModifiedEvent)\
297  _vtk_add_event(PropertyModifiedEvent)\
298  _vtk_add_event(UpdateEvent)\
299  _vtk_add_event(RegisterEvent)\
300  _vtk_add_event(UnRegisterEvent)\
301  _vtk_add_event(UpdateInformationEvent)\
302  _vtk_add_event(AnnotationChangedEvent)\
303  _vtk_add_event(SelectionChangedEvent)\
304  _vtk_add_event(UpdatePropertyEvent)\
305  _vtk_add_event(ViewProgressEvent)\
306  _vtk_add_event(UpdateDataEvent)\
307  _vtk_add_event(CurrentChangedEvent)\
308  _vtk_add_event(ComputeVisiblePropBoundsEvent)\
309  _vtk_add_event(TDxMotionEvent)\
310  /*^ 3D Connexion device event */\
311  _vtk_add_event(TDxButtonPressEvent)\
312  /*^ 3D Connexion device event */\
313  _vtk_add_event(TDxButtonReleaseEvent)\
314  /* 3D Connexion device event */\
315  _vtk_add_event(HoverEvent)\
316  _vtk_add_event(LoadStateEvent)\
317  _vtk_add_event(SaveStateEvent)\
318  _vtk_add_event(StateChangedEvent)\
319  _vtk_add_event(WindowMakeCurrentEvent)\
320  _vtk_add_event(WindowIsCurrentEvent)\
321  _vtk_add_event(WindowFrameEvent)\
322  _vtk_add_event(HighlightEvent)\
323  _vtk_add_event(WindowSupportsOpenGLEvent)\
324  _vtk_add_event(WindowIsDirectEvent)\
325  _vtk_add_event(UncheckedPropertyModifiedEvent)\
326  _vtk_add_event(UpdateShaderEvent)\
327  _vtk_add_event(MessageEvent)\
328  _vtk_add_event(StartPinchEvent)\
329  _vtk_add_event(PinchEvent)\
330  _vtk_add_event(EndPinchEvent)\
331  _vtk_add_event(StartRotateEvent)\
332  _vtk_add_event(RotateEvent)\
333  _vtk_add_event(EndRotateEvent)\
334  _vtk_add_event(StartPanEvent)\
335  _vtk_add_event(PanEvent)\
336  _vtk_add_event(EndPanEvent)\
337  _vtk_add_event(TapEvent)\
338  _vtk_add_event(LongTapEvent)\
339  _vtk_add_event(SwipeEvent)\
340  _vtk_add_event(FourthButtonPressEvent)\
341  _vtk_add_event(FourthButtonReleaseEvent)\
342  _vtk_add_event(FifthButtonPressEvent)\
343  _vtk_add_event(FifthButtonReleaseEvent)\
344  _vtk_add_event(Move3DEvent)\
345  _vtk_add_event(Button3DEvent)
346 
347 #define vtkEventDeclarationMacro(_enum_name)\
348  enum _enum_name{\
349  NoEvent = 0,\
350  vtkAllEventsMacro() \
351  UserEvent = 1000\
352  };
353 
354 
355 // The superclass that all commands should be subclasses of
356 class VTKCOMMONCORE_EXPORT vtkCommand : public vtkObjectBase
357 {
358 public:
359  vtkBaseTypeMacro(vtkCommand,vtkObjectBase);
360 
366  void UnRegister();
367  void UnRegister(vtkObjectBase *) override
368  { this->UnRegister(); }
369 
382  virtual void Execute(vtkObject *caller, unsigned long eventId,
383  void *callData) = 0;
384 
386 
390  static const char *GetStringFromEventId(unsigned long event);
391  static unsigned long GetEventIdFromString(const char *event);
393 
397  static bool EventHasData(unsigned long event);
398 
403  void SetAbortFlag(int f)
404  { this->AbortFlag = f; }
406  { return this->AbortFlag; }
407  void AbortFlagOn()
408  { this->SetAbortFlag(1); }
410  { this->SetAbortFlag(0); }
411 
418  void SetPassiveObserver(int f)
419  { this->PassiveObserver = f; }
421  { return this->PassiveObserver; }
423  { this->SetPassiveObserver(1); }
425  { this->SetPassiveObserver(0); }
426 
433 #define _vtk_add_event(Enum) Enum,
435 #undef _vtk_add_event
436 
437 protected:
438  int AbortFlag;
439  int PassiveObserver;
440 
441  vtkCommand();
442  ~vtkCommand() override {}
443 
444  friend class vtkSubjectHelper;
445 
447  void operator=(const vtkCommand&) {}
448 
449 };
450 
451 #endif /* vtkCommand_h */
452 
453 // VTK-HeaderTest-Exclude: vtkCommand.h
void SetPassiveObserver(int f)
Set/Get the passive observer flag.
Definition: vtkCommand.h:418
void AbortFlagOff()
Definition: vtkCommand.h:409
void operator=(const vtkCommand &)
Definition: vtkCommand.h:447
abstract base class for most VTK objects
Definition: vtkObject.h:59
void AbortFlagOn()
Definition: vtkCommand.h:407
void UnRegister(vtkObjectBase *) override
Decrease the reference count (release by another object).
Definition: vtkCommand.h:367
vtkCommand(const vtkCommand &c)
Definition: vtkCommand.h:446
void SetAbortFlag(int f)
Set/Get the abort flag.
Definition: vtkCommand.h:403
void PassiveObserverOn()
Definition: vtkCommand.h:422
superclass for callback/observer methods
Definition: vtkCommand.h:356
virtual void UnRegister(vtkObjectBase *o)
Decrease the reference count (release by another object).
void PassiveObserverOff()
Definition: vtkCommand.h:424
~vtkCommand() override
Definition: vtkCommand.h:442
abstract base class for most VTK objects
Definition: vtkObjectBase.h:68
vtkEventDeclarationMacro(EventIds) protected int PassiveObserver
Definition: vtkCommand.h:434
int GetAbortFlag()
Definition: vtkCommand.h:405
int GetPassiveObserver()
Definition: vtkCommand.h:420
#define vtkEventDeclarationMacro(_enum_name)
Definition: vtkCommand.h:347