vtkProgrammableFilter Class Reference

#include <vtkProgrammableFilter.h>

Inheritance diagram for vtkProgrammableFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkProgrammableFilter:

Collaboration graph
[legend]

List of all members.


Detailed Description

a user-programmable filter

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.

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
Tests:
vtkProgrammableFilter (Tests)

Definition at line 49 of file vtkProgrammableFilter.h.


Public Types

typedef vtkPassInputTypeAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetExecuteMethod (void(*f)(void *), void *arg)
void SetExecuteMethodArgDelete (void(*f)(void *))
vtkPolyDataGetPolyDataInput ()
vtkStructuredPointsGetStructuredPointsInput ()
vtkStructuredGridGetStructuredGridInput ()
vtkUnstructuredGridGetUnstructuredGridInput ()
vtkRectilinearGridGetRectilinearGridInput ()
vtkGraphGetGraphInput ()
virtual void SetCopyArrays (bool)
virtual bool GetCopyArrays ()
virtual void CopyArraysOn ()
virtual void CopyArraysOff ()

Static Public Member Functions

static vtkProgrammableFilterNew ()
static int IsTypeOf (const char *type)
static vtkProgrammableFilterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkProgrammableFilter ()
 ~vtkProgrammableFilter ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int port, vtkInformation *info)

Protected Attributes

void(* ExecuteMethod )(void *)
void(* ExecuteMethodArgDelete )(void *)
void * ExecuteMethodArg
bool CopyArrays

Member Typedef Documentation

Reimplemented from vtkPassInputTypeAlgorithm.

Definition at line 53 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::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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.

virtual void vtkProgrammableFilter::SetCopyArrays ( bool   )  [virtual]

When CopyArrays is true, all arrays are copied to the output iff input and output are of the same type. False by default.

virtual bool vtkProgrammableFilter::GetCopyArrays (  )  [virtual]

When CopyArrays is true, all arrays are copied to the output iff input and output are of the same type. False by default.

virtual void vtkProgrammableFilter::CopyArraysOn (  )  [virtual]

When CopyArrays is true, all arrays are copied to the output iff input and output are of the same type. False by default.

virtual void vtkProgrammableFilter::CopyArraysOff (  )  [virtual]

When CopyArrays is true, all arrays are copied to the output iff input and output are of the same type. False by default.

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]

Definition at line 101 of file vtkProgrammableFilter.h.

Definition at line 103 of file vtkProgrammableFilter.h.


The documentation for this class was generated from the following file:

Generated on Wed Jun 3 19:27:17 2009 for VTK by  doxygen 1.5.6