ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkSource Class Reference

vtkSource - abstract class specifies interface for visualization network source More...

Inheritance diagram for Kitware.VTK.vtkSource:
[legend]
Collaboration diagram for Kitware.VTK.vtkSource:
[legend]

List of all members.

Public Member Functions

 vtkSource (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual void ComputeInputUpdateExtents (vtkDataObject output)
 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.
virtual int GetNumberOfOutputs ()
 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 GetOutputIndex (vtkDataObject arg0)
 Return what index output the passed in output is, return -1 if it does not match any of the outputs.
override int GetReleaseDataFlag ()
 Turn on/off flag to control whether this object's data is released after being used by a source.
override int IsA (string type)
 Undocumented Block.
new vtkSource NewInstance ()
 Undocumented Block.
virtual void PropagateUpdateExtent (vtkDataObject output)
 WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. The update extent for this object is propagated up the pipeline. This propagation may early terminate based on the PipelineMTime.
virtual new void ReleaseDataFlagOff ()
 Turn on/off flag to control whether this object's data is released after being used by a source.
virtual new void ReleaseDataFlagOn ()
 Turn on/off flag to control whether this object's data is released after being used by a source.
override void SetExecutive (vtkExecutive executive)
 Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.
override void SetReleaseDataFlag (int arg0)
 Turn on/off flag to control whether this object's data is released after being used by a source.
virtual void TriggerAsynchronousUpdate ()
 WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Propagate back up the pipeline for ports and trigger the update on the other side of the port to allow for asynchronous parallel processing in the pipeline. This propagation may early terminate based on the PipelineMTime.
void UnRegisterAllOutputs ()
 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.
override void Update ()
 Bring object up-to-date before execution. Update() checks modified time against last execution time, and re-executes object if necessary.
virtual void UpdateData (vtkDataObject output)
 WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Propagate the update back up the pipeline, and perform the actual work of updating on the way down. When the propagate arrives at a port, block and wait for the asynchronous update to finish on the other side. This propagation may early terminate based on the PipelineMTime.
override void UpdateInformation ()
 Updates any global information about the data (like spacing for images)
override void UpdateWholeExtent ()
 Like update, but make sure the update extent is the whole extent in the output.

Static Public Member Functions

static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkSource SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkSource"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "9vtkSource"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal void vtkSource_ComputeInputUpdateExtents_01 (HandleRef pThis, HandleRef output)
static internal int vtkSource_GetNumberOfOutputs_02 (HandleRef pThis)
static internal int vtkSource_GetOutputIndex_03 (HandleRef pThis, HandleRef arg0)
static internal int vtkSource_GetReleaseDataFlag_04 (HandleRef pThis)
static internal int vtkSource_IsA_05 (HandleRef pThis, string type)
static internal int vtkSource_IsTypeOf_06 (string type)
static internal IntPtr vtkSource_NewInstance_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSource_PropagateUpdateExtent_08 (HandleRef pThis, HandleRef output)
static internal void vtkSource_ReleaseDataFlagOff_09 (HandleRef pThis)
static internal void vtkSource_ReleaseDataFlagOn_10 (HandleRef pThis)
static internal IntPtr vtkSource_SafeDownCast_11 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSource_SetExecutive_12 (HandleRef pThis, HandleRef executive)
static internal void vtkSource_SetReleaseDataFlag_13 (HandleRef pThis, int arg0)
static internal void vtkSource_TriggerAsynchronousUpdate_14 (HandleRef pThis)
static internal void vtkSource_UnRegisterAllOutputs_15 (HandleRef pThis)
static internal void vtkSource_Update_16 (HandleRef pThis)
static internal void vtkSource_UpdateData_17 (HandleRef pThis, HandleRef output)
static internal void vtkSource_UpdateInformation_18 (HandleRef pThis)
static internal void vtkSource_UpdateWholeExtent_19 (HandleRef pThis)

Static Private Member Functions

static vtkSource ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSource - abstract class specifies interface for visualization network source

Description 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).


Constructor & Destructor Documentation

static Kitware.VTK.vtkSource.vtkSource ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkSource.vtkSource ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.


Member Function Documentation

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 Kitware.VTK.vtkPointSetToPointSetFilter, Kitware.VTK.vtkDataSetToDataSetFilter, Kitware.VTK.vtkUnstructuredGridToPolyDataFilter, and Kitware.VTK.vtkDataSetToPolyDataFilter.

