vtkLine Class Reference

#include <vtkLine.h>

Inheritance diagram for vtkLine:

[legend]Collaboration diagram for vtkLine:

[legend]List of all members.

Detailed Description

cell represents a 1D line

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

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (100%)

CVS logs (CVSweb):

.cxx (/Filtering/vtkLine.cxx)
.h (/Filtering/vtkLine.h)

Examples:: vtkLine (Examples)

Tests:: vtkLine (Tests)

Definition at line 42 of file vtkLine.h.

Public Types

typedef vtkCell Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

int GetCellType ()

int GetCellDimension ()

int GetNumberOfEdges ()

int GetNumberOfFaces ()

vtkCell * GetEdge (int)

vtkCell * GetFace (int)

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)

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 Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)

void Derivatives (int subId, double pcoords[3], double *values, int dim, double *derivs)

virtual double * GetParametricCoords ()

void Clip (double value, vtkDataArray *cellScalars, vtkPointLocator *locator, vtkCellArray *lines, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)

int IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)

Static Public Member Functions

vtkLine * New ()

int IsTypeOf (const char *type)

vtkLine * SafeDownCast (vtkObject *o)

double DistanceToLine (double x[3], double p1[3], double p2[3])

void InterpolationFunctions (double pcoords[3], double weights[2])

int Intersection (double p1[3], double p2[3], double x1[3], double x2[3], double &u, double &v)

double DistanceToLine (double x[3], double p1[3], double p2[3], double &t, double closestPoint[3])

Protected Member Functions

vtkLine ()

~vtkLine ()

Member Typedef Documentation

typedef vtkCell vtkLine::Superclass

Reimplemented from vtkCell.
Definition at line 46 of file vtkLine.h.

Constructor & Destructor Documentation

vtkLine::vtkLine ( ) [protected]

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

Definition at line 122 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]

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 vtkTypeRevisionMacro 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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkCell.

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

Reimplemented from vtkCell.

void vtkLine::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 vtkLine::GetCellType ( ) [inline, virtual]

See the vtkCell API for descriptions of these methods.
Implements vtkCell.
Definition at line 51 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Implements vtkCell.
Definition at line 52 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Implements vtkCell.
Definition at line 53 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Implements vtkCell.
Definition at line 54 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Implements vtkCell.
Definition at line 55 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Implements vtkCell.
Definition at line 56 of file vtkLine.h.

int vtkLine::CellBoundary ( int subId,

double pcoords[3],

vtkIdList * pts

) [virtual]

See the vtkCell API for descriptions of these methods.
Implements vtkCell.

void vtkLine::Contour ( double value,

vtkDataArray * cellScalars,

vtkPointLocator * locator,

vtkCellArray * verts,

vtkCellArray * lines,

vtkCellArray * polys,

vtkPointData * inPd,

vtkPointData * outPd,

vtkCellData * inCd,

vtkIdType cellId,

vtkCellData * outCd

) [virtual]

See the vtkCell API for descriptions of these methods.
Implements vtkCell.

int vtkLine::EvaluatePosition ( double x[3],

double * closestPoint,

int & subId,

double pcoords[3],

double & dist2,

double * weights

) [virtual]

See the vtkCell API for descriptions of these methods.
Implements vtkCell.

void vtkLine::EvaluateLocation ( int & subId,

double pcoords[3],

double x[3],

double * weights

) [virtual]

See the vtkCell API for descriptions of these methods.
Implements vtkCell.

int vtkLine::Triangulate ( int index,

vtkIdList * ptIds,

vtkPoints * pts

) [virtual]

See the vtkCell API for descriptions of these methods.
Implements vtkCell.

void vtkLine::Derivatives ( int subId,

double pcoords[3],

double * values,

int dim,

double * derivs

) [virtual]

See the vtkCell API for descriptions of these methods.
Implements vtkCell.

virtual double* vtkLine::GetParametricCoords ( ) [virtual]

See the vtkCell API for descriptions of these methods.
Reimplemented from vtkCell.

void vtkLine::Clip ( double value,

vtkDataArray * cellScalars,

vtkPointLocator * locator,

vtkCellArray * lines,

vtkPointData * inPd,

vtkPointData * outPd,

vtkCellData * inCd,

vtkIdType 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.
Implements vtkCell.

int vtkLine::IntersectWithLine ( double p1[3],

double p2[3],

double tol,

double & t,

double x[3],

double pcoords[3],

int & subId

) [virtual]

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

int vtkLine::Intersection ( double p1[3],

double p2[3],

double x1[3],

double x2[3],

double & u,

double & 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.

double vtkLine::DistanceToLine ( double x[3],

double p1[3],

double p2[3],

double & t,

double closestPoint[3]

) [static]

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

double vtkLine::DistanceToLine ( double x[3],

double p1[3],

double 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 ( double pcoords[3],

double weights[2]

) [static]

Line specific methods.

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

dox/Filtering/vtkLine.h


Public Types
typedef vtkCell	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

int	GetCellType ()
int	GetCellDimension ()
int	GetNumberOfEdges ()
int	GetNumberOfFaces ()
vtkCell *	GetEdge (int)
vtkCell *	GetFace (int)
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)
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	Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
void	Derivatives (int subId, double pcoords[3], double values, int dim, double derivs)
virtual double *	GetParametricCoords ()

void	Clip (double value, vtkDataArray cellScalars, vtkPointLocator locator, vtkCellArray lines, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)

int	IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
Static Public Member Functions
vtkLine *	New ()
int	IsTypeOf (const char *type)
vtkLine *	SafeDownCast (vtkObject *o)
double	DistanceToLine (double x[3], double p1[3], double p2[3])
void	InterpolationFunctions (double pcoords[3], double weights[2])

int	Intersection (double p1[3], double p2[3], double x1[3], double x2[3], double &u, double &v)

double	DistanceToLine (double x[3], double p1[3], double p2[3], double &t, double closestPoint[3])
Protected Member Functions
	vtkLine ()
	~vtkLine ()