VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkProcessObject Class Reference

abstract class specifies interface for visualization filters More...

#include <vtkProcessObject.h>

Inheritance diagram for vtkProcessObject:
[legend]
Collaboration diagram for vtkProcessObject:
[legend]

Public Types

typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SqueezeInputArray ()
 
void RemoveAllInputs ()
 
vtkDataObject ** GetInputs ()
 
int GetNumberOfInputs ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkProcessObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

void SetNumberOfInputs (int num)
 
virtual void SetNthInput (int num, vtkDataObject *input)
 
virtual void AddInput (vtkDataObject *input)
 
virtual void RemoveInput (vtkDataObject *input)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual int FillInputPortInformation (int, vtkInformation *)
 
virtual int FillOutputPortInformation (int, vtkInformation *)
 
void AddInputInternal (vtkDataObject *input)
 
void RemoveInputInternal (vtkDataObject *input)
 
void SetupInputs ()
 

Protected Attributes

int NumberOfInputs
 
int NumberOfRequiredInputs
 
vtkDataObject ** Inputs
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
 vtkProcessObject ()
 
 ~vtkProcessObject ()
 

Detailed Description

abstract class specifies interface for visualization filters

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 fires events for Start and End events before and after object execution (via Execute()). These events can be used for any purpose (e.g., debugging info, highlighting/notifying user interface, etc.)

Another event, Progress, can be observed. Some filters fire this event periodically during their execution. The use is similar to that of Start and End events. 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).

See Also
vtkDataObject vtkSource vtkFilter vtkMapper vtkWriter

Definition at line 51 of file vtkProcessObject.h.

Member Typedef Documentation

typedef vtkAlgorithm vtkProcessObject::Superclass

Definition at line 54 of file vtkProcessObject.h.

Constructor & Destructor Documentation

vtkProcessObject::vtkProcessObject ( )
protected

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

vtkProcessObject::~vtkProcessObject ( )
protected

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Member Function Documentation

virtual const char* vtkProcessObject::GetClassName ( )
virtual
static int vtkProcessObject::IsTypeOf ( const char *  type)
static
virtual int vtkProcessObject::IsA ( const char *  type)
virtual
static vtkProcessObject* vtkProcessObject::SafeDownCast ( vtkObject o)
static
void vtkProcessObject::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
vtkDataObject** vtkProcessObject::GetInputs ( )

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

int vtkProcessObject::GetNumberOfInputs ( )

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

void vtkProcessObject::SqueezeInputArray ( )

This method will rearrange the input array so that all NULL entries are removed.

void vtkProcessObject::RemoveAllInputs ( )

Remove all the input data.

virtual void vtkProcessObject::SetInputConnection ( vtkAlgorithmOutput input)
inlinevirtual

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Definition at line 74 of file vtkProcessObject.h.

virtual void vtkProcessObject::SetInputConnection ( int  port,
vtkAlgorithmOutput input 
)
virtual

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

virtual void vtkProcessObject::AddInputConnection ( int  port,
vtkAlgorithmOutput input 
)
virtual

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

virtual void vtkProcessObject::AddInputConnection ( vtkAlgorithmOutput input)
inlinevirtual

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Definition at line 78 of file vtkProcessObject.h.

virtual void vtkProcessObject::RemoveInputConnection ( int  port,
vtkAlgorithmOutput input 
)
virtual

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

virtual void vtkProcessObject::SetNthInputConnection ( int  port,
int  index,
vtkAlgorithmOutput input 
)
virtual

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

virtual void vtkProcessObject::SetNumberOfInputConnections ( int  port,
int  n 
)
virtual

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

void vtkProcessObject::SetNumberOfInputs ( int  num)
protected
virtual void vtkProcessObject::SetNthInput ( int  num,
vtkDataObject input 
)
protectedvirtual
virtual void vtkProcessObject::AddInput ( vtkDataObject input)
protectedvirtual
virtual void vtkProcessObject::RemoveInput ( vtkDataObject input)
protectedvirtual
virtual void vtkProcessObject::ReportReferences ( vtkGarbageCollector )
protectedvirtual

Reimplemented in vtkSource.

virtual int vtkProcessObject::FillInputPortInformation ( int  ,
vtkInformation  
)
protectedvirtual
virtual int vtkProcessObject::FillOutputPortInformation ( int  ,
vtkInformation  
)
protectedvirtual
void vtkProcessObject::AddInputInternal ( vtkDataObject input)
protected
void vtkProcessObject::RemoveInputInternal ( vtkDataObject input)
protected
void vtkProcessObject::SetupInputs ( )
protected

Member Data Documentation

int vtkProcessObject::NumberOfInputs
protected

Definition at line 91 of file vtkProcessObject.h.

int vtkProcessObject::NumberOfRequiredInputs
protected

Definition at line 92 of file vtkProcessObject.h.

vtkDataObject** vtkProcessObject::Inputs
protected

Definition at line 93 of file vtkProcessObject.h.


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