VTK  9.3.20240519
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDataObject Class Reference

general representation of visualization data More...

#include <vtkDataObject.h>

Inheritance diagram for vtkDataObject:
[legend]
Collaboration diagram for vtkDataObject:
[legend]

Public Types

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
}
 Possible values for the FIELD_ASSOCIATION information entry. More...
 
enum  AttributeTypes {
  POINT , CELL , FIELD , POINT_THEN_CELL ,
  VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES
}
 Possible attribute types. More...
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
 Possible values for the FIELD_OPERATION information entry. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDataObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkMTimeType GetMTime () override
 Data objects are composite objects and need to check each part for MTime.
 
virtual void Initialize ()
 Restore data object to initial state,.
 
void ReleaseData ()
 Release data back to system to conserve memory resource.
 
virtual int GetDataObjectType ()
 Return class name of data type.
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).
 
virtual unsigned long GetActualMemorySize ()
 Return the actual size of the data in kibibytes (1024 bytes).
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information.
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information.
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data.
 
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted.
 
virtual void ShallowCopy (vtkDataObject *src)
 The goal of the method is to copy the data up to the array pointers only.
 
virtual void DeepCopy (vtkDataObject *src)
 The goal of the method is to copy the complete data from src into this object.
 
virtual int GetExtentType ()
 The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.
 
virtual void Crop (const int *updateExtent)
 This method crops the data object (if necessary) so that the extent matches the update extent.
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type.
 
virtual vtkUnsignedCharArrayGetGhostArray (int type)
 Returns the ghost arrays of the data object of the specified attribute type.
 
virtual bool SupportsGhostArray (int type)
 Returns if this type of data object support ghost array for specified type.
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 Returns the attributes of the data object as a vtkFieldData.
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from.
 
virtual vtkIdType GetNumberOfElements (int type)
 Get the number of elements for a specific attribute type (POINT, CELL, etc.).
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this data object.
 
virtual vtkTypeBool GetDataReleased ()
 Get the flag indicating the data has been released.
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object.
 
virtual vtkFieldDataGetFieldData ()
 Assign or retrieve a general field data to this data object.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS)
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name.
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array.
 
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters.
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e.
 
static int GetAssociationTypeFromString (const char *associationName)
 Given a string association name, this static method returns an integer association type for the attribute (i.e.
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataObject ()
 
 ~vtkDataObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkFieldDataFieldData
 
vtkTypeBool DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
static void SetGlobalReleaseDataFlag (vtkTypeBool val)
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
static vtkTypeBool GetGlobalReleaseDataFlag ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
void GlobalReleaseDataFlagOn ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
void GlobalReleaseDataFlagOff ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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 vtkDataObjectToDataSetFilter vtkFieldDataToAttributeDataFilter
Examples:
vtkDataObject (Examples)
Online 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
Online Examples:

Definition at line 164 of file vtkDataObject.h.

Member Typedef Documentation

◆ Superclass

Definition at line 169 of file vtkDataObject.h.

Member Enumeration Documentation

◆ 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 363 of file vtkDataObject.h.

◆ 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 379 of file vtkDataObject.h.

◆ 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 462 of file vtkDataObject.h.

Constructor & Destructor Documentation

◆ vtkDataObject()

vtkDataObject::vtkDataObject ( )
protected

◆ ~vtkDataObject()

vtkDataObject::~vtkDataObject ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkDataObject * vtkDataObject::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkDataObject::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkDataObject::IsA ( const char *  name)
virtual

◆ SafeDownCast()

static vtkDataObject * vtkDataObject::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDataObject::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDataObject * vtkDataObject::NewInstance ( ) const

◆ PrintSelf()

void vtkDataObject::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

◆ GetInformation()

virtual vtkInformation * vtkDataObject::GetInformation ( )
virtual

Set/Get the information object associated with this data object.

◆ SetInformation()

virtual void vtkDataObject::SetInformation ( vtkInformation )
virtual

Set/Get the information object associated with this data object.

◆ GetMTime()

vtkMTimeType vtkDataObject::GetMTime ( )
overridevirtual

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, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkPartitionedDataSetCollection, vtkPointSet, vtkPolyData, and vtkSelection.

◆ Initialize()

virtual void vtkDataObject::Initialize ( )
virtual

◆ ReleaseData()

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.

◆ GetDataReleased()

virtual vtkTypeBool vtkDataObject::GetDataReleased ( )
virtual

Get the flag indicating the data has been released.

◆ SetGlobalReleaseDataFlag()

static void vtkDataObject::SetGlobalReleaseDataFlag ( vtkTypeBool  val)
static

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

◆ GlobalReleaseDataFlagOn()

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 213 of file vtkDataObject.h.

◆ GlobalReleaseDataFlagOff()

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 214 of file vtkDataObject.h.

◆ GetGlobalReleaseDataFlag()

static vtkTypeBool vtkDataObject::GetGlobalReleaseDataFlag ( )
static

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

◆ SetFieldData()

virtual void vtkDataObject::SetFieldData ( vtkFieldData )
virtual

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

◆ GetFieldData()

virtual vtkFieldData * vtkDataObject::GetFieldData ( )
virtual

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

◆ GetDataObjectType()

virtual int vtkDataObject::GetDataObjectType ( )
inlinevirtual

◆ GetUpdateTime()

vtkMTimeType vtkDataObject::GetUpdateTime ( )

Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).

◆ GetActualMemorySize()

virtual unsigned long vtkDataObject::GetActualMemorySize ( )
virtual

Return the actual size of the data in kibibytes (1024 bytes).

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 vtkmDataSet, vtkCellGrid, vtkCompositeDataSet, vtkDataObjectTree, vtkDataSet, vtkExplicitStructuredGrid, vtkGenericDataSet, vtkGraph, vtkHyperTreeGrid, vtkImageData, vtkMolecule, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkStructuredGrid, vtkTable, and vtkUnstructuredGrid.

◆ CopyInformationFromPipeline()

virtual void vtkDataObject::CopyInformationFromPipeline ( vtkInformation vtkNotUsedinfo)
inlinevirtual

Copy from the pipeline information to the data object's own information.

Called right before the main execution pass.

Definition at line 253 of file vtkDataObject.h.

◆ CopyInformationToPipeline()

virtual void vtkDataObject::CopyInformationToPipeline ( vtkInformation vtkNotUsedinfo)
inlinevirtual

Copy information from this data object to the pipeline information.

This is used by the vtkTrivialProducer that is created when someone calls SetInputData() to connect a data object to a pipeline.

Definition at line 260 of file vtkDataObject.h.

◆ GetActiveFieldInformation()

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

Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS)

◆ GetNamedFieldInformation()

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

Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name.

◆ RemoveNamedFieldInformation()

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

Remove the info associated with an array.

◆ SetActiveAttribute()

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

Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

Returns the active field information object and creates on entry if one not found.

◆ SetActiveAttributeInfo()

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

Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

If there is not an active attribute of the specified type, an entry in the information object is created. If arrayType, numComponents, or numTuples equal to -1, or name=nullptr the value is not changed.

◆ SetPointDataActiveScalarInfo()

static void vtkDataObject::SetPointDataActiveScalarInfo ( vtkInformation info,
int  arrayType,
int  numComponents 
)
static

Convenience version of previous method for use (primarily) by the Imaging filters.

If arrayType or numComponents == -1, the value is not changed.

◆ DataHasBeenGenerated()

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.

◆ PrepareForNewData()

virtual void vtkDataObject::PrepareForNewData ( )
inlinevirtual

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 324 of file vtkDataObject.h.

◆ ShallowCopy()

virtual void vtkDataObject::ShallowCopy ( vtkDataObject src)
virtual

The goal of the method is to copy the data up to the array pointers only.

The implementation is delegated to the differenent subclasses. If you want to copy the actual data,

See also
DeepCopy.

This method shallow copy the field data and copy the internal structure.

Reimplemented in vtkHyperTreeGrid, vtkUniformHyperTreeGrid, vtkCellGrid, vtkPiecewiseFunction, vtkImageStencilData, vtkGraph, vtkMolecule, vtkAnnotation, vtkAnnotationLayers, vtkArrayData, vtkmDataSet, vtkBSPCuts, vtkDataObjectTree, vtkDataSet, vtkExplicitStructuredGrid, vtkImageData, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkPartitionedDataSetCollection, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkTable, vtkUniformGridAMR, and vtkUnstructuredGrid.

◆ DeepCopy()

virtual void vtkDataObject::DeepCopy ( vtkDataObject src)
virtual

The goal of the method is to copy the complete data from src into this object.

The implementation is delegated to the differenent subclasses. If you want to copy the data up to the array pointers only,

See also
ShallowCopy.

This method deep copy the field data and copy the internal structure.

