VTK
9.3.20240831
|
general representation of visualization data More...
#include <vtkDataObject.h>
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. | |
vtkDataObject * | NewInstance () 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 vtkDataSetAttributes * | GetAttributes (int type) |
Returns the attributes of the data object of the specified attribute type. | |
virtual vtkUnsignedCharArray * | GetGhostArray (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 vtkFieldData * | GetAttributesAsFieldData (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 vtkInformation * | GetInformation () |
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 vtkFieldData * | GetFieldData () |
Assign or retrieve a general field data to this data object. | |
![]() | |
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. | |
vtkCommand * | GetCommand (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. | |
![]() | |
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 vtkDataObject * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkDataObject * | SafeDownCast (vtkObjectBase *o) |
static vtkInformation * | GetActiveFieldInformation (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 vtkInformation * | GetNamedFieldInformation (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 vtkInformation * | SetActiveAttribute (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 vtkInformationStringKey * | DATA_TYPE_NAME () |
static vtkInformationDataObjectKey * | DATA_OBJECT () |
static vtkInformationIntegerKey * | DATA_EXTENT_TYPE () |
static vtkInformationIntegerPointerKey * | DATA_EXTENT () |
static vtkInformationIntegerVectorKey * | ALL_PIECES_EXTENT () |
static vtkInformationIntegerKey * | DATA_PIECE_NUMBER () |
static vtkInformationIntegerKey * | DATA_NUMBER_OF_PIECES () |
static vtkInformationIntegerKey * | DATA_NUMBER_OF_GHOST_LEVELS () |
static vtkInformationDoubleKey * | DATA_TIME_STEP () |
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 vtkInformationIntegerVectorKey * | PIECE_EXTENT () |
static vtkInformationStringKey * | FIELD_NAME () |
static vtkInformationDoubleVectorKey * | ORIGIN () |
static vtkInformationDoubleVectorKey * | SPACING () |
static vtkInformationDoubleVectorKey * | DIRECTION () |
static vtkInformationDoubleVectorKey * | BOUNDING_BOX () |
static vtkInformationDataObjectKey * | SIL () |
static vtkDataObject * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. | |
static vtkDataObject * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. | |
![]() | |
static vtkObject * | New () |
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 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 vtkObjectBase * | New () |
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 vtkObjectBase * | NewInstanceInternal () const |
vtkDataObject () | |
~vtkDataObject () override | |
![]() | |
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. | |
![]() | |
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 | |
vtkFieldData * | FieldData |
vtkTypeBool | DataReleased |
vtkTimeStamp | UpdateTime |
vtkInformation * | Information |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
![]() | |
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 vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
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.
Definition at line 164 of file vtkDataObject.h.
typedef vtkObject vtkDataObject::Superclass |
Definition at line 169 of file vtkDataObject.h.
Possible values for the FIELD_ASSOCIATION information entry.
Definition at line 363 of file vtkDataObject.h.
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.
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.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 vtkObjectBase.
Reimplemented in vtkmDataSet, vtkAbstractElectronicData, vtkAnnotation, vtkAnnotationLayers, vtkArrayData, vtkBSPCuts, vtkCellGrid, vtkCompositeDataSet, vtkDataObjectTree, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkExplicitStructuredGrid, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperTreeGrid, vtkImageData, vtkMolecule, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkNonOverlappingAMR, vtkOverlappingAMR, vtkPartitionedDataSet, vtkPartitionedDataSetCollection, vtkPath, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkReebGraph, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUniformGridAMR, vtkUniformHyperTreeGrid, vtkUnstructuredGrid, vtkOpenQubeElectronicData, vtkProgrammableElectronicData, vtkImageStencilData, vtkGeoJSONFeature, and vtkLabelHierarchy.
|
static |
|
protectedvirtual |
Reimplemented in vtkmDataSet, vtkAbstractElectronicData, vtkAnnotation, vtkAnnotationLayers, vtkArrayData, vtkBSPCuts, vtkCellGrid, vtkCompositeDataSet, vtkDataObjectTree, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkExplicitStructuredGrid, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperTreeGrid, vtkImageData, vtkMolecule, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkNonOverlappingAMR, vtkOverlappingAMR, vtkPartitionedDataSet, vtkPartitionedDataSetCollection, vtkPath, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkReebGraph, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUniformGridAMR, vtkUniformHyperTreeGrid, vtkUnstructuredGrid, vtkOpenQubeElectronicData, vtkProgrammableElectronicData, vtkImageStencilData, vtkGeoJSONFeature, and vtkLabelHierarchy.
vtkDataObject * vtkDataObject::NewInstance | ( | ) | const |
|
overridevirtual |
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 vtkObjectBase.
Reimplemented in vtkOpenQubeElectronicData, vtkmDataSet, vtkDataObjectTree, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkExplicitStructuredGrid, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperTreeGrid, vtkImageData, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkMolecule, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkNonOverlappingAMR, vtkOverlappingAMR, vtkPartitionedDataSet, vtkPartitionedDataSetCollection, vtkPath, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkReebGraph, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUniformGridAMR, vtkUniformHyperTreeGrid, vtkUnstructuredGrid, vtkUnstructuredGridBase, vtkProgrammableElectronicData, vtkImageStencilData, vtkGeoJSONFeature, and vtkLabelHierarchy.
|
virtual |
Set/Get the information object associated with this data object.
|
virtual |
Set/Get the information object associated with this data object.
|
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.
|
virtual |
Restore data object to initial state,.
Reimplemented in vtkmDataSet, vtkAnnotation, vtkAnnotationLayers, vtkBSPCuts, vtkCellGrid, vtkCompositeDataSet, vtkDataObjectTree, vtkDataSet, vtkExplicitStructuredGrid, vtkGraph, vtkHyperTreeGrid, vtkImageData, vtkMolecule, vtkPartitionedDataSetCollection, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkSelection, vtkStructuredGrid, vtkTable, vtkUniformGrid, vtkUniformGridAMR, vtkUniformHyperTreeGrid, 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.
|
virtual |
Get the flag indicating the data has been released.
|
static |
Turn on/off flag to control whether every object releases its data after being used by a filter.
|
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.
|
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.
|
static |
Turn on/off flag to control whether every object releases its data after being used by a filter.
|
virtual |
Assign or retrieve a general field data to this data object.
|
virtual |
Assign or retrieve a general field data to this data object.
|
inlinevirtual |
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 vtkmDataSet, vtkAbstractElectronicData, vtkAnnotation, vtkAnnotationLayers, vtkArrayData, vtkBSPCuts, vtkCellGrid, vtkCompositeDataSet, vtkDataObjectTree, vtkDataSet, vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkExplicitStructuredGrid, vtkGenericDataSet, vtkGraph, vtkHierarchicalBoxDataSet, vtkHyperTreeGrid, vtkImageData, vtkMolecule, vtkMultiBlockDataSet, vtkMultiPieceDataSet, vtkNonOverlappingAMR, vtkOverlappingAMR, vtkPartitionedDataSet, vtkPartitionedDataSetCollection, vtkPath, vtkPiecewiseFunction, vtkPointSet, vtkPolyData, vtkRectilinearGrid, vtkReebGraph, vtkSelection, vtkStructuredGrid, vtkStructuredPoints, vtkTable, vtkTree, vtkUndirectedGraph, vtkUniformGrid, vtkUniformGridAMR, vtkUniformHyperTreeGrid, vtkUnstructuredGrid, vtkUnstructuredGridBase, vtkOpenQubeElectronicData, vtkImageStencilData, and vtkGeoJSONFeature.
Definition at line 232 of file vtkDataObject.h.
vtkMTimeType vtkDataObject::GetUpdateTime | ( | ) |
Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).
|
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.
|
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.
|
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.
|
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)
|
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.
|
static |
Remove the info associated with an array.
|
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.
|
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.
|
static |
Convenience version of previous method for use (primarily) by the Imaging filters.
If arrayType or numComponents == -1, the value is not changed.
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.
|
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.
|
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,
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.
|
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,
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.
|
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.
|
virtual |
This method crops the data object (if necessary) so that the extent matches the update extent.
Reimplemented in vtkExplicitStructuredGrid, vtkImageData, vtkRectilinearGrid, and vtkStructuredGrid.
|
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.
Reimplemented in vtkCellGrid, and vtkGenericDataSet.
|
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.
|
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.
|
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.
|
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.
|
virtual |
Get the number of elements for a specific attribute type (POINT, CELL, etc.).
Reimplemented in vtkCellGrid, vtkCompositeDataSet, vtkDataSet, vtkGenericDataSet, vtkGraph, vtkHyperTreeGrid, and vtkTable.
|
static |
Given an integer association type, this static method returns a string type for the attribute (i.e.
associationType = 0: returns "Points").
|
static |
Given a string association name, this static method returns an integer association type for the attribute (i.e.
associationName = "Points": returns 0).
|
static |
Retrieve an instance of this class from an information object.
|
static |
Retrieve an instance of this class from an information object.
|
protected |
Definition at line 610 of file vtkDataObject.h.
|
protected |
Definition at line 613 of file vtkDataObject.h.
|
protected |
Definition at line 616 of file vtkDataObject.h.
|
protected |
Definition at line 619 of file vtkDataObject.h.