dataset represents arbitrary combinations of all possible cell types More...

#include <vtkUnstructuredGrid.h>

Inheritance diagram for vtkUnstructuredGrid:

Collaboration diagram for vtkUnstructuredGrid:

Public Member Functions
int	GetDataObjectType () override
	Standard vtkDataSet API methods.

bool	AllocateEstimate (vtkIdType numCells, vtkIdType maxCellSize)
	Pre-allocate memory in internal data structures.

bool	AllocateExact (vtkIdType numCells, vtkIdType connectivitySize)
	Pre-allocate memory in internal data structures.

void	Allocate (vtkIdType numCells=1000, int vtkNotUsed(extSize)=1000) override
	Method allocates initial storage for the cell connectivity.

int	GetCellType (vtkIdType cellId) override
	Get the type of the cell with the given cellId.

vtkIdType	GetCellSize (vtkIdType cellId) override
	Get the size of the cell with given cellId.

void	GetCellTypes (vtkCellTypes *types) override
	Get a list of types of cells in a dataset.

vtkUnsignedCharArray *	GetDistinctCellTypesArray ()
	Get a list of types of cells in a dataset.

void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const *&pts)
	A higher-performing variant of the virtual vtkDataSet::GetCellPoints() for unstructured grids.

void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const &pts, vtkIdList ptIds) override
	A higher-performing variant of the virtual vtkDataSet::GetCellPoints() for unstructured grids.

vtkUnsignedCharArray *	GetCellTypesArray ()
	Get the array of all cell types in the grid.

void	Squeeze () override
	Squeeze all arrays in the grid to conserve memory.

void	Initialize () override
	Reset the grid to an empty state and free any memory.

int	GetMaxCellSize () override
	Get the size, in number of points, of the largest cell.

void	BuildLinks ()
	Build topological links from points to lists of cells that use each point.

vtkAbstractCellLinks *	GetCellLinks ()
	Get the cell links.

void	GetFaceStream (vtkIdType cellId, vtkIdList *ptIds)
	Get the face stream of a polyhedron cell in the following format: (numCellFaces, numFace0Pts, id1, id2, id3, numFace1Pts,id1, id2, id3, ...).

void	GetFaceStream (vtkIdType cellId, vtkIdType &nfaces, vtkIdType const *&ptIds)
	Get the number of faces and the face stream of a polyhedral cell.

vtkCellArray *	GetCells ()
	Return the unstructured grid connectivity array.

virtual int	GetGhostLevel ()
	Get the ghost level.

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).

void	GetIdsOfCellsOfType (int type, vtkIdTypeArray *array) override
	Fill vtkIdTypeArray container with list of cell Ids.

int	IsHomogeneous () override
	Returns whether cells are all of the same type.

void	RemoveGhostCells ()
	This method will remove any cell that is marked as ghost (has the vtkDataSetAttributes::DUPLICATECELL or the vtkDataSetAttributes::HIDDENCELL bit set).

vtkIdType *	GetFaces (vtkIdType cellId)
	Special support for polyhedron.

void	GetPolyhedronFaces (vtkIdType cellId, vtkCellArray *faces)
	Special support for polyhedron.

int	InitializeFacesRepresentation (vtkIdType numPrevCells)
	Special function used by vtkUnstructuredGridReader.

vtkMTimeType	GetMeshMTime () override
	Return the mesh (geometry/topology) modification time.

vtkIdTypeArray *	GetCellLocationsArray ()
	Get the array of all the starting indices of cell definitions in the cell array.


void	Reset ()
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

void	CopyStructure (vtkDataSet *ds) override
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

vtkIdType	GetNumberOfCells () override
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

vtkCell *	GetCell (vtkIdType cellId) override
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

void	GetCell (vtkIdType cellId, vtkGenericCell *cell) override
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

void	GetCellBounds (vtkIdType cellId, double bounds[6]) override
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

vtkCellIterator *	NewCellIterator () override
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

virtual vtkCell *	GetCell (vtkIdType cellId)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkCell *	GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
	Standard vtkDataSet methods; see vtkDataSet.h for documentation.

virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.


void	GetPointCells (vtkIdType ptId, vtkIdType &ncells, vtkIdType *&cells)
	Special (efficient) operation to return the list of cells using the specified point ptId.


int	GetMaxSpatialDimension () override
	Get the maximum/minimum spatial dimensionality of the data which is the maximum/minimum dimension of all cells.

int	GetMinSpatialDimension () override
	Get the maximum/minimum spatial dimensionality of the data which is the maximum/minimum dimension of all cells.


	vtkSetSmartPointerMacro (Links, vtkAbstractCellLinks)
	Set/Get the links that you created possibly without using BuildLinks.

	vtkGetSmartPointerMacro (Links, vtkAbstractCellLinks)
	Set/Get the links that you created possibly without using BuildLinks.


void	SetCells (int type, vtkCellArray *cells)
	Provide cell information to define the dataset.

void	SetCells (int types, vtkCellArray cells)
	Provide cell information to define the dataset.

void	SetCells (vtkUnsignedCharArray cellTypes, vtkCellArray cells)
	Provide cell information to define the dataset.

void	SetPolyhedralCells (vtkUnsignedCharArray cellTypes, vtkCellArray cells, vtkCellArray faceLocations, vtkCellArray faces)
	Provide cell information to define the dataset.

void	SetCells (vtkUnsignedCharArray cellTypes, vtkCellArray cells, vtkIdTypeArray faceLocations, vtkIdTypeArray faces)
	Provide cell information to define the dataset.


void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds) override
	A topological inquiry to retrieve all of the cells using list of points exclusive of the current cell specified (e.g., cellId).

void	GetCellNeighbors (vtkIdType cellId, vtkIdType npts, const vtkIdType ptIds, vtkIdList cellIds)
	A topological inquiry to retrieve all of the cells using list of points exclusive of the current cell specified (e.g., cellId).


bool	IsCellBoundary (vtkIdType cellId, vtkIdType npts, const vtkIdType *ptIds, vtkIdType &neighborCellId)
	A topological inquiry to determine whether a topological entity (e.g., point, edge, or face) defined by the point ids (ptIds of length npts) is a boundary entity of a specified cell (indicated by cellId).

bool	IsCellBoundary (vtkIdType cellId, vtkIdType npts, const vtkIdType *ptIds)
	A topological inquiry to determine whether a topological entity (e.g., point, edge, or face) defined by the point ids (ptIds of length npts) is a boundary entity of a specified cell (indicated by cellId).

bool	IsCellBoundary (vtkIdType cellId, vtkIdType npts, const vtkIdType ptIds, vtkIdList vtkNotUsed(cellIds))
	A topological inquiry to determine whether a topological entity (e.g., point, edge, or face) defined by the point ids (ptIds of length npts) is a boundary entity of a specified cell (indicated by cellId).


vtkIdType	InsertNextLinkedCell (int type, int npts, const vtkIdType pts[])
	Use these methods only if the dataset has been specified as Editable.

void	RemoveReferenceToCell (vtkIdType ptId, vtkIdType cellId)
	Use these methods only if the dataset has been specified as Editable.

void	AddReferenceToCell (vtkIdType ptId, vtkIdType cellId)
	Use these methods only if the dataset has been specified as Editable.

void	ResizeCellList (vtkIdType ptId, int size)
	Use these methods only if the dataset has been specified as Editable.


virtual int	GetPiece ()
	Set / Get the piece and the number of pieces.

virtual int	GetNumberOfPieces ()
	Set / Get the piece and the number of pieces.


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

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


vtkIdTypeArray *	GetFaces ()
	Get pointer to faces and facelocations.

vtkIdTypeArray *	GetFaceLocations ()
	Get pointer to faces and facelocations.

vtkCellArray *	GetPolyhedronFaces ()
	Get pointer to faces and facelocations for polyhedron cells.

vtkCellArray *	GetPolyhedronFaceLocations ()
	Get pointer to faces and facelocations.


void	SetCells (vtkUnsignedCharArray cellTypes, vtkIdTypeArray cellLocations, vtkCellArray *cells)
	Special methods specific to vtkUnstructuredGrid for defining the cells composing the dataset.

