vtkProgrammableFilter Class Reference

#include <vtkProgrammableFilter.h>

Inheritance diagram for vtkProgrammableFilter:

[legend]

Collaboration diagram for vtkProgrammableFilter:

[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

Examples:: vtkProgrammableFilter (Examples)

Tests:: vtkProgrammableFilter (Tests)

Definition at line 53 of file vtkProgrammableFilter.h.


Public Types
typedef vtkPassInputTypeAlgorithm	Superclass
typedef void(*	ProgrammableMethodCallbackType )(void *arg)
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 ))
vtkPolyData *	GetPolyDataInput ()
vtkStructuredPoints *	GetStructuredPointsInput ()
vtkStructuredGrid *	GetStructuredGridInput ()
vtkUnstructuredGrid *	GetUnstructuredGridInput ()
vtkRectilinearGrid *	GetRectilinearGridInput ()
vtkGraph *	GetGraphInput ()
vtkTable *	GetTableInput ()

virtual void	SetCopyArrays (bool)
virtual bool	GetCopyArrays ()
virtual void	CopyArraysOn ()
virtual void	CopyArraysOff ()
Static Public Member Functions
static vtkProgrammableFilter *	New ()
static int	IsTypeOf (const char *type)
static vtkProgrammableFilter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkProgrammableFilter ()
	~vtkProgrammableFilter ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Attributes
ProgrammableMethodCallbackType	ExecuteMethod
ProgrammableMethodCallbackType	ExecuteMethodArgDelete
void *	ExecuteMethodArg
bool	CopyArrays

Member Typedef Documentation

typedef vtkPassInputTypeAlgorithm vtkProgrammableFilter::Superclass

Reimplemented from vtkPassInputTypeAlgorithm.

Definition at line 57 of file vtkProgrammableFilter.h.

typedef void(* vtkProgrammableFilter::ProgrammableMethodCallbackType)(void *arg)

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.

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 vtkTypeMacro 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 vtkTypeMacro 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 ( )