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 =========================================================================*/
218 #ifndef vtkCommand_h
219 #define vtkCommand_h
220 
221 #include "vtkCommonCoreModule.h" // For export macro
222 #include "vtkObjectBase.h"
223 #include "vtkObject.h" // Need vtkTypeMacro
224 
225 // Define all types of events here.
226 // Using this macro makes it possible to avoid mismatches between the event
227 // enums and their string counterparts.
228 #define vtkAllEventsMacro() \
229  _vtk_add_event(AnyEvent)\
230  _vtk_add_event(DeleteEvent)\
231  _vtk_add_event(StartEvent)\
232  _vtk_add_event(EndEvent)\
233  _vtk_add_event(RenderEvent)\
234  _vtk_add_event(ProgressEvent)\
235  _vtk_add_event(PickEvent)\
236  _vtk_add_event(StartPickEvent)\
237  _vtk_add_event(EndPickEvent)\
238  _vtk_add_event(AbortCheckEvent)\
239  _vtk_add_event(ExitEvent)\
240  _vtk_add_event(LeftButtonPressEvent)\
241  _vtk_add_event(LeftButtonReleaseEvent)\
242  _vtk_add_event(MiddleButtonPressEvent)\
243  _vtk_add_event(MiddleButtonReleaseEvent)\
244  _vtk_add_event(RightButtonPressEvent)\
245  _vtk_add_event(RightButtonReleaseEvent)\
246  _vtk_add_event(EnterEvent)\
247  _vtk_add_event(LeaveEvent)\
248  _vtk_add_event(KeyPressEvent)\
249  _vtk_add_event(KeyReleaseEvent)\
250  _vtk_add_event(CharEvent)\
251  _vtk_add_event(ExposeEvent)\
252  _vtk_add_event(ConfigureEvent)\
253  _vtk_add_event(TimerEvent)\
254  _vtk_add_event(MouseMoveEvent)\
255  _vtk_add_event(MouseWheelForwardEvent)\
256  _vtk_add_event(MouseWheelBackwardEvent)\
257  _vtk_add_event(ActiveCameraEvent)\
258  _vtk_add_event(CreateCameraEvent)\
259  _vtk_add_event(ResetCameraEvent)\
260  _vtk_add_event(ResetCameraClippingRangeEvent)\
261  _vtk_add_event(ModifiedEvent)\
262  _vtk_add_event(WindowLevelEvent)\
263  _vtk_add_event(StartWindowLevelEvent)\
264  _vtk_add_event(EndWindowLevelEvent)\
265  _vtk_add_event(ResetWindowLevelEvent)\
266  _vtk_add_event(SetOutputEvent)\
267  _vtk_add_event(ErrorEvent)\
268  _vtk_add_event(WarningEvent)\
269  _vtk_add_event(StartInteractionEvent)\
270  /*^ mainly used by vtkInteractorObservers*/\
271  _vtk_add_event(InteractionEvent)\
272  _vtk_add_event(EndInteractionEvent)\
273  _vtk_add_event(EnableEvent)\
274  _vtk_add_event(DisableEvent)\
275  _vtk_add_event(CreateTimerEvent)\
276  _vtk_add_event(DestroyTimerEvent)\
277  _vtk_add_event(PlacePointEvent)\
278  _vtk_add_event(DeletePointEvent)\
279  _vtk_add_event(PlaceWidgetEvent)\
280  _vtk_add_event(CursorChangedEvent)\
281  _vtk_add_event(ExecuteInformationEvent)\
282  _vtk_add_event(RenderWindowMessageEvent)\
283  _vtk_add_event(WrongTagEvent)\
284  _vtk_add_event(StartAnimationCueEvent)\
285  _vtk_add_event(ResliceAxesChangedEvent)\
286  /*^ used by vtkAnimationCue*/ \
287  _vtk_add_event(AnimationCueTickEvent)\
288  _vtk_add_event(EndAnimationCueEvent)\
289  _vtk_add_event(VolumeMapperRenderEndEvent)\
290  _vtk_add_event(VolumeMapperRenderProgressEvent)\
291  _vtk_add_event(VolumeMapperRenderStartEvent)\
292  _vtk_add_event(VolumeMapperComputeGradientsEndEvent)\
293  _vtk_add_event(VolumeMapperComputeGradientsProgressEvent)\
294  _vtk_add_event(VolumeMapperComputeGradientsStartEvent)\
295  _vtk_add_event(WidgetModifiedEvent)\
296  _vtk_add_event(WidgetValueChangedEvent)\
297  _vtk_add_event(WidgetActivateEvent)\
298  _vtk_add_event(ConnectionCreatedEvent)\
299  _vtk_add_event(ConnectionClosedEvent)\
300  _vtk_add_event(DomainModifiedEvent)\
301  _vtk_add_event(PropertyModifiedEvent)\
302  _vtk_add_event(UpdateEvent)\
303  _vtk_add_event(RegisterEvent)\
304  _vtk_add_event(UnRegisterEvent)\
305  _vtk_add_event(UpdateInformationEvent)\
306  _vtk_add_event(AnnotationChangedEvent)\
307  _vtk_add_event(SelectionChangedEvent)\
308  _vtk_add_event(UpdatePropertyEvent)\
309  _vtk_add_event(ViewProgressEvent)\
310  _vtk_add_event(UpdateDataEvent)\
311  _vtk_add_event(CurrentChangedEvent)\
312  _vtk_add_event(ComputeVisiblePropBoundsEvent)\
313  _vtk_add_event(TDxMotionEvent)\
314  /*^ 3D Connexion device event */\
315  _vtk_add_event(TDxButtonPressEvent)\
316  /*^ 3D Connexion device event */\
317  _vtk_add_event(TDxButtonReleaseEvent)\
318  /* 3D Connexion device event */\
319  _vtk_add_event(HoverEvent)\
320  _vtk_add_event(LoadStateEvent)\
321  _vtk_add_event(SaveStateEvent)\
322  _vtk_add_event(StateChangedEvent)\
323  _vtk_add_event(WindowMakeCurrentEvent)\
324  _vtk_add_event(WindowIsCurrentEvent)\
325  _vtk_add_event(WindowFrameEvent)\
326  _vtk_add_event(HighlightEvent)\
327  _vtk_add_event(WindowSupportsOpenGLEvent)\
328  _vtk_add_event(WindowIsDirectEvent)\
329  _vtk_add_event(UncheckedPropertyModifiedEvent)\
330  _vtk_add_event(UpdateShaderEvent)\
331  _vtk_add_event(MessageEvent)\
332  _vtk_add_event(StartPinchEvent)\
333  _vtk_add_event(PinchEvent)\
334  _vtk_add_event(EndPinchEvent)\
335  _vtk_add_event(StartRotateEvent)\
336  _vtk_add_event(RotateEvent)\
337  _vtk_add_event(EndRotateEvent)\
338  _vtk_add_event(StartPanEvent)\
339  _vtk_add_event(PanEvent)\
340  _vtk_add_event(EndPanEvent)\
341  _vtk_add_event(TapEvent)\
342  _vtk_add_event(LongTapEvent)\
343  _vtk_add_event(SwipeEvent)\
344  _vtk_add_event(FourthButtonPressEvent)\
345  _vtk_add_event(FourthButtonReleaseEvent)\
346  _vtk_add_event(FifthButtonPressEvent)\
347  _vtk_add_event(FifthButtonReleaseEvent)\
348  _vtk_add_event(Move3DEvent)\
349  _vtk_add_event(Button3DEvent)
350 
351 #define vtkEventDeclarationMacro(_enum_name)\
352  enum _enum_name{\
353  NoEvent = 0,\
354  vtkAllEventsMacro() \
355  UserEvent = 1000\
356  };
357 
358 
359 // The superclass that all commands should be subclasses of
360 class VTKCOMMONCORE_EXPORT vtkCommand : public vtkObjectBase
361 {
362 public:
363  vtkBaseTypeMacro(vtkCommand,vtkObjectBase);
364 
370  void UnRegister();
371  void UnRegister(vtkObjectBase *) override
372  { this->UnRegister(); }
373 
386  virtual void Execute(vtkObject *caller, unsigned long eventId,
387  void *callData) = 0;
388 
390 
394  static const char *GetStringFromEventId(unsigned long event);
395  static unsigned long GetEventIdFromString(const char *event);
397 
401  static bool EventHasData(unsigned long event);
402 
407  void SetAbortFlag(int f)
408  { this->AbortFlag = f; }
410  { return this->AbortFlag; }
411  void AbortFlagOn()
412  { this->SetAbortFlag(1); }
414  { this->SetAbortFlag(0); }
415 
422  void SetPassiveObserver(int f)
423  { this->PassiveObserver = f; }
425  { return this->PassiveObserver; }
427  { this->SetPassiveObserver(1); }
429  { this->SetPassiveObserver(0); }
430 
437 #define _vtk_add_event(Enum) Enum,
439 #undef _vtk_add_event
440 
441 protected:
442  int AbortFlag;
443  int PassiveObserver;
444 
445  vtkCommand();
446  ~vtkCommand() override {}
447 
448  friend class vtkSubjectHelper;
449 
451  void operator=(const vtkCommand&) {}
452 
453 };
454 
455 #endif /* vtkCommand_h */
456 
457 // VTK-HeaderTest-Exclude: vtkCommand.h
void SetPassiveObserver(int f)
Set/Get the passive observer flag.
Definition: vtkCommand.h:422
void AbortFlagOff()
Definition: vtkCommand.h:413
void operator=(const vtkCommand &)
Definition: vtkCommand.h:451
abstract base class for most VTK objects
Definition: vtkObject.h:59
void AbortFlagOn()
Definition: vtkCommand.h:411
void UnRegister(vtkObjectBase *) override
Decrease the reference count (release by another object).
Definition: vtkCommand.h:371
vtkCommand(const vtkCommand &c)
Definition: vtkCommand.h:450
void SetAbortFlag(int f)
Set/Get the abort flag.
Definition: vtkCommand.h:407
void PassiveObserverOn()
Definition: vtkCommand.h:426
superclass for callback/observer methods
Definition: vtkCommand.h:360
virtual void UnRegister(vtkObjectBase *o)
Decrease the reference count (release by another object).
void PassiveObserverOff()
Definition: vtkCommand.h:428
~vtkCommand() override
Definition: vtkCommand.h:446
abstract base class for most VTK objects
Definition: vtkObjectBase.h:68
vtkEventDeclarationMacro(EventIds) protected int PassiveObserver
Definition: vtkCommand.h:438
int GetAbortFlag()
Definition: vtkCommand.h:409
int GetPassiveObserver()
Definition: vtkCommand.h:424
#define vtkEventDeclarationMacro(_enum_name)
Definition: vtkCommand.h:351