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

helper class to get VTK data object types as string and instantiate them

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

Examples:: vtkDataObject (Examples)

Tests:: vtkDataObject (Tests)

vtkDataObjectTypes is a helper class that supports conversion between integer types defined in vtkType.h and string names as well as creation of data objects from either integer or string types. This class has to be updated every time a new data type is added to VTK.

See also:: vtkDataObject

Definition at line 70 of file vtkDataObject.h.


static void	SetGlobalReleaseDataFlag (int val)
static int	GetGlobalReleaseDataFlag ()
void	GlobalReleaseDataFlagOn ()
void	GlobalReleaseDataFlagOff ()
Public Types
typedef vtkObject	Superclass

enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS }

enum	AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }

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)
virtual vtkAlgorithmOutput *	GetProducerPort ()
unsigned long int	GetMTime ()
virtual void	Initialize ()
void	ReleaseData ()
int	ShouldIReleaseData ()
virtual void	Register (vtkObjectBase *o)
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)
virtual void	CopyInformationFromPipeline (vtkInformation *request)
void	DataHasBeenGenerated ()
virtual void	PrepareForNewData ()
virtual int	GetExtentType ()
virtual void	Crop ()
virtual vtkDataSetAttributes *	GetAttributes (int type)
virtual vtkFieldData *	GetAttributesAsFieldData (int type)
virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
virtual vtkIdType	GetNumberOfElements (int type)

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 piece, int numPieces, int 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	CopyInformationToPipeline (vtkInformation request, vtkInformation input, vtkInformation *output, int forceCopy)

void	CopyInformationToPipeline (vtkInformation request, vtkInformation input)

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

void	SetExtentTranslator (vtkExtentTranslator *translator)
vtkExtentTranslator *	GetExtentTranslator ()
Static Public Member Functions
static vtkDataObject *	New ()
static int	IsTypeOf (const char *type)
static vtkDataObject *	SafeDownCast (vtkObject *o)
static const char *	GetAssociationTypeAsString (int associationType)
static vtkInformationStringKey *	DATA_TYPE_NAME ()
static vtkInformationDataObjectKey *	DATA_OBJECT ()
static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()
static vtkInformationIntegerPointerKey *	DATA_EXTENT ()
static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()
static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()
static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()
static vtkInformationDoubleKey *	DATA_RESOLUTION ()
static vtkInformationDoubleVectorKey *	DATA_TIME_STEPS ()
static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()
static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()
static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()
static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()
static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()
static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()
static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()
static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()
static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()
static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()
static vtkInformationIntegerKey *	FIELD_OPERATION ()
static vtkInformationDoubleVectorKey *	FIELD_RANGE ()
static vtkInformationDoubleVectorKey *	PIECE_FIELD_RANGE ()
static vtkInformationStringKey *	FIELD_ARRAY_NAME ()
static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()
static vtkInformationStringKey *	FIELD_NAME ()
static vtkInformationDoubleVectorKey *	ORIGIN ()
static vtkInformationDoubleVectorKey *	SPACING ()
static vtkInformationIntegerKey *	DATA_GEOMETRY_UNMODIFIED ()
static vtkInformationDataObjectKey *	SIL ()

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)

static vtkDataObject *	GetData (vtkInformation *info)
static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
Protected Types
typedef vtkStreamingDemandDrivenPipeline	SDDP
Protected Member Functions
	vtkDataObject ()
	~vtkDataObject ()
vtkExecutive *	GetExecutive ()
int	GetPortNumber ()
virtual void	ReportReferences (vtkGarbageCollector *)
vtkStreamingDemandDrivenPipeline *	TrySDDP (const char *method)
Protected Attributes
vtkFieldData *	FieldData
vtkSource *	Source
int	DataReleased
vtkTimeStamp	UpdateTime
vtkInformation *	Information
vtkInformation *	PipelineInformation
Static Protected Attributes
static const char	AssociationNames [NUMBER_OF_ASSOCIATIONS][55]
Friends
class	vtkStreamingDemandDrivenPipelineToDataObjectFriendship

Member Typedef Documentation

typedef vtkObject vtkDataObject::Superclass

typedef vtkStreamingDemandDrivenPipeline vtkDataObject::SDDP [protected]

Definition at line 581 of file vtkDataObject.h.

Member Enumeration Documentation

enum vtkDataObject::FieldAssociations

Possible values for the FIELD_ASSOCIATION information entry.

Enumerator:

FIELD_ASSOCIATION_POINTS
FIELD_ASSOCIATION_CELLS
FIELD_ASSOCIATION_NONE
FIELD_ASSOCIATION_POINTS_THEN_CELLS
FIELD_ASSOCIATION_VERTICES
FIELD_ASSOCIATION_EDGES
FIELD_ASSOCIATION_ROWS
NUMBER_OF_ASSOCIATIONS

Definition at line 432 of file vtkDataObject.h.

enum vtkDataObject::AttributeTypes

Possible attribute types. POINT_THEN_CELL is provided for consistency with FieldAssociations.

Enumerator:

POINT
CELL
FIELD
POINT_THEN_CELL
VERTEX
EDGE
ROW
NUMBER_OF_ATTRIBUTE_TYPES

Definition at line 450 of file vtkDataObject.h.

enum vtkDataObject::FieldOperations

Possible values for the FIELD_OPERATION information entry.

Enumerator:

FIELD_OPERATION_PRESERVED
FIELD_OPERATION_REINTERPOLATED
FIELD_OPERATION_MODIFIED
FIELD_OPERATION_REMOVED

Definition at line 492 of file vtkDataObject.h.

Constructor & Destructor Documentation

vtkDataObject::vtkDataObject ( ) [protected]

vtkDataObject::~vtkDataObject ( ) [protected]

Member Function Documentation

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 vtkAnnotation, vtkAnnotationLayers, vtkArrayData, vtkBSPCuts, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPolyData, vtkRectilinearGrid, vtkReebGraph, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, vtkImageStencilData, and vtkLabelHierarchy.

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

static int vtkDataObject::IsTypeOf ( const char * name ) [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 vtkObject.

Reimplemented in vtkAnnotation, vtkAnnotationLayers, vtkArrayData, vtkBSPCuts, vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkReebGraph, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, vtkImageStencilData, and vtkLabelHierarchy.

virtual int vtkDataObject::IsA ( const char * name ) [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 vtkObject.

Reimplemented in vtkAnnotation, vtkAnnotationLayers, vtkArrayData, vtkBSPCuts, vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkReebGraph, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, vtkImageStencilData, and vtkLabelHierarchy.

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

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 vtkAnnotation, vtkAnnotationLayers, vtkArrayData, vtkBSPCuts, vtkCompositeDataSet, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperOctree, vtkImageData, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkReebGraph, vtkSelection, vtkStructuredGrid, vtkTable, vtkTemporalDataSet, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUnstructuredGrid, vtkBridgeDataSet, vtkImageStencilData, and vtkLabelHierarchy.

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.

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 vtkAnnotation, vtkAnnotationLayers, vtkDataSet, vtkGenericDataSet, vtkGraph, vtkPointSet, vtkSelection, and vtkBridgeDataSet.

virtual void vtkDataObject::Initialize ( ) [virtual]

Restore data object to initial state,

Reimplemented in vtkAnnotation, vtkAnnotationLayers, vtkBSPCuts, 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]

Turn on/off flag to control whether every object releases its data after being used by a filter.

Definition at line 133 of file vtkDataObject.h.

void vtkDataObject::GlobalReleaseDataFlagOff ( ) [inline]

Turn on/off flag to control whether every object releases its data after being used by a filter.

Definition at line 134 of file vtkDataObject.h.

static int vtkDataObject::GetGlobalReleaseDataFlag ( ) [static]

Turn on/off flag to control whether every object releases its data after being used by a filter.

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

Assign or retrieve a general field data to this data object.

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

Assign or retrieve a general field data to this data object.

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 195 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 vtkArrayData, 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 219 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 vtkCompositeDataSet, 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 ( vtkDataObject * data ) [inline, virtual]

By default, there is no type specific information

Reimplemented in vtkImageData.

Definition at line 247 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]`