VTK  9.4.20241220
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkCellGrid Class Reference

Visualization data composed of cells of arbitrary type. More...

#include <vtkCellGrid.h>

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

Public Types

using CellTypeId = vtkStringToken
 
typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
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.
 
vtkCellGridNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Initialize () override
 Restore data object to initial state,.
 
int GetDataObjectType () override
 Return class name of data type.
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes).
 
vtkUnsignedCharArrayGetGhostArray (int type) override
 Returns the ghost arrays of the data object of the specified attribute type.
 
bool SupportsGhostArray (int type) override
 Returns true if type is CELL, false otherwise.
 
int GetAttributeTypeForArray (vtkAbstractArray *arr) override
 Retrieves the attribute type that an array came from.
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.).
 
vtkIdType GetNumberOfCells ()
 Return the number of cells (of all types).
 
void GetBounds (double bounds[6])
 Fill the provided bounding box with the bounds of all the cells present in the grid.
 
virtual bool GetCellAttributeRange (vtkCellAttribute *attribute, int componentIndex, double range[2], bool finiteRange=false) const
 Return information on the range of values taken on by a component of an attribute.
 
vtkCellGridRangeQuery::CacheMapGetRangeCache () const
 Return the cache of cell-attribute range data.
 
void ClearRangeCache (const std::string &attributeName=std::string())
 Clear the cache of cell-attribute range data.
 
std::set< int > GetCellAttributeIds () const
 Return the set of cell attribute IDs.
 
std::vector< int > GetUnorderedCellAttributeIds () const
 
std::vector< vtkSmartPointer< vtkCellAttribute > > GetCellAttributeList () const
 Return a vector of all this grid's cell-attributes.
 
virtual void SetSchema (vtkStringToken name, vtkTypeUInt32 version)
 Set the schema name and version number that generated this object.
 
 vtkGetStringTokenMacro (SchemaName)
 
virtual vtkTypeUInt32 GetSchemaVersion ()
 
virtual void SetContentVersion (vtkTypeUInt32)
 Set the version number of the object's contents.
 
virtual vtkTypeUInt32 GetContentVersion ()
 
Copying Copying

Copy baseSrc by reference (which must be a vtkCellGrid) into this object.

This copies cell metadata (i.e., topology) and cell-attributes (including the cell-attribute holding the geometric shape).

void ShallowCopy (vtkDataObject *baseSrc) override
 Copy baseSrc by value (which must be a vtkCellGrid) into this object.
 
void DeepCopy (vtkDataObject *baseSrc) override
 Copy baseSrc by value (which must be a vtkCellGrid) into this object.
 
bool CopyStructure (vtkCellGrid *other, bool byReference=true)
 Copy the geometric and topological data from other, but not any attributes.
 
ArrayGroups Array-groups.

A cell grid can have any number of groups of arrays.

Each group must have the same number of tuples. The groups are related to a particular type (generally they are functional groups related to a particular type of cell or its sides).

vtkDataSetAttributesGetAttributes (int type) override
 Fetch a partition of DOF arrays.
 
vtkDataSetAttributesGetAttributes (vtkStringToken type)
 Fetch a partition of DOF arrays.
 
vtkDataSetAttributesFindAttributes (int type) const
 Fetch a partition of DOF arrays.
 
vtkDataSetAttributesFindAttributes (vtkStringToken type) const
 Fetch a partition of DOF arrays.
 
const std::unordered_map< int, vtkSmartPointer< vtkDataSetAttributes > > & GetArrayGroups () const
 Fetch a partition of DOF arrays.
 
void MapArrayLocations (std::unordered_map< vtkAbstractArray *, vtkStringToken > &arrayLocations) const
 This method populates the map you pass with pointers to all arrays in this cell-grid's vtkDataSetAttributes instances.
 
template<typename CellType >
CellType * AddCellMetadata ()
 Insert a cell type, if possible.
 
vtkCellMetadataAddCellMetadata (vtkCellMetadata *cellType)
 Insert a cell type, if possible.
 
vtkCellMetadataAddCellMetadata (vtkStringToken cellTypeName)
 Insert a cell type, if possible.
 
int AddAllCellMetadata ()
 Add every registered cell type to this grid.
 
