vtkUnstructuredGrid Class Reference

#include <vtkUnstructuredGrid.h>

Inheritance diagram for vtkUnstructuredGrid:

[legend]Collaboration diagram for vtkUnstructuredGrid:

[legend]List of all members.

---

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

Examples:

vtkUnstructuredGrid (Examples)

Tests:

vtkUnstructuredGrid (Tests)

Definition at line 66 of file vtkUnstructuredGrid.h.

void	RemoveGhostCells (int level)
static vtkUnstructuredGrid *	GetData (vtkInformation *info)
static vtkUnstructuredGrid *	GetData (vtkInformationVector *v, int i=0)
Public Types
typedef vtkPointSet	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	Reset ()
virtual void	CopyStructure (vtkDataSet *ds)
vtkIdType	GetNumberOfCells ()
virtual vtkCell *	GetCell (vtkIdType cellId)
virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)
virtual void	GetCellBounds (vtkIdType cellId, double bounds[6])
virtual void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)
void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds)
int	GetCellType (vtkIdType cellId)
vtkUnsignedCharArray *	GetCellTypesArray ()
vtkIdTypeArray *	GetCellLocationsArray ()
void	Squeeze ()
void	Initialize ()
int	GetMaxCellSize ()
void	BuildLinks ()
vtkCellLinks *	GetCellLinks ()
virtual int	GetGhostLevel ()
void	GetIdsOfCellsOfType (int type, vtkIdTypeArray *array)
int	IsHomogeneous ()
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetDataObjectType ()
virtual void	Allocate (vtkIdType numCells=1000, int extSize=1000)
vtkIdType	InsertNextCell (int type, vtkIdType npts, vtkIdType *pts)
vtkIdType	InsertNextCell (int type, vtkIdList *ptIds)
virtual void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType *&pts)
void	SetCells (int type, vtkCellArray *cells)
void	SetCells (int *types, vtkCellArray *cells)
void	SetCells (vtkUnsignedCharArray *cellTypes, vtkIdTypeArray *cellLocations, vtkCellArray *cells)
vtkCellArray *	GetCells ()
void	ReplaceCell (vtkIdType cellId, int npts, vtkIdType *pts)
int	InsertNextLinkedCell (int type, int npts, vtkIdType *pts)
void	RemoveReferenceToCell (vtkIdType ptId, vtkIdType cellId)
void	AddReferenceToCell (vtkIdType ptId, vtkIdType cellId)
void	ResizeCellList (vtkIdType ptId, int size)
virtual void	GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
void	GetUpdateExtent (int &piece, int &numPieces, int &ghostLevel)
virtual int *	GetUpdateExtent ()
virtual void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void	GetUpdateExtent (int extent[6])
virtual int	GetPiece ()
virtual int	GetNumberOfPieces ()
unsigned long	GetActualMemorySize ()
virtual void	ShallowCopy (vtkDataObject *src)
virtual void	DeepCopy (vtkDataObject *src)
Static Public Member Functions
static vtkUnstructuredGrid *	New ()
static int	IsTypeOf (const char *type)
static vtkUnstructuredGrid *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkUnstructuredGrid ()
	~vtkUnstructuredGrid ()
Protected Attributes
vtkVertex *	Vertex
vtkPolyVertex *	PolyVertex
vtkLine *	Line
vtkPolyLine *	PolyLine
vtkTriangle *	Triangle
vtkTriangleStrip *	TriangleStrip
vtkPixel *	Pixel
vtkQuad *	Quad
vtkPolygon *	Polygon
vtkTetra *	Tetra
vtkVoxel *	Voxel
vtkHexahedron *	Hexahedron
vtkWedge *	Wedge
vtkPyramid *	Pyramid
vtkPentagonalPrism *	PentagonalPrism
vtkHexagonalPrism *	HexagonalPrism
vtkQuadraticEdge *	QuadraticEdge
vtkQuadraticTriangle *	QuadraticTriangle
vtkQuadraticQuad *	QuadraticQuad
vtkQuadraticTetra *	QuadraticTetra
vtkQuadraticHexahedron *	QuadraticHexahedron
vtkQuadraticWedge *	QuadraticWedge
vtkQuadraticPyramid *	QuadraticPyramid
vtkConvexPointSet *	ConvexPointSet
vtkEmptyCell *	EmptyCell
vtkCellArray *	Connectivity
vtkCellLinks *	Links
vtkUnsignedCharArray *	Types
vtkIdTypeArray *	Locations

