vtkProgrammableFilter Class Reference
#include <vtkProgrammableFilter.h>
Detailed Description
a user-programmable filtervtkProgrammableFilter 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.
- Warning:
- 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.
- See also:
- vtkProgrammablePointDataFilter vtkProgrammableSource
- Examples:
- vtkProgrammableFilter (Examples)
Definition at line 52 of file vtkProgrammableFilter.h.
Member Typedef Documentation
Reimplemented from vtkPassInputTypeAlgorithm.
Definition at line 56 of file vtkProgrammableFilter.h.
Constructor & Destructor Documentation
| vtkProgrammableFilter::vtkProgrammableFilter | ( | ) | [protected] |
| vtkProgrammableFilter::~vtkProgrammableFilter | ( | ) | [protected] |
Member Function Documentation
| static vtkProgrammableFilter* vtkProgrammableFilter::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkPassInputTypeAlgorithm.
| virtual const char* vtkProgrammableFilter::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkPassInputTypeAlgorithm.
| static int vtkProgrammableFilter::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkPassInputTypeAlgorithm.
| virtual int vtkProgrammableFilter::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkPassInputTypeAlgorithm.
| static vtkProgrammableFilter* vtkProgrammableFilter::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkPassInputTypeAlgorithm.
| void vtkProgrammableFilter::SetExecuteMethod | ( | void(*)(void *) | f, | |
| void * | arg | |||
| ) |
Specify the function to use to operate on the point attribute data. Note that the function takes a single (void *) argument.
| void vtkProgrammableFilter::SetExecuteMethodArgDelete | ( | void(*)(void *) | f | ) |
Set the arg delete method. This is used to free user memory.
| vtkPolyData* vtkProgrammableFilter::GetPolyDataInput | ( | ) |
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.
| vtkStructuredPoints* vtkProgrammableFilter::GetStructuredPointsInput | ( | ) |
Get the input as a concrete type.
| vtkStructuredGrid* vtkProgrammableFilter::GetStructuredGridInput | ( | ) |
Get the input as a concrete type.
| vtkUnstructuredGrid* vtkProgrammableFilter::GetUnstructuredGridInput | ( | ) |
Get the input as a concrete type.
| vtkRectilinearGrid* vtkProgrammableFilter::GetRectilinearGridInput | ( | ) |
Get the input as a concrete type.
| vtkGraph* vtkProgrammableFilter::GetGraphInput | ( | ) |
Get the input as a concrete type.
| int vtkProgrammableFilter::RequestData | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [protected, virtual] |
This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.
Reimplemented from vtkPassInputTypeAlgorithm.
| virtual int vtkProgrammableFilter::FillInputPortInformation | ( | int | port, | |
| vtkInformation * | info | |||
| ) | [protected, virtual] |
Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkPassInputTypeAlgorithm.
Member Data Documentation
void(* vtkProgrammableFilter::ExecuteMethod)(void *) [protected] |
void(* vtkProgrammableFilter::ExecuteMethodArgDelete)(void *) [protected] |
void* vtkProgrammableFilter::ExecuteMethodArg [protected] |
Definition at line 95 of file vtkProgrammableFilter.h.
The documentation for this class was generated from the following file:
- dox/Graphics/vtkProgrammableFilter.h
