Documentation for vtkProcessObject

vtkProcessObject - abstract class specifies interface for visualization filters

Description:

vtkProcessObject is an abstract object that specifies behavior and interface of visualization network process objects (sources, filters, mappers). Source objects are creators of visualization data; filters input, process, and output visualization data; and mappers transform data into another form (like rendering primitives or write data to a file). vtkProcessObject provides a mechanism for invoking the methods StartMethod() and EndMethod() before and after object execution (via Execute()). These are convenience methods you can use for any purpose (e.g., debugging info, highlighting/notifying user interface, etc.) These methods accept a single void* pointer that can be used to send data to the methods. It is also possible to specify a function to delete the argument via StartMethodArgDelete and EndMethodArgDelete. Another method, ProgressMethod() can be specified. Some filters invoke this method periodically during their execution. The use is similar to that of StartMethod() and EndMethod(). Filters may also check their AbortExecute flag to determine whether to prematurally end their execution. An important feature of subclasses of vtkProcessObject is that it is possible to control the memory-management model (i.e., retain output versus delete output data). If enabled the ReleaseDataFlag enables the deletion of the output data once the downstream process object finishes processing the data (please see text).

See Also:

vtkDataObject vtkSource vtkFilter vtkMapper vtkWriter

Methods:

	void vtkProcessObject ()
	void vtkProcessObject ()
	static vtkProcessObject *New ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	void SetStartMethod (const )
	void SetProgressMethod (const )
	void SetEndMethod (const )
	void SetStartMethodArgDelete (const )
	void SetProgressMethodArgDelete (const )
	void SetEndMethodArgDelete (const )
	void SetAbortExecute (int )
	int GetAbortExecute ()
	void AbortExecuteOn ()
	void AbortExecuteOff ()
	void SetProgress (float )
	float GetProgress ()
	void UpdateProgress (float )

Detailed Method Descriptions:

Instantiate object with no start, end, or progress methods.

void vtkProcessObject ()

Specify function to be called before object executes.

void SetStartMethod (const )

Specify function to be called to show progress of filter

void SetProgressMethod (const )

Specify function to be called after object executes.

void SetEndMethod (const )

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

	void SetStartMethodArgDelete (const )
	void SetProgressMethodArgDelete (const )
	void SetEndMethodArgDelete (const )

Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.

	void SetAbortExecute (int )
	int GetAbortExecute ()
	void AbortExecuteOn ()
	void AbortExecuteOff ()

Set/Get the execution progress of a process object.

	void SetProgress (float )
	float GetProgress ()

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

void UpdateProgress (float )