vtkPolyLine Class Reference

#include <vtkPolyLine.h>

Inheritance diagram for vtkPolyLine:

[legend]Collaboration diagram for vtkPolyLine:

[legend]List of all members.

Detailed Description

cell represents a set of 1D lines

vtkPolyLine is a concrete implementation of vtkCell to represent a set of 1D lines.

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (100%)

CVS logs (CVSweb):

.cxx (/Filtering/vtkPolyLine.cxx)
.h (/Filtering/vtkPolyLine.h)

Examples:: vtkPolyLine (Examples)

Tests:: vtkPolyLine (Tests)

Definition at line 53 of file vtkPolyLine.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 GetParametricCenter (double pcoords[3])

int GenerateSlidingNormals (vtkPoints *, vtkCellArray *, vtkDataArray *)

int GenerateSlidingNormals (vtkPoints *, vtkCellArray *, vtkDataArray *, double *firstNormal)

int GetCellType ()

int GetCellDimension ()

int GetNumberOfEdges ()

int GetNumberOfFaces ()

vtkCell * GetEdge (int vtkNotUsed(edgeId))

vtkCell * GetFace (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 *lines, 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

vtkPolyLine * New ()

int IsTypeOf (const char *type)

vtkPolyLine * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkPolyLine ()

~vtkPolyLine ()

Protected Attributes

vtkLine * Line

Member Typedef Documentation

typedef vtkCell vtkPolyLine::Superclass

Reimplemented from vtkCell.
Definition at line 57 of file vtkPolyLine.h.

Constructor & Destructor Documentation

vtkPolyLine::vtkPolyLine ( ) [protected]

vtkPolyLine::~vtkPolyLine ( ) [protected]

Member Function Documentation

vtkPolyLine* vtkPolyLine::New ( ) [static]

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

virtual const char* vtkPolyLine::GetClassName ( ) [virtual]

Reimplemented from vtkCell.

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

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

Reimplemented from vtkCell.

void vtkPolyLine::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 vtkPolyLine::GenerateSlidingNormals ( vtkPoints * ,

vtkCellArray * ,

vtkDataArray *

)

Given points and lines, compute normals to lines. These are not true normals, they are "orientation" normals used by classes like vtkTubeFilter that control the rotation around the line. The normals try to stay pointing in the same direction as much as possible (i.e., minimal rotation).

int vtkPolyLine::GenerateSlidingNormals ( vtkPoints * ,

vtkCellArray * ,

vtkDataArray * ,

double * firstNormal

)

Given points and lines, compute normals to lines. These are not true normals, they are "orientation" normals used by classes like vtkTubeFilter that control the rotation around the line. The normals try to stay pointing in the same direction as much as possible (i.e., minimal rotation).

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

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

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

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

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

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

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

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

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

See the vtkCell API for descriptions of these methods.
Definition at line 77 of file vtkPolyLine.h.

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

See the vtkCell API for descriptions of these methods.
Definition at line 78 of file vtkPolyLine.h.

int vtkPolyLine::CellBoundary ( int subId,

double pcoords[3],

vtkIdList * pts

) [virtual]

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

void vtkPolyLine::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.

void vtkPolyLine::Clip ( double value,

vtkDataArray * cellScalars,

vtkPointLocator * locator,

vtkCellArray * lines,

vtkPointData * inPd,

vtkPointData * outPd,

vtkCellData * inCd,

vtkIdType cellId,

vtkCellData * outCd,

int insideOut

) [virtual]

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

int vtkPolyLine::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 vtkPolyLine::EvaluateLocation ( int & subId,

double pcoords[3],

double x[3],

double * weights

) [virtual]

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

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

double p2[3],

double tol,

double & t,

double x[3],

double pcoords[3],

int & subId

) [virtual]

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

int vtkPolyLine::Triangulate ( int index,

vtkIdList * ptIds,

vtkPoints * pts

) [virtual]

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

void vtkPolyLine::Derivatives ( int subId,

double pcoords[3],

double * values,

int dim,

double * derivs

) [virtual]

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

int vtkPolyLine::IsPrimaryCell ( ) [inline, virtual]

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

int vtkPolyLine::GetParametricCenter ( double pcoords[3] ) [virtual]

Return the center of the point cloud in parametric coordinates.
Reimplemented from vtkCell.

Member Data Documentation

vtkLine* vtkPolyLine::Line [protected]

Definition at line 111 of file vtkPolyLine.h.

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

dox/Filtering/vtkPolyLine.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	GetParametricCenter (double pcoords[3])

int	GenerateSlidingNormals (vtkPoints , vtkCellArray , vtkDataArray *)
int	GenerateSlidingNormals (vtkPoints , vtkCellArray , vtkDataArray , double firstNormal)

int	GetCellType ()
int	GetCellDimension ()
int	GetNumberOfEdges ()
int	GetNumberOfFaces ()
vtkCell *	GetEdge (int vtkNotUsed(edgeId))
vtkCell *	GetFace (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 lines, 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
vtkPolyLine *	New ()
int	IsTypeOf (const char *type)
vtkPolyLine *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPolyLine ()
	~vtkPolyLine ()
Protected Attributes
vtkLine *	Line