Reimplemented in vtkHyperTreeGrid, vtkUniformHyperTreeGrid, vtkCellGrid, vtkPiecewiseFunction, vtkImageStencilData, vtkOpenQubeElectronicData, vtkAbstractElectronicData, vtkGraph, vtkMolecule, vtkProgrammableElectronicData, vtkAnnotation, vtkAnnotationLayers, vtkArrayData, vtkmDataSet, vtkBSPCuts, vtkDataObjectTree, vtkDataSet, vtkExplicitStructuredGrid, vtkImageData, vtkPartitionedDataSetCollection, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkReebGraph, vtkSelection, vtkStructuredGrid, vtkTable, vtkUniformGridAMR, vtkUnstructuredGrid, and vtkUnstructuredGridBase.

◆ GetExtentType()

virtual int vtkDataObject::GetExtentType ( )
inlinevirtual

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 vtkExplicitStructuredGrid, vtkHyperTreeGrid, vtkImageData, vtkRectilinearGrid, vtkStructuredGrid, and vtkImageStencilData.

Definition at line 352 of file vtkDataObject.h.

◆ Crop()

virtual void vtkDataObject::Crop ( const int *  updateExtent)
virtual

This method crops the data object (if necessary) so that the extent matches the update extent.

Reimplemented in vtkExplicitStructuredGrid, vtkImageData, vtkRectilinearGrid, and vtkStructuredGrid.

◆ GetAttributes()

virtual vtkDataSetAttributes * vtkDataObject::GetAttributes ( int  type)
virtual

Returns the attributes of the data object of the specified attribute type.

The type may be:

The other attribute type, FIELD, will return nullptr since field data is stored as a vtkFieldData instance, not a vtkDataSetAttributes instance. To retrieve field data, use GetAttributesAsFieldData.

Warning
This method NEEDS to be overridden in subclasses to work as documented. If not, it returns nullptr for any type but FIELD.

Reimplemented in vtkCellGrid, and vtkGenericDataSet.

◆ GetGhostArray()

virtual vtkUnsignedCharArray * vtkDataObject::GetGhostArray ( int  type)
virtual

Returns the ghost arrays of the data object of the specified attribute type.

The type may be:

The other attribute types, will return nullptr since ghosts arrays are not defined for now outside of point or cell.

Reimplemented in vtkCellGrid, and vtkDataSet.

◆ SupportsGhostArray()

virtual bool vtkDataObject::SupportsGhostArray ( int  type)
virtual

Returns if this type of data object support ghost array for specified type.

The type may be:

The other attribute types, will return false since ghosts arrays are not defined for now outside of point or cell. for vtkDataObject, this always return false but subclasses may override this method and implement their own logic.

Reimplemented in vtkCellGrid, vtkCompositeDataSet, vtkDataSet, and vtkHyperTreeGrid.

◆ GetAttributesAsFieldData()

virtual vtkFieldData * vtkDataObject::GetAttributesAsFieldData ( int  type)
virtual

Returns the attributes of the data object as a vtkFieldData.

This returns non-null values in all the same cases as GetAttributes, in addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.

Reimplemented in vtkDataSet, vtkGraph, vtkHyperTreeGrid, and vtkTable.

◆ GetAttributeTypeForArray()

virtual int vtkDataObject::GetAttributeTypeForArray ( vtkAbstractArray arr)
virtual

Retrieves the attribute type that an array came from.

This is useful for obtaining which attribute type a input array to an algorithm came from (retrieved from GetInputAbstractArrayToProcesss).

Reimplemented in vtkCellGrid.

◆ GetNumberOfElements()

virtual vtkIdType vtkDataObject::GetNumberOfElements ( int  type)
virtual

Get the number of elements for a specific attribute type (POINT, CELL, etc.).

Reimplemented in vtkCellGrid, vtkCompositeDataSet, vtkDataSet, vtkGenericDataSet, vtkGraph, vtkHyperTreeGrid, and vtkTable.

◆ GetAssociationTypeAsString()

static const char * vtkDataObject::GetAssociationTypeAsString ( int  associationType)
static

Given an integer association type, this static method returns a string type for the attribute (i.e.

associationType = 0: returns "Points").

◆ GetAssociationTypeFromString()

static int vtkDataObject::GetAssociationTypeFromString ( const char *  associationName)
static

Given a string association name, this static method returns an integer association type for the attribute (i.e.

associationName = "Points": returns 0).

◆ DATA_TYPE_NAME()

static vtkInformationStringKey * vtkDataObject::DATA_TYPE_NAME ( )
static

◆ DATA_OBJECT()

static vtkInformationDataObjectKey * vtkDataObject::DATA_OBJECT ( )
static

◆ DATA_EXTENT_TYPE()

static vtkInformationIntegerKey * vtkDataObject::DATA_EXTENT_TYPE ( )
static

