vtkDataObject Class Reference

#include <vtkDataObject.h>

Inheritance diagram for vtkDataObject:

[legend]Collaboration diagram for vtkDataObject:

[legend]List of all members.

Detailed Description

general representation of visualization data

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.

See also:: vtkDataSet vtkFieldData vtkDataObjectSource vtkDataObjectFilter vtkDataObjectMapper vtkDataObjectToDataSet vtkFieldDataToAttributeDataFilter

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (60%)
Martin, Ken (39%)

CVS logs (CVSweb):

.h (/Filtering/vtkDataObject.h)
.cxx (/Filtering/vtkDataObject.cxx)

Member Typedef Documentation

typedef vtkObject vtkDataObject::Superclass

Reimplemented from vtkObject.
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkGenericDataSet, vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, vtkImageData, vtkMultiBlockDataSet, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUniformGrid, vtkUnstructuredGrid, vtkImageCanvasSource2D, and vtkImageStencilData.
Definition at line 73 of file vtkDataObject.h.

typedef vtkStreamingDemandDrivenPipeline vtkDataObject::SDDP [protected]

Definition at line 431 of file vtkDataObject.h.

Member Enumeration Documentation

enum vtkDataObject::FieldAssociations

Possible values for the FIELD_ASSOCIATION information entry.
Enumeration values:

FIELD_ASSOCIATION_POINTS

FIELD_ASSOCIATION_CELLS

FIELD_ASSOCIATION_NONE

Definition at line 349 of file vtkDataObject.h.

enum vtkDataObject::FieldOperations

Possible values for the FIELD_OPERATION information entry.
Enumeration values:

FIELD_OPERATION_PRESERVED

FIELD_OPERATION_REINTERPOLATED

FIELD_OPERATION_MODIFIED

FIELD_OPERATION_REMOVED

Definition at line 361 of file vtkDataObject.h.

Constructor & Destructor Documentation

vtkDataObject::vtkDataObject ( ) [protected]

vtkDataObject::~vtkDataObject ( ) [protected]

Member Function Documentation

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 vtkHierarchicalBoxDataSet, vtkImageData, vtkMultiBlockDataSet, vtkPiecewiseFunction, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUniformGrid, vtkUnstructuredGrid, vtkImageCanvasSource2D, and vtkImageStencilData.

virtual const char* vtkDataObject::GetClassName ( ) [virtual]

Reimplemented from vtkObject.
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkGenericDataSet, vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, vtkImageData, vtkMultiBlockDataSet, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUniformGrid, vtkUnstructuredGrid, vtkImageCanvasSource2D, and vtkImageStencilData.

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, vtkGenericDataSet, vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, vtkImageData, vtkMultiBlockDataSet, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUniformGrid, vtkUnstructuredGrid, vtkImageCanvasSource2D, 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, vtkGenericDataSet, vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, vtkImageData, vtkMultiBlockDataSet, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUniformGrid, vtkUnstructuredGrid, vtkImageCanvasSource2D, and vtkImageStencilData.

vtkDataObject* vtkDataObject::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkGenericDataSet, vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, vtkImageData, vtkMultiBlockDataSet, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUniformGrid, vtkUnstructuredGrid, vtkImageCanvasSource2D, 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, vtkGenericDataSet, vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, vtkImageData, vtkMultiBlockDataSet, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkUniformGrid, vtkUnstructuredGrid, vtkImageCanvasSource2D, 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.

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.

vtkAlgorithmOutput* vtkDataObject::GetProducerPort ( )

Get the port currently producing this object.

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, vtkPiecewiseFunction, and vtkPointSet.

virtual void vtkDataObject::Initialize ( ) [virtual]

Restore data object to initial state,
Reimplemented in vtkCompositeDataSet, vtkDataSet, vtkHierarchicalDataSet, vtkImageData, vtkMultiBlockDataSet, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, 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.

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.

int vtkDataObject::GetGlobalReleaseDataFlag ( ) [static]

virtual void vtkDataObject::SetFieldData ( vtkFieldData * ) [virtual]

Assign or retrieve field data to this data object.

virtual vtkFieldData* vtkDataObject::GetFieldData ( ) [virtual]