void	SetCells (vtkUnsignedCharArray cellTypes, vtkIdTypeArray cellLocations, vtkCellArray cells, vtkIdTypeArray faceLocations, vtkIdTypeArray *faces)
	Special methods specific to vtkUnstructuredGrid for defining the cells composing the dataset.

Public Member Functions inherited from vtkUnstructuredGridBase
	vtkAbstractTypeMacro (vtkUnstructuredGridBase, vtkPointSet)

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing.

int	GetDataObjectType () override
	Standard vtkDataSet API methods.

virtual void	Allocate (vtkIdType numCells=1000, int extSize=1000)=0
	Allocate memory for the number of cells indicated.

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

vtkIdType	InsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[])
	Insert/create cell in object by type and list of point ids defining cell topology.

vtkIdType	InsertNextCell (int type, vtkIdList *ptIds)
	Insert/create cell in object by a list of point ids defining cell topology.

vtkIdType	InsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[], vtkIdType nfaces, const vtkIdType faces[])

vtkIdType	InsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[], vtkCellArray *faces)

void	ReplaceCell (vtkIdType cellId, int npts, const vtkIdType pts[])
	Replace the points defining cell "cellId" with a new set of points.

virtual void	GetIdsOfCellsOfType (int type, vtkIdTypeArray *array)=0
	Fill vtkIdTypeArray container with list of cell Ids.

virtual int	IsHomogeneous ()=0
	Traverse cells and determine if cells are all of the same type.

Public Member Functions inherited from vtkPointSet
int	GetDataObjectType () override
	Standard vtkDataSet API methods.

void	Initialize () override
	Reset to an empty state and free any memory.

void	CopyStructure (vtkDataSet *pd) override
	Copy the geometric structure of an input point set object.

vtkCell *	GetCell (vtkIdType) override
	This method always return a `vtkEmptyCell`, as there is no cell in a `vtkPointSet`.

void	GetCell (vtkIdType, vtkGenericCell *cell) override
	This method sets cell to be an empty cell.

int	GetCellType (vtkIdType) override
	This method always returns `VTK_EMPTY_CELL`, as there is no cell in a `vtkPointSet`.

vtkIdType	GetCellSize (vtkIdType) override
	This method always returns 1, as all cells are point in a pure `vtkPointSet`.

double *	GetPoint (vtkIdType ptId) override
	See vtkDataSet for additional information.

vtkCellIterator *	NewCellIterator () override
	Return an iterator that traverses the cells in this data set.

void	BuildCellLocator ()
	Build the cell locator.

vtkMTimeType	GetMTime () override
	Get MTime which also considers its vtkPoints MTime.

void	ComputeBounds () override
	Compute the (X, Y, Z) bounds of the data.

void	Squeeze () override
	Reclaim any unused memory.

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).

virtual vtkCell *	GetCell (vtkIdType cellId)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkCell *	GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))

virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual void	SetEditable (bool)
	Specify whether this dataset is editable after creation.

virtual bool	GetEditable ()
	Specify whether this dataset is editable after creation.

virtual void	EditableOn ()
	Specify whether this dataset is editable after creation.

virtual void	EditableOff ()
	Specify whether this dataset is editable after creation.

vtkIdType	GetNumberOfPoints () override
	See vtkDataSet for additional information.

void	GetPoint (vtkIdType ptId, double x[3]) override
	See vtkDataSet for additional information.

vtkIdType	FindPoint (double x[3]) override
	See vtkDataSet for additional information.

vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights) override
	See vtkDataSet for additional information.

vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
	See vtkDataSet for additional information.

void	BuildPointLocator ()
	Build the internal point locator .

void	BuildLocator ()
	Build the internal point locator .

virtual void	SetPointLocator (vtkAbstractPointLocator *)
	Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods.

virtual vtkAbstractPointLocator *	GetPointLocator ()
	Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods.

virtual void	SetCellLocator (vtkAbstractCellLocator *)
	Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCell() operation.

virtual vtkAbstractCellLocator *	GetCellLocator ()
	Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCell() operation.

virtual void	SetPoints (vtkPoints *)
	Specify point array to define point coordinates.

vtkPoints *	GetPoints () override
	Specify point array to define point coordinates.

bool	UsesGarbageCollector () const override
	Overwritten to handle the data/locator loop.

vtkPointSet *	NewInstance () const
	Standard methods for type information and printing.

Public Member Functions inherited from vtkDataSet
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataSet *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	CopyStructure (vtkDataSet *ds)=0
	Copy the geometric and topological structure of an object.

virtual void	CopyAttributes (vtkDataSet *ds)
	Copy the attributes associated with the specified dataset to this instance of vtkDataSet.

virtual vtkIdType	GetNumberOfPoints ()=0
	Determine the number of points composing the dataset.

virtual vtkIdType	GetNumberOfCells ()=0
	Determine the number of cells composing the dataset.

virtual vtkPoints *	GetPoints ()
	If the subclass has (implicit/explicit) points, then return them.

virtual double *	GetPoint (vtkIdType ptId)=0
	Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.

virtual void	GetPoint (vtkIdType id, double x[3])
	Copy point coordinates into user provided array x[3] for specified point id.

virtual vtkCellIterator *	NewCellIterator ()
	Return an iterator that traverses the cells in this data set.

virtual vtkCell *	GetCell (vtkIdType cellId)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkCell *	GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))

void	SetCellOrderAndRationalWeights (vtkIdType cellId, vtkGenericCell *cell)

virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual void	GetCellBounds (vtkIdType cellId, double bounds[6])
	Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual int	GetCellType (vtkIdType cellId)=0
	Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkIdType	GetCellSize (vtkIdType cellId)
	Get the size of cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual void	GetCellTypes (vtkCellTypes *types)
	Get a list of types of cells in a dataset.

virtual void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0
	Topological inquiry to get points defining cell.

virtual void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const &pts, vtkIdList ptIds)
	Topological inquiry to get points defining cell.

virtual void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds)=0
	Topological inquiry to get cells using point.

virtual void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds)
	Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId).

int	GetCellNumberOfFaces (vtkIdType cellId, unsigned char &cellType, vtkGenericCell *cell)
	Get the number of faces of a cell.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)=0
	Locate cell based on global coordinate x and tolerance squared.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
	This is a version of the above method that can be used with multithreaded applications.

virtual vtkCell *	FindAndGetCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)
	Locate the cell that contains a point and return the cell.

vtkMTimeType	GetMTime () override
	Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.

vtkCellData *	GetCellData ()
	Return a pointer to this dataset's cell data.

vtkPointData *	GetPointData ()
	Return a pointer to this dataset's point data.

virtual void	Squeeze ()
	Reclaim any extra memory used to store data.

virtual void	ComputeBounds ()
	Compute the data bounding box from data points.

double *	GetBounds ()
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

void	GetBounds (double bounds[6])
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

double *	GetCenter ()
	Get the center of the bounding box.

void	GetCenter (double center[3])
	Get the center of the bounding box.

double	GetLength ()
	Return the length of the diagonal of the bounding box.

double	GetLength2 ()
	Return the squared length of the diagonal of the bounding box.

void	Initialize () override
	Restore data object to initial state.

virtual void	GetScalarRange (double range[2])
	Convenience method to get the range of the first component (and only the first component) of any scalars in the data set.

double *	GetScalarRange ()
	Convenience method to get the range of the first component (and only the first component) of any scalars in the data set.

virtual int	GetMaxCellSize ()=0
	Convenience method returns largest cell size in dataset.

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).

int	GetDataObjectType () override
	Return the type of data object.

int	CheckAttributes ()
	This method checks to see if the cell and point attributes match the geometry.

vtkFieldData *	GetAttributesAsFieldData (int type) override
	Returns the attributes of the data object as a vtkFieldData.

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

virtual vtkMTimeType	GetMeshMTime ()
	Abstract method which return the mesh (geometry/topology) modification time.

bool	HasAnyGhostCells ()
	Returns 1 if there are any ghost cells 0 otherwise.

bool	HasAnyGhostPoints ()
	Returns 1 if there are any ghost points 0 otherwise.

virtual bool	HasAnyBlankCells ()
	Returns 1 if there are any blanking cells 0 otherwise.

