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 123 124 125 126 127 128 129
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkProgrammableFilter.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 vtkProgrammableFilter - a user-programmable filter
// .SECTION Description
// vtkProgrammableFilter is a filter that can be programmed by the user. To
// use the filter you define a function that retrieves input of the correct
// type, creates data, and then manipulates the output of the filter. Using
// this filter avoids the need for subclassing - and the function can be
// defined in an interpreter wrapper language such as Tcl or Java.
//
// The trickiest part of using this filter is that the input and output
// methods are unusual and cannot be compile-time type checked. Instead, as a
// user of this filter it is your responsibility to set and get the correct
// input and output types.
// .SECTION Caveats
// The filter correctly manages modified time and network execution in most
// cases. However, if you change the definition of the filter function,
// you'll want to send a manual Modified() method to the filter to force it
// to reexecute.
// .SECTION See Also
// vtkProgrammablePointDataFilter vtkProgrammableSource
#ifndef __vtkProgrammableFilter_h
#define __vtkProgrammableFilter_h
#include "vtkPassInputTypeAlgorithm.h"
class vtkGraph;
class vtkTable;
class VTK_GRAPHICS_EXPORT vtkProgrammableFilter : public vtkPassInputTypeAlgorithm
{
public:
static vtkProgrammableFilter *New();
vtkTypeMacro(vtkProgrammableFilter,vtkPassInputTypeAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Signature definition for programmable method callbacks. Methods passed to
// SetExecuteMethod or SetExecuteMethodArgDelete 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 operate on the point attribute 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:
// Get the input as a concrete type. This method is typically used by the
// writer of the filter function to get the input as a particular type (i.e.,
// it essentially does type casting). It is the users responsibility to know
// the correct type of the input data.
vtkPolyData *GetPolyDataInput();
// Description:
// Get the input as a concrete type.
vtkStructuredPoints *GetStructuredPointsInput();
// Description:
// Get the input as a concrete type.
vtkStructuredGrid *GetStructuredGridInput();
// Description:
// Get the input as a concrete type.
vtkUnstructuredGrid *GetUnstructuredGridInput();
// Description:
// Get the input as a concrete type.
vtkRectilinearGrid *GetRectilinearGridInput();
// Description:
// Get the input as a concrete type.
vtkGraph *GetGraphInput();
// Description:
// Get the input as a concrete type.
vtkTable *GetTableInput();
// Description:
// When CopyArrays is true, all arrays are copied to the output
// iff input and output are of the same type. False by default.
vtkSetMacro(CopyArrays, bool);
vtkGetMacro(CopyArrays, bool);
vtkBooleanMacro(CopyArrays, bool);
protected:
vtkProgrammableFilter();
~vtkProgrammableFilter();
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
virtual int FillInputPortInformation(int port, vtkInformation* info);
ProgrammableMethodCallbackType ExecuteMethod; //function to invoke
ProgrammableMethodCallbackType ExecuteMethodArgDelete;
void *ExecuteMethodArg;
bool CopyArrays;
private:
vtkProgrammableFilter(const vtkProgrammableFilter&); // Not implemented.
void operator=(const vtkProgrammableFilter&); // Not implemented.
};
#endif
|