template<typename CellType >
bool RemoveCellMetadata ()
 
bool RemoveCellMetadata (vtkCellMetadata *meta)
 
int RemoveUnusedCellMetadata ()
 Remove every registered cell type in this grid which has no cells.
 
template<typename CellType >
const CellType * GetCellsOfType () const
 Get a cell metadata object of the given type.
 
template<typename CellType >
CellType * GetCellsOfType ()
 Get a cell metadata object of the given type.
 
template<typename Container >
void CellTypes (Container &cellTypes) const
 Fill a container with all the cell types (as string tokens).
 
template<typename Container >
Container CellTypes () const
 Fill a container with all the cell types (as string tokens).
 
std::vector< vtkStringTokenCellTypeArray () const
 Fill a container with all the cell types (as string tokens).
 
std::vector< std::string > GetCellTypes () const
 Fill a container with all the cell types (as string tokens).
 
const vtkCellMetadataGetCellType (vtkStringToken cellTypeName) const
 Return an object that can operate on this vtkCellGrid's cells of the given type.
 
vtkCellMetadataGetCellType (vtkStringToken cellTypeName)
 Return an object that can operate on this vtkCellGrid's cells of the given type.
 
virtual bool AddCellAttribute (vtkCellAttribute *attribute)
 Add a cell-attribute to the dataset.
 
virtual bool RemoveCellAttribute (vtkCellAttribute *attribute)
 Remove a cell-attribute from the dataset.
 
vtkCellAttributeGetCellAttribute (vtkStringToken::Hash hash)
 Return an attribute given its hash.
 
vtkCellAttributeGetCellAttributeById (int attributeId)
 Return an attribute given its name or identifier.
 
vtkCellAttributeGetCellAttributeByName (const std::string &name)
 Return an attribute given its name or identifier.
 
vtkCellAttributeGetShapeAttribute ()
 Set/get the "shape attribute" (i.e., a vector-valued cell-attribute that maps from reference to world coordinates).
 
bool SetShapeAttribute (vtkCellAttribute *shape)
 Set/get the "shape attribute" (i.e., a vector-valued cell-attribute that maps from reference to world coordinates).
 
bool Query (vtkCellGridQuery *query)
 Perform a query on all the cells in this instance.
 
- Public Member Functions inherited from vtkDataObject
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.
 
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.
 
- 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 vtkCellGridNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridSafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayCorrespondingArray (vtkCellGrid *gridA, vtkDataArray *arrayA, vtkCellGrid *gridB)
 Identify a correspondence between arrays in two cell grid objects.
 
static vtkInformationIntegerVectorKeyARRAY_GROUP_IDS ()
 This information key is used to mark arrays with the string token(s) of their owning vtkDataSetAttributes instance.
 
static vtkCellGridGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkCellGridGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkDataObject
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 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.
 
- 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
 
 vtkCellGrid ()
 
 ~vtkCellGrid () override
 
bool ComputeBoundsInternal ()
 
bool ComputeRangeInternal (vtkCellAttribute *attribute, int component, bool finiteRange) const
 
- Protected Member Functions inherited from vtkDataObject
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

std::unordered_map< int, vtkSmartPointer< vtkDataSetAttributes > > ArrayGroups
 
std::unordered_map< CellTypeId, vtkSmartPointer< vtkCellMetadata > > Cells
 
std::unordered_map< vtkStringToken::Hash, vtkSmartPointer< vtkCellAttribute > > Attributes
 
int NextAttribute = 0
 
vtkStringToken ShapeAttribute
 
bool HaveShape { false }
 
vtkStringToken SchemaName
 A string specifying the schema which generated this cell-grid.
 
vtkTypeUInt32 SchemaVersion { 0 }
 The monotonically-increasing version number associated with SchemaName.
 
vtkTypeUInt32 ContentVersion { 0 }
 A user-provided version number for the grid's data.
 
std::array< double, 6 > CachedBounds
 
vtkTimeStamp CachedBoundsTime
 
vtkCellGridRangeQuery::CacheMap RangeCache
 Cache for cell attribute component ranges.
 
- Protected Attributes inherited from vtkDataObject
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
 

