vtkProgrammableFilter - a user-programmable filter

Super Class: vtkFilter

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.

Caveats:

The filter correctlymanages 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

Methods:

• vtkProgrammableFilter ();
• ~vtkProgrammableFilter ();
• vtkProgrammableFilter *New ();
• char *GetClassName ();
• void PrintSelf (ostream &os, vtkIndent indent);
• void SetExecuteMethod (void (*func)(void *) , void *arg);
• void SetExecuteMethodArgDelete (void (*func)(void *) );
• void SetInput (vtkDataSet *input);
• vtkPolyData *GetPolyDataInput ();
• vtkStructuredPoints *GetStructuredPointsInput ();
• vtkStructuredGrid *GetStructuredGridInput ();
• vtkUnstructuredGrid *GetUnstructuredGridInput ();
• vtkRectilinearGrid *GetRectilinearGridInput ();
• vtkPolyData *GetPolyDataOutput ();
• vtkStructuredPoints *GetStructuredPointsOutput ();
• vtkStructuredGrid *GetStructuredGridOutput ();
• vtkUnstructuredGrid *GetUnstructuredGridOutput ();
• vtkRectilinearGrid *GetRectilinearGridOutput ();
• void Execute ();

Detailed Method Descriptions:

• void SetExecuteMethod (void (*func)(void *) , void *arg);

Specify the function to use to operate on the point attribute data. Note that the function takes a single (void *) argument.

• void SetExecuteMethodArgDelete (void (*func)(void *) );

Set the arg delete method. This is used to free user memory.

• void SetInput (vtkDataSet *input);

Specify the input data or filter.

• vtkPolyData *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 *GetStructuredPointsInput ();
• vtkStructuredGrid *GetStructuredGridInput ();
• vtkUnstructuredGrid *GetUnstructuredGridInput ();
• vtkRectilinearGrid *GetRectilinearGridInput ();

Get the input as a concrete type.

• vtkPolyData *GetPolyDataOutput ();

Get the output as a concrete type. This method is typically used by the writer of the filter 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.

• vtkStructuredPoints *GetStructuredPointsOutput ();
• vtkStructuredGrid *GetStructuredGridOutput ();
• vtkUnstructuredGrid *GetUnstructuredGridOutput ();
• vtkRectilinearGrid *GetRectilinearGridOutput ();

Get the output as a concrete type.