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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkProgrammableSource.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.
=========================================================================*/
// .NAME vtkProgrammableSource - generate source dataset via a user-specified function
// .SECTION Description
// vtkProgrammableSource is a source object that is programmable by the
// user. To use this object, you must specify a function that creates the
// output. It is possible to generate an output dataset of any (concrete)
// type; it is up to the function to properly initialize and define the
// output. Typically, you use one of the methods to get a concrete output
// type (e.g., GetPolyDataOutput() or GetStructuredPointsOutput()), and
// then manipulate the output in the user-specified function.
//
// Example use of this include writing a function to read a data file or
// interface to another system. (You might want to do this in favor of
// deriving a new class.) Another important use of this class is that it
// allows users of interpreters (e.g., Tcl or Java) the ability to write
// source objects without having to recompile C++ code or generate new
// libraries.
// .SECTION See Also
// vtkProgrammableFilter vtkProgrammableAttributeDataFilter
// vtkProgrammableDataObjectSource
#ifndef vtkProgrammableSource_h
#define vtkProgrammableSource_h
#include "vtkFiltersSourcesModule.h" // For export macro
#include "vtkDataSetAlgorithm.h"
class vtkPolyData;
class vtkStructuredPoints;
class vtkStructuredGrid;
class vtkUnstructuredGrid;
class vtkRectilinearGrid;
class VTKFILTERSSOURCES_EXPORT vtkProgrammableSource : public vtkDataSetAlgorithm
{
public:
static vtkProgrammableSource *New();
vtkTypeMacro(vtkProgrammableSource,vtkDataSetAlgorithm);
// Description:
// Signature definition for programmable method callbacks. Methods passed
// to SetExecuteMethod, SetExecuteMethodArgDelete or
// SetRequestInformationMethod must conform to this signature.
// The presence of this typedef is useful for reference and for external
// analysis tools, but it cannot be used in the method signatures in these
// header files themselves because it prevents the internal VTK wrapper
// generators from wrapping these methods.
typedef void (*ProgrammableMethodCallbackType)(void *arg);
// Description:
// Specify the function to use to generate the source data. Note
// that the function takes a single (void *) argument.
void SetExecuteMethod(void (*f)(void *), void *arg);
// Description:
// Set the arg delete method. This is used to free user memory.
void SetExecuteMethodArgDelete(void (*f)(void *));
// Description:
// Specify the function to use to fill in information about the source data.
void SetRequestInformationMethod(void (*f)(void *));
// Description:
// Get the output as a concrete type. This method is typically used by the
// writer of the source function to get the output as a particular type
// (i.e., it essentially does type casting). It is the users responsibility
// to know the correct type of the output data.
vtkPolyData *GetPolyDataOutput();
// Description:
// Get the output as a concrete type.
vtkStructuredPoints *GetStructuredPointsOutput();
// Description:
// Get the output as a concrete type.
vtkStructuredGrid *GetStructuredGridOutput();
// Description:
// Get the output as a concrete type.
vtkUnstructuredGrid *GetUnstructuredGridOutput();
// Description:
// Get the output as a concrete type.
vtkRectilinearGrid *GetRectilinearGridOutput();
protected:
vtkProgrammableSource();
~vtkProgrammableSource();
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
virtual int RequestDataObject(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
ProgrammableMethodCallbackType ExecuteMethod; //function to invoke
ProgrammableMethodCallbackType ExecuteMethodArgDelete;
void *ExecuteMethodArg;
ProgrammableMethodCallbackType RequestInformationMethod; // function to invoke
vtkTimeStamp ExecuteTime;
int RequestedDataType;
private:
vtkProgrammableSource(const vtkProgrammableSource&); // Not implemented.
void operator=(const vtkProgrammableSource&); // Not implemented.
};
#endif
// VTK-HeaderTest-Exclude: vtkProgrammableSource.h
|