virtual bool	HasAnyBlankPoints ()
	Returns 1 if there are any blanking points 0 otherwise.

vtkUnsignedCharArray *	GetPointGhostArray ()
	Gets the array that defines the ghost type of each point.

void	UpdatePointGhostArrayCache ()
	Updates the pointer to the point ghost array.

vtkUnsignedCharArray *	AllocatePointGhostArray ()
	Allocate ghost array for points.

vtkUnsignedCharArray *	GetCellGhostArray ()
	Get the array that defines the ghost type of each cell.

void	UpdateCellGhostArrayCache ()
	Updates the pointer to the cell ghost array.

vtkUnsignedCharArray *	AllocateCellGhostArray ()
	Allocate ghost array for cells.

vtkUnsignedCharArray *	GetGhostArray (int type) override
	Returns the ghost array for the given type (point or cell).

bool	SupportsGhostArray (int type) override
	Returns true for POINT or CELL, false otherwise.

vtkIdType	FindPoint (double x, double y, double z)
	Locate the closest point to the global coordinate x.

virtual void	GenerateGhostArray (int zeroExt[6])
	Normally called by pipeline executives or algorithms only.

virtual void	GenerateGhostArray (int zeroExt[6], bool cellOnly)
	Normally called by pipeline executives or algorithms only.

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.

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.

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.

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

Static Public Member Functions
static vtkUnstructuredGrid *	New ()
	Standard instantiation method.

static vtkUnstructuredGrid *	ExtendedNew ()

static void	DecomposeAPolyhedronCell (vtkCellArray polyhedronCellArray, vtkIdType &nCellpts, vtkIdType &nCellfaces, vtkCellArray cellArray, vtkIdTypeArray *faces)
	A static method for converting a polyhedron vtkCellArray of format [nCellFaces, nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] into three components: (1) an integer indicating the number of faces (2) a standard vtkCellArray storing point ids [nCell0Pts, i, j, k] and (3) an vtkIdTypeArray storing face connectivity in format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] Note: input is assumed to contain only one polyhedron cell.

static void	DecomposeAPolyhedronCell (const vtkIdType polyhedronCellStream, vtkIdType &nCellpts, vtkIdType &nCellfaces, vtkCellArray cellArray, vtkIdTypeArray *faces)

static void	DecomposeAPolyhedronCell (vtkIdType nCellFaces, const vtkIdType inFaceStream, vtkIdType &nCellpts, vtkCellArray cellArray, vtkIdTypeArray *faces)
	A static method for converting an input polyhedron cell stream of format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] into three components: (1) an integer indicating the number of faces (2) a standard vtkCellArray storing point ids [nCell0Pts, i, j, k] and (3) an vtkIdTypeArray storing face connectivity in format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] Note: input is assumed to contain only one polyhedron cell.

static void	ConvertFaceStreamPointIds (vtkIdList faceStream, vtkIdType idMap)
	Convert pid in a face stream into idMap[pid].

static void	ConvertFaceStreamPointIds (vtkIdType nfaces, vtkIdType faceStream, vtkIdType idMap)
	Convert pid in a face stream into idMap[pid].

static void	ConvertFaceStreamPointIds (vtkCellArray faces, vtkIdType idMap)
	Convert pid in a face stream into idMap[pid].


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

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

Static Public Member Functions inherited from vtkUnstructuredGridBase
static vtkUnstructuredGridBase *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

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

Static Public Member Functions inherited from vtkPointSet
static vtkPointSet *	New ()
	Standard instantiation method.

static vtkPointSet *	ExtendedNew ()

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

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

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and printing.

static vtkPointSet *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing.

Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataSet *	SafeDownCast (vtkObjectBase *o)

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

static vtkDataSet *	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
	vtkUnstructuredGrid ()

	~vtkUnstructuredGrid () override

void	ReportReferences (vtkGarbageCollector *) override

vtkIdType	InternalInsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[]) override

vtkIdType	InternalInsertNextCell (int type, vtkIdList *ptIds) override

vtkIdType	InternalInsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[], vtkIdType nfaces, const vtkIdType faces[])

vtkIdType	InternalInsertNextCell (int type, vtkIdType npts, const vtkIdType pts[], vtkCellArray *faces) override

void	InternalReplaceCell (vtkIdType cellId, int npts, const vtkIdType pts[]) override

Protected Member Functions inherited from vtkUnstructuredGridBase
	vtkUnstructuredGridBase ()

	~vtkUnstructuredGridBase () override

virtual vtkIdType	InternalInsertNextCell (int type, vtkIdList *ptIds)=0

virtual vtkIdType	InternalInsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[])=0

virtual vtkIdType	InternalInsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[], vtkCellArray *faces)=0

virtual void	InternalReplaceCell (vtkIdType cellId, int npts, const vtkIdType pts[])=0

Protected Member Functions inherited from vtkPointSet
	vtkPointSet ()

	~vtkPointSet () override

void	ReportReferences (vtkGarbageCollector *) override

Protected Member Functions inherited from vtkDataSet
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataSet ()

	~vtkDataSet () override

vtkMTimeType	GetGhostCellsTime ()
	Return the MTime of the ghost cells array.

virtual void	ComputeScalarRange ()
	Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime).

Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBase *	NewInstanceInternal () 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 &)

Static Protected Member Functions
static void	DecomposeAPolyhedronCell (const vtkIdType cellStream, vtkIdType &numCellPts, vtkIdType &nCellFaces, vtkCellArray cellArray, vtkCellArray *faces)
	A static method for converting an input polyhedron cell stream of format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] into three components: (1) an integer indicating the number of faces (2) a standard vtkCellArray storing point ids [nCell0Pts, i, j, k] and (3) an vtkIdTypeArray storing face connectivity in format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] Note: input is assumed to contain only one polyhedron cell.

static void	DecomposeAPolyhedronCell (vtkIdType nCellFaces, const vtkIdType cellStream, vtkIdType &numCellPts, vtkCellArray cellArray, vtkCellArray *facesArray)

static void	DecomposeAPolyhedronCell (vtkCellArray polyhedronCell, vtkIdType &numCellPts, vtkIdType &nCellfaces, vtkCellArray cellArray, vtkCellArray *faces)

static void	DecomposeAPolyhedronCell (const vtkIdType cellStream, vtkIdType &numCellPts, vtkIdType &nCellFaces, vtkCellArray cellArray, vtkCellArray faces, vtkCellArray faceLocations)

static void	DecomposeAPolyhedronCell (vtkIdType nCellFaces, const vtkIdType cellStream, vtkIdType &numCellPts, vtkCellArray cellArray, vtkCellArray faces, vtkCellArray faceLocations)

static int	CopyPolyhedronToFaceStream (vtkCellArray faceArray, vtkCellArray faceLocationArray, vtkIdTypeArray faceStream, vtkIdTypeArray faceLocation)
	Backward compatibility function to convert new polyhedron storage to legacy.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkSmartPointer< vtkCellArray >	Connectivity

vtkSmartPointer< vtkAbstractCellLinks >	Links

vtkSmartPointer< vtkUnsignedCharArray >	Types

vtkSmartPointer< vtkCellTypes >	DistinctCellTypes

vtkMTimeType	DistinctCellTypesUpdateMTime

vtkSmartPointer< vtkCellArray >	Faces
	Special support for polyhedra/cells with explicit face representations.

vtkSmartPointer< vtkCellArray >	FaceLocations

vtkSmartPointer< vtkIdTypeArray >	CellLocations

vtkSmartPointer< vtkIdTypeArray >	LegacyFaces
	Legacy support – stores the old-style Faces && FaceLocations Special support for polyhedra/cells with explicit face representations.

vtkSmartPointer< vtkIdTypeArray >	LegacyFaceLocations

vtkSmartPointer< vtkIdList >	LegacyPointIdsBuffer
	Legacy backward compatibility for GetFaceStream This member should be removed simultaneously with the deprecated GetFaceStream.

Protected Attributes inherited from vtkPointSet
bool	Editable

vtkPoints *	Points

vtkAbstractPointLocator *	PointLocator

vtkAbstractCellLocator *	CellLocator

Protected Attributes inherited from vtkDataSet
vtkNew< vtkGenericCell >	GenericCell

