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

#include <vtkCellGrid.h>

Inheritance diagram for vtkCellGrid:

Collaboration diagram for vtkCellGrid:

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.

vtkCellGrid *	NewInstance () 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).

vtkUnsignedCharArray *	GetGhostArray (int type) override
	Returns the ghost arrays of the data object of the specified attribute type.

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.


void	ShallowCopy (vtkDataObject *baseSrc) override
	Shallow and Deep copy.

void	DeepCopy (vtkDataObject *baseSrc) override
	Shallow and Deep copy.


vtkDataSetAttributes *	GetAttributes (int type) override
	Fetch a partition of DOF arrays.

vtkDataSetAttributes *	GetAttributes (vtkStringToken type)
	Fetch a partition of DOF arrays.

vtkDataSetAttributes *	FindAttributes (int type) const
	Fetch a partition of DOF arrays.

const std::unordered_map< int, vtkSmartPointer< vtkDataSetAttributes > > &	GetArrayGroups () const
	Fetch a partition of DOF arrays.


template<typename CellType >
CellType *	AddCellMetadata ()
	Insert a cell type, if possible.

vtkCellMetadata *	AddCellMetadata (vtkCellMetadata *cellType)
	Insert a cell type, if possible.


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< vtkStringToken >	CellTypeArray () const
	Fill a container with all the cell types (as string tokens).


const vtkCellMetadata *	GetCellType (vtkStringToken cellTypeName) const
	Return an object that can operate on this vtkCellGrid's cells of the given type.

vtkCellMetadata *	GetCellType (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.


vtkCellAttribute *	GetCellAttributeById (int attributeId)
	Return an attribute given its name or identifier.

vtkCellAttribute *	GetCellAttributeByName (const std::string &name)
	Return an attribute given its name or identifier.


vtkCellAttribute *	GetShapeAttribute ()
	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
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.

void	ReleaseData ()
	Release data back to system to conserve memory resource.

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

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 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 vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData.

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.

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.

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.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

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.

virtual 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 vtkCellGrid *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkCellGrid *	SafeDownCast (vtkObjectBase *o)


static vtkCellGrid *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkCellGrid *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

Static Public Member Functions inherited from vtkDataObject
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 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 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 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 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

	vtkCellGrid ()

	~vtkCellGrid () override

bool	ComputeBoundsInternal ()

Protected Member Functions inherited from vtkDataObject
	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	ReportReferences (vtkGarbageCollector *)

	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 }

std::array< double, 6 >	CachedBounds

vtkTimeStamp	CachedBoundsTime

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

vtkTypeBool	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

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

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

Tests:: vtkCellGrid (Tests)

Definition at line 41 of file vtkCellGrid.h.

Member Typedef Documentation

◆ CellTypeId

using vtkCellGrid::CellTypeId = vtkStringToken

Definition at line 44 of file vtkCellGrid.h.

◆ Superclass

typedef vtkDataObject vtkCellGrid::Superclass

Definition at line 48 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 60 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

Shallow and Deep copy.

These copy the data, but not any pipeline connections.

Reimplemented from vtkDataObject.

◆ DeepCopy()

void vtkCellGrid::DeepCopy ( vtkDataObject * baseSrc )

overridevirtual

Shallow and Deep copy.

These copy the data, but not any pipeline connections.

Reimplemented from vtkDataObject.

◆ 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()

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.

◆ 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 89 of file vtkCellGrid.h.

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

◆ 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/2]

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 138 of file vtkCellGrid.h.

◆ AddCellMetadata() [2/2]

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.

◆ GetCellsOfType() [1/2]

template<typename CellType >

const CellType * vtkCellGrid::GetCellsOfType ( ) const

inline

Get a cell metadata object of the given type.

Definition at line 166 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 176 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 192 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 200 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 206 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.

◆ 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).

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

◆ ComputeBoundsInternal()

bool vtkCellGrid::ComputeBoundsInternal ( )

protected

Member Data Documentation

◆ ArrayGroups

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

protected

Definition at line 301 of file vtkCellGrid.h.

◆ Cells

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

protected

Definition at line 302 of file vtkCellGrid.h.

◆ Attributes

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

protected

Definition at line 303 of file vtkCellGrid.h.

◆ NextAttribute

int vtkCellGrid::NextAttribute = 0

protected

Definition at line 304 of file vtkCellGrid.h.

◆ ShapeAttribute

vtkStringToken vtkCellGrid::ShapeAttribute

protected

Definition at line 305 of file vtkCellGrid.h.

◆ HaveShape

bool vtkCellGrid::HaveShape { false }

protected

Definition at line 306 of file vtkCellGrid.h.

◆ CachedBounds

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

mutableprotected

Definition at line 308 of file vtkCellGrid.h.

◆ CachedBoundsTime

vtkTimeStamp vtkCellGrid::CachedBoundsTime

mutableprotected

Definition at line 309 of file vtkCellGrid.h.

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

Common/DataModel/vtkCellGrid.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CellTypeId

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCellGrid()

◆ ~vtkCellGrid()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ GetDataObjectType()

◆ GetActualMemorySize()

◆ ShallowCopy()

◆ DeepCopy()

◆ GetAttributes() [1/2]

◆ GetAttributes() [2/2]

◆ FindAttributes()

◆ GetArrayGroups()

◆ GetGhostArray()

◆ GetAttributeTypeForArray()

◆ GetNumberOfElements()

◆ GetNumberOfCells()

◆ GetBounds()

◆ AddCellMetadata() [1/2]

◆ AddCellMetadata() [2/2]

◆ GetCellsOfType() [1/2]

◆ GetCellsOfType() [2/2]

◆ CellTypes() [1/2]

◆ CellTypes() [2/2]

◆ CellTypeArray()

◆ GetCellType() [1/2]

◆ GetCellType() [2/2]

◆ AddCellAttribute()

◆ GetCellAttributeById()

◆ GetCellAttributeByName()

◆ GetShapeAttribute()

◆ SetShapeAttribute()

◆ Query()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ ComputeBoundsInternal()

Member Data Documentation

◆ ArrayGroups

◆ Cells

◆ Attributes

◆ NextAttribute

◆ ShapeAttribute

◆ HaveShape

◆ CachedBounds

◆ CachedBoundsTime