Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

vtkUnstructuredGrid Class Reference

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

#include <vtkUnstructuredGrid.h>

Inheritance diagram for vtkUnstructuredGrid:

[legend]Collaboration diagram for vtkUnstructuredGrid:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetDataObjectType ()
void	Allocate (int numCells=1000, int extSize=1000)
int	InsertNextCell (int type, int npts, int *pts)
int	InsertNextCell (int type, vtkIdList *ptIds)
void	Reset ()
void	SetCells (int types, vtkCellArray cells)
vtkCellArray *	GetCells ()
vtkDataObject *	MakeObject ()
void	CopyStructure (vtkDataSet *ds)
int	GetNumberOfCells ()
vtkCell *	GetCell (int cellId)
void	GetCell (int cellId, vtkGenericCell *cell)
void	GetCellBounds (int cellId, float bounds[6])
void	GetCellPoints (int cellId, vtkIdList *ptIds)
void	GetPointCells (int ptId, vtkIdList *cellIds)
int	GetCellType (int cellId)
void	Squeeze ()
void	Initialize ()
int	GetMaxCellSize ()
void	BuildLinks ()
vtkCellLinks *	GetCellLinks ()
void	GetCellPoints (int cellId, int &npts, int *&pts)
void	ReplaceCell (int cellId, int npts, int *pts)
int	InsertNextLinkedCell (int type, int npts, int *pts)
void	RemoveReferenceToCell (int ptId, int cellId)
void	AddReferenceToCell (int ptId, int cellId)
void	ResizeCellList (int ptId, int size)
virtual void	GetCellNeighbors (int cellId, vtkIdList ptIds, vtkIdList cellIds)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces)
void	GetUpdateExtent (int &piece, int &numPieces, int &ghostLevel)
virtual int *	GetUpdateExtent ()
virtual void	GetUpdateExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetUpdateExtent (int[6])
void	SetUpdateExtent (int x1, int x2, int y1, int y2, int z1, int z2)
void	SetUpdateExtent (int ext[6])
virtual int	GetPiece ()
virtual int	GetNumberOfPieces ()
virtual int	GetGhostLevel ()
unsigned long	GetActualMemorySize ()
void	ShallowCopy (vtkDataObject *src)
void	DeepCopy (vtkDataObject *src)
void	GetCellPoints (int cellId, vtkIdList &ptIds)
void	GetPointCells (int ptId, vtkIdList &cellIds)
int	InsertNextCell (int type, vtkIdList &pts)
Static Public Methods
vtkUnstructuredGrid *	New ()
int	IsTypeOf (const char *type)
vtkUnstructuredGrid *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkUnstructuredGrid ()
	~vtkUnstructuredGrid ()
	vtkUnstructuredGrid (const vtkUnstructuredGrid &)
void	operator= (const 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
vtkCellTypes *	Cells
vtkCellArray *	Connectivity
vtkCellLinks *	Links

Detailed Description

dataset represents arbitrary combinations of all possible cell types.

Date:: 2000/12/10 20:08:20

Revision:: 1.67

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)

Definition at line 78 of file vtkUnstructuredGrid.h.

Constructor & Destructor Documentation

vtkUnstructuredGrid::vtkUnstructuredGrid ( ) [protected]

vtkUnstructuredGrid::~vtkUnstructuredGrid ( ) [protected]

vtkUnstructuredGrid::vtkUnstructuredGrid ( const vtkUnstructuredGrid & ) [inline, protected]

Definition at line 174 of file vtkUnstructuredGrid.h.

Member Function Documentation

vtkUnstructuredGrid* vtkUnstructuredGrid::New ( ) [static]

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

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkPointSet.

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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkPointSet.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
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 86 of file vtkUnstructuredGrid.h.

void vtkUnstructuredGrid::Allocate ( int numCells = 1000,

int extSize = 1000

)

int vtkUnstructuredGrid::InsertNextCell ( int type,

int npts,

int * pts

)

int vtkUnstructuredGrid::InsertNextCell ( int type,

vtkIdList * ptIds

)

void vtkUnstructuredGrid::Reset ( )

void vtkUnstructuredGrid::SetCells ( int * types,

vtkCellArray * cells

)

vtkCellArray* vtkUnstructuredGrid::GetCells ( ) [inline]

Definition at line 92 of file vtkUnstructuredGrid.h.

vtkDataObject* vtkUnstructuredGrid::MakeObject ( ) [inline, virtual]

Create concrete instance of this data object.
Reimplemented from vtkDataObject.
Definition at line 93 of file vtkUnstructuredGrid.h.

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

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

int vtkUnstructuredGrid::GetNumberOfCells ( ) [virtual]

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

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

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

