vtkOldStyleCallbackCommand.h 2.36 KB
Newer Older
Ken Martin's avatar
Ken Martin committed
1
2
3
4
5
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkOldStyleCallbackCommand.h

6
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7
8
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
Ken Martin's avatar
Ken Martin committed
9

10
11
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12
     PURPOSE.  See the above copyright notice for more information.
Ken Martin's avatar
Ken Martin committed
13
14

=========================================================================*/
15
// .NAME vtkOldStyleCallbackCommand - supports legacy function callbacks for VTK
16
// .SECTION Description
17
// vtkOldStyleCallbackCommand is a callback that supports the legacy callback
18
19
20
// methods found in VTK. For example, the legacy method
// vtkProcessObject::SetStartMethod() is actually invoked using the
// command/observer design pattern of VTK, and the vtkOldStyleCallbackCommand
21
22
23
24
25
26
// is used to provide the legacy functionality. The callback function should
// have the form void func(void *clientdata), where clientdata is special data
// that should is associated with this instance of vtkCallbackCommand.
//
// .SECTION Caveats
// This is legacy glue. Please do not use; it will be eventually eliminated.
27
28

// .SECTION See Also
29
// vtkCommand vtkCallbackCommand
Ken Martin's avatar
Ken Martin committed
30
31
32
33
34
35
36
37
38
39

#ifndef __vtkOldStyleCallbackCommand_h
#define __vtkOldStyleCallbackCommand_h

#include "vtkCommand.h"

// the old style void fund(void *) callbacks
class VTK_COMMON_EXPORT vtkOldStyleCallbackCommand : public vtkCommand
{
public:
40
41
  vtkTypeMacro(vtkOldStyleCallbackCommand,vtkCommand);

Ken Martin's avatar
Ken Martin committed
42
43
44
  static vtkOldStyleCallbackCommand *New() 
    {return new vtkOldStyleCallbackCommand;};

45
46
  // Description:
  // Satisfy the superclass API for callbacks.
47
  void Execute(vtkObject *invoker, unsigned long eid, void *calldata);
48
49
50

  // Description:
  // Methods to set and get client and callback information.
Ken Martin's avatar
Ken Martin committed
51
52
  void SetClientData(void *cd) 
    {this->ClientData = cd;};
53
  void SetCallback(void (*f)(void *clientdata)) 
Ken Martin's avatar
Ken Martin committed
54
55
56
57
58
59
60
    {this->Callback = f;};
  void SetClientDataDeleteCallback(void (*f)(void *))
    {this->ClientDataDeleteCallback = f;};
  
  void *ClientData;
  void (*Callback)(void *);
  void (*ClientDataDeleteCallback)(void *);
61

Ken Martin's avatar
Ken Martin committed
62
63
64
65
66
67
68
69
protected:
  vtkOldStyleCallbackCommand();
  ~vtkOldStyleCallbackCommand();
};


#endif /* __vtkOldStyleCallbackCommand_h */