Documentation for vtkCell

vtkCell - abstract class to specify cell behavior

Super Class: vtkObject

Description:

vtkCell is an abstract class that specifies the interfaces for data cells. Data cells are simple topological elements like points, lines, polygons, and tetrahedra of which visualization datasets are composed. In some cases visualization datasets may explicitly represent cells (e.g., vtkPolyData, vtkUnstructuredGrid), and in some cases, the datasets are implicitly composed of cells (e.g., vtkStructuredPoints).

 

Caveats:

The #define VTK_CELL_SIZE is a parameter used to construct cells and provide a general guideline for controlling object execution. This parameter is not a hard boundary: you can create cells with more points.

 

See Also:

vtkHexahedron vtkLine vtkPixel vtkPolyLine vtkPolyVertex vtkPolygon vtkQuad vtkTetra vtkTriangle vtkTriangleStrip vtkVertex vtkVoxel

 

Methods:

void vtkCell ()
void vtkCell ()
void Initialize (int ,int * ,vtkPoints *)
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
vtkCell *MakeObject ()
void ShallowCopy (vtkCell *)
void DeepCopy (vtkCell *)
int GetCellType ()
int GetCellDimension ()
int GetInterpolationOrder ()
vtkPoints *GetPoints ()
int GetNumberOfPoints ()
int GetNumberOfEdges ()
int GetNumberOfFaces ()
vtkIdList *GetPointIds ()
int GetPointId (int )
vtkCell *GetEdge (int )
vtkCell *GetFace (int )
int CellBoundary (int ,float ,vtkIdList *)
int EvaluatePosition (float ,float ,int & ,float ,float & ,float *)
void EvaluateLocation (int & ,float ,float ,float *)
void Contour (float ,vtkScalars * ,vtkPointLocator * ,vtkCellArray * ,vtkCellArray * ,vtkCellArray * ,vtkPointData * ,vtkPointData * ,vtkCellData * ,int ,vtkCellData *)
void Clip (float ,vtkScalars * ,vtkPointLocator * ,vtkCellArray * ,vtkPointData * ,vtkPointData * ,vtkCellData * ,int ,vtkCellData * ,int )
int IntersectWithLine (float ,float ,float ,float & ,float ,float ,int &)
int Triangulate (int ,vtkIdList * ,vtkPoints *)
void Derivatives (int ,float ,float * ,int ,float *)
void GetBounds (float )
float *GetBounds ()
float GetLength2 ()
int GetParametricCenter (float )
static char HitBBox (float ,float ,float ,float ,float &)
void DeepCopy (vtkCell &)
void ShallowCopy (vtkCell &)

 

Detailed Method Descriptions:

Create concrete copy of this cell. Initially, the copy is made by performing a ShallowCopy() operation.

vtkCell *MakeObject ()

Copy this cell by reference counting the internal data structures. This is safe if you want a "read-only" copy. If you modify the cell you might wish to use DeepCopy().

void ShallowCopy (vtkCell *)

Copy this cell by completely copying internal data structures. This is slower but safer than ShallowCopy().

void DeepCopy (vtkCell *)

Return the type of cell.

int GetCellType ()

Return the topological dimensional of the cell (0,1,2, or 3).

int GetCellDimension ()

Return the interpolation order of the cell. Usually linear.

int GetInterpolationOrder ()

Get the point coordinates for the cell.

vtkPoints *GetPoints ()

Return the number of points in the cell.

int GetNumberOfPoints ()

Return the number of edges in the cell.

int GetNumberOfEdges ()

Return the number of faces in the cell.

int GetNumberOfFaces ()

Return the list of point ids defining the cell.

vtkIdList *GetPointIds ()

For cell point i, return the actual point id.

int GetPointId (int )

Return the edge cell from the edgeId of the cell.

vtkCell *GetEdge (int )

Return the face cell from the faceId of the cell.

vtkCell *GetFace (int )

Given parametric coordinates of a point, return the closest cell boundary, and whether the point is inside or outside of the cell. The cell boundary is defined by a list of points (pts) that specify a face (3D cell), edge (2D cell), or vertex (1D cell). If the return value of the method is != 0, then the point is inside the cell.

int CellBoundary (int ,float ,vtkIdList *)

Given a point x[3] return inside(=1) or outside(=0) cell; evaluate parametric coordinates, sub-cell id (!=0 only if cell is composite), distance squared of point x[3] to cell (in particular, the sub-cell indicated), closest point on cell to x[3], and interpolation weights in cell. (The number of weights is equal to the number of points defining the cell). Note: on rare occasions a -1 is returned from the method. This means that numerical error has occurred and all data returned from this method should be ignored. Also, inside/outside is determine parametrically. That is, a point is inside if it satisfies parametric limits. This can cause problems for cells of topological dimension 2 or less, since a point in 3D can project onto the cell within parametric limits but be "far" from the cell. Thus the value dist2 may be checked to determine true in/out.

int EvaluatePosition (float ,float ,int & ,float ,float & ,float *)

Determine global coordinate (x[3]) from subId and parametric coordinates. Also returns interpolation weights. (The number of weights is equal to the number of points in the cell.)

void EvaluateLocation (int & ,float ,float ,float *)

Generate contouring primitives. The scalar list cellScalars are scalar values at each cell point. The point locator is essentially a points list that merges points as they are inserted (i.e., prevents duplicates). Contouring primitives can be vertices, lines, or polygons. It is possible to interpolate point data along the edge by providing input and output point data - if outPd is NULL, then no interpolation is performed. Also, if the output cell data is non-NULL, the cell data from the contoured cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell from which the cell data is copied.)

void Contour (float ,vtkScalars * ,vtkPointLocator * ,vtkCellArray * ,vtkCellArray * ,vtkCellArray * ,vtkPointData * ,vtkPointData * ,vtkCellData * ,int ,vtkCellData *)

Cut (or clip) the cell based on the input cellScalars and the specified value. The output of the clip operation will be one or more cells of the same topological dimension as the original cell. The flag insideOut controls what part of the cell is considered inside - normally cell points whose scalar value is greater than "value" are considered inside. If insideOut is on, this is reversed. Also, if the output cell data is non-NULL, the cell data from the clipped cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell from which the cell data is copied.)

void Clip (float ,vtkScalars * ,vtkPointLocator * ,vtkCellArray * ,vtkPointData * ,vtkPointData * ,vtkCellData * ,int ,vtkCellData * ,int )

Intersect with a ray. Return parametric coordinates (both line and cell) and global intersection coordinates, given ray definition and tolerance. The method returns non-zero value if intersection occurs.

int IntersectWithLine (float ,float ,float ,float & ,float ,float ,int &)

Generate simplices of proper dimension. If cell is 3D, tetrahedron are generated; if 2D triangles; if 1D lines; if 0D points. The form of the output is a sequence of points, each n+1 points (where n is topological cell dimension) defining a simplex. The index is a parameter that controls which triangulation to use (if more than one is possible). If numerical degeneracy encountered, 0 is returned, otherwise 1 is returned.

int Triangulate (int ,vtkIdList * ,vtkPoints *)

Compute derivatives given cell subId and parametric coordinates. The values array is a series of data value(s) at the cell points. There is a one-to-one correspondence between cell point and data value(s). Dim is the number of data values per cell point. Derivs are derivatives in the x-y-z coordinate directions for each data value. Thus, if computing derivatives for a scalar function in a hexahedron, dim=1, 8 values are supplied, and 3 deriv values are returned (i.e., derivatives in x-y-z directions). On the other hand, if computing derivatives of velocity (vx,vy,vz) dim=3, 24 values are supplied ((vx,vy,vz)1, (vx,vy,vz)2, ....()8), and 9 deriv values are returned ((d(vx)/dx),(d(vx)/dy),(d(vx)/dz), (d(vy)/dx),(d(vy)/dy), (d(vy)/dz), (d(vz)/dx),(d(vz)/dy),(d(vz)/dz)).

void Derivatives (int ,float ,float * ,int ,float *)

Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). Copy result into user provided array.

void GetBounds (float )

Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). Return pointer to array of six float values.

float *GetBounds ()

Compute Length squared of cell (i.e., bounding box diagonal squared).

float GetLength2 ()

Return center of the cell in parametric coordinates. Note that the parametric center is not always located at (0.5,0.5,0.5). The return value is the subId that the center is in (if a composite cell). If you want the center in x-y-z space, invoke the EvaluateLocation() method.

int GetParametricCenter (float )

Bounding box intersection modified from Graphics Gems Vol I. Note: the intersection ray is assumed normalized, such that valid intersections can only occur between [0,1]. Method returns non-zero value if bounding box is hit. Origin[3] starts the ray, dir[3] is the components of the ray in the x-y-z directions, coord[3] is the location of hit, and t is the parametric coordinate along line.

static char HitBBox (float ,float ,float ,float ,float &)

For legacy compatibility. Do not use.

void DeepCopy (vtkCell &)