override void Kitware.VTK.vtkSource.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkProcessObject.

Reimplemented in Kitware.VTK.vtkPLOT3DReader, Kitware.VTK.vtkSpatialRepresentationFilter, Kitware.VTK.vtkImageSpatialFilter, Kitware.VTK.vtkSESAMEReader, Kitware.VTK.vtkPointSetToPointSetFilter, Kitware.VTK.vtkDataSetToDataSetFilter, Kitware.VTK.vtkImageToImageFilter, Kitware.VTK.vtkPolyDataToPolyDataFilter, Kitware.VTK.vtkImageTwoInputFilter, Kitware.VTK.vtkDataSetToStructuredGridFilter, Kitware.VTK.vtkDataSetToStructuredPointsFilter, Kitware.VTK.vtkDataSetToUnstructuredGridFilter, Kitware.VTK.vtkImageSource, Kitware.VTK.vtkStructuredGridToStructuredGridFilter, Kitware.VTK.vtkStructuredPointsToPolyDataFilter, Kitware.VTK.vtkStructuredPointsToStructuredPointsFilter, Kitware.VTK.vtkStructuredPointsToUnstructuredGridFilter, Kitware.VTK.vtkUnstructuredGridToPolyDataFilter, Kitware.VTK.vtkDataSetToImageFilter, Kitware.VTK.vtkDataSetToPolyDataFilter, Kitware.VTK.vtkImageMultipleInputFilter, Kitware.VTK.vtkImageMultipleInputOutputFilter, Kitware.VTK.vtkPolyDataSource, Kitware.VTK.vtkRectilinearGridSource, Kitware.VTK.vtkRectilinearGridToPolyDataFilter, Kitware.VTK.vtkStructuredGridSource, Kitware.VTK.vtkStructuredGridToPolyDataFilter, Kitware.VTK.vtkStructuredPointsSource, Kitware.VTK.vtkUnstructuredGridSource, Kitware.VTK.vtkDataSetSource, Kitware.VTK.vtkPointSetSource, Kitware.VTK.vtkUnstructuredGridToUnstructuredGridFilter, and Kitware.VTK.vtkDataObjectSource.

virtual int Kitware.VTK.vtkSource.GetNumberOfOutputs ( ) [virtual]

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

Reimplemented in Kitware.VTK.vtkPLOT3DReader.

Return what index output the passed in output is, return -1 if it does not match any of the outputs.

override int Kitware.VTK.vtkSource.GetReleaseDataFlag ( ) [virtual]

Turn on/off flag to control whether this object's data is released after being used by a source.

Reimplemented from Kitware.VTK.vtkAlgorithm.

override int Kitware.VTK.vtkSource.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkSource.IsTypeOf ( string  type) [static]
virtual void Kitware.VTK.vtkSource.PropagateUpdateExtent ( vtkDataObject  output) [virtual]

WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. The update extent for this object is propagated up the pipeline. This propagation may early terminate based on the PipelineMTime.

virtual new void Kitware.VTK.vtkSource.ReleaseDataFlagOff ( ) [virtual]

Turn on/off flag to control whether this object's data is released after being used by a source.

Reimplemented from Kitware.VTK.vtkAlgorithm.

virtual new void Kitware.VTK.vtkSource.ReleaseDataFlagOn ( ) [virtual]

Turn on/off flag to control whether this object's data is released after being used by a source.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkProcessObject.

