#include <vtkDataObject.h>
Inheritance diagram for vtkDataObject:


vtkDataObject is an general representation of visualization data. It serves to encapsulate instance variables and methods for visualization network execution, as well as representing data consisting of a field (i.e., just an unstructured pile of data). This is to be compared with a vtkDataSet, which is data with geometric and/or topological structure.
vtkDataObjects are used to represent arbitrary repositories of data via the vtkFieldData instance variable. These data must be eventually mapped into a concrete subclass of vtkDataSet before they can actually be displayed.
Definition at line 68 of file vtkDataObject.h.
| typedef vtkObject vtkDataObject::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, and vtkImageStencilData.
Definition at line 73 of file vtkDataObject.h.
typedef vtkStreamingDemandDrivenPipeline vtkDataObject::SDDP [protected] |
Definition at line 529 of file vtkDataObject.h.
Possible values for the FIELD_ASSOCIATION information entry.
Definition at line 430 of file vtkDataObject.h.
Possible values for the FIELD_OPERATION information entry.
| FIELD_OPERATION_PRESERVED | |
| FIELD_OPERATION_REINTERPOLATED | |
| FIELD_OPERATION_MODIFIED | |
| FIELD_OPERATION_REMOVED |
Definition at line 447 of file vtkDataObject.h.
| vtkDataObject::vtkDataObject | ( | ) | [protected] |
| vtkDataObject::~vtkDataObject | ( | ) | [protected] |
| static vtkDataObject* vtkDataObject::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
Reimplemented in vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, and vtkImageStencilData.
| virtual const char* vtkDataObject::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, and vtkImageStencilData.
| static int vtkDataObject::IsTypeOf | ( | const char * | type | ) | [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, and vtkImageStencilData.
| virtual int vtkDataObject::IsA | ( | const char * | type | ) | [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, and vtkImageStencilData.
| static vtkDataObject* vtkDataObject::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, and vtkImageStencilData.
| void vtkDataObject::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [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 vtkObject.
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, and vtkImageStencilData.
| virtual vtkSource* vtkDataObject::GetSource | ( | ) | [virtual] |
Set/Get the source object creating this data object.
| void vtkDataObject::SetSource | ( | vtkSource * | s | ) |
Set/Get the source object creating this data object.
| virtual vtkInformation* vtkDataObject::GetInformation | ( | ) | [virtual] |
Set/Get the information object associated with this data object.
Referenced by boost::vertices().
| virtual void vtkDataObject::SetInformation | ( | vtkInformation * | ) | [virtual] |
Set/Get the information object associated with this data object.
| virtual vtkInformation* vtkDataObject::GetPipelineInformation | ( | ) | [virtual] |
Get/Set the pipeline information object that owns this data object.
| virtual void vtkDataObject::SetPipelineInformation | ( | vtkInformation * | ) | [virtual] |
Get/Set the pipeline information object that owns this data object.
| virtual vtkAlgorithmOutput* vtkDataObject::GetProducerPort | ( | ) | [virtual] |
Get the port currently producing this object.
Reimplemented in vtkCompositeDataSet.
| unsigned long int vtkDataObject::GetMTime | ( | ) | [virtual] |
Data objects are composite objects and need to check each part for MTime. The information object also needs to be considered.
Reimplemented from vtkObject.
Reimplemented in vtkDataSet, vtkGenericDataSet, vtkGraph, vtkPointSet, vtkSelection, and vtkBridgeDataSet.
| virtual void vtkDataObject::Initialize | ( | ) | [virtual] |
Restore data object to initial state,
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkGraph, vtkHyperOctree, vtkImageData, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkTable, vtkUniformGrid, vtkUnstructuredGrid, and vtkImageStencilData.
| void vtkDataObject::ReleaseData | ( | ) |
Release data back to system to conserve memory resource. Used during visualization network execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.
| int vtkDataObject::ShouldIReleaseData | ( | ) |
Return flag indicating whether data should be released after use by a filter.
| virtual int vtkDataObject::GetDataReleased | ( | ) | [virtual] |
Get the flag indicating the data has been released.
| void vtkDataObject::SetReleaseDataFlag | ( | int | ) |
Turn on/off flag to control whether this object's data is released after being used by a filter.
| int vtkDataObject::GetReleaseDataFlag | ( | ) |
Turn on/off flag to control whether this object's data is released after being used by a filter.
| virtual void vtkDataObject::ReleaseDataFlagOn | ( | ) | [virtual] |
Turn on/off flag to control whether this object's data is released after being used by a filter.
| virtual void vtkDataObject::ReleaseDataFlagOff | ( | ) | [virtual] |
Turn on/off flag to control whether this object's data is released after being used by a filter.
| static void vtkDataObject::SetGlobalReleaseDataFlag | ( | int | val | ) | [static] |
Turn on/off flag to control whether every object releases its data after being used by a filter.
| void vtkDataObject::GlobalReleaseDataFlagOn | ( | ) | [inline] |
Definition at line 131 of file vtkDataObject.h.
| void vtkDataObject::GlobalReleaseDataFlagOff | ( | ) | [inline] |
Definition at line 132 of file vtkDataObject.h.
| static int vtkDataObject::GetGlobalReleaseDataFlag | ( | ) | [static] |
| virtual void vtkDataObject::SetFieldData | ( | vtkFieldData * | ) | [virtual] |
Assign or retrieve field data to this data object.
Referenced by vtkSelection::SetSelectionData().
| virtual vtkFieldData* vtkDataObject::GetFieldData | ( | ) | [virtual] |
Assign or retrieve field data to this data object.
Referenced by vtkSelection::GetSelectionData().
| virtual void vtkDataObject::Register | ( | vtkObjectBase * | o | ) | [virtual] |
Increase the reference count (mark as used by another object).
Reimplemented from vtkObjectBase.
| virtual void vtkDataObject::UnRegister | ( | vtkObjectBase * | o | ) | [virtual] |
Decrease the reference count (release by another object). This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).
Reimplemented from vtkObjectBase.
| virtual void vtkDataObject::Update | ( | ) | [virtual] |
Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateInformation(), PropagateUpdateExtent(), TriggerAsynchronousUpdate(), and UpdateData().
| virtual void vtkDataObject::UpdateInformation | ( | ) | [virtual] |
WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Update all the "easy to update" information about the object such as the extent which will be used to control the update. This propagates all the way up then back down the pipeline. As a by-product the PipelineMTime is updated.
Reimplemented in vtkImageData.
| virtual void vtkDataObject::PropagateUpdateExtent | ( | ) | [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 void vtkDataObject::TriggerAsynchronousUpdate | ( | ) | [virtual] |
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.
| virtual void vtkDataObject::UpdateData | ( | ) | [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.
| virtual unsigned long vtkDataObject::GetEstimatedMemorySize | ( | ) | [virtual] |
Get the estimated size of this data object itself. Should be called after UpdateInformation() and PropagateUpdateExtent() have both been called. Should be overridden in a subclass - otherwise the default is to assume that this data object requires no memory. The size is returned in kilobytes.
Reimplemented in vtkImageData.
| virtual void vtkDataObject::SetUpdateExtent | ( | int | piece, | |
| int | numPieces, | |||
| int | ghostLevel | |||
| ) | [virtual] |
A generic way of specifying an update extent. Subclasses must decide what a piece is. When the NumberOfPieces is zero, then no data is requested, and the source will not execute.
| void vtkDataObject::SetUpdateExtent | ( | int | piece, | |
| int | numPieces | |||
| ) | [inline] |
A generic way of specifying an update extent. Subclasses must decide what a piece is. When the NumberOfPieces is zero, then no data is requested, and the source will not execute.
Definition at line 193 of file vtkDataObject.h.
| virtual void vtkDataObject::SetUpdateExtent | ( | int | x0, | |
| int | x1, | |||
| int | y0, | |||
| int | y1, | |||
| int | z0, | |||
| int | z1 | |||
| ) | [virtual] |
Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
| virtual void vtkDataObject::SetUpdateExtent | ( | int | extent[6] | ) | [virtual] |
Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
| virtual int* vtkDataObject::GetUpdateExtent | ( | ) | [virtual] |
Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
Reimplemented in vtkPolyData, and vtkUnstructuredGrid.
| virtual void vtkDataObject::GetUpdateExtent | ( | int & | x0, | |
| int & | x1, | |||
| int & | y0, | |||
| int & | y1, | |||
| int & | z0, | |||
| int & | z1 | |||
| ) | [virtual] |
Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
Reimplemented in vtkPolyData, and vtkUnstructuredGrid.
| virtual void vtkDataObject::GetUpdateExtent | ( | int | extent[6] | ) | [virtual] |
Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
Reimplemented in vtkPolyData, and vtkUnstructuredGrid.
| virtual int vtkDataObject::GetDataObjectType | ( | ) | [inline, virtual] |
Return class name of data type. This is one of VTK_STRUCTURED_GRID, VTK_STRUCTURED_POINTS, VTK_UNSTRUCTURED_GRID, VTK_POLY_DATA, or VTK_RECTILINEAR_GRID (see vtkSetGet.h for definitions). THIS METHOD IS THREAD SAFE
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkPiecewiseFunction, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, and vtkImageStencilData.
Definition at line 217 of file vtkDataObject.h.
References VTK_DATA_OBJECT.
| unsigned long vtkDataObject::GetUpdateTime | ( | ) |
Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).
| void vtkDataObject::SetUpdateExtentToWholeExtent | ( | ) |
If the whole input extent is required to generate the requested output extent, this method can be called to set the input update extent to the whole input extent. This method assumes that the whole extent is known (that UpdateInformation has been called)
| unsigned long vtkDataObject::GetPipelineMTime | ( | ) |
Get the cumulative modified time of everything upstream. Does not include the MTime of this object.
| virtual unsigned long vtkDataObject::GetActualMemorySize | ( | ) | [virtual] |
Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value).
Reimplemented in vtkDataSet, vtkGenericDataSet, vtkHyperOctree, vtkImageData, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkTable, and vtkUnstructuredGrid.
| void vtkDataObject::CopyInformation | ( | vtkDataObject * | data | ) |
Copy the generic information (WholeExtent ...)
| virtual void vtkDataObject::CopyTypeSpecificInformation | ( | vtkDataObje |