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

vtkLine Class Reference

cell represents a 1D line. More...

#include <vtkLine.h>

Inheritance diagram for vtkLine:

Inheritance graph
[legend]
Collaboration diagram for vtkLine:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
vtkCellMakeObject ()
int GetCellType ()
int GetCellDimension ()
int GetNumberOfEdges ()
int GetNumberOfFaces ()
vtkCellGetEdge (int)
vtkCellGetFace (int)
int CellBoundary (int subId, float pcoords[3], vtkIdList *pts)
void Contour (float value, vtkScalars *cellScalars, vtkPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, int cellId, vtkCellData *outCd)
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 Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)
void Derivatives (int subId, float pcoords[3], float *values, int dim, float *derivs)
void Clip (float value, vtkScalars *cellScalars, vtkPointLocator *locator, vtkCellArray *lines, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, int cellId, vtkCellData *outCd, int insideOut)
int IntersectWithLine (float p1[3], float p2[3], float tol, float &t, float x[3], float pcoords[3], int &subId)
int CellBoundary (int subId, float pcoords[3], vtkIdList &pts)
int Triangulate (int index, vtkIdList &ptIds, vtkPoints &pts)

Static Public Methods

vtkLine * New ()
int IsTypeOf (const char *type)
vtkLine * SafeDownCast (vtkObject *o)
int Intersection (float p1[3], float p2[3], float x1[3], float x2[3], float &u, float &v)
float DistanceToLine (float x[3], float p1[3], float p2[3], float &t, float closestPoint[3])
float DistanceToLine (float x[3], float p1[3], float p2[3])
void InterpolationFunctions (float pcoords[3], float weights[2])

Protected Methods

 vtkLine ()
 ~vtkLine ()
 vtkLine (const vtkLine &)
void operator= (const vtkLine &)

Detailed Description

cell represents a 1D line.

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

vtkLine is a concrete implementation of vtkCell to represent a 1D line.

Examples:
vtkLine (examples)

Definition at line 57 of file vtkLine.h.


Constructor & Destructor Documentation

vtkLine::vtkLine   [protected]
 

vtkLine::~vtkLine   [inline, protected]
 

Definition at line 132 of file vtkLine.h.

vtkLine::vtkLine const vtkLine &    [inline, protected]
 

Definition at line 133 of file vtkLine.h.


Member Function Documentation

vtkLine* vtkLine::New   [static]
 

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

Reimplemented from vtkObject.

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

vtkLine* vtkLine::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* vtkLine::MakeObject   [virtual]
 

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

int vtkLine::GetCellType   [inline, virtual]
 

Return the type of cell.

Reimplemented from vtkCell.

Definition at line 65 of file vtkLine.h.

int vtkLine::GetCellDimension   [inline, virtual]
 

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

Reimplemented from vtkCell.

Definition at line 66 of file vtkLine.h.

int vtkLine::GetNumberOfEdges   [inline, virtual]
 

Return the number of edges in the cell.

Reimplemented from vtkCell.

Definition at line 67 of file vtkLine.h.

int vtkLine::GetNumberOfFaces   [inline, virtual]
 

Return the number of faces in the cell.

Reimplemented from vtkCell.

Definition at line 68 of file vtkLine.h.

vtkCell* vtkLine::GetEdge int    edgeId [inline, virtual]
 

Return the edge cell from the edgeId of the cell.

Reimplemented from vtkCell.

Definition at line 69 of file vtkLine.h.

vtkCell* vtkLine::GetFace int    faceId [inline, virtual]
 

Return the face cell from the faceId of the cell.

Reimplemented from vtkCell.

Definition at line 70 of file vtkLine.h.

int vtkLine::CellBoundary int    subId,
float    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.

Reimplemented from vtkCell.

void vtkLine::Contour float    value,
vtkScalars   cellScalars,
vtkPointLocator   locator,
vtkCellArray   verts,
vtkCellArray   lines,
vtkCellArray   polys,
vtkPointData   inPd,
vtkPointData   outPd,
vtkCellData   inCd,
int    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.)

Reimplemented from vtkCell.

int vtkLine::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 vtkLine::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 vtkLine::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 vtkLine::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.

void vtkLine::Clip float    value,
vtkScalars   cellScalars,
vtkPointLocator   locator,
vtkCellArray   lines,
vtkPointData   inPd,
vtkPointData   outPd,
vtkCellData   inCd,
int    cellId,
vtkCellData   outCd,
int    insideOut
[virtual]
 

Clip this line using scalar value provided. Like contouring, except that it cuts the line to produce other lines.

Reimplemented from vtkCell.

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

Line-line intersection. Intersection has to occur within [0,1] parametric coordinates and with specified tolerance.

Reimplemented from vtkCell.

int vtkLine::Intersection float    p1[3],
float    p2[3],
float    x1[3],
float    x2[3],
float &    u,
float &    v
[static]
 

Performs intersection of two finite 3D lines. An intersection is found if the projection of the two lines onto the plane perpendicular to the cross product of the two lines intersect. The parameters (u,v) are the parametric coordinates of the lines at the position of closest approach.

float vtkLine::DistanceToLine float    x[3],
float    p1[3],
float    p2[3],
float &    t,
float    closestPoint[3]
[static]
 

Compute distance to finite line. Returns parametric coordinate t and point location on line.

float vtkLine::DistanceToLine float    x[3],
float    p1[3],
float    p2[3]
[static]
 

Determine the distance of the current vertex to the edge defined by the vertices provided. Returns distance squared. Note: line is assumed infinite in extent.

void vtkLine::InterpolationFunctions float    pcoords[3],
float    weights[2]
[static]
 

Line specific methods.

int vtkLine::CellBoundary int    subId,
float    pcoords[3],
vtkIdList   pts
[inline]
 

For legacy compatibility. Do not use.

Definition at line 124 of file vtkLine.h.

int vtkLine::Triangulate int    index,
vtkIdList   ptIds,
vtkPoints   pts
[inline]
 

Definition at line 126 of file vtkLine.h.

void vtkLine::operator= const vtkLine &    [inline, protected]
 

Definition at line 134 of file vtkLine.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:52:44 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001