Reimplemented in Kitware.VTK.vtkPLOT3DReader, Kitware.VTK.vtkDataSetToDataSetFilter, Kitware.VTK.vtkSpatialRepresentationFilter, Kitware.VTK.vtkPointSetToPointSetFilter, Kitware.VTK.vtkSESAMEReader, Kitware.VTK.vtkImageMultipleInputFilter, Kitware.VTK.vtkImageSpatialFilter, Kitware.VTK.vtkImageToImageFilter, Kitware.VTK.vtkImageTwoInputFilter, Kitware.VTK.vtkImageSource, Kitware.VTK.vtkImageMultipleInputOutputFilter, Kitware.VTK.vtkPolyDataSource, Kitware.VTK.vtkRectilinearGridSource, Kitware.VTK.vtkStructuredGridSource, Kitware.VTK.vtkStructuredPointsSource, Kitware.VTK.vtkUnstructuredGridSource, Kitware.VTK.vtkDataSetSource, Kitware.VTK.vtkPointSetSource, Kitware.VTK.vtkDataObjectSource, Kitware.VTK.vtkUnstructuredGridToPolyDataFilter, Kitware.VTK.vtkDataSetToPolyDataFilter, Kitware.VTK.vtkUnstructuredGridToUnstructuredGridFilter, Kitware.VTK.vtkPolyDataToPolyDataFilter, Kitware.VTK.vtkDataSetToStructuredGridFilter, Kitware.VTK.vtkDataSetToStructuredPointsFilter, Kitware.VTK.vtkDataSetToUnstructuredGridFilter, Kitware.VTK.vtkStructuredGridToStructuredGridFilter, Kitware.VTK.vtkStructuredPointsToPolyDataFilter, Kitware.VTK.vtkStructuredPointsToStructuredPointsFilter, Kitware.VTK.vtkStructuredPointsToUnstructuredGridFilter, Kitware.VTK.vtkDataSetToImageFilter, Kitware.VTK.vtkRectilinearGridToPolyDataFilter, and Kitware.VTK.vtkStructuredGridToPolyDataFilter.

Here is the call graph for this function:

override void Kitware.VTK.vtkSource.SetExecutive ( vtkExecutive  executive) [virtual]

Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.

Reimplemented from Kitware.VTK.vtkAlgorithm.

override void Kitware.VTK.vtkSource.SetReleaseDataFlag ( int  arg0) [virtual]

Turn on/off flag to control whether this object's data is released after being used by a source.

Reimplemented from Kitware.VTK.vtkAlgorithm.

WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Propagate back up the pipeline for ports and trigger the update on the other side of the port to allow for asynchronous parallel processing in the pipeline. This propagation may early terminate based on the PipelineMTime.

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.

override void Kitware.VTK.vtkSource.Update ( ) [virtual]

Bring object up-to-date before execution. Update() checks modified time against last execution time, and re-executes object if necessary.

Reimplemented from Kitware.VTK.vtkAlgorithm.

virtual void Kitware.VTK.vtkSource.UpdateData ( vtkDataObject  output) [virtual]

WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Propagate the update back up the pipeline, and perform the actual work of updating on the way down. When the propagate arrives at a port, block and wait for the asynchronous update to finish on the other side. This propagation may early terminate based on the PipelineMTime.

override void Kitware.VTK.vtkSource.UpdateInformation ( ) [virtual]

Updates any global information about the data (like spacing for images)

Reimplemented from Kitware.VTK.vtkAlgorithm.

override void Kitware.VTK.vtkSource.UpdateWholeExtent ( ) [virtual]

Like update, but make sure the update extent is the whole extent in the output.

Reimplemented from Kitware.VTK.vtkAlgorithm.

static internal void Kitware.VTK.vtkSource.vtkSource_ComputeInputUpdateExtents_01 ( HandleRef  pThis,
HandleRef  output 
) [private]
static internal int Kitware.VTK.vtkSource.vtkSource_GetNumberOfOutputs_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSource.vtkSource_GetOutputIndex_03 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkSource.vtkSource_GetReleaseDataFlag_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSource.vtkSource_IsA_05 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkSource.vtkSource_IsTypeOf_06 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSource.vtkSource_NewInstance_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_PropagateUpdateExtent_08 ( HandleRef  pThis,
HandleRef  output 
) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_ReleaseDataFlagOff_09 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_ReleaseDataFlagOn_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSource.vtkSource_SafeDownCast_11 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_SetExecutive_12 ( HandleRef  pThis,
HandleRef  executive 
) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_SetReleaseDataFlag_13 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_TriggerAsynchronousUpdate_14 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_UnRegisterAllOutputs_15 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_Update_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_UpdateData_17 ( HandleRef  pThis,
HandleRef  output 
) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_UpdateInformation_18 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSource.vtkSource_UpdateWholeExtent_19 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSource.MRClassNameKey = "9vtkSource" [static]
new const string Kitware.VTK.vtkSource.MRFullTypeName = "Kitware.VTK.vtkSource"

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