VTK
|
abstract class specifies interface for visualization filters More...
#include <vtkProcessObject.h>
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 () |
![]() | |
int | HasExecutive () |
vtkExecutive * | GetExecutive () |
virtual void | SetExecutive (vtkExecutive *executive) |
virtual int | ModifyRequest (vtkInformation *request, int when) |
vtkInformation * | GetInputPortInformation (int port) |
vtkInformation * | GetOutputPortInformation (int port) |
int | GetNumberOfInputPorts () |
int | GetNumberOfOutputPorts () |
void | UpdateProgress (double amount) |
vtkInformation * | GetInputArrayInformation (int idx) |
vtkDataObject * | GetOutputDataObject (int port) |
int | GetNumberOfInputConnections (int port) |
int | GetTotalNumberOfInputConnections () |
vtkAlgorithmOutput * | GetInputConnection (int port, int index) |
virtual void | Update () |
virtual void | UpdateInformation () |
virtual void | UpdateWholeExtent () |
void | ConvertTotalInputToPortConnection (int ind, int &port, int &conn) |
virtual double | ComputePriority () |
virtual int | ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) |
int | ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo) |
virtual int | ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime) |
virtual vtkInformation * | GetInformation () |
virtual void | SetInformation (vtkInformation *) |
virtual void | Register (vtkObjectBase *o) |
virtual void | UnRegister (vtkObjectBase *o) |
virtual void | SetAbortExecute (int) |
virtual int | GetAbortExecute () |
virtual void | AbortExecuteOn () |
virtual void | AbortExecuteOff () |
virtual void | SetProgress (double) |
virtual double | GetProgress () |
void | SetProgressText (const char *ptext) |
virtual char * | GetProgressText () |
virtual unsigned long | GetErrorCode () |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name) |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) |
virtual void | SetInputArrayToProcess (int idx, vtkInformation *info) |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName) |
vtkDataObject * | GetInputDataObject (int port, int connection) |
vtkAlgorithmOutput * | GetOutputPort (int index) |
vtkAlgorithmOutput * | GetOutputPort () |
virtual void | SetReleaseDataFlag (int) |
virtual int | GetReleaseDataFlag () |
void | ReleaseDataFlagOn () |
void | ReleaseDataFlagOff () |
int | UpdateExtentIsEmpty (vtkDataObject *output) |
int | UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType) |
![]() | |
virtual void | DebugOn () |
virtual void | DebugOff () |
unsigned char | GetDebug () |
void | SetDebug (unsigned char debugFlag) |
virtual void | Modified () |
virtual unsigned long | GetMTime () |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
int | HasObserver (unsigned long event, vtkCommand *) |
int | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
int | HasObserver (unsigned long event) |
int | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
int | InvokeEvent (unsigned long event, void *callData) |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
const char * | GetClassName () const |
virtual void | Delete () |
virtual void | FastDelete () |
void | Print (ostream &os) |
void | SetReferenceCount (int) |
void | PrintRevisions (ostream &os) |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
Protected Attributes | |
int | NumberOfInputs |
int | NumberOfRequiredInputs |
vtkDataObject ** | Inputs |
![]() | |
vtkInformation * | Information |
double | Progress |
char * | ProgressText |
unsigned long | ErrorCode |
![]() | |
unsigned char | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
int | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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 () |
Additional Inherited Members | |
![]() | |
int | AbortExecute |
![]() | |
static vtkInformationIntegerKey * | PORT_REQUIREMENTS_FILLED () |
![]() | |
static vtkExecutive * | DefaultExecutivePrototype |
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).
Definition at line 51 of file vtkProcessObject.h.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkPLOT3DReader, vtkSpatialRepresentationFilter, vtkDataObjectSource, vtkMPEG2Writer, vtkSource, vtkDataSetToDataSetFilter, vtkPointSetToPointSetFilter, vtkPolyDataToPolyDataFilter, vtkFFMPEGWriter, vtkImageSpatialFilter, vtkImageToImageFilter, vtkOggTheoraWriter, vtkAVIWriter, vtkDataSetToPolyDataFilter, vtkPolyDataSource, vtkSESAMEReader, vtkDataSetToUnstructuredGridFilter, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkGenericMovieWriter, vtkDataSetToStructuredPointsFilter, vtkImageSource, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridToPolyDataFilter, vtkDataSetToImageFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredPointsSource, vtkUnstructuredGridSource, vtkStructuredGridToStructuredGridFilter, vtkDataSetToStructuredGridFilter, vtkImageTwoInputFilter, vtkDataSetSource, vtkPointSetSource, and vtkUnstructuredGridToUnstructuredGridFilter.
Definition at line 54 of file vtkProcessObject.h.
|
protected |
Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.
|
protected |
Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.
|
virtual |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkPLOT3DReader, vtkSpatialRepresentationFilter, vtkDataObjectSource, vtkMPEG2Writer, vtkSource, vtkDataSetToDataSetFilter, vtkPointSetToPointSetFilter, vtkPolyDataToPolyDataFilter, vtkFFMPEGWriter, vtkImageSpatialFilter, vtkImageToImageFilter, vtkOggTheoraWriter, vtkAVIWriter, vtkDataSetToPolyDataFilter, vtkPolyDataSource, vtkSESAMEReader, vtkDataSetToUnstructuredGridFilter, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkGenericMovieWriter, vtkDataSetToStructuredPointsFilter, vtkImageSource, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridToPolyDataFilter, vtkDataSetToImageFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredPointsSource, vtkUnstructuredGridSource, vtkStructuredGridToStructuredGridFilter, vtkDataSetToStructuredGridFilter, vtkImageTwoInputFilter, vtkDataSetSource, vtkPointSetSource, and vtkUnstructuredGridToUnstructuredGridFilter.
|
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 vtkAlgorithm.
Reimplemented in vtkPLOT3DReader, vtkSpatialRepresentationFilter, vtkDataObjectSource, vtkMPEG2Writer, vtkSource, vtkDataSetToDataSetFilter, vtkPointSetToPointSetFilter, vtkPolyDataToPolyDataFilter, vtkFFMPEGWriter, vtkImageSpatialFilter, vtkImageToImageFilter, vtkOggTheoraWriter, vtkAVIWriter, vtkDataSetToPolyDataFilter, vtkPolyDataSource, vtkSESAMEReader, vtkDataSetToUnstructuredGridFilter, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkGenericMovieWriter, vtkDataSetToStructuredPointsFilter, vtkImageSource, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridToPolyDataFilter, vtkDataSetToImageFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredPointsSource, vtkUnstructuredGridSource, vtkStructuredGridToStructuredGridFilter, vtkDataSetToStructuredGridFilter, vtkImageTwoInputFilter, vtkDataSetSource, vtkPointSetSource, and vtkUnstructuredGridToUnstructuredGridFilter.
|
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 vtkAlgorithm.
Reimplemented in vtkPLOT3DReader, vtkSpatialRepresentationFilter, vtkDataObjectSource, vtkMPEG2Writer, vtkSource, vtkDataSetToDataSetFilter, vtkPointSetToPointSetFilter, vtkPolyDataToPolyDataFilter, vtkFFMPEGWriter, vtkImageSpatialFilter, vtkImageToImageFilter, vtkOggTheoraWriter, vtkAVIWriter, vtkDataSetToPolyDataFilter, vtkPolyDataSource, vtkSESAMEReader, vtkDataSetToUnstructuredGridFilter, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkGenericMovieWriter, vtkDataSetToStructuredPointsFilter, vtkImageSource, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridToPolyDataFilter, vtkDataSetToImageFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredPointsSource, vtkUnstructuredGridSource, vtkStructuredGridToStructuredGridFilter, vtkDataSetToStructuredGridFilter, vtkImageTwoInputFilter, vtkDataSetSource, vtkPointSetSource, and vtkUnstructuredGridToUnstructuredGridFilter.
|
static |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkPLOT3DReader, vtkSpatialRepresentationFilter, vtkDataObjectSource, vtkMPEG2Writer, vtkSource, vtkDataSetToDataSetFilter, vtkPointSetToPointSetFilter, vtkPolyDataToPolyDataFilter, vtkFFMPEGWriter, vtkImageSpatialFilter, vtkImageToImageFilter, vtkOggTheoraWriter, vtkAVIWriter, vtkDataSetToPolyDataFilter, vtkPolyDataSource, vtkSESAMEReader, vtkDataSetToUnstructuredGridFilter, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkGenericMovieWriter, vtkDataSetToStructuredPointsFilter, vtkImageSource, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridToPolyDataFilter, vtkDataSetToImageFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredPointsSource, vtkUnstructuredGridSource, vtkStructuredGridToStructuredGridFilter, vtkDataSetToStructuredGridFilter, vtkImageTwoInputFilter, vtkDataSetSource, vtkPointSetSource, and vtkUnstructuredGridToUnstructuredGridFilter.
|
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 vtkAlgorithm.
Reimplemented in vtkPLOT3DReader, vtkSpatialRepresentationFilter, vtkDataObjectSource, vtkMPEG2Writer, vtkSource, vtkDataSetToDataSetFilter, vtkPointSetToPointSetFilter, vtkPolyDataToPolyDataFilter, vtkFFMPEGWriter, vtkImageSpatialFilter, vtkImageToImageFilter, vtkOggTheoraWriter, vtkAVIWriter, vtkSESAMEReader, vtkDataSetToPolyDataFilter, vtkPolyDataSource, vtkDataSetToUnstructuredGridFilter, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkGenericMovieWriter, vtkDataSetToStructuredPointsFilter, vtkImageSource, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridToPolyDataFilter, vtkDataSetToImageFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredPointsSource, vtkUnstructuredGridSource, vtkStructuredGridToStructuredGridFilter, vtkDataSetToStructuredGridFilter, vtkImageTwoInputFilter, vtkDataSetSource, vtkPointSetSource, and vtkUnstructuredGridToUnstructuredGridFilter.
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.
Reimplemented from vtkAlgorithm.
|
inlinevirtual |
Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.
Reimplemented from vtkAlgorithm.
Definition at line 74 of file vtkProcessObject.h.
|
virtual |
Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.
Reimplemented from vtkAlgorithm.
|
virtual |
Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.
Reimplemented from vtkAlgorithm.
|
inlinevirtual |
Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.
Reimplemented from vtkAlgorithm.
Definition at line 78 of file vtkProcessObject.h.
|
virtual |
Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.
Reimplemented from vtkAlgorithm.
|
virtual |
Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.
Reimplemented from vtkAlgorithm.
|
virtual |
Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.
Reimplemented from vtkAlgorithm.
|
protected |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkSource, and vtkSpatialRepresentationFilter.
|
protectedvirtual |
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 vtkAlgorithm.
Reimplemented in vtkImageToImageFilter, vtkSpatialRepresentationFilter, vtkImageMultipleInputFilter, vtkDataSetToDataSetFilter, vtkPolyDataToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkDataSetToPolyDataFilter, vtkDataSetToStructuredPointsFilter, vtkUnstructuredGridToPolyDataFilter, vtkDataSetToImageFilter, vtkStructuredPointsToPolyDataFilter, vtkDataSetToUnstructuredGridFilter, vtkStructuredPointsToUnstructuredGridFilter, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridToPolyDataFilter, vtkStructuredGridToStructuredGridFilter, vtkDataSetToStructuredGridFilter, and vtkUnstructuredGridToUnstructuredGridFilter.
|
protectedvirtual |
Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkSource, vtkDataObjectSource, vtkImageSource, vtkPolyDataSource, vtkUnstructuredGridSource, vtkStructuredPointsSource, vtkRectilinearGridSource, vtkStructuredGridSource, vtkDataSetSource, and vtkPointSetSource.
|
protected |
|
protected |
|
protected |
|
protected |
Definition at line 91 of file vtkProcessObject.h.
|
protected |
Definition at line 92 of file vtkProcessObject.h.
|
protected |
Definition at line 93 of file vtkProcessObject.h.