1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkCallbackCommand.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkCallbackCommand
* @brief supports function callbacks
*
* Use vtkCallbackCommand for generic function callbacks. That is, this class
* can be used when you wish to execute a function (of the signature
* described below) using the Command/Observer design pattern in VTK.
* The callback function should have the form
* <pre>
* void func(vtkObject*, unsigned long eid, void* clientdata, void *calldata)
* </pre>
* where the parameter vtkObject* is the object invoking the event; eid is
* the event id (see vtkCommand.h); clientdata is special data that should
* is associated with this instance of vtkCallbackCommand; and calldata is
* data that the vtkObject::InvokeEvent() may send with the callback. For
* example, the invocation of the ProgressEvent sends along the progress
* value as calldata.
*
*
* @sa
* vtkCommand vtkOldStyleCallbackCommand
*/
#ifndef vtkCallbackCommand_h
#define vtkCallbackCommand_h
#include "vtkCommand.h"
#include "vtkCommonCoreModule.h" // For export macro
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkCallbackCommand : public vtkCommand
{
public:
vtkTypeMacro(vtkCallbackCommand, vtkCommand);
static vtkCallbackCommand* New() { return new vtkCallbackCommand; }
/**
* Satisfy the superclass API for callbacks. Recall that the caller is
* the instance invoking the event; eid is the event id (see
* vtkCommand.h); and calldata is information sent when the callback
* was invoked (e.g., progress value in the vtkCommand::ProgressEvent).
*/
void Execute(vtkObject* caller, unsigned long eid, void* callData) override;
/**
* Methods to set and get client and callback information, and the callback
* function.
*/
virtual void SetClientData(void* cd) { this->ClientData = cd; }
virtual void* GetClientData() { return this->ClientData; }
virtual void SetCallback(
void (*f)(vtkObject* caller, unsigned long eid, void* clientdata, void* calldata))
{
this->Callback = f;
}
virtual void SetClientDataDeleteCallback(void (*f)(void*)) { this->ClientDataDeleteCallback = f; }
/**
* Set/Get the abort flag on execute. If this is set to true the AbortFlag
* will be set to On automatically when the Execute method is triggered *and*
* a callback is set.
*/
void SetAbortFlagOnExecute(int f) { this->AbortFlagOnExecute = f; }
int GetAbortFlagOnExecute() { return this->AbortFlagOnExecute; }
void AbortFlagOnExecuteOn() { this->SetAbortFlagOnExecute(1); }
void AbortFlagOnExecuteOff() { this->SetAbortFlagOnExecute(0); }
void (*Callback)(vtkObject*, unsigned long, void*, void*);
void (*ClientDataDeleteCallback)(void*);
protected:
int AbortFlagOnExecute;
void* ClientData;
vtkCallbackCommand();
~vtkCallbackCommand() override;
};
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkCallbackCommand.h
|
