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