vtkCellData *	CellData

vtkPointData *	PointData

vtkCallbackCommand *	DataObserver

vtkTimeStamp	ComputeTime

double	Bounds [6]

double	Center [3]

double	ScalarRange [2]

vtkTimeStamp	ScalarRangeComputeTime

vtkUnsignedCharArray *	PointGhostArray
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))

vtkUnsignedCharArray *	CellGhostArray
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))

bool	PointGhostArrayCached
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))

bool	CellGhostArrayCached
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))

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

typedef vtkUnstructuredGridBase	Superclass
	Standard methods for type information and printing.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and printing.

static vtkUnstructuredGrid *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type information and printing.

vtkUnstructuredGrid *	NewInstance () const
	Standard methods for type information and printing.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for type information and printing.

Additional Inherited Members
Public Types inherited from vtkPointSet
typedef vtkDataSet	Superclass
	Standard methods for type information and printing.

Public Types inherited from vtkDataSet
enum	FieldDataType { DATA_OBJECT_FIELD = 0 , POINT_DATA_FIELD = 1 , CELL_DATA_FIELD = 2 }

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

Detailed Description

dataset represents arbitrary combinations of all possible cell types

vtkUnstructuredGrid is a data object that is a concrete implementation of vtkDataSet. vtkUnstructuredGrid represents any combinations of any cell types. This includes 0D (e.g., points), 1D (e.g., lines, polylines), 2D (e.g., triangles, polygons), and 3D (e.g., hexahedron, tetrahedron, polyhedron, etc.). vtkUnstructuredGrid provides random access to cells, as well as topological information (such as lists of cells using each point).

Examples:: vtkUnstructuredGrid (Examples)

Online Examples:

CellTypeSource

Pyramid

MoveAVertexUnstructuredGrid

TissueLens

InterpolateFieldDataDemo

Finance

CellsInsideObject

ExtractSelectionOriginalId

GeometryFilter

StructuredPointsToUnstructuredGrid

Tests:: vtkUnstructuredGrid (Tests)

Definition at line 150 of file vtkUnstructuredGrid.h.

Member Typedef Documentation

◆ Superclass

typedef vtkUnstructuredGridBase vtkUnstructuredGrid::Superclass

Standard methods for type information and printing.

Definition at line 164 of file vtkUnstructuredGrid.h.

Constructor & Destructor Documentation

◆ vtkUnstructuredGrid()

vtkUnstructuredGrid::vtkUnstructuredGrid ( )

protected

◆ ~vtkUnstructuredGrid()

vtkUnstructuredGrid::~vtkUnstructuredGrid ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkUnstructuredGrid * vtkUnstructuredGrid::New ( )

static

Standard instantiation method.

◆ ExtendedNew()

static vtkUnstructuredGrid * vtkUnstructuredGrid::ExtendedNew ( )

static

◆ IsTypeOf()

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

static

Standard methods for type information and printing.

◆ IsA()

virtual vtkTypeBool vtkUnstructuredGrid::IsA ( const char * type )

virtual

Standard methods for type information and printing.

Reimplemented from vtkPointSet.

◆ SafeDownCast()

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

static

Standard methods for type information and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkUnstructuredGrid::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and printing.

Reimplemented from vtkPointSet.

◆ NewInstance()

vtkUnstructuredGrid * vtkUnstructuredGrid::NewInstance ( ) const

Standard methods for type information and printing.

◆ PrintSelf()

void vtkUnstructuredGrid::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard methods for type information and printing.

Reimplemented from vtkPointSet.

◆ GetDataObjectType()

int vtkUnstructuredGrid::GetDataObjectType ( )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkPointSet.

Definition at line 171 of file vtkUnstructuredGrid.h.

◆ AllocateEstimate()

bool vtkUnstructuredGrid::AllocateEstimate	(	vtkIdType	numCells,
		vtkIdType	maxCellSize
	)

inline

Pre-allocate memory in internal data structures.

Does not change the number of cells, only the array capacities. Existing data is NOT preserved.

Parameters

numCells	The number of expected cells in the dataset.
maxCellSize	The number of points per cell to allocate memory for.

Returns: True if allocation succeeds.

See also: Squeeze();

Definition at line 182 of file vtkUnstructuredGrid.h.

◆ AllocateExact()

bool vtkUnstructuredGrid::AllocateExact	(	vtkIdType	numCells,
		vtkIdType	connectivitySize
	)

Pre-allocate memory in internal data structures.

Does not change the number of cells, only the array capacities. Existing data is NOT preserved.

Parameters

numCells	The number of expected cells in the dataset.
connectivitySize	The total number of pointIds stored for all cells.

Returns: True if allocation succeeds.

See also: Squeeze();

◆ Allocate()

void vtkUnstructuredGrid::Allocate	(	vtkIdType	numCells = `1000`,
		int	vtkNotUsedextSize = `1000`
	)

inlineoverride

Method allocates initial storage for the cell connectivity.

Use this method before the method InsertNextCell(). The array capacity is doubled when the inserting a cell exceeds the current capacity. extSize is no longer used.

Note: Prefer AllocateExact or AllocateEstimate, which give more control over how allocations are distributed.

Definition at line 207 of file vtkUnstructuredGrid.h.

◆ Reset()

void vtkUnstructuredGrid::Reset ( )

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

◆ CopyStructure()

void vtkUnstructuredGrid::CopyStructure ( vtkDataSet * ds )

overridevirtual

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

Reimplemented from vtkPointSet.

◆ GetNumberOfCells()

vtkIdType vtkUnstructuredGrid::GetNumberOfCells ( )

overridevirtual

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

Reimplemented from vtkPointSet.

◆ GetCell() [1/5]

vtkCell * vtkUnstructuredGrid::GetCell ( vtkIdType cellId )

overridevirtual

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

Reimplemented from vtkPointSet.

◆ GetCell() [2/5]

void vtkUnstructuredGrid::GetCell	(	vtkIdType	cellId,
		vtkGenericCell *	cell
	)

overridevirtual

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

Reimplemented from vtkPointSet.

◆ GetCellBounds()

void vtkUnstructuredGrid::GetCellBounds	(	vtkIdType	cellId,
		double	bounds[6]
	)

overridevirtual

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

Reimplemented from vtkDataSet.

◆ GetCellPoints() [1/3]

void vtkUnstructuredGrid::GetCellPoints	(	vtkIdType	cellId,
		vtkIdList *	ptIds
	)

overridevirtual

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

Reimplemented from vtkPointSet.

◆ GetPointCells() [1/2]

void vtkUnstructuredGrid::GetPointCells	(	vtkIdType	ptId,
		vtkIdList *	cellIds
	)

overridevirtual

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

Reimplemented from vtkPointSet.

◆ NewCellIterator()

vtkCellIterator * vtkUnstructuredGrid::NewCellIterator ( )

overridevirtual

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

Reimplemented from vtkPointSet.

◆ GetCellType()

int vtkUnstructuredGrid::GetCellType ( vtkIdType cellId )

overridevirtual

Get the type of the cell with the given cellId.

Reimplemented from vtkPointSet.

◆ GetCellSize()

vtkIdType vtkUnstructuredGrid::GetCellSize ( vtkIdType cellId )

overridevirtual

Get the size of the cell with given cellId.

Reimplemented from vtkPointSet.

◆ GetCellTypes()

void vtkUnstructuredGrid::GetCellTypes ( vtkCellTypes * types )

overridevirtual

Get a list of types of cells in a dataset.

The list consists of an array of types (not necessarily in any order), with a single entry per type. For example a dataset with 5 triangles, 3 lines, and 100 hexahedra would result in a list of three entries, corresponding to the types VTK_TRIANGLE, VTK_LINE, and VTK_HEXAHEDRON. This override implements an optimization that recomputes cell types only when the types of cells may have changed.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

◆ GetDistinctCellTypesArray()

vtkUnsignedCharArray * vtkUnstructuredGrid::GetDistinctCellTypesArray ( )

Get a list of types of cells in a dataset.

The list consists of an array of types (not necessarily in any order), with a single entry per type. For example a dataset with 5 triangles, 3 lines, and 100 hexahedra would result in a list of three entries, corresponding to the types VTK_TRIANGLE, VTK_LINE, and VTK_HEXAHEDRON. This override implements an optimization that recomputes cell types only when the types of cells may have changed. This method never returns nullptr.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

