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

vtkEmptyCell Class Reference

an empty cell used as a place-holder during processing. More...

#include <vtkEmptyCell.h>

Inheritance diagram for vtkEmptyCell:

Inheritance graph
[legend]
Collaboration diagram for vtkEmptyCell:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
int EvaluatePosition (float x[3], float *closestPoint, int &subId, float pcoords[3], float &dist2, float *weights)
void EvaluateLocation (int &subId, float pcoords[3], float x[3], float *weights)
int IntersectWithLine (float p1[3], float p2[3], float tol, float &t, float x[3], float pcoords[3], int &subId)
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)
void Derivatives (int subId, float pcoords[3], float *values, int dim, float *derivs)
vtkCell * MakeObject ()
int GetCellType ()
int GetCellDimension ()
int GetNumberOfEdges ()
int GetNumberOfFaces ()
vtkCell * GetEdge (int)
vtkCell * GetFace (int)
int CellBoundary (int subId, float pcoords[3], vtkIdList *pts)
void Contour (float value, vtkDataArray *cellScalars, vtkPointLocator *locator, vtkCellArray *verts1, vtkCellArray *lines, vtkCellArray *verts2, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)
void Clip (float value, vtkDataArray *cellScalars, vtkPointLocator *locator, vtkCellArray *pts, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)

Static Public Methods

vtkEmptyCell * New ()
int IsTypeOf (const char *type)
vtkEmptyCell * SafeDownCast (vtkObject *o)

Protected Methods

 vtkEmptyCell ()
 ~vtkEmptyCell ()

Detailed Description

an empty cell used as a place-holder during processing.

Date:
2001/11/02 16:41:05
Revision:
1.31

vtkEmptyCell is a concrete implementation of vtkCell. It is used during processing to represented a deleted element.

Tests:
vtkEmptyCell (Tests)

Definition at line 58 of file vtkEmptyCell.h.

Constructor & Destructor Documentation

vtkEmptyCell::vtkEmptyCell (    )  [inline, protected]
 

Definition at line 98 of file vtkEmptyCell.h.

vtkEmptyCell::~vtkEmptyCell (    )  [inline, protected]
 

Definition at line 99 of file vtkEmptyCell.h.

Member Function Documentation

vtkEmptyCell* vtkEmptyCell::New (    )  [static]
 

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

Reimplemented from vtkObject.

Referenced by MakeObject().

virtual const char* vtkEmptyCell::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 vtkCell.

int vtkEmptyCell::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 vtkCell.

virtual int vtkEmptyCell::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 vtkCell.

vtkEmptyCell* vtkEmptyCell::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 vtkCell.

vtkCell* vtkEmptyCell::MakeObject (    )  [inline, virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

Definition at line 66 of file vtkEmptyCell.h.

int vtkEmptyCell::GetCellType (    )  [inline, virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

Definition at line 67 of file vtkEmptyCell.h.

int vtkEmptyCell::GetCellDimension (    )  [inline, virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

Definition at line 68 of file vtkEmptyCell.h.

int vtkEmptyCell::GetNumberOfEdges (    )  [inline, virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

Definition at line 69 of file vtkEmptyCell.h.

int vtkEmptyCell::GetNumberOfFaces (    )  [inline, virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

Definition at line 70 of file vtkEmptyCell.h.

vtkCell* vtkEmptyCell::GetEdge (  int    edgeId )  [inline, virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

Definition at line 71 of file vtkEmptyCell.h.

vtkCell* vtkEmptyCell::GetFace (  int    faceId )  [inline, virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

Definition at line 72 of file vtkEmptyCell.h.

int vtkEmptyCell::CellBoundary (  int    subId,
float    pcoords[3],
vtkIdList *    pts
)  [virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

void vtkEmptyCell::Contour (  float    value,
vtkDataArray *    cellScalars,
vtkPointLocator *    locator,
vtkCellArray *    verts1,
vtkCellArray *    lines,
vtkCellArray *    verts2,
vtkPointData *    inPd,
vtkPointData *    outPd,
vtkCellData *    inCd,
vtkIdType    cellId,
vtkCellData *    outCd
)  [virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

void vtkEmptyCell::Clip (  float    value,
vtkDataArray *    cellScalars,
vtkPointLocator *    locator,
vtkCellArray *    pts,
vtkPointData *    inPd,
vtkPointData *    outPd,
vtkCellData *    inCd,
vtkIdType    cellId,
vtkCellData *    outCd,
int    insideOut
)  [virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

int vtkEmptyCell::EvaluatePosition (  float    x[3],
float *    closestPoint,
int &    subId,
float    pcoords[3],
float &    dist2,
float *    weights
)  [virtual]
 

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] (unless closestPoint is null, in which case, the closest point and dist2 are not found), 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.

Reimplemented from vtkCell.

void vtkEmptyCell::EvaluateLocation (  int &    subId,
float    pcoords[3],
float    x[3],
float *    weights
)  [virtual]
 

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

Reimplemented from vtkCell.

int vtkEmptyCell::IntersectWithLine (  float    p1[3],
float    p2[3],
float    tol,
float &    t,
float    x[3],
float    pcoords[3],
int &    subId
)  [virtual]
 

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.

Reimplemented from vtkCell.

int vtkEmptyCell::Triangulate (  int    index,
vtkIdList *    ptIds,
vtkPoints *    pts
)  [virtual]
 

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.

Reimplemented from vtkCell.

void vtkEmptyCell::Derivatives (  int    subId,
float    pcoords[3],
float *    values,
int    dim,
float *    derivs
)  [virtual]
 

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

Reimplemented from vtkCell.

The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:29:02 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001