Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkPolyVertex Class Reference

#include <vtkPolyVertex.h>

Inheritance diagram for vtkPolyVertex:

Inheritance graph
[legend]
Collaboration diagram for vtkPolyVertex:

Collaboration graph
[legend]
List of all members.

Detailed Description

cell represents a set of 0D vertices

vtkPolyVertex is a concrete implementation of vtkCell to represent a set of 3D vertices.

Examples:
vtkPolyVertex (Examples)
Tests:
vtkPolyVertex (Tests)

Definition at line 35 of file vtkPolyVertex.h.

Public Types

typedef vtkCell Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
int GetParametricCenter (double pcoords[3])
void PrintSelf (ostream &os, vtkIndent indent)
int GetCellType ()
int GetCellDimension ()
int GetNumberOfEdges ()
int GetNumberOfFaces ()
vtkCellGetEdge (int vtkNotUsed(edgeId))
vtkCellGetFace (int vtkNotUsed(faceId))
int CellBoundary (int subId, double pcoords[3], vtkIdList *pts)
void Contour (double value, vtkDataArray *cellScalars, vtkPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)
void Clip (double value, vtkDataArray *cellScalars, vtkPointLocator *locator, vtkCellArray *verts, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)
int EvaluatePosition (double x[3], double *closestPoint, int &subId, double pcoords[3], double &dist2, double *weights)
void EvaluateLocation (int &subId, double pcoords[3], double x[3], double *weights)
int IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)
void Derivatives (int subId, double pcoords[3], double *values, int dim, double *derivs)
int IsPrimaryCell ()

Static Public Member Functions

static vtkPolyVertexNew ()
static int IsTypeOf (const char *type)
static vtkPolyVertexSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPolyVertex ()
 ~vtkPolyVertex ()

Protected Attributes

vtkVertexVertex


Member Typedef Documentation

typedef vtkCell vtkPolyVertex::Superclass
 

Reimplemented from vtkCell.

Definition at line 39 of file vtkPolyVertex.h.


Constructor & Destructor Documentation

vtkPolyVertex::vtkPolyVertex  )  [protected]
 

vtkPolyVertex::~vtkPolyVertex  )  [protected]
 


Member Function Documentation

static vtkPolyVertex* vtkPolyVertex::New  )  [static]
 

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

Reimplemented from vtkObject.

virtual const char* vtkPolyVertex::GetClassName  )  [virtual]
 

Reimplemented from vtkCell.

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

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

static vtkPolyVertex* vtkPolyVertex::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkCell.

void vtkPolyVertex::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 vtkCell.

int vtkPolyVertex::GetCellType  )  [inline, virtual]
 

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 44 of file vtkPolyVertex.h.

References VTK_POLY_VERTEX.

int vtkPolyVertex::GetCellDimension  )  [inline, virtual]
 

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

Implements vtkCell.

Definition at line 45 of file vtkPolyVertex.h.

int vtkPolyVertex::GetNumberOfEdges  )  [inline, virtual]
 

Return the number of edges in the cell.

Implements vtkCell.

Definition at line 46 of file vtkPolyVertex.h.

int vtkPolyVertex::GetNumberOfFaces  )  [inline, virtual]
 

Return the number of faces in the cell.

Implements vtkCell.

Definition at line 47 of file vtkPolyVertex.h.

vtkCell* vtkPolyVertex::GetEdge int   vtkNotUsed(edgeId)  )  [inline]
 

Definition at line 48 of file vtkPolyVertex.h.

vtkCell* vtkPolyVertex::GetFace int   vtkNotUsed(faceId)  )  [inline]
 

Definition at line 49 of file vtkPolyVertex.h.

int vtkPolyVertex::CellBoundary int  subId,
double  pcoords[3],
vtkIdList pts
[virtual]
 

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.

Implements vtkCell.

void vtkPolyVertex::Contour double  value,
vtkDataArray cellScalars,
vtkPointLocator locator,
vtkCellArray verts,
vtkCellArray lines,
vtkCellArray polys,
vtkPointData inPd,
vtkPointData outPd,
vtkCellData inCd,
vtkIdType  cellId,
vtkCellData outCd
[virtual]
 

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

Implements vtkCell.

void vtkPolyVertex::Clip double  value,
vtkDataArray cellScalars,
vtkPointLocator locator,
vtkCellArray verts,
vtkPointData inPd,
vtkPointData outPd,
vtkCellData inCd,
vtkIdType  cellId,
vtkCellData outCd,
int  insideOut
[virtual]
 

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

Implements vtkCell.

int vtkPolyVertex::EvaluatePosition double  x[3],
double *  closestPoint,
int &  subId,
double  pcoords[3],
double &  dist2,
double *  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.

Implements vtkCell.

void vtkPolyVertex::EvaluateLocation int &  subId,
double  pcoords[3],
double  x[3],
double *  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.)

Implements vtkCell.

int vtkPolyVertex::IntersectWithLine double  p1[3],
double  p2[3],
double  tol,
double &  t,
double  x[3],
double  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.

Implements vtkCell.

int vtkPolyVertex::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. This method does not insert new points: all the points that define the simplices are the points that define the cell.

Implements vtkCell.

void vtkPolyVertex::Derivatives int  subId,
double  pcoords[3],
double *  values,
int  dim,
double *  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)).

Implements vtkCell.

int vtkPolyVertex::IsPrimaryCell  )  [inline, virtual]
 

Return whether this cell type has a fixed topology or whether the topology varies depending on the data (e.g., vtkConvexPointSet). This compares to composite cells that are typically composed of primary cells (e.g., a triangle strip composite cell is made up of triangle primary cells).

Reimplemented from vtkCell.

Definition at line 71 of file vtkPolyVertex.h.

int vtkPolyVertex::GetParametricCenter double  pcoords[3]  )  [virtual]
 

Return the center of the point cloud in parametric coordinates.

Reimplemented from vtkCell.


Member Data Documentation

vtkVertex* vtkPolyVertex::Vertex [protected]
 

Definition at line 82 of file vtkPolyVertex.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:10:10 2008 for VTK by  doxygen 1.4.3-20050530