Friends

class vtkCellGridCopyQuery
 

Additional Inherited Members

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

Detailed Description

Visualization data composed of cells of arbitrary type.

vtkCellGrid inherits vtkDataObject in order to introduce the concept of cells that, instead of relying on spatial points to specify their shape, rely on degrees of freedom (which may or may not be embedded in a world coordinate system).

The degrees of freedom that define cells and the functions using those cells as their domain are provided in data arrays. The arrays are partitioned into groups (vtkDataSetAttributes) by the registered cell types. Each array in a group has the same number of tuples.

See also
vtkDataObject vtkDataSetAttributes
Examples:
vtkCellGrid (Examples)
Tests:
vtkCellGrid (Tests)

Definition at line 48 of file vtkCellGrid.h.

Member Typedef Documentation

◆ CellTypeId

Definition at line 51 of file vtkCellGrid.h.

◆ Superclass

Definition at line 55 of file vtkCellGrid.h.

Constructor & Destructor Documentation

◆ vtkCellGrid()

vtkCellGrid::vtkCellGrid ( )
protected

◆ ~vtkCellGrid()

vtkCellGrid::~vtkCellGrid ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCellGrid * vtkCellGrid::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCellGrid::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 vtkDataObject.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellGrid::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObject.

◆ NewInstance()

vtkCellGrid * vtkCellGrid::NewInstance ( ) const

◆ PrintSelf()

void vtkCellGrid::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

◆ Initialize()

void vtkCellGrid::Initialize ( )
overridevirtual

Restore data object to initial state,.

Reimplemented from vtkDataObject.

◆ GetDataObjectType()

int vtkCellGrid::GetDataObjectType ( )
inlineoverridevirtual

Return class name of data type.

THIS METHOD IS THREAD SAFE

Reimplemented from vtkDataObject.

Definition at line 67 of file vtkCellGrid.h.

◆ GetActualMemorySize()

unsigned long vtkCellGrid::GetActualMemorySize ( )
overridevirtual

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 from vtkDataObject.

◆ ShallowCopy()

void vtkCellGrid::ShallowCopy ( vtkDataObject baseSrc)
overridevirtual

Copy baseSrc by value (which must be a vtkCellGrid) into this object.

This copies cell metadata (i.e., topology) and cell-attributes (including the cell-attribute holding the geometric shape).

Reimplemented from vtkDataObject.

◆ DeepCopy()

void vtkCellGrid::DeepCopy ( vtkDataObject baseSrc)
overridevirtual

Copy baseSrc by value (which must be a vtkCellGrid) into this object.

This copies cell metadata (i.e., topology) and cell-attributes (including the cell-attribute holding the geometric shape).

Reimplemented from vtkDataObject.

◆ CopyStructure()

bool vtkCellGrid::CopyStructure ( vtkCellGrid other,
bool  byReference = true 
)

Copy the geometric and topological data from other, but not any attributes.

If byReference is true, references to source arrays are used directly. Otherwise, deep copies of the other cell-grid's arrays are created.

◆ GetAttributes() [1/2]

vtkDataSetAttributes * vtkCellGrid::GetAttributes ( int  type)
overridevirtual

Fetch a partition of DOF arrays.

The GetAttributes method will create an empty one if no arrays of that type exist; the GetArrayGroups method returns the map from types to existing partitions. The FindAttributes method will return a null pointer if no arrays of that type exist.

Reimplemented from vtkDataObject.

◆ GetAttributes() [2/2]

vtkDataSetAttributes * vtkCellGrid::GetAttributes ( vtkStringToken  type)

Fetch a partition of DOF arrays.

The GetAttributes method will create an empty one if no arrays of that type exist; the GetArrayGroups method returns the map from types to existing partitions. The FindAttributes method will return a null pointer if no arrays of that type exist.

◆ FindAttributes() [1/2]

vtkDataSetAttributes * vtkCellGrid::FindAttributes ( int  type) const

Fetch a partition of DOF arrays.

The GetAttributes method will create an empty one if no arrays of that type exist; the GetArrayGroups method returns the map from types to existing partitions. The FindAttributes method will return a null pointer if no arrays of that type exist.