---

Member Typedef Documentation

typedef vtkPointSet vtkUnstructuredGrid::Superclass

Reimplemented from vtkPointSet. Definition at line 71 of file vtkUnstructuredGrid.h.

---

Constructor & Destructor Documentation

vtkUnstructuredGrid::vtkUnstructuredGrid (   )  [protected]

vtkUnstructuredGrid::~vtkUnstructuredGrid (   )  [protected]

---

Member Function Documentation

static vtkUnstructuredGrid* vtkUnstructuredGrid::New (   )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkDataObject.

virtual const char* vtkUnstructuredGrid::GetClassName (   )  [virtual]

Reimplemented from vtkPointSet.

static int vtkUnstructuredGrid::IsTypeOf (  const char *  type  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkPointSet.

virtual int vtkUnstructuredGrid::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkPointSet.

static vtkUnstructuredGrid* vtkUnstructuredGrid::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkPointSet.

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

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

int vtkUnstructuredGrid::GetDataObjectType (   )  [inline, virtual]

Standard vtkDataSet API methods. See vtkDataSet for more information. Reimplemented from vtkDataSet. Definition at line 76 of file vtkUnstructuredGrid.h. References VTK_UNSTRUCTURED_GRID.

virtual void vtkUnstructuredGrid::Allocate (  vtkIdType  numCells = 1000, int  extSize = 1000 )  [virtual]

vtkIdType vtkUnstructuredGrid::InsertNextCell (  int  type, vtkIdType  npts, vtkIdType *  pts )

Insert/create cell in object by type and list of point ids defining cell topology.

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

Insert/create cell in object by type and list of point ids defining cell topology.

void vtkUnstructuredGrid::Reset (   )

virtual void vtkUnstructuredGrid::CopyStructure (  vtkDataSet *  ds  )  [virtual]

Copy the geometric structure of an input point set object. Reimplemented from vtkPointSet.

vtkIdType vtkUnstructuredGrid::GetNumberOfCells (   )  [virtual]

Determine the number of cells composing the dataset. THIS METHOD IS THREAD SAFE Implements vtkDataSet.

virtual vtkCell* vtkUnstructuredGrid::GetCell (  vtkIdType  cellId  )  [virtual]

Get cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS NOT THREAD SAFE. Implements vtkDataSet.

virtual void vtkUnstructuredGrid::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 Implements vtkDataSet.

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

Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. A subclass may be able to determine the bounds of cell without using an expensive GetCell() method. A default implementation is provided that actually uses a GetCell() call. This is to ensure the method is available to all datasets. Subclasses should override this method to provide an efficient implementation. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED Reimplemented from vtkDataSet.

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

Topological inquiry to get points defining cell. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED Implements vtkDataSet.

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

Topological inquiry to get cells using point. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED Implements vtkDataSet.

int vtkUnstructuredGrid::GetCellType (  vtkIdType  cellId  )  [virtual]

Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED Implements vtkDataSet.

vtkUnsignedCharArray* vtkUnstructuredGrid::GetCellTypesArray (   )  [inline]

Definition at line 97 of file vtkUnstructuredGrid.h.

vtkIdTypeArray* vtkUnstructuredGrid::GetCellLocationsArray (   )  [inline]

Definition at line 98 of file vtkUnstructuredGrid.h.

void vtkUnstructuredGrid::Squeeze (   )  [virtual]

Reclaim any unused memory. Reimplemented from vtkPointSet.

void vtkUnstructuredGrid::Initialize (   )  [virtual]

Reset to an empty state and free any memory. Reimplemented from vtkPointSet.

int vtkUnstructuredGrid::GetMaxCellSize (   )  [virtual]

Convenience method returns largest cell size in dataset. This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE Implements vtkDataSet.

void vtkUnstructuredGrid::BuildLinks (   )

vtkCellLinks* vtkUnstructuredGrid::GetCellLinks (   )  [inline]

Definition at line 103 of file vtkUnstructuredGrid.h.

virtual void vtkUnstructuredGrid::GetCellPoints (  vtkIdType  cellId, vtkIdType &  npts, vtkIdType *&  pts )  [virtual]

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

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

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

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

vtkCellArray* vtkUnstructuredGrid::GetCells (   )  [inline]

Definition at line 114 of file vtkUnstructuredGrid.h.

void vtkUnstructuredGrid::ReplaceCell (  vtkIdType  cellId, int  npts, vtkIdType *  pts )

int vtkUnstructuredGrid::InsertNextLinkedCell (  int  type, int  npts, vtkIdType *  pts )

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

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

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

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

Topological inquiry to get all cells using list of points exclusive of 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.

void vtkUnstructuredGrid::GetUpdateExtent (  int &  piece, int &  numPieces, int &  ghostLevel )

For streaming. User/next filter specifies which piece the want updated. The source of this poly data has to return exactly this piece.

virtual int* vtkUnstructuredGrid::GetUpdateExtent (   )  [virtual]

We need this here to avoid hiding superclass method Reimplemented from vtkDataObject.

virtual void vtkUnstructuredGrid::GetUpdateExtent (  int &  x0, int &  x1, int &  y0, int &  y1, int &  z0, int &  z1 )  [virtual]

For streaming. User/next filter specifies which piece the want updated. The source of this poly data has to return exactly this piece. Reimplemented from vtkDataObject.

virtual void vtkUnstructuredGrid::GetUpdateExtent (  int  extent[6]  )  [virtual]

For streaming. User/next filter specifies which piece the want updated. The source of this poly data has to return exactly this piece. Reimplemented from vtkDataObject.

virtual int vtkUnstructuredGrid::GetPiece (   )  [virtual]

Set / Get the piece and the number of pieces. Similar to extent in 3D.

virtual int vtkUnstructuredGrid::GetNumberOfPieces (   )  [virtual]

Set / Get the piece and the number of pieces. Similar to extent in 3D.

virtual int vtkUnstructuredGrid::GetGhostLevel (   )  [virtual]

Get the ghost level.

unsigned long vtkUnstructuredGrid::GetActualMemorySize (   )  [virtual]

Return the actual size of the data in kilobytes. 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.

virtual void vtkUnstructuredGrid::ShallowCopy (  vtkDataObject *  src  )  [virtual]

Shallow and Deep copy. Reimplemented from vtkPointSet.

virtual void vtkUnstructuredGrid::DeepCopy (  vtkDataObject *  src  )  [virtual]

Return the actual size of the data in kilobytes. 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.

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

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.

int vtkUnstructuredGrid::IsHomogeneous (   )

Traverse cells and determine if cells are all of the same type.

void vtkUnstructuredGrid::RemoveGhostCells (  int  level  )

This method will remove any cell that has a ghost level array value greater or equal to level.

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

Retrieve an instance of this class from an information object. Reimplemented from vtkPointSet.

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

This method will remove any cell that has a ghost level array value greater or equal to level. Reimplemented from vtkPointSet.

---

Member Data Documentation

vtkVertex* vtkUnstructuredGrid::Vertex [protected]

Definition at line 191 of file vtkUnstructuredGrid.h.

vtkPolyVertex* vtkUnstructuredGrid::PolyVertex [protected]

Definition at line 192 of file vtkUnstructuredGrid.h.

vtkLine* vtkUnstructuredGrid::Line [protected]

Definition at line 193 of file vtkUnstructuredGrid.h.

vtkPolyLine* vtkUnstructuredGrid::PolyLine [protected]

Definition at line 194 of file vtkUnstructuredGrid.h.

vtkTriangle* vtkUnstructuredGrid::Triangle [protected]

Definition at line 195 of file vtkUnstructuredGrid.h.

vtkTriangleStrip* vtkUnstructuredGrid::TriangleStrip [protected]

Definition at line 196 of file vtkUnstructuredGrid.h.

vtkPixel* vtkUnstructuredGrid::Pixel [protected]

Definition at line 197 of file vtkUnstructuredGrid.h.

vtkQuad* vtkUnstructuredGrid::Quad [protected]

Definition at line 198 of file vtkUnstructuredGrid.h.

vtkPolygon* vtkUnstructuredGrid::Polygon [protected]

Definition at line 199 of file vtkUnstructuredGrid.h.

vtkTetra* vtkUnstructuredGrid::Tetra [protected]

Definition at line 200 of file vtkUnstructuredGrid.h.

vtkVoxel* vtkUnstructuredGrid::Voxel [protected]

Definition at line 201 of file vtkUnstructuredGrid.h.

vtkHexahedron* vtkUnstructuredGrid::Hexahedron [protected]

Definition at line 202 of file vtkUnstructuredGrid.h.

vtkWedge* vtkUnstructuredGrid::Wedge [protected]

Definition at line 203 of file vtkUnstructuredGrid.h.

vtkPyramid* vtkUnstructuredGrid::Pyramid [protected]

Definition at line 204 of file vtkUnstructuredGrid.h.

vtkPentagonalPrism* vtkUnstructuredGrid::PentagonalPrism [protected]

Definition at line 205 of file vtkUnstructuredGrid.h.

vtkHexagonalPrism* vtkUnstructuredGrid::HexagonalPrism [protected]

Definition at line 206 of file vtkUnstructuredGrid.h.

vtkQuadraticEdge* vtkUnstructuredGrid::QuadraticEdge [protected]

Definition at line 207 of file vtkUnstructuredGrid.h.

vtkQuadraticTriangle* vtkUnstructuredGrid::QuadraticTriangle [protected]

Definition at line 208 of file vtkUnstructuredGrid.h.

vtkQuadraticQuad* vtkUnstructuredGrid::QuadraticQuad [protected]

Definition at line 209 of file vtkUnstructuredGrid.h.

vtkQuadraticTetra* vtkUnstructuredGrid::QuadraticTetra [protected]

Definition at line 210 of file vtkUnstructuredGrid.h.

vtkQuadraticHexahedron* vtkUnstructuredGrid::QuadraticHexahedron [protected]

Definition at line 211 of file vtkUnstructuredGrid.h.

vtkQuadraticWedge* vtkUnstructuredGrid::QuadraticWedge [protected]

Definition at line 212 of file vtkUnstructuredGrid.h.

vtkQuadraticPyramid* vtkUnstructuredGrid::QuadraticPyramid [protected]

Definition at line 213 of file vtkUnstructuredGrid.h.

vtkConvexPointSet* vtkUnstructuredGrid::ConvexPointSet [protected]

Definition at line 214 of file vtkUnstructuredGrid.h.

vtkEmptyCell* vtkUnstructuredGrid::EmptyCell [protected]

Definition at line 215 of file vtkUnstructuredGrid.h.

vtkCellArray* vtkUnstructuredGrid::Connectivity [protected]

Definition at line 219 of file vtkUnstructuredGrid.h.

vtkCellLinks* vtkUnstructuredGrid::Links [protected]

Definition at line 220 of file vtkUnstructuredGrid.h.

vtkUnsignedCharArray* vtkUnstructuredGrid::Types [protected]

Definition at line 221 of file vtkUnstructuredGrid.h.

vtkIdTypeArray* vtkUnstructuredGrid::Locations [protected]

Definition at line 222 of file vtkUnstructuredGrid.h.

---

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

• dox/Filtering/vtkUnstructuredGrid.h

---