◆ GetCellPoints() [2/3]

void vtkUnstructuredGrid::GetCellPoints	(	vtkIdType	cellId,
		vtkIdType &	npts,
		vtkIdType const *&	pts
	)

inline

A higher-performing variant of the virtual vtkDataSet::GetCellPoints() for unstructured grids.

Given a cellId, return the number of defining points and the list of points defining the cell.

Warning: Subsequent calls to this method may invalidate previous call results.

The pts pointer must not be modified.

Note: This method MAY NOT be thread-safe. (See GetCellAtId at vtkCellArray)

Definition at line 277 of file vtkUnstructuredGrid.h.

◆ GetCellPoints() [3/3]

void vtkUnstructuredGrid::GetCellPoints	(	vtkIdType	cellId,
		vtkIdType &	npts,
		vtkIdType const *&	pts,
		vtkIdList *	ptIds
	)

inlineoverridevirtual

A higher-performing variant of the virtual vtkDataSet::GetCellPoints() for unstructured grids.

Given a cellId, return the number of defining points and the list of points defining the cell.

This function MAY use ptIds, which is an object that is created by each thread, to guarantee thread safety.

Warning: Subsequent calls to this method may invalidate previous call results.

The pts pointer must not be modified.

Note: This method is thread-safe.

Reimplemented from vtkPointSet.

Definition at line 297 of file vtkUnstructuredGrid.h.

◆ GetPointCells() [2/2]

void vtkUnstructuredGrid::GetPointCells	(	vtkIdType	ptId,
		vtkIdType &	ncells,
		vtkIdType *&	cells
	)

Special (efficient) operation to return the list of cells using the specified point ptId.

Use carefully (i.e., make sure that BuildLinks() has been called).

◆ GetCellTypesArray()

vtkUnsignedCharArray * vtkUnstructuredGrid::GetCellTypesArray ( )

Get the array of all cell types in the grid.

Each single-component tuple in the array at an index that corresponds to the type of the cell with the same index. To get an array of only the distinct cell types in the dataset, use GetCellTypes().

◆ Squeeze()

void vtkUnstructuredGrid::Squeeze ( )

overridevirtual

Squeeze all arrays in the grid to conserve memory.

Reimplemented from vtkPointSet.

◆ Initialize()

void vtkUnstructuredGrid::Initialize ( )

overridevirtual

Reset the grid to an empty state and free any memory.

Reimplemented from vtkPointSet.

◆ GetMaxCellSize()

int vtkUnstructuredGrid::GetMaxCellSize ( )

overridevirtual

Get the size, in number of points, of the largest cell.

Reimplemented from vtkPointSet.

◆ GetMaxSpatialDimension()

int vtkUnstructuredGrid::GetMaxSpatialDimension ( )

overridevirtual

Get the maximum/minimum spatial dimensionality of the data which is the maximum/minimum dimension of all cells.

Reimplemented from vtkDataSet.

◆ GetMinSpatialDimension()

int vtkUnstructuredGrid::GetMinSpatialDimension ( )

overridevirtual

Get the maximum/minimum spatial dimensionality of the data which is the maximum/minimum dimension of all cells.

Reimplemented from vtkDataSet.

◆ BuildLinks()

void vtkUnstructuredGrid::BuildLinks ( )

Build topological links from points to lists of cells that use each point.

See vtkAbstractCellLinks for more information.

◆ vtkSetSmartPointerMacro()

vtkUnstructuredGrid::vtkSetSmartPointerMacro	(	Links	,
		vtkAbstractCellLinks
	)

Set/Get the links that you created possibly without using BuildLinks.

◆ vtkGetSmartPointerMacro()

vtkUnstructuredGrid::vtkGetSmartPointerMacro	(	Links	,
		vtkAbstractCellLinks
	)

Set/Get the links that you created possibly without using BuildLinks.

◆ GetCellLinks()

vtkAbstractCellLinks * vtkUnstructuredGrid::GetCellLinks ( )

Get the cell links.

The cell links will be one of nullptr=0; vtkCellLinks=1; vtkStaticCellLinksTemplate<VTK_UNSIGNED_SHORT>=2; vtkStaticCellLinksTemplate<VTK_UNSIGNED_INT>=3; vtkStaticCellLinksTemplate<VTK_ID_TYPE>=4. (See enum types defined in vtkAbstractCellLinks.)

◆ GetFaceStream() [1/2]

void vtkUnstructuredGrid::GetFaceStream	(	vtkIdType	cellId,
		vtkIdList *	ptIds
	)

Get the face stream of a polyhedron cell in the following format: (numCellFaces, numFace0Pts, id1, id2, id3, numFace1Pts,id1, id2, id3, ...).

If the requested cell is not a polyhedron, then the standard GetCellPoints is called to return a list of unique point ids (id1, id2, id3, ...). This function is threadsafe.

◆ GetFaceStream() [2/2]

void vtkUnstructuredGrid::GetFaceStream	(	vtkIdType	cellId,
		vtkIdType &	nfaces,
		vtkIdType const *&	ptIds
	)

Get the number of faces and the face stream of a polyhedral cell.

The output ptIds has the following format: (numFace0Pts, id1, id2, id3, numFace1Pts,id1, id2, id3, ...). If the requested cell is not a polyhedron, then the standard GetCellPoints is called to return the number of points and a list of unique point ids (id1, id2, id3, ...). This function is NOT THREADSAFE.

◆ SetCells() [1/6]

void vtkUnstructuredGrid::SetCells	(	int	type,
		vtkCellArray *	cells
	)

Provide cell information to define the dataset.

Cells like vtkPolyhedron require points plus a list of faces. To handle vtkPolyhedron, use SetPolyhedralCells() SetPolyhedralCells requires a faces vtkCellArray that will describe the faces use by the polyhedral cells. SetPolyhedralCells also requires a faceLocations vtkCellArray to fully describe a polyhedron cell The faceLocations is a collection of face ids pointing to the faces vtkCellArray.

◆ SetCells() [2/6]

void vtkUnstructuredGrid::SetCells	(	int *	types,
		vtkCellArray *	cells
	)

Provide cell information to define the dataset.

Cells like vtkPolyhedron require points plus a list of faces. To handle vtkPolyhedron, use SetPolyhedralCells() SetPolyhedralCells requires a faces vtkCellArray that will describe the faces use by the polyhedral cells. SetPolyhedralCells also requires a faceLocations vtkCellArray to fully describe a polyhedron cell The faceLocations is a collection of face ids pointing to the faces vtkCellArray.

◆ SetCells() [3/6]

void vtkUnstructuredGrid::SetCells	(	vtkUnsignedCharArray *	cellTypes,
		vtkCellArray *	cells
	)

Provide cell information to define the dataset.

Cells like vtkPolyhedron require points plus a list of faces. To handle vtkPolyhedron, use SetPolyhedralCells() SetPolyhedralCells requires a faces vtkCellArray that will describe the faces use by the polyhedral cells. SetPolyhedralCells also requires a faceLocations vtkCellArray to fully describe a polyhedron cell The faceLocations is a collection of face ids pointing to the faces vtkCellArray.

◆ SetPolyhedralCells()

void vtkUnstructuredGrid::SetPolyhedralCells	(	vtkUnsignedCharArray *	cellTypes,
		vtkCellArray *	cells,
		vtkCellArray *	faceLocations,
		vtkCellArray *	faces
	)

Provide cell information to define the dataset.

Cells like vtkPolyhedron require points plus a list of faces. To handle vtkPolyhedron, use SetPolyhedralCells() SetPolyhedralCells requires a faces vtkCellArray that will describe the faces use by the polyhedral cells. SetPolyhedralCells also requires a faceLocations vtkCellArray to fully describe a polyhedron cell The faceLocations is a collection of face ids pointing to the faces vtkCellArray.

◆ SetCells() [4/6]

void vtkUnstructuredGrid::SetCells	(	vtkUnsignedCharArray *	cellTypes,
		vtkCellArray *	cells,
		vtkIdTypeArray *	faceLocations,
		vtkIdTypeArray *	faces
	)