◆ FindAttributes() [2/2]

vtkDataSetAttributes * vtkCellGrid::FindAttributes ( vtkStringToken  type) const

Fetch a partition of DOF arrays.

The GetAttributes method will create an empty one if no arrays of that type exist; the GetArrayGroups method returns the map from types to existing partitions. The FindAttributes method will return a null pointer if no arrays of that type exist.

◆ GetArrayGroups()

const std::unordered_map< int, vtkSmartPointer< vtkDataSetAttributes > > & vtkCellGrid::GetArrayGroups ( ) const
inline

Fetch a partition of DOF arrays.

The GetAttributes method will create an empty one if no arrays of that type exist; the GetArrayGroups method returns the map from types to existing partitions. The FindAttributes method will return a null pointer if no arrays of that type exist.

Definition at line 117 of file vtkCellGrid.h.

◆ MapArrayLocations()

void vtkCellGrid::MapArrayLocations ( std::unordered_map< vtkAbstractArray *, vtkStringToken > &  arrayLocations) const

This method populates the map you pass with pointers to all arrays in this cell-grid's vtkDataSetAttributes instances.

Various queries and responders need ways to refer to arrays by name rather than by pointer; this provides a way to produce names based on the array-group that the array belongs to.

◆ GetGhostArray()

vtkUnsignedCharArray * vtkCellGrid::GetGhostArray ( int  type)
overridevirtual

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

This may return a null pointer.

Reimplemented from vtkDataObject.

◆ SupportsGhostArray()

bool vtkCellGrid::SupportsGhostArray ( int  type)
overridevirtual

Returns true if type is CELL, false otherwise.

Reimplemented from vtkDataObject.

◆ GetAttributeTypeForArray()

int vtkCellGrid::GetAttributeTypeForArray ( vtkAbstractArray arr)
overridevirtual

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 from vtkDataObject.

◆ GetNumberOfElements()

vtkIdType vtkCellGrid::GetNumberOfElements ( int  type)
overridevirtual

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

Reimplemented from vtkDataObject.

◆ GetNumberOfCells()

vtkIdType vtkCellGrid::GetNumberOfCells ( )

Return the number of cells (of all types).

◆ GetBounds()

void vtkCellGrid::GetBounds ( double  bounds[6])

Fill the provided bounding box with the bounds of all the cells present in the grid.

If no cells are present, the bounding box will be reset to uninitialized bounds. It is up to each cell type to implement a specialization of the BoundsQuery operation.

The bounds are ordered { -x, +x, -y, +y, -z, +z }.

◆ AddCellMetadata() [1/3]

template<typename CellType >
CellType * vtkCellGrid::AddCellMetadata ( )
inline

Insert a cell type, if possible.

If this instance of vtkCellGrid contains the necessary attribute types (i.e., if FindAttributes returns a non-empty object for all the attribute IDs specified by the cell type), then insert an instance into this->Cells and return it. Otherwise, this method will return a null pointer.

If the cell type already exists, this will simply return the existing metadata object.

Definition at line 180 of file vtkCellGrid.h.

◆ AddCellMetadata() [2/3]

vtkCellMetadata * vtkCellGrid::AddCellMetadata ( vtkCellMetadata cellType)

Insert a cell type, if possible.

If this instance of vtkCellGrid contains the necessary attribute types (i.e., if FindAttributes returns a non-empty object for all the attribute IDs specified by the cell type), then insert an instance into this->Cells and return it. Otherwise, this method will return a null pointer.

If the cell type already exists, this will simply return the existing metadata object.

◆ AddCellMetadata() [3/3]

vtkCellMetadata * vtkCellGrid::AddCellMetadata ( vtkStringToken  cellTypeName)

Insert a cell type, if possible.

If this instance of vtkCellGrid contains the necessary attribute types (i.e., if FindAttributes returns a non-empty object for all the attribute IDs specified by the cell type), then insert an instance into this->Cells and return it. Otherwise, this method will return a null pointer.

If the cell type already exists, this will simply return the existing metadata object.

◆ AddAllCellMetadata()

int vtkCellGrid::AddAllCellMetadata ( )

Add every registered cell type to this grid.

This is useful for queries that need to iterate over registered cell types in order to determine which type of cell to construct. Afterward, your VTK filter/source can call RemoveUnusedCellMetadata() to remove metadata for which no cells exist.

The number of metadata entries added is returned.

◆ RemoveCellMetadata() [1/2]

template<typename CellType >
bool vtkCellGrid::RemoveCellMetadata ( )
inline

Remove all cells of the given type from this cell grid.

This returns true if cell metadata of the given type was present.

Definition at line 223 of file vtkCellGrid.h.

◆ RemoveCellMetadata() [2/2]

bool vtkCellGrid::RemoveCellMetadata ( vtkCellMetadata meta)

Remove all cells of the given type from this cell grid.

This returns true if cell metadata of the given type was present.

◆ RemoveUnusedCellMetadata()

int vtkCellGrid::RemoveUnusedCellMetadata ( )

Remove every registered cell type in this grid which has no cells.

The number of metadata entries removed is returned.

See also
vtkCellGrid::AddAllCellMetadata

◆ GetCellsOfType() [1/2]

template<typename CellType >
const CellType * vtkCellGrid::GetCellsOfType ( ) const
inline

Get a cell metadata object of the given type.

Definition at line 251 of file vtkCellGrid.h.

◆ GetCellsOfType() [2/2]

template<typename CellType >
CellType * vtkCellGrid::GetCellsOfType ( )
inline

Get a cell metadata object of the given type.

Definition at line 261 of file vtkCellGrid.h.

◆ CellTypes() [1/2]

template<typename Container >
void vtkCellGrid::CellTypes ( Container &  cellTypes) const
inline

Fill a container with all the cell types (as string tokens).

Definition at line 277 of file vtkCellGrid.h.

◆ CellTypes() [2/2]

template<typename Container >
Container vtkCellGrid::CellTypes ( ) const
inline

Fill a container with all the cell types (as string tokens).

Definition at line 285 of file vtkCellGrid.h.

◆ CellTypeArray()

std::vector< vtkStringToken > vtkCellGrid::CellTypeArray ( ) const
inline

Fill a container with all the cell types (as string tokens).

Definition at line 291 of file vtkCellGrid.h.

◆ GetCellTypes()

std::vector< std::string > vtkCellGrid::GetCellTypes ( ) const
inline

Fill a container with all the cell types (as string tokens).

Definition at line 306 of file vtkCellGrid.h.

◆ GetCellType() [1/2]

const vtkCellMetadata * vtkCellGrid::GetCellType ( vtkStringToken  cellTypeName) const

Return an object that can operate on this vtkCellGrid's cells of the given type.

◆ GetCellType() [2/2]

vtkCellMetadata * vtkCellGrid::GetCellType ( vtkStringToken  cellTypeName)

Return an object that can operate on this vtkCellGrid's cells of the given type.

◆ AddCellAttribute()

virtual bool vtkCellGrid::AddCellAttribute ( vtkCellAttribute attribute)
virtual

Add a cell-attribute to the dataset.

A cell-attribute is an object representing a consistent collection of arrays that specify a function over the entire vtkCellGrid's domain (i.e., all cells of all types present in the vtkCellGrid), with custom storage available to each cell type to facilitate interpolation, rendering, and other basic visualization operations.

◆ RemoveCellAttribute()

virtual bool vtkCellGrid::RemoveCellAttribute ( vtkCellAttribute attribute)
virtual

Remove a cell-attribute from the dataset.

This returns true if the cell-attribute was removed. Note that you cannot remove the shape attribute.

◆ GetCellAttributeRange()

virtual bool vtkCellGrid::GetCellAttributeRange ( vtkCellAttribute attribute,
int  componentIndex,
double  range[2],
bool  finiteRange = false 
) const
virtual

Return information on the range of values taken on by a component of an attribute.

This method also accommodates computing the range of the Lā‚ or Lā‚‚ norm of the entire tuple by passing -1 or -2, respectively, for the componentIndex.

When called with finiteRange equal to false (the default), either component of range may be NaN (not-a-number) or +/-Inf (āˆž). When finiteRange is true, the returned range values will always be finite.

Note that if this cell-attribute has no values, the range will be marked invalid (i.e., range[1] < range[0]).