Assign or retrieve field data to this data object.

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 vtkObject.

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.

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.
Reimplemented in vtkImageStencilData.

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.
Reimplemented in vtkImageStencilData.

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.
Reimplemented in vtkImageStencilData.

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 vtkNotUsed(piece),

int vtkNotUsed(numPieces),

int vtkNotUsed(ghostLevel)

) [inline, 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.
Definition at line 191 of file vtkDataObject.h.
Referenced by vtkUnstructuredGrid::SetUpdateExtent(), vtkUniformGrid::SetUpdateExtent(), vtkStructuredGrid::SetUpdateExtent(), vtkRectilinearGrid::SetUpdateExtent(), vtkPolyData::SetUpdateExtent(), vtkImageData::SetUpdateExtent(), and vtkCompositeDataSet::SetUpdateExtent().

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.
Reimplemented in vtkCompositeDataSet, vtkImageData, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkUniformGrid, and vtkUnstructuredGrid.
Definition at line 194 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.
Reimplemented in vtkCompositeDataSet, vtkGenericDataSet, vtkImageData, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkUniformGrid, and vtkUnstructuredGrid.

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.
Reimplemented in vtkCompositeDataSet, vtkGenericDataSet, vtkImageData, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkUniformGrid, and vtkUnstructuredGrid.

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 vtkCompositeDataSet, 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 vtkCompositeDataSet, 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 vtkCompositeDataSet, 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, vtkGenericDataSet, vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, vtkImageData, vtkMultiBlockDataSet, vtkPiecewiseFunction, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkStructuredPoints, vtkUniformGrid, vtkUnstructuredGrid, and vtkImageStencilData.
Definition at line 218 of file vtkDataObject.h.

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, vtkImageData, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkUniformGrid, and vtkUnstructuredGrid.

void vtkDataObject::CopyInformation ( vtkDataObject * data )

Copy the generic information (WholeExtent ...)

virtual void vtkDataObject::CopyTypeSpecificInformation ( vtkDataObject * data ) [inline, virtual]

By default, there is no type specific information
Reimplemented in vtkImageData.
Definition at line 246 of file vtkDataObject.h.

void vtkDataObject::SetUpdatePiece ( int piece )

Set / Get the update piece and the update number of pieces. Similar to update extent in 3D.

void vtkDataObject::SetUpdateNumberOfPieces ( int num )

Set / Get the update piece and the update number of pieces. Similar to update extent in 3D.

virtual int vtkDataObject::GetUpdatePiece ( ) [virtual]

Set / Get the update piece and the update number of pieces. Similar to update extent in 3D.

virtual int vtkDataObject::GetUpdateNumberOfPieces ( ) [virtual]

Set / Get the update piece and the update number of pieces. Similar to update extent in 3D.

void vtkDataObject::SetUpdateGhostLevel ( int level )

Set / Get the update ghost level and the update number of ghost levels. Similar to update extent in 3D.

virtual int vtkDataObject::GetUpdateGhostLevel ( ) [virtual]

Set / Get the update ghost level and the update number of ghost levels. Similar to update extent in 3D.

virtual void vtkDataObject::SetRequestExactExtent ( int flag ) [virtual]

This request flag indicates whether the requester can handle more data than requested. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.

virtual int vtkDataObject::GetRequestExactExtent ( ) [virtual]

This request flag indicates whether the requester can handle more data than requested. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.

virtual void vtkDataObject::RequestExactExtentOn ( ) [virtual]

This request flag indicates whether the requester can handle more data than requested. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.

virtual void vtkDataObject::RequestExactExtentOff ( ) [virtual]

This request flag indicates whether the requester can handle more data than requested. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.

virtual void vtkDataObject::SetWholeExtent ( int x0,

int x1,

int y0,

int y1,

int z0,

int z1

) [virtual]

Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.

virtual void vtkDataObject::SetWholeExtent ( int extent[6] ) [virtual]

Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.

virtual int* vtkDataObject::GetWholeExtent ( ) [virtual]

Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.

virtual void vtkDataObject::GetWholeExtent ( int & x0,

int & x1,

int & y0,

int & y1,

int & z0,

int & z1

) [virtual]

Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.

virtual void vtkDataObject::GetWholeExtent ( int extent[6] ) [virtual]

Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.

virtual void vtkDataObject::SetWholeBoundingBox ( double x0,

double x1,

double y0,

double y1,

double z0,

double z1

) [virtual]

Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.

virtual void vtkDataObject::SetWholeBoundingBox ( double bb[6] ) [virtual]

Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.

virtual double* vtkDataObject::GetWholeBoundingBox ( ) [virtual]

Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.

virtual void vtkDataObject::GetWholeBoundingBox ( double & x0,

double & x1,

double & y0,

double & y1,

double & z0,

double & z1

) [virtual]

Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.

virtual void vtkDataObject::GetWholeBoundingBox ( double extent[6] ) [virtual]

Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.

virtual void vtkDataObject::SetMaximumNumberOfPieces ( int ) [virtual]

Set/Get the maximum number of pieces that can be requested. The maximum number of pieces is meta data for unstructured data sets. It gets set by the source during the update information call. A value of -1 indicates that there is no maximum. A value of

virtual int vtkDataObject::GetMaximumNumberOfPieces ( ) [virtual]

Set/Get the maximum number of pieces that can be requested. The maximum number of pieces is meta data for unstructured data sets. It gets set by the source during the update information call. A value of -1 indicates that there is no maximum. A value of

void vtkDataObject::DataHasBeenGenerated ( )

This method is called by the source when it executes to generate data. It is sort of the opposite of ReleaseData. It sets the DataReleased flag to 0, and sets a new UpdateTime.

virtual void vtkDataObject::PrepareForNewData ( ) [inline, virtual]

make the output data ready for new data to be inserted. For most objects we just call Initialize. But for vtkImageData we leave the old data in case the memory can be reused.
Reimplemented in vtkImageData.
Definition at line 319 of file vtkDataObject.h.

virtual void vtkDataObject::ShallowCopy ( vtkDataObject * src ) [virtual]

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.
Reimplemented in vtkDataSet, vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, vtkImageData, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkUniformGrid, vtkUnstructuredGrid, and vtkImageStencilData.

virtual void vtkDataObject::DeepCopy ( vtkDataObject * src ) [virtual]

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.
Reimplemented in vtkDataSet, vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, vtkImageData, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkUniformGrid, vtkUnstructuredGrid, and vtkImageStencilData.

void vtkDataObject::SetExtentTranslator ( vtkExtentTranslator * translator )

An object that will translate pieces into structured extents.

vtkExtentTranslator* vtkDataObject::GetExtentTranslator ( )

An object that will translate pieces into structured extents.

virtual int vtkDataObject::GetExtentType ( ) [inline, virtual]

The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. The ExtentType will be changed to VTK_3D_EXTENT for data objects with 3D structure such as vtkImageData (and its subclass vtkStructuredPoints), vtkRectilinearGrid, and vtkStructuredGrid. The default is the have an extent in pieces, with only one piece (no streaming possible).
Reimplemented in vtkImageData, vtkRectilinearGrid, vtkStructuredGrid, vtkUniformGrid, and vtkImageStencilData.
Definition at line 340 of file vtkDataObject.h.

virtual void vtkDataObject::Crop ( ) [virtual]

This method crops the data object (if necesary) so that the extent matches the update extent.
Reimplemented in vtkImageData, vtkPolyData, vtkRectilinearGrid, and vtkStructuredGrid.

vtkInformationStringKey* vtkDataObject::DATA_TYPE_NAME ( ) [static]

vtkInformationDataObjectKey* vtkDataObject::DATA_OBJECT ( ) [static]

vtkInformationIntegerKey* vtkDataObject::DATA_EXTENT_TYPE ( ) [static]

vtkInformationIntegerVectorKey* vtkDataObject::DATA_EXTENT ( ) [static]

vtkInformationIntegerKey* vtkDataObject::DATA_PIECE_NUMBER ( ) [static]

vtkInformationIntegerKey* vtkDataObject::DATA_NUMBER_OF_PIECES ( ) [static]

vtkInformationIntegerKey* vtkDataObject::DATA_NUMBER_OF_GHOST_LEVELS ( ) [static]

vtkInformationIntegerKey* vtkDataObject::SCALAR_TYPE ( ) [static]

vtkInformationIntegerKey* vtkDataObject::SCALAR_NUMBER_OF_COMPONENTS ( ) [static]

vtkInformationIntegerKey* vtkDataObject::FIELD_ARRAY_TYPE ( ) [static]

vtkInformationIntegerKey* vtkDataObject::FIELD_ASSOCIATION ( ) [static]

vtkInformationIntegerKey* vtkDataObject::FIELD_ATTRIBUTE_TYPE ( ) [static]

vtkInformationIntegerKey* vtkDataObject::FIELD_NUMBER_OF_COMPONENTS ( ) [static]

vtkInformationIntegerKey* vtkDataObject::FIELD_NUMBER_OF_TUPLES ( ) [static]

vtkInformationIntegerKey* vtkDataObject::FIELD_OPERATION ( ) [static]

vtkInformationStringKey* vtkDataObject::FIELD_NAME ( ) [static]

vtkInformationDoubleVectorKey* vtkDataObject::ORIGIN ( ) [static]

vtkInformationDoubleVectorKey* vtkDataObject::SPACING ( ) [static]

virtual void vtkDataObject::CopyPipelineInformation ( vtkInformation * oldPInfo,

vtkInformation * newPInfo

) [protected, virtual]

Reimplemented in vtkImageData.

vtkExecutive* vtkDataObject::GetExecutive ( ) [protected]

int vtkDataObject::GetPortNumber ( ) [protected]

virtual void vtkDataObject::ReportReferences ( vtkGarbageCollector * ) [protected, virtual]

Reimplemented from vtkObjectBase.
Reimplemented in vtkPointSet.

virtual void vtkDataObject::RemoveReferences ( ) [protected, virtual]

Reimplemented from vtkObjectBase.
Reimplemented in vtkPointSet.

virtual void vtkDataObject::GarbageCollectionStarting ( ) [protected, virtual]

Reimplemented from vtkObjectBase.

vtkStreamingDemandDrivenPipeline* vtkDataObject::TrySDDP ( const char * method ) [protected]

Member Data Documentation

vtkFieldData* vtkDataObject::FieldData [protected]

Definition at line 396 of file vtkDataObject.h.

vtkSource* vtkDataObject::Source [protected]

Definition at line 399 of file vtkDataObject.h.

int vtkDataObject::DataReleased [protected]

Definition at line 402 of file vtkDataObject.h.

vtkTimeStamp vtkDataObject::UpdateTime [protected]

Definition at line 408 of file vtkDataObject.h.

int vtkDataObject::GarbageCollecting [protected]

Definition at line 419 of file vtkDataObject.h.

vtkInformation* vtkDataObject::Information [protected]

Definition at line 422 of file vtkDataObject.h.

vtkInformation* vtkDataObject::PipelineInformation [protected]

Definition at line 426 of file vtkDataObject.h.

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

dox/Filtering/vtkDataObject.h


[NOHEADER]
void	GlobalReleaseDataFlagOn ()
void	GlobalReleaseDataFlagOff ()
void	SetGlobalReleaseDataFlag (int val)
int	GetGlobalReleaseDataFlag ()
Public Types
typedef vtkObject	Superclass

enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE }

enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkAlgorithmOutput *	GetProducerPort ()
unsigned long int	GetMTime ()
virtual void	Initialize ()
void	ReleaseData ()
int	ShouldIReleaseData ()
virtual void	UnRegister (vtkObjectBase *o)
virtual void	Update ()
virtual void	UpdateInformation ()
virtual void	PropagateUpdateExtent ()
virtual void	TriggerAsynchronousUpdate ()
virtual void	UpdateData ()
virtual unsigned long	GetEstimatedMemorySize ()
virtual int	GetDataObjectType ()
unsigned long	GetUpdateTime ()
void	SetUpdateExtentToWholeExtent ()
unsigned long	GetPipelineMTime ()
virtual unsigned long	GetActualMemorySize ()
void	CopyInformation (vtkDataObject *data)
void	DataHasBeenGenerated ()
virtual void	PrepareForNewData ()
virtual int	GetExtentType ()
virtual void	Crop ()

virtual vtkSource *	GetSource ()
void	SetSource (vtkSource *s)

virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)

virtual vtkInformation *	GetPipelineInformation ()
virtual void	SetPipelineInformation (vtkInformation *)

virtual int	GetDataReleased ()

void	SetReleaseDataFlag (int)
int	GetReleaseDataFlag ()
virtual void	ReleaseDataFlagOn ()
virtual void	ReleaseDataFlagOff ()