Provide cell information to define the dataset.

Cells like vtkPolyhedron require points plus a list of faces. To handle vtkPolyhedron, use SetPolyhedralCells() SetPolyhedralCells requires a faces vtkCellArray that will describe the faces use by the polyhedral cells. SetPolyhedralCells also requires a faceLocations vtkCellArray to fully describe a polyhedron cell The faceLocations is a collection of face ids pointing to the faces vtkCellArray.

◆ GetCells()

vtkCellArray * vtkUnstructuredGrid::GetCells ( )

inline

Return the unstructured grid connectivity array.

Definition at line 414 of file vtkUnstructuredGrid.h.

◆ GetCellNeighbors() [1/2]

void vtkUnstructuredGrid::GetCellNeighbors	(	vtkIdType	cellId,
		vtkIdList *	ptIds,
		vtkIdList *	cellIds
	)

inlineoverridevirtual

A topological inquiry to retrieve all of the cells using list of points exclusive of the current cell specified (e.g., cellId).

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

Reimplemented from vtkDataSet.

Definition at line 423 of file vtkUnstructuredGrid.h.

◆ GetCellNeighbors() [2/2]

void vtkUnstructuredGrid::GetCellNeighbors	(	vtkIdType	cellId,
		vtkIdType	npts,
		const vtkIdType *	ptIds,
		vtkIdList *	cellIds
	)

A topological inquiry to retrieve all of the cells using list of points exclusive of the current cell specified (e.g., cellId).

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

◆ IsCellBoundary() [1/3]

bool vtkUnstructuredGrid::IsCellBoundary	(	vtkIdType	cellId,
		vtkIdType	npts,
		const vtkIdType *	ptIds,
		vtkIdType &	neighborCellId
	)

A topological inquiry to determine whether a topological entity (e.g., point, edge, or face) defined by the point ids (ptIds of length npts) is a boundary entity of a specified cell (indicated by cellId).

A boundary entity is a topological feature used by exactly one cell. This method is related to GetCellNeighbors() except that it simply indicates whether a topological feature is boundary - hence the method is faster. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

◆ IsCellBoundary() [2/3]

bool vtkUnstructuredGrid::IsCellBoundary	(	vtkIdType	cellId,
		vtkIdType	npts,
		const vtkIdType *	ptIds
	)

inline

A topological inquiry to determine whether a topological entity (e.g., point, edge, or face) defined by the point ids (ptIds of length npts) is a boundary entity of a specified cell (indicated by cellId).

A boundary entity is a topological feature used by exactly one cell. This method is related to GetCellNeighbors() except that it simply indicates whether a topological feature is boundary - hence the method is faster. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

Definition at line 444 of file vtkUnstructuredGrid.h.

◆ IsCellBoundary() [3/3]

bool vtkUnstructuredGrid::IsCellBoundary	(	vtkIdType	cellId,
		vtkIdType	npts,
		const vtkIdType *	ptIds,
		vtkIdList *	vtkNotUsedcellIds
	)

inline

A topological inquiry to determine whether a topological entity (e.g., point, edge, or face) defined by the point ids (ptIds of length npts) is a boundary entity of a specified cell (indicated by cellId).

A boundary entity is a topological feature used by exactly one cell. This method is related to GetCellNeighbors() except that it simply indicates whether a topological feature is boundary - hence the method is faster. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

Definition at line 450 of file vtkUnstructuredGrid.h.

◆ InsertNextLinkedCell()

vtkIdType vtkUnstructuredGrid::InsertNextLinkedCell	(	int	type,
		int	npts,
		const vtkIdType	pts[]
	)

Use these methods only if the dataset has been specified as Editable.

See vtkPointSet for more information.

◆ RemoveReferenceToCell()

void vtkUnstructuredGrid::RemoveReferenceToCell	(	vtkIdType	ptId,
		vtkIdType	cellId
	)

Use these methods only if the dataset has been specified as Editable.

See vtkPointSet for more information.

◆ AddReferenceToCell()

void vtkUnstructuredGrid::AddReferenceToCell	(	vtkIdType	ptId,
		vtkIdType	cellId
	)

Use these methods only if the dataset has been specified as Editable.

See vtkPointSet for more information.

◆ ResizeCellList()

void vtkUnstructuredGrid::ResizeCellList	(	vtkIdType	ptId,
		int	size
	)

Use these methods only if the dataset has been specified as Editable.

See vtkPointSet for more information.

◆ GetPiece()

virtual int vtkUnstructuredGrid::GetPiece ( )

virtual

Set / Get the piece and the number of pieces.

Similar to extent in 3D.

◆ GetNumberOfPieces()

virtual int vtkUnstructuredGrid::GetNumberOfPieces ( )

virtual

Set / Get the piece and the number of pieces.

Similar to extent in 3D.

◆ GetGhostLevel()

virtual int vtkUnstructuredGrid::GetGhostLevel ( )

virtual

Get the ghost level.

◆ GetActualMemorySize()

unsigned long vtkUnstructuredGrid::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). THIS METHOD IS THREAD SAFE.

Reimplemented from vtkPointSet.

◆ ShallowCopy()

void vtkUnstructuredGrid::ShallowCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

Reimplemented from vtkPointSet.

◆ DeepCopy()

void vtkUnstructuredGrid::DeepCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

Reimplemented from vtkPointSet.

◆ GetIdsOfCellsOfType()

void vtkUnstructuredGrid::GetIdsOfCellsOfType	(	int	type,
		vtkIdTypeArray *	array
	)

overridevirtual

Fill vtkIdTypeArray container with list of cell Ids.

This method traverses all cells and, for a particular cell type, inserts the cell Id into the container.

Implements vtkUnstructuredGridBase.

◆ IsHomogeneous()

int vtkUnstructuredGrid::IsHomogeneous ( )

overridevirtual

Returns whether cells are all of the same type.

Implements vtkUnstructuredGridBase.

◆ RemoveGhostCells()

void vtkUnstructuredGrid::RemoveGhostCells ( )

This method will remove any cell that is marked as ghost (has the vtkDataSetAttributes::DUPLICATECELL or the vtkDataSetAttributes::HIDDENCELL bit set).

◆ GetData() [1/2]

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

static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

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

static

Retrieve an instance of this class from an information object.

◆ GetFaces() [1/2]

vtkIdType * vtkUnstructuredGrid::GetFaces ( vtkIdType cellId )

Special support for polyhedron.

Return nullptr for all other cell types.

◆ GetPolyhedronFaces() [1/2]

void vtkUnstructuredGrid::GetPolyhedronFaces	(	vtkIdType	cellId,
		vtkCellArray *	faces
	)

Special support for polyhedron.

Do not handle all other cell types.

◆ GetFaces() [2/2]

vtkIdTypeArray * vtkUnstructuredGrid::GetFaces ( )

Get pointer to faces and facelocations.

Support for polyhedron cells. Use an internal cache to handle legacy layout

◆ GetFaceLocations()

vtkIdTypeArray * vtkUnstructuredGrid::GetFaceLocations ( )

Get pointer to faces and facelocations.

Support for polyhedron cells. Use an internal cache to handle legacy layout

◆ GetPolyhedronFaces() [2/2]

vtkCellArray * vtkUnstructuredGrid::GetPolyhedronFaces ( )

Get pointer to faces and facelocations for polyhedron cells.

This is a direct access to internal vtkCellArray structures without any copy.

◆ GetPolyhedronFaceLocations()

vtkCellArray * vtkUnstructuredGrid::GetPolyhedronFaceLocations ( )

Get pointer to faces and facelocations.

Support for polyhedron cells. Use an internal cache to handle legacy layout

◆ InitializeFacesRepresentation()

int vtkUnstructuredGrid::InitializeFacesRepresentation ( vtkIdType numPrevCells )

Special function used by vtkUnstructuredGridReader.

By default vtkUnstructuredGrid does not contain face information, which is only used by polyhedron cells. If so far no polyhedron cells have been added, Faces and FaceLocations pointers will be nullptr. In this case, need to initialize the arrays and assign values to the previous non-polyhedron cells.

◆ GetMeshMTime()

vtkMTimeType vtkUnstructuredGrid::GetMeshMTime ( )