Note that attribute must be an attribute owned by this cell-grid.

◆ GetRangeCache()

vtkCellGridRangeQuery::CacheMap & vtkCellGrid::GetRangeCache ( ) const
inline

Return the cache of cell-attribute range data.

Responders to vtkCellGridRangeQuery are expected to update this.

Definition at line 370 of file vtkCellGrid.h.

◆ ClearRangeCache()

void vtkCellGrid::ClearRangeCache ( const std::string &  attributeName = std::string())

Clear the cache of cell-attribute range data.

If attributeName is empty, the entire cache is cleared. Otherwise, attributes with the given name are cleared from the cache. This method exists for python scripts.

◆ GetCellAttributeIds()

std::set< int > vtkCellGrid::GetCellAttributeIds ( ) const

Return the set of cell attribute IDs.

Values in this set can be passed to GetCellAttributeById().

◆ GetUnorderedCellAttributeIds()

std::vector< int > vtkCellGrid::GetUnorderedCellAttributeIds ( ) const

◆ GetCellAttributeList()

std::vector< vtkSmartPointer< vtkCellAttribute > > vtkCellGrid::GetCellAttributeList ( ) const

Return a vector of all this grid's cell-attributes.

This is a convenience for scripting.

◆ GetCellAttribute()

vtkCellAttribute * vtkCellGrid::GetCellAttribute ( vtkStringToken::Hash  hash)

Return an attribute given its hash.

This method is fast (O(1)) and preferred compared to the GetCellAttributeById and GetCellAttributeByName methods below.

◆ GetCellAttributeById()

vtkCellAttribute * vtkCellGrid::GetCellAttributeById ( int  attributeId)

Return an attribute given its name or identifier.

This is currently an O(n) process, but additional indices could be added internally if needed.

These methods may return a null pointer if no such attribute exists.

Multiple attributes with the same name are possible. The first match will be returned.

◆ GetCellAttributeByName()

vtkCellAttribute * vtkCellGrid::GetCellAttributeByName ( const std::string &  name)

Return an attribute given its name or identifier.

This is currently an O(n) process, but additional indices could be added internally if needed.

These methods may return a null pointer if no such attribute exists.

Multiple attributes with the same name are possible. The first match will be returned.

◆ GetShapeAttribute()

vtkCellAttribute * vtkCellGrid::GetShapeAttribute ( )

Set/get the "shape attribute" (i.e., a vector-valued cell-attribute that maps from reference to world coordinates).

If there is no shape attribute, then a vtkCellGrid cannot be rendered.

A shape attribute must have between 1 and 4 components (inclusive).

If you call SetShapeAttribute with an attribute that does not satisfy this constraint, this method will return false and have no effect. If you wish to "remove" a grid's shape, call SetShapeAttribute(nullptr).

◆ SetShapeAttribute()

bool vtkCellGrid::SetShapeAttribute ( vtkCellAttribute shape)

Set/get the "shape attribute" (i.e., a vector-valued cell-attribute that maps from reference to world coordinates).

If there is no shape attribute, then a vtkCellGrid cannot be rendered.

A shape attribute must have between 1 and 4 components (inclusive).

If you call SetShapeAttribute with an attribute that does not satisfy this constraint, this method will return false and have no effect. If you wish to "remove" a grid's shape, call SetShapeAttribute(nullptr).

◆ Query()

bool vtkCellGrid::Query ( vtkCellGridQuery query)

Perform a query on all the cells in this instance.

The return value indicates success (true when all cells respond to the query) or failure (false when some cell type is unable to handle the query).

◆ SetSchema()

virtual void vtkCellGrid::SetSchema ( vtkStringToken  name,
vtkTypeUInt32  version 
)
virtual

Set the schema name and version number that generated this object.

◆ vtkGetStringTokenMacro()

vtkCellGrid::vtkGetStringTokenMacro ( SchemaName  )

◆ GetSchemaVersion()

virtual vtkTypeUInt32 vtkCellGrid::GetSchemaVersion ( )
virtual

◆ SetContentVersion()

virtual void vtkCellGrid::SetContentVersion ( vtkTypeUInt32  )
virtual

