VTK  9.3.0
vtkCallbackCommand.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
41 #ifndef vtkCallbackCommand_h
42 #define vtkCallbackCommand_h
43 
44 #include "vtkCommand.h"
45 #include "vtkCommonCoreModule.h" // For export macro
46 
47 VTK_ABI_NAMESPACE_BEGIN
48 class VTKCOMMONCORE_EXPORT vtkCallbackCommand : public vtkCommand
49 {
50 public:
52 
53  static vtkCallbackCommand* New() { return new vtkCallbackCommand; }
54 
61  void Execute(vtkObject* caller, unsigned long eid, void* callData) override;
62 
67  virtual void SetClientData(void* cd) { this->ClientData = cd; }
68  virtual void* GetClientData() { return this->ClientData; }
69  virtual void SetCallback(
70  void (*f)(vtkObject* caller, unsigned long eid, void* clientdata, void* calldata))
71  {
72  this->Callback = f;
73  }
74  virtual void SetClientDataDeleteCallback(void (*f)(void*)) { this->ClientDataDeleteCallback = f; }
75 
81  void SetAbortFlagOnExecute(int f) { this->AbortFlagOnExecute = f; }
82  int GetAbortFlagOnExecute() { return this->AbortFlagOnExecute; }
83  void AbortFlagOnExecuteOn() { this->SetAbortFlagOnExecute(1); }
84  void AbortFlagOnExecuteOff() { this->SetAbortFlagOnExecute(0); }
85 
86  void (*Callback)(vtkObject*, unsigned long, void*, void*);
87  void (*ClientDataDeleteCallback)(void*);
88 
89 protected:
91  void* ClientData;
92 
94  ~vtkCallbackCommand() override;
95 };
96 
97 VTK_ABI_NAMESPACE_END
98 #endif
99 
100 // VTK-HeaderTest-Exclude: vtkCallbackCommand.h
supports function callbacks
~vtkCallbackCommand() override
virtual void SetClientDataDeleteCallback(void(*f)(void *))
static vtkCallbackCommand * New()
void SetAbortFlagOnExecute(int f)
Set/Get the abort flag on execute.
virtual void SetCallback(void(*f)(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata))
virtual void * GetClientData()
virtual void SetClientData(void *cd)
Methods to set and get client and callback information, and the callback function.
void Execute(vtkObject *caller, unsigned long eid, void *callData) override
Satisfy the superclass API for callbacks.
superclass for callback/observer methods
Definition: vtkCommand.h:384
abstract base class for most VTK objects
Definition: vtkObject.h:61