overridevirtual

Return the mesh (geometry/topology) modification time.

This time is different from the usual MTime which also takes into account the modification of data arrays. This function can be used to track the changes on the mesh separately from the data arrays (eg. static mesh over time with transient data).

Reimplemented from vtkDataSet.

◆ DecomposeAPolyhedronCell() [1/8]

static void vtkUnstructuredGrid::DecomposeAPolyhedronCell	(	vtkCellArray *	polyhedronCellArray,
		vtkIdType &	nCellpts,
		vtkIdType &	nCellfaces,
		vtkCellArray *	cellArray,
		vtkIdTypeArray *	faces
	)

static

A static method for converting a polyhedron vtkCellArray of format [nCellFaces, nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] into three components: (1) an integer indicating the number of faces (2) a standard vtkCellArray storing point ids [nCell0Pts, i, j, k] and (3) an vtkIdTypeArray storing face connectivity in format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] Note: input is assumed to contain only one polyhedron cell.

Outputs (2) and (3) will be stacked at the end of the input cellArray and faces. The original data in the input will not be touched.

◆ DecomposeAPolyhedronCell() [2/8]

static void vtkUnstructuredGrid::DecomposeAPolyhedronCell	(	const vtkIdType *	polyhedronCellStream,
		vtkIdType &	nCellpts,
		vtkIdType &	nCellfaces,
		vtkCellArray *	cellArray,
		vtkIdTypeArray *	faces
	)

static

◆ DecomposeAPolyhedronCell() [3/8]

static void vtkUnstructuredGrid::DecomposeAPolyhedronCell	(	vtkIdType	nCellFaces,
		const vtkIdType *	inFaceStream,
		vtkIdType &	nCellpts,
		vtkCellArray *	cellArray,
		vtkIdTypeArray *	faces
	)

static

A static method for converting an input polyhedron cell stream of format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] into three components: (1) an integer indicating the number of faces (2) a standard vtkCellArray storing point ids [nCell0Pts, i, j, k] and (3) an vtkIdTypeArray storing face connectivity in format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] Note: input is assumed to contain only one polyhedron cell.

Outputs (2) and (3) will be stacked at the end of the input cellArray and faces. The original data in the input will not be touched.

◆ ConvertFaceStreamPointIds() [1/3]

static void vtkUnstructuredGrid::ConvertFaceStreamPointIds	(	vtkIdList *	faceStream,
		vtkIdType *	idMap
	)

static

Convert pid in a face stream into idMap[pid].

The face stream is of format [nCellFaces, nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...]. The user is responsible to make sure all the Ids in faceStream do not exceed the range of idMap.

◆ ConvertFaceStreamPointIds() [2/3]

static void vtkUnstructuredGrid::ConvertFaceStreamPointIds	(	vtkIdType	nfaces,
		vtkIdType *	faceStream,
		vtkIdType *	idMap
	)

static

Convert pid in a face stream into idMap[pid].

The face stream is of format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...]. The user is responsible to make sure all the Ids in faceStream do not exceed the range of idMap.

◆ ConvertFaceStreamPointIds() [3/3]

static void vtkUnstructuredGrid::ConvertFaceStreamPointIds	(	vtkCellArray *	faces,
		vtkIdType *	idMap
	)

static

Convert pid in a face stream into idMap[pid].

The face stream is of format vtkCellArray. The user is responsible to make sure all the Ids in faceStream do not exceed the range of idMap.

◆ GetCellLocationsArray()

vtkIdTypeArray * vtkUnstructuredGrid::GetCellLocationsArray ( )

Get the array of all the starting indices of cell definitions in the cell array.

Warning: vtkCellArray supports random access now. This array is no longer used.

◆ SetCells() [5/6]

void vtkUnstructuredGrid::SetCells	(	vtkUnsignedCharArray *	cellTypes,
		vtkIdTypeArray *	cellLocations,
		vtkCellArray *	cells
	)

Special methods specific to vtkUnstructuredGrid for defining the cells composing the dataset.

Most cells require just arrays of cellTypes, cellLocations and cellConnectivities which implicitly define the set of points in each cell and their ordering. In those cases the cellConnectivities are of the format (numFace0Pts, id1, id2, id3, numFace1Pts, id1, id2, id3...). However, some cells like vtkPolyhedron require points plus a list of faces. To handle vtkPolyhedron, SetCells() support a special input cellConnectivities format (numCellFaces, numFace0Pts, id1, id2, id3, numFace1Pts,id1, id2, id3, ...) The functions use vtkPolyhedron::DecomposeAPolyhedronCell() to convert polyhedron cells into standard format.

Warning: The cellLocations array is no longer used; this information is stored in vtkCellArray. Use the other SetCells overloads.

◆ SetCells() [6/6]

void vtkUnstructuredGrid::SetCells	(	vtkUnsignedCharArray *	cellTypes,
		vtkIdTypeArray *	cellLocations,
		vtkCellArray *	cells,
		vtkIdTypeArray *	faceLocations,
		vtkIdTypeArray *	faces
	)

Special methods specific to vtkUnstructuredGrid for defining the cells composing the dataset.

Most cells require just arrays of cellTypes, cellLocations and cellConnectivities which implicitly define the set of points in each cell and their ordering. In those cases the cellConnectivities are of the format (numFace0Pts, id1, id2, id3, numFace1Pts, id1, id2, id3...). However, some cells like vtkPolyhedron require points plus a list of faces. To handle vtkPolyhedron, SetCells() support a special input cellConnectivities format (numCellFaces, numFace0Pts, id1, id2, id3, numFace1Pts,id1, id2, id3, ...) The functions use vtkPolyhedron::DecomposeAPolyhedronCell() to convert polyhedron cells into standard format.

Warning: The cellLocations array is no longer used; this information is stored in vtkCellArray. Use the other SetCells overloads.

◆ ReportReferences()

void vtkUnstructuredGrid::ReportReferences ( vtkGarbageCollector * )

overrideprotectedvirtual

Reimplemented from vtkPointSet.

◆ InternalInsertNextCell() [1/4]

vtkIdType vtkUnstructuredGrid::InternalInsertNextCell	(	int	type,
		vtkIdType	npts,
		const vtkIdType	ptIds[]
	)

overrideprotectedvirtual

Implements vtkUnstructuredGridBase.

◆ InternalInsertNextCell() [2/4]

vtkIdType vtkUnstructuredGrid::InternalInsertNextCell	(	int	type,
		vtkIdList *	ptIds
	)

overrideprotectedvirtual

Implements vtkUnstructuredGridBase.

◆ InternalInsertNextCell() [3/4]

vtkIdType vtkUnstructuredGrid::InternalInsertNextCell	(	int	type,
		vtkIdType	npts,
		const vtkIdType	ptIds[],
		vtkIdType	nfaces,
		const vtkIdType	faces[]
	)

protected

◆ InternalInsertNextCell() [4/4]

vtkIdType vtkUnstructuredGrid::InternalInsertNextCell	(	int	type,
		vtkIdType	npts,
		const vtkIdType	pts[],
		vtkCellArray *	faces
	)

overrideprotectedvirtual

Implements vtkUnstructuredGridBase.

◆ InternalReplaceCell()

void vtkUnstructuredGrid::InternalReplaceCell	(	vtkIdType	cellId,
		int	npts,
		const vtkIdType	pts[]
	)

overrideprotectedvirtual

Implements vtkUnstructuredGridBase.

◆ DecomposeAPolyhedronCell() [4/8]

static void vtkUnstructuredGrid::DecomposeAPolyhedronCell	(	const vtkIdType *	cellStream,
		vtkIdType &	numCellPts,
		vtkIdType &	nCellFaces,
		vtkCellArray *	cellArray,
		vtkCellArray *	faces
	)

staticprotected

A static method for converting an input polyhedron cell stream of format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] into three components: (1) an integer indicating the number of faces (2) a standard vtkCellArray storing point ids [nCell0Pts, i, j, k] and (3) an vtkIdTypeArray storing face connectivity in format [nFace0Pts, i, j, k, nFace1Pts, i, j, k, ...] Note: input is assumed to contain only one polyhedron cell.

Outputs (2) and (3) will be stacked at the end of the input cellArray and faces. The original data in the input will not be touched.

◆ DecomposeAPolyhedronCell() [5/8]

static void vtkUnstructuredGrid::DecomposeAPolyhedronCell	(	vtkIdType	nCellFaces,
		const vtkIdType *	cellStream,
		vtkIdType &	numCellPts,
		vtkCellArray *	cellArray,
		vtkCellArray *	facesArray
	)

staticprotected

◆ DecomposeAPolyhedronCell() [6/8]

static void vtkUnstructuredGrid::DecomposeAPolyhedronCell	(	vtkCellArray *	polyhedronCell,
		vtkIdType &	numCellPts,
		vtkIdType &	nCellfaces,
		vtkCellArray *	cellArray,
		vtkCellArray *	faces
	)

staticprotected

◆ DecomposeAPolyhedronCell() [7/8]

static void vtkUnstructuredGrid::DecomposeAPolyhedronCell	(	const vtkIdType *	cellStream,
		vtkIdType &	numCellPts,
		vtkIdType &	nCellFaces,
		vtkCellArray *	cellArray,
		vtkCellArray *	faces,
		vtkCellArray *	faceLocations
	)

staticprotected

◆ DecomposeAPolyhedronCell() [8/8]

static void vtkUnstructuredGrid::DecomposeAPolyhedronCell	(	vtkIdType	nCellFaces,
		const vtkIdType *	cellStream,
		vtkIdType &	numCellPts,
		vtkCellArray *	cellArray,
		vtkCellArray *	faces,
		vtkCellArray *	faceLocations
	)

staticprotected

◆ CopyPolyhedronToFaceStream()

static int vtkUnstructuredGrid::CopyPolyhedronToFaceStream	(	vtkCellArray *	faceArray,
		vtkCellArray *	faceLocationArray,
		vtkIdTypeArray *	faceStream,
		vtkIdTypeArray *	faceLocation
	)

staticprotected

Backward compatibility function to convert new polyhedron storage to legacy.

◆ GetCell() [3/5]

virtual vtkCell * vtkDataSet::GetCell ( vtkIdType cellId )

virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

The returned vtkCell is an object owned by this instance, hence the return value must not be deleted by the caller.

Warning: Repeat calls to this function for different face ids will change the data stored in the internal member object whose pointer is returned by this function.; THIS METHOD IS NOT THREAD SAFE. For a thread-safe version, please use void GetCell(vtkIdType cellId, vtkGenericCell* cell).

Reimplemented from vtkPointSet.

◆ GetCell() [4/5]

virtual vtkCell * vtkDataSet::GetCell	(	int	vtkNotUsedi,
		int	vtkNotUsedj,
		int	vtkNotUsedk
	)

inlinevirtual

Standard vtkDataSet methods; see vtkDataSet.h for documentation.

Reimplemented from vtkPointSet.

Definition at line 239 of file vtkDataSet.h.

◆ GetCell() [5/5]

virtual void vtkDataSet::GetCell	(	vtkIdType	cellId,
		vtkGenericCell *	cell
	)

virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkPointSet.

Member Data Documentation

◆ Connectivity

vtkSmartPointer<vtkCellArray> vtkUnstructuredGrid::Connectivity

protected

Definition at line 679 of file vtkUnstructuredGrid.h.

◆ Links

vtkSmartPointer<vtkAbstractCellLinks> vtkUnstructuredGrid::Links

protected

Definition at line 680 of file vtkUnstructuredGrid.h.

◆ Types

vtkSmartPointer<vtkUnsignedCharArray> vtkUnstructuredGrid::Types

protected

Definition at line 681 of file vtkUnstructuredGrid.h.

◆ DistinctCellTypes

vtkSmartPointer<vtkCellTypes> vtkUnstructuredGrid::DistinctCellTypes

protected

Definition at line 684 of file vtkUnstructuredGrid.h.

◆ DistinctCellTypesUpdateMTime

vtkMTimeType vtkUnstructuredGrid::DistinctCellTypesUpdateMTime

protected

Definition at line 688 of file vtkUnstructuredGrid.h.

◆ Faces

vtkSmartPointer<vtkCellArray> vtkUnstructuredGrid::Faces

protected

Special support for polyhedra/cells with explicit face representations.

The Faces class represents polygonal faces using a vtkCellArray structure. The FaceLocations store a polyhedron as a list of faces defined in Faces using a vtkCellArray structure.

Definition at line 696 of file vtkUnstructuredGrid.h.

◆ FaceLocations

vtkSmartPointer<vtkCellArray> vtkUnstructuredGrid::FaceLocations

protected

Definition at line 697 of file vtkUnstructuredGrid.h.

◆ CellLocations

vtkSmartPointer<vtkIdTypeArray> vtkUnstructuredGrid::CellLocations

protected

Definition at line 700 of file vtkUnstructuredGrid.h.

◆ LegacyFaces

vtkSmartPointer<vtkIdTypeArray> vtkUnstructuredGrid::LegacyFaces

protected

Legacy support – stores the old-style Faces && FaceLocations Special support for polyhedra/cells with explicit face representations.

The Faces class represents polygonal faces using a modified vtkCellArray structure. Each cell face list begins with the total number of faces in the cell, followed by a vtkCellArray data organization (n,i,j,k,n,i,j,k,...).

Warning: The Faces and FaceLocations arrays are no longer used; this information is stored in vtkCellArrays ElementFaces and ElementFaceLocations. Use SetPolyhedralCells.

Definition at line 722 of file vtkUnstructuredGrid.h.

◆ LegacyFaceLocations

vtkSmartPointer<vtkIdTypeArray> vtkUnstructuredGrid::LegacyFaceLocations

protected

Definition at line 723 of file vtkUnstructuredGrid.h.

◆ LegacyPointIdsBuffer

vtkSmartPointer<vtkIdList> vtkUnstructuredGrid::LegacyPointIdsBuffer

protected

Legacy backward compatibility for GetFaceStream This member should be removed simultaneously with the deprecated GetFaceStream.

Definition at line 730 of file vtkUnstructuredGrid.h.

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

Common/DataModel/vtkUnstructuredGrid.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkUnstructuredGrid()

◆ ~vtkUnstructuredGrid()

Member Function Documentation

◆ New()

◆ ExtendedNew()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetDataObjectType()

◆ AllocateEstimate()

◆ AllocateExact()

◆ Allocate()

◆ Reset()

◆ CopyStructure()

◆ GetNumberOfCells()

◆ GetCell() [1/5]

◆ GetCell() [2/5]

◆ GetCellBounds()

◆ GetCellPoints() [1/3]

◆ GetPointCells() [1/2]

◆ NewCellIterator()

◆ GetCellType()

◆ GetCellSize()

◆ GetCellTypes()

◆ GetDistinctCellTypesArray()

◆ GetCellPoints() [2/3]

◆ GetCellPoints() [3/3]

◆ GetPointCells() [2/2]

◆ GetCellTypesArray()

◆ Squeeze()

◆ Initialize()

◆ GetMaxCellSize()

◆ GetMaxSpatialDimension()

◆ GetMinSpatialDimension()

◆ BuildLinks()

◆ vtkSetSmartPointerMacro()

◆ vtkGetSmartPointerMacro()

◆ GetCellLinks()

◆ GetFaceStream() [1/2]

◆ GetFaceStream() [2/2]

◆ SetCells() [1/6]

◆ SetCells() [2/6]

◆ SetCells() [3/6]

◆ SetPolyhedralCells()

◆ SetCells() [4/6]

◆ GetCells()

◆ GetCellNeighbors() [1/2]

◆ GetCellNeighbors() [2/2]

◆ IsCellBoundary() [1/3]

◆ IsCellBoundary() [2/3]

◆ IsCellBoundary() [3/3]

◆ InsertNextLinkedCell()

◆ RemoveReferenceToCell()

◆ AddReferenceToCell()

◆ ResizeCellList()

◆ GetPiece()

◆ GetNumberOfPieces()

◆ GetGhostLevel()

◆ GetActualMemorySize()

◆ ShallowCopy()

◆ DeepCopy()

◆ GetIdsOfCellsOfType()

◆ IsHomogeneous()

◆ RemoveGhostCells()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetFaces() [1/2]