Set the version number of the object's contents.

This is not intended to be incremented with each change in memory (as a vtkTimeStamp would) but when the object is serialized to disk.

◆ GetContentVersion()

virtual vtkTypeUInt32 vtkCellGrid::GetContentVersion ( )
virtual

◆ GetData() [1/2]

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

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

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

Retrieve an instance of this class from an information object.

◆ CorrespondingArray()

static vtkDataArray * vtkCellGrid::CorrespondingArray ( vtkCellGrid gridA,
vtkDataArray arrayA,
vtkCellGrid gridB 
)
static

Identify a correspondence between arrays in two cell grid objects.

Given two cell-grids and an array held by the former, return the corresponding array of the latter (i..e, one of the same name held in an array-group (vtkDataSetAttributes) instance of the same name.

If no match is found, this returns a null pointer.

◆ ARRAY_GROUP_IDS()

static vtkInformationIntegerVectorKey * vtkCellGrid::ARRAY_GROUP_IDS ( )
static

This information key is used to mark arrays with the string token(s) of their owning vtkDataSetAttributes instance.

If this key exists on an array, it indicates that calling vtkCellGrid::GetAttributes() with its value will return a vtkDataSetAttributes instance that holds the array. It is used to accelerate the CorrespondingArray() method.

◆ ComputeBoundsInternal()

bool vtkCellGrid::ComputeBoundsInternal ( )
protected

◆ ComputeRangeInternal()

bool vtkCellGrid::ComputeRangeInternal ( vtkCellAttribute attribute,
int  component,
bool  finiteRange 
) const
protected

Friends And Related Symbol Documentation

◆ vtkCellGridCopyQuery

friend class vtkCellGridCopyQuery
friend

Definition at line 486 of file vtkCellGrid.h.

Member Data Documentation

◆ ArrayGroups

std::unordered_map<int, vtkSmartPointer<vtkDataSetAttributes> > vtkCellGrid::ArrayGroups
protected

Definition at line 494 of file vtkCellGrid.h.

◆ Cells

std::unordered_map<CellTypeId, vtkSmartPointer<vtkCellMetadata> > vtkCellGrid::Cells
protected

Definition at line 495 of file vtkCellGrid.h.

◆ Attributes

std::unordered_map<vtkStringToken::Hash, vtkSmartPointer<vtkCellAttribute> > vtkCellGrid::Attributes
protected

Definition at line 496 of file vtkCellGrid.h.

◆ NextAttribute

int vtkCellGrid::NextAttribute = 0
protected

Definition at line 497 of file vtkCellGrid.h.

◆ ShapeAttribute

vtkStringToken vtkCellGrid::ShapeAttribute
protected

Definition at line 498 of file vtkCellGrid.h.

◆ HaveShape

bool vtkCellGrid::HaveShape { false }
protected

Definition at line 499 of file vtkCellGrid.h.

◆ SchemaName

vtkStringToken vtkCellGrid::SchemaName
protected

A string specifying the schema which generated this cell-grid.

Definition at line 502 of file vtkCellGrid.h.

◆ SchemaVersion

vtkTypeUInt32 vtkCellGrid::SchemaVersion { 0 }
protected

The monotonically-increasing version number associated with SchemaName.

The number 0 is reserved to indicate no version has been set.

Definition at line 506 of file vtkCellGrid.h.

◆ ContentVersion

vtkTypeUInt32 vtkCellGrid::ContentVersion { 0 }
protected

A user-provided version number for the grid's data.

This number should be incremented each time the data is serialized.

The number 0 is reserved to indicate no version has been set.

Definition at line 511 of file vtkCellGrid.h.

◆ CachedBounds

std::array<double, 6> vtkCellGrid::CachedBounds
mutableprotected

Definition at line 513 of file vtkCellGrid.h.

◆ CachedBoundsTime

vtkTimeStamp vtkCellGrid::CachedBoundsTime
mutableprotected

Definition at line 514 of file vtkCellGrid.h.

◆ RangeCache

vtkCellGridRangeQuery::CacheMap vtkCellGrid::RangeCache
mutableprotected

Cache for cell attribute component ranges.

Definition at line 517 of file vtkCellGrid.h.


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