void vtkUnstructuredGrid::GetCell ( int 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 vtkDataSet.

void vtkUnstructuredGrid::GetCellBounds ( int cellId,

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

void vtkUnstructuredGrid::GetCellPoints ( int 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
Reimplemented from vtkDataSet.

void vtkUnstructuredGrid::GetPointCells ( int 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
Reimplemented from vtkDataSet.

int vtkUnstructuredGrid::GetCellType ( int 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
Reimplemented from vtkDataSet.

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
Reimplemented from vtkDataSet.

void vtkUnstructuredGrid::BuildLinks ( )

vtkCellLinks* vtkUnstructuredGrid::GetCellLinks ( ) [inline]

Definition at line 107 of file vtkUnstructuredGrid.h.

void vtkUnstructuredGrid::GetCellPoints ( int cellId,

int & npts,

int *& pts

)

void vtkUnstructuredGrid::ReplaceCell ( int cellId,

int npts,

int * pts

)

int vtkUnstructuredGrid::InsertNextLinkedCell ( int type,

int npts,

int * pts

)

void vtkUnstructuredGrid::RemoveReferenceToCell ( int ptId,

int cellId

)

void vtkUnstructuredGrid::AddReferenceToCell ( int ptId,

int cellId

)

void vtkUnstructuredGrid::ResizeCellList ( int ptId,

int size

)

virtual void vtkUnstructuredGrid::GetCellNeighbors ( int 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::SetUpdateExtent ( 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.

void vtkUnstructuredGrid::SetUpdateExtent ( int piece,

int numPieces

) [inline]

Reimplemented from vtkDataObject.
Definition at line 125 of file vtkUnstructuredGrid.h.

void vtkUnstructuredGrid::GetUpdateExtent ( int & piece,

int & numPieces,

int & ghostLevel

)

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

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

virtual void vtkUnstructuredGrid::GetUpdateExtent ( int & ,

int & ,

int & ,

int & ,

int & ,

int &

) [virtual]

Reimplemented from vtkDataObject.

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

Reimplemented from vtkDataObject.

void vtkUnstructuredGrid::SetUpdateExtent ( int x1,

int x2,

int y1,

int y2,

int z1,

int z2

) [inline, virtual]

Call superclass method to avoid hiding Since this data type does not use 3D extents, this set method is useless but necessary since vtkDataSetToDataSetFilter does not know what type of data it is working on.
Reimplemented from vtkDataObject.
Definition at line 136 of file vtkUnstructuredGrid.h.

void vtkUnstructuredGrid::SetUpdateExtent ( int ext[6] ) [inline, virtual]

Reimplemented from vtkDataObject.
Definition at line 138 of file vtkUnstructuredGrid.h.

virtual int vtkUnstructuredGrid::GetPiece ( ) [virtual]

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

virtual int vtkUnstructuredGrid::GetNumberOfPieces ( ) [virtual]

virtual int vtkUnstructuredGrid::GetGhostLevel ( ) [virtual]

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

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

Shallow and Deep copy.
Reimplemented from vtkPointSet.

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

Reimplemented from vtkPointSet.

void vtkUnstructuredGrid::GetCellPoints ( int cellId,

vtkIdList & ptIds

) [inline]

For legacy compatibility. Do not use.
Reimplemented from vtkDataSet.
Definition at line 163 of file vtkUnstructuredGrid.h.

void vtkUnstructuredGrid::GetPointCells ( int ptId,

vtkIdList & cellIds

) [inline]

Reimplemented from vtkDataSet.
Definition at line 165 of file vtkUnstructuredGrid.h.

int vtkUnstructuredGrid::InsertNextCell ( int type,

vtkIdList & pts

) [inline]

Definition at line 167 of file vtkUnstructuredGrid.h.

void vtkUnstructuredGrid::operator= ( const vtkUnstructuredGrid & ) [inline, protected]

Definition at line 175 of file vtkUnstructuredGrid.h.

Member Data Documentation

vtkVertex* vtkUnstructuredGrid::Vertex [protected]

Definition at line 178 of file vtkUnstructuredGrid.h.

vtkPolyVertex* vtkUnstructuredGrid::PolyVertex [protected]

Definition at line 179 of file vtkUnstructuredGrid.h.

vtkLine* vtkUnstructuredGrid::Line [protected]

Definition at line 180 of file vtkUnstructuredGrid.h.

vtkPolyLine* vtkUnstructuredGrid::PolyLine [protected]

Definition at line 181 of file vtkUnstructuredGrid.h.

vtkTriangle* vtkUnstructuredGrid::Triangle [protected]

Definition at line 182 of file vtkUnstructuredGrid.h.

vtkTriangleStrip* vtkUnstructuredGrid::TriangleStrip [protected]

Definition at line 183 of file vtkUnstructuredGrid.h.

vtkPixel* vtkUnstructuredGrid::Pixel [protected]

Definition at line 184 of file vtkUnstructuredGrid.h.

vtkQuad* vtkUnstructuredGrid::Quad [protected]

Definition at line 185 of file vtkUnstructuredGrid.h.

vtkPolygon* vtkUnstructuredGrid::Polygon [protected]

Definition at line 186 of file vtkUnstructuredGrid.h.

vtkTetra* vtkUnstructuredGrid::Tetra [protected]

Definition at line 187 of file vtkUnstructuredGrid.h.

vtkVoxel* vtkUnstructuredGrid::Voxel [protected]

Definition at line 188 of file vtkUnstructuredGrid.h.

vtkHexahedron* vtkUnstructuredGrid::Hexahedron [protected]

Definition at line 189 of file vtkUnstructuredGrid.h.

vtkWedge* vtkUnstructuredGrid::Wedge [protected]

Definition at line 190 of file vtkUnstructuredGrid.h.

vtkPyramid* vtkUnstructuredGrid::Pyramid [protected]

Definition at line 191 of file vtkUnstructuredGrid.h.

vtkCellTypes* vtkUnstructuredGrid::Cells [protected]

Definition at line 195 of file vtkUnstructuredGrid.h.

vtkCellArray* vtkUnstructuredGrid::Connectivity [protected]

Definition at line 196 of file vtkUnstructuredGrid.h.

vtkCellLinks* vtkUnstructuredGrid::Links [protected]

Definition at line 197 of file vtkUnstructuredGrid.h.

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

common/vtkUnstructuredGrid.h

Generated on Wed Nov 21 13:01:25 2001 for VTK by

vtkUnstructuredGrid Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation