#include <vtkProcessObject.h>
Inheritance diagram for vtkProcessObject:
Public Methods | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
void | SetStartMethod (void(*f)(void *), void *arg) |
void | SetProgressMethod (void(*f)(void *), void *arg) |
void | SetEndMethod (void(*f)(void *), void *arg) |
void | SetStartMethodArgDelete (void(*f)(void *)) |
void | SetProgressMethodArgDelete (void(*f)(void *)) |
void | SetEndMethodArgDelete (void(*f)(void *)) |
virtual void | SetAbortExecute (int) |
virtual int | GetAbortExecute () |
virtual void | AbortExecuteOn () |
virtual void | AbortExecuteOff () |
virtual void | SetProgress (float) |
virtual float | GetProgress () |
void | UpdateProgress (float amount) |
virtual void | SetProgressText (const char *) |
virtual char * | GetProgressText () |
vtkDataObject ** | GetInputs () |
virtual int | GetNumberOfInputs () |
void | SqueezeInputArray () |
void | RemoveAllInputs () |
Static Public Methods | |
vtkProcessObject * | New () |
int | IsTypeOf (const char *type) |
vtkProcessObject * | SafeDownCast (vtkObject *o) |
Public Attributes | |
int | AbortExecute |
Protected Methods | |
vtkProcessObject () | |
~vtkProcessObject () | |
vtkProcessObject (const vtkProcessObject &) | |
void | operator= (const vtkProcessObject &) |
void | SortInputsByLocality () |
void | SortMerge (vtkDataObject **a1, int l1, vtkDataObject **a2, int l2, vtkDataObject **results) |
void | SetNumberOfInputs (int num) |
virtual void | SetNthInput (int num, vtkDataObject *input) |
virtual void | AddInput (vtkDataObject *input) |
virtual void | RemoveInput (vtkDataObject *input) |
Protected Attributes | |
unsigned long | StartTag |
unsigned long | ProgressTag |
unsigned long | EndTag |
float | Progress |
char * | ProgressText |
int | NumberOfInputs |
int | NumberOfRequiredInputs |
vtkDataObject ** | Inputs |
vtkDataObject ** | SortedInputs |
vtkDataObject ** | SortedInputs2 |
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 prematurely 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).
|
Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkAbstractMapper. |
|
Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc. |
|
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 vtkObject. Reimplemented in vtkAbstractMapper. |
|
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 vtkObject. Reimplemented in vtkAbstractMapper. |
|
Instantiate object with no start, end, or progress methods. Reimplemented from vtkObject. Reimplemented in vtkImageSource. |
|
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 vtkObject. Reimplemented in vtkAbstractMapper. |
|
Remove all the input data. |
|
Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkAbstractMapper. |
|
Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways. |
|
Specify function to be called after object executes. |
|
Set the arg delete method. This is used to free user memory. |
|
Set/Get the execution progress of a process object. |
|
Specify function to be called to show progress of filter |
|
Set the arg delete method. This is used to free user memory. |
|
Set the current text message associated with the progress state. This may be used by a calling process/GUI. |
|
Specify function to be called before object executes. |
|
Set the arg delete method. This is used to free user memory. |
|
This method will rearrange the input array so that all NULL entries are removed. |
|
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). |