virtual void	SetFieldData (vtkFieldData *)
virtual vtkFieldData *	GetFieldData ()

virtual void	SetUpdateExtent (int vtkNotUsed(piece), int vtkNotUsed(numPieces), int vtkNotUsed(ghostLevel))
void	SetUpdateExtent (int piece, int numPieces)

virtual void	SetUpdateExtent (int x0, int x1, int y0, int y1, int z0, int z1)
virtual void	SetUpdateExtent (int extent[6])
virtual int *	GetUpdateExtent ()
virtual void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void	GetUpdateExtent (int extent[6])

virtual void	CopyTypeSpecificInformation (vtkDataObject *data)

void	SetUpdatePiece (int piece)
void	SetUpdateNumberOfPieces (int num)
virtual int	GetUpdatePiece ()
virtual int	GetUpdateNumberOfPieces ()

void	SetUpdateGhostLevel (int level)
virtual int	GetUpdateGhostLevel ()

virtual void	SetRequestExactExtent (int flag)
virtual int	GetRequestExactExtent ()
virtual void	RequestExactExtentOn ()
virtual void	RequestExactExtentOff ()

virtual void	SetWholeExtent (int x0, int x1, int y0, int y1, int z0, int z1)
virtual void	SetWholeExtent (int extent[6])
virtual int *	GetWholeExtent ()
virtual void	GetWholeExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void	GetWholeExtent (int extent[6])

virtual void	SetWholeBoundingBox (double x0, double x1, double y0, double y1, double z0, double z1)
virtual void	SetWholeBoundingBox (double bb[6])
virtual double *	GetWholeBoundingBox ()
virtual void	GetWholeBoundingBox (double &x0, double &x1, double &y0, double &y1, double &z0, double &z1)
virtual void	GetWholeBoundingBox (double extent[6])

virtual void	SetMaximumNumberOfPieces (int)
virtual int	GetMaximumNumberOfPieces ()

virtual void	ShallowCopy (vtkDataObject *src)
virtual void	DeepCopy (vtkDataObject *src)

void	SetExtentTranslator (vtkExtentTranslator *translator)
vtkExtentTranslator *	GetExtentTranslator ()
Static Public Member Functions
vtkDataObject *	New ()
int	IsTypeOf (const char *type)
vtkDataObject *	SafeDownCast (vtkObject *o)
vtkInformationStringKey *	DATA_TYPE_NAME ()
vtkInformationDataObjectKey *	DATA_OBJECT ()
vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()
vtkInformationIntegerVectorKey *	DATA_EXTENT ()
vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()
vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()
vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()
vtkInformationIntegerKey *	SCALAR_TYPE ()
vtkInformationIntegerKey *	SCALAR_NUMBER_OF_COMPONENTS ()
vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()
vtkInformationIntegerKey *	FIELD_ASSOCIATION ()
vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()
vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()
vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()
vtkInformationIntegerKey *	FIELD_OPERATION ()
vtkInformationStringKey *	FIELD_NAME ()
vtkInformationDoubleVectorKey *	ORIGIN ()
vtkInformationDoubleVectorKey *	SPACING ()
Protected Types
typedef vtkStreamingDemandDrivenPipeline	SDDP
Protected Member Functions
	vtkDataObject ()
	~vtkDataObject ()
virtual void	CopyPipelineInformation (vtkInformation oldPInfo, vtkInformation newPInfo)
vtkExecutive *	GetExecutive ()
int	GetPortNumber ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	RemoveReferences ()
virtual void	GarbageCollectionStarting ()
vtkStreamingDemandDrivenPipeline *	TrySDDP (const char *method)
Protected Attributes
vtkFieldData *	FieldData
vtkSource *	Source
int	DataReleased
vtkTimeStamp	UpdateTime
int	GarbageCollecting
vtkInformation *	Information
vtkInformation *	PipelineInformation

vtkDataObject Class Reference

Detailed Description

[NOHEADER]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation