#include <vtkSource.h>
Inheritance diagram for vtkSource:
Public Methods | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual void | Update () |
virtual void | UpdateWholeExtent () |
virtual void | UpdateInformation () |
virtual void | PropagateUpdateExtent (vtkDataObject *output) |
virtual void | TriggerAsynchronousUpdate () |
virtual void | UpdateData (vtkDataObject *output) |
void | ComputeEstimatedPipelineMemorySize (vtkDataObject *output, unsigned long size[3]) |
virtual void | ComputeEstimatedOutputMemorySize (vtkDataObject *output, unsigned long *inputSize, unsigned long size[2]) |
virtual void | EnlargeOutputUpdateExtents (vtkDataObject *vtkNotUsed(output)) |
virtual void | ComputeInputUpdateExtents (vtkDataObject *output) |
virtual void | SetReleaseDataFlag (int) |
virtual int | GetReleaseDataFlag () |
virtual void | ReleaseDataFlagOn () |
virtual void | ReleaseDataFlagOff () |
void | UnRegister (vtkObject *o) |
virtual int | InRegisterLoop (vtkObject *) |
vtkDataObject ** | GetOutputs () |
virtual int | GetNumberOfOutputs () |
void | UnRegisterAllOutputs (void) |
Static Public Methods | |
vtkSource * | New () |
int | IsTypeOf (const char *type) |
vtkSource * | SafeDownCast (vtkObject *o) |
Protected Methods | |
vtkSource () | |
~vtkSource () | |
vtkSource (const vtkSource &) | |
void | operator= (const vtkSource &) |
virtual void | Execute () |
virtual void | ExecuteInformation () |
void | SetNumberOfOutputs (int num) |
vtkDataObject * | GetOutput (int idx) |
virtual void | SetNthOutput (int num, vtkDataObject *output) |
virtual void | AddOutput (vtkDataObject *output) |
virtual void | RemoveOutput (vtkDataObject *output) |
Protected Attributes | |
vtkDataObject ** | Outputs |
int | NumberOfOutputs |
int | Updating |
vtkTimeStamp | InformationTime |
vtkSource is an abstract object that specifies behavior and interface of source objects. Source objects are objects that begin visualization pipeline. Sources include readers (read data from file or communications port) and procedural sources (generate data programmatically). vtkSource objects are also objects that generate output data. In this sense vtkSource is used as a superclass to vtkFilter.
Concrete subclasses of vtkSource must define Update() and Execute() methods. The public method Update() invokes network execution and will bring the network up-to-date. The protected Execute() method actually does the work of data creation/generation. The difference between the two methods is that Update() implements input consistency checks and modified time comparisons and then invokes the Execute() which is an implementation of a particular algorithm.
An important feature of subclasses of vtkSource 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).
|
The estimated size of the specified output after execution of this source is stored in the first size entry. The second size is the sum of all estimated output memory. The size of all inputs is given to help this filter in the estimation. All sizes are in kilobytes. |
|
Propagate the computation of the size of the pipeline. The first size is the size of the pipeline after this source has finished executing (and potentially freeing some input data). The second size is the size of the specified output. The third size is the maximum pipeline size encountered so far during this propagation. All sizes are in kilobytes. |
|
What is the input update extent that is required to produce the desired output? By default, the whole input is always required but this is overridden in many subclasses. Reimplemented in vtkImageToStructuredPoints. |
|
Give the source a chance to say that it will produce more output than it was asked to produce. For example, FFT always produces the whole thing, and many imaging filters must produce the output in whole slices (whole extent in two dimensions). By default we do not modify the output update extent. |
|
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 vtkProcessObject. Reimplemented in vtkImageSource. |
|
Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc. |
|
Test to see if this object is in a reference counting loop. Reimplemented in vtkSelectPolyData. |
|
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 vtkProcessObject. Reimplemented in vtkImageSource. |
|
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 vtkProcessObject. Reimplemented in vtkImageSource. |
|
Instantiate object with no start, end, or progress methods. Reimplemented from vtkProcessObject. 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 vtkProcessObject. Reimplemented in vtkImageToStructuredPoints. |
|
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 vtkProcessObject. Reimplemented in vtkImageSource. |
|
Turn on/off flag to control whether this object's data is released after being used by a source. |
|
Handle the source/data loop. Reimplemented from vtkObject. Reimplemented in vtkSelectPolyData. |
|
Release/disconnect all outputs of this source. This is intended to be called prior to Delete() if the user is concerned about outputs holding on to the filter/source. |
|
Bring object up-to-date before execution. Update() checks modified time against last execution time, and re-executes object if necessary. Reimplemented in vtkChairDisplay. |
|
Updates any global information about the data (like spacing for images) Reimplemented in vtkAsynchronousBuffer. |
|
Like update, but make sure the update extent is the whole extent in the output. |