◆ DATA_EXTENT()

static vtkInformationIntegerPointerKey * vtkDataObject::DATA_EXTENT ( )
static

◆ ALL_PIECES_EXTENT()

static vtkInformationIntegerVectorKey * vtkDataObject::ALL_PIECES_EXTENT ( )
static

◆ DATA_PIECE_NUMBER()

static vtkInformationIntegerKey * vtkDataObject::DATA_PIECE_NUMBER ( )
static

◆ DATA_NUMBER_OF_PIECES()

static vtkInformationIntegerKey * vtkDataObject::DATA_NUMBER_OF_PIECES ( )
static

◆ DATA_NUMBER_OF_GHOST_LEVELS()

static vtkInformationIntegerKey * vtkDataObject::DATA_NUMBER_OF_GHOST_LEVELS ( )
static

◆ DATA_TIME_STEP()

static vtkInformationDoubleKey * vtkDataObject::DATA_TIME_STEP ( )
static

◆ POINT_DATA_VECTOR()

static vtkInformationInformationVectorKey * vtkDataObject::POINT_DATA_VECTOR ( )
static

◆ CELL_DATA_VECTOR()

static vtkInformationInformationVectorKey * vtkDataObject::CELL_DATA_VECTOR ( )
static

◆ VERTEX_DATA_VECTOR()

static vtkInformationInformationVectorKey * vtkDataObject::VERTEX_DATA_VECTOR ( )
static

◆ EDGE_DATA_VECTOR()

static vtkInformationInformationVectorKey * vtkDataObject::EDGE_DATA_VECTOR ( )
static

◆ FIELD_ARRAY_TYPE()

static vtkInformationIntegerKey * vtkDataObject::FIELD_ARRAY_TYPE ( )
static

◆ FIELD_ASSOCIATION()

static vtkInformationIntegerKey * vtkDataObject::FIELD_ASSOCIATION ( )
static

◆ FIELD_ATTRIBUTE_TYPE()

static vtkInformationIntegerKey * vtkDataObject::FIELD_ATTRIBUTE_TYPE ( )
static

◆ FIELD_ACTIVE_ATTRIBUTE()

static vtkInformationIntegerKey * vtkDataObject::FIELD_ACTIVE_ATTRIBUTE ( )
static

◆ FIELD_NUMBER_OF_COMPONENTS()

static vtkInformationIntegerKey * vtkDataObject::FIELD_NUMBER_OF_COMPONENTS ( )
static

◆ FIELD_NUMBER_OF_TUPLES()

static vtkInformationIntegerKey * vtkDataObject::FIELD_NUMBER_OF_TUPLES ( )
static

◆ FIELD_OPERATION()

static vtkInformationIntegerKey * vtkDataObject::FIELD_OPERATION ( )
static

◆ FIELD_RANGE()

static vtkInformationDoubleVectorKey * vtkDataObject::FIELD_RANGE ( )
static

◆ PIECE_EXTENT()

static vtkInformationIntegerVectorKey * vtkDataObject::PIECE_EXTENT ( )
static

◆ FIELD_NAME()

static vtkInformationStringKey * vtkDataObject::FIELD_NAME ( )
static

◆ ORIGIN()

static vtkInformationDoubleVectorKey * vtkDataObject::ORIGIN ( )
static

◆ SPACING()

static vtkInformationDoubleVectorKey * vtkDataObject::SPACING ( )
static

◆ DIRECTION()

static vtkInformationDoubleVectorKey * vtkDataObject::DIRECTION ( )
static

◆ BOUNDING_BOX()

static vtkInformationDoubleVectorKey * vtkDataObject::BOUNDING_BOX ( )
static

◆ SIL()

static vtkInformationDataObjectKey * vtkDataObject::SIL ( )
static

◆ GetData() [1/2]

static vtkDataObject * vtkDataObject::GetData ( vtkInformation info)
static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

static vtkDataObject * vtkDataObject::GetData ( vtkInformationVector v,
int  i = 0 
)
static

Retrieve an instance of this class from an information object.

Member Data Documentation

◆ FieldData

vtkFieldData* vtkDataObject::FieldData
protected

Definition at line 554 of file vtkDataObject.h.

◆ DataReleased

vtkTypeBool vtkDataObject::DataReleased
protected

Definition at line 557 of file vtkDataObject.h.

◆ UpdateTime

vtkTimeStamp vtkDataObject::UpdateTime
protected

Definition at line 560 of file vtkDataObject.h.

◆ Information

vtkInformation* vtkDataObject::Information
protected

Definition at line 563 of file vtkDataObject.h.


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