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:

[legend]Collaboration diagram for vtkLine:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)

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 verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType 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, vtkDataArray cellScalars, vtkPointLocator locator, vtkCellArray lines, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType 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)
Static Public Methods
vtkLine *	New ()
int	IsTypeOf (const char *type)
vtkLine *	SafeDownCast (vtkObject *o)
float	DistanceToLine (float x[3], float p1[3], float p2[3])
void	InterpolationFunctions (float pcoords[3], float weights[2])

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])
Protected Methods
	vtkLine ()
	~vtkLine ()

Detailed Description

cell represents a 1D line.

Date:: 2001/11/02 16:41:10

Revision:: 1.59

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

Examples:: vtkLine (Examples)

Tests:: vtkLine (Tests)

Definition at line 60 of file vtkLine.h.

Constructor & Destructor Documentation

vtkLine::vtkLine ( ) [protected]

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

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

See the vtkCell API for descriptions of these methods.
Reimplemented from vtkCell.
Definition at line 69 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Reimplemented from vtkCell.
Definition at line 70 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Reimplemented from vtkCell.
Definition at line 71 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Reimplemented from vtkCell.
Definition at line 72 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Reimplemented from vtkCell.
Definition at line 73 of file vtkLine.h.

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

See the vtkCell API for descriptions of these methods.
Reimplemented from vtkCell.
Definition at line 74 of file vtkLine.h.

int vtkLine::CellBoundary ( int subId,

float pcoords[3],

vtkIdList * pts

) [virtual]

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

void vtkLine::Contour ( float 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.
Reimplemented from vtkCell.

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

float * closestPoint,

int & subId,

float pcoords[3],

float & dist2,

float * weights

) [virtual]

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

void vtkLine::EvaluateLocation ( int & subId,

float pcoords[3],

float x[3],

float * weights

) [virtual]

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

int vtkLine::Triangulate ( int index,

vtkIdList * ptIds,

vtkPoints * pts

) [virtual]

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

void vtkLine::Derivatives ( int subId,

float pcoords[3],

float * values,

int dim,

float * derivs

) [virtual]

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

void vtkLine::Clip ( float 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.
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.

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

Common/vtkLine.h

Generated on Thu Mar 28 14:34:44 2002 for VTK by

vtkLine Class Reference

Public Methods

Static Public Methods

Protected Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation