vtkLine Class Reference

#include <vtkLine.h>

Inheritance diagram for vtkLine:

List of all members.

Detailed Description

cell represents a 1D line

Date: 2002/11/12 18:55:41

Revision: 1.62

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

Examples:: vtkLine (Examples)

Tests:: vtkLine (Tests)

Definition at line 36 of file vtkLine.h.

Public Types

typedef vtkCell Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

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 Member Functions

static vtkLine * New ()

static int IsTypeOf (const char *type)

static vtkLine * SafeDownCast (vtkObject *o)

static float DistanceToLine (float x[3], float p1[3], float p2[3])

static void InterpolationFunctions (float pcoords[3], float weights[2])

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

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

Protected Member Functions

vtkLine ()

~vtkLine ()

Member Typedef Documentation

typedef vtkCell vtkLine::Superclass

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

Constructor & Destructor Documentation

vtkLine::vtkLine ( ) [protected]

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

Definition at line 113 of file vtkLine.h.

Member Function Documentation

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

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

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

Reimplemented from vtkCell.

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

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

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

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

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

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

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

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

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

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

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

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

int vtkLine::CellBoundary ( int subId,

float pcoords[3],

vtkIdList * pts

) [virtual]

See the vtkCell API for descriptions of these methods.
Implements 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.
Implements 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.
Implements vtkCell.

void vtkLine::EvaluateLocation ( int & subId,

float pcoords[3],

float x[3],

float * 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,

float pcoords[3],

float * values,

int dim,

float * derivs

) [virtual]

See the vtkCell API for descriptions of these methods.
Implements 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.
Implements 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.
Implements vtkCell.

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

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

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

static void vtkLine::InterpolationFunctions ( float pcoords[3],

float weights[2]

) [static]

Line specific methods.

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

dox/Common/vtkLine.h


Public Types
typedef vtkCell	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)

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 Member Functions
static vtkLine *	New ()
static int	IsTypeOf (const char *type)
static vtkLine *	SafeDownCast (vtkObject *o)
static float	DistanceToLine (float x[3], float p1[3], float p2[3])
static void	InterpolationFunctions (float pcoords[3], float weights[2])

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

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