vtkLine Class Reference

cell represents a 1D line More...

#include <vtkLine.h>

Inheritance diagram for vtkLine:

Collaboration diagram for vtkLine:

Public Types
typedef vtkCell	Superclass
Public Types inherited from vtkCell
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkLine *	NewInstance () const
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, vtkIncrementalPointLocator *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, vtkIncrementalPointLocator *locator, vtkCellArray *lines, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)
int	GetParametricCenter (double pcoords[3])
int	IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
virtual void	InterpolateFunctions (double pcoords[3], double weights[2])
virtual void	InterpolateDerivs (double pcoords[3], double derivs[2])
Public Member Functions inherited from vtkCell
vtkCell *	NewInstance () const
void	Initialize (int npts, vtkIdType *pts, vtkPoints *p)
virtual void	ShallowCopy (vtkCell *c)
virtual void	DeepCopy (vtkCell *c)
virtual int	IsLinear ()
virtual int	RequiresInitialization ()
virtual void	Initialize ()
virtual int	IsExplicitCell ()
virtual int	RequiresExplicitFaceRepresentation ()
virtual void	SetFaces (vtkIdType *vtkNotUsed(faces))
virtual vtkIdType *	GetFaces ()
vtkPoints *	GetPoints ()
vtkIdType	GetNumberOfPoints ()
vtkIdList *	GetPointIds ()
vtkIdType	GetPointId (int ptId)
void	GetBounds (double bounds[6])
double *	GetBounds ()
double	GetLength2 ()
virtual double	GetParametricDistance (double pcoords[3])
virtual int	IsPrimaryCell ()
virtual void	InterpolateFunctions (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
virtual void	InterpolateDerivs (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
int	GetReferenceCount ()
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkLine *	New ()
static int	IsTypeOf (const char *type)
static vtkLine *	SafeDownCast (vtkObjectBase *o)
static int	Intersection (double p1[3], double p2[3], double x1[3], double x2[3], double &u, double &v)
static double	DistanceToLine (double x[3], double p1[3], double p2[3], double &t, double closestPoint[3])
static double	DistanceToLine (double x[3], double p1[3], double p2[3])
static double	DistanceBetweenLines (double l0[3], double l1[3], double m0[3], double m1[3], double closestPt1[3], double closestPt2[3], double &t1, double &t2)
static double	DistanceBetweenLineSegments (double l0[3], double l1[3], double m0[3], double m1[3], double closestPt1[3], double closestPt2[3], double &t1, double &t2)
static void	InterpolationFunctions (double pcoords[3], double weights[2])
static void	InterpolationDerivs (double pcoords[3], double derivs[2])
Static Public Member Functions inherited from vtkCell
static int	IsTypeOf (const char *type)
static vtkCell *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkLine ()
	~vtkLine ()
Protected Member Functions inherited from vtkCell
	vtkCell ()
	~vtkCell ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkCell
vtkPoints *	Points
vtkIdList *	PointIds
Protected Attributes inherited from vtkCell
double	Bounds [6]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

cell represents a 1D line

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

Examples:

vtkLine (Examples)

Tests:

vtkLine (Tests)

Definition at line 34 of file vtkLine.h.

Member Typedef Documentation

Superclass

typedef vtkCell vtkLine::Superclass

Definition at line 38 of file vtkLine.h.

Constructor & Destructor Documentation

vtkLine()

vtkLine::vtkLine ( )

protected

~vtkLine()

vtkLine::~vtkLine ( )

inlineprotected

Definition at line 163 of file vtkLine.h.

Member Function Documentation

New()

static vtkLine* vtkLine::New ( )

static

IsTypeOf()

static int vtkLine::IsTypeOf ( const char *  type )

static

IsA()

virtual int vtkLine::IsA ( const char *  name )

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.

SafeDownCast()

static vtkLine* vtkLine::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase* vtkLine::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCell.

NewInstance()

vtkLine* vtkLine::NewInstance

(

)

const

PrintSelf()

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.

GetCellType()

int vtkLine::GetCellType ( )

inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 43 of file vtkLine.h.

GetCellDimension()

int vtkLine::GetCellDimension ( )

inlinevirtual

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

Implements vtkCell.

Definition at line 44 of file vtkLine.h.

GetNumberOfEdges()

int vtkLine::GetNumberOfEdges ( )

inlinevirtual

Return the number of edges in the cell.

Implements vtkCell.

Definition at line 45 of file vtkLine.h.

GetNumberOfFaces()

int vtkLine::GetNumberOfFaces ( )

inlinevirtual

Return the number of faces in the cell.

Implements vtkCell.

Definition at line 46 of file vtkLine.h.

GetEdge()

vtkCell* vtkLine::GetEdge ( int  edgeId )

inlinevirtual

Return the edge cell from the edgeId of the cell.

Implements vtkCell.

Definition at line 47 of file vtkLine.h.

GetFace()

vtkCell* vtkLine::GetFace ( int  faceId )

inlinevirtual

Return the face cell from the faceId of the cell.

Implements vtkCell.

Definition at line 48 of file vtkLine.h.

CellBoundary()

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

Implements vtkCell.

Contour()

void vtkLine::Contour ( double  value, vtkDataArray *  cellScalars, vtkIncrementalPointLocator *  locator, vtkCellArray *  verts, vtkCellArray *  lines, vtkCellArray *  polys, vtkPointData *  inPd, vtkPointData *  outPd, vtkCellData *  inCd, vtkIdType  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.)

Implements vtkCell.

EvaluatePosition()

int vtkLine::EvaluatePosition ( double  x[3], double *  closestPoint, int &  subId, double  pcoords[3], double &  dist2, double *  weights  )

virtual

Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; 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.

Implements vtkCell.

EvaluateLocation()

void vtkLine::EvaluateLocation ( int &  subId, double  pcoords[3], double  x[3], double *  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.)

Implements vtkCell.

Triangulate()

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. This method does not insert new points: all the points that define the simplices are the points that define the cell.

Implements vtkCell.

Derivatives()

void vtkLine::Derivatives ( int  subId, double  pcoords[3], double *  values, int  dim, double *  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)).

Implements vtkCell.

GetParametricCoords()

virtual double* vtkLine::GetParametricCoords ( )

virtual

Return a contiguous array of parametric coordinates of the points defining this cell. In other words, (px,py,pz, px,py,pz, etc..) The coordinates are ordered consistent with the definition of the point ordering for the cell. This method returns a non-NULL pointer when the cell is a primary type (i.e., IsPrimaryCell() is true). Note that 3D parametric coordinates are returned no matter what the topological dimension of the cell.

Reimplemented from vtkCell.

Clip()

void vtkLine::Clip ( double  value, vtkDataArray *  cellScalars, vtkIncrementalPointLocator *  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.

GetParametricCenter()

int vtkLine::GetParametricCenter ( double  pcoords[3] )

inlinevirtual

Return the center of the triangle in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 171 of file vtkLine.h.

IntersectWithLine()

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.

Intersection()

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

DistanceToLine() [1/2]

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

static

Compute the distance of a point x to a finite line (p1,p2). The method computes the parametric coordinate t and the point location on the line. Note that t is unconstrained (i.e., it may lie outside the range [0,1]) but the closest point will lie within the finite line [p1,p2]. Also, the method returns the distance squared between x and the line (p1,p2).

DistanceToLine() [2/2]

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

DistanceBetweenLines()

static double vtkLine::DistanceBetweenLines ( double  l0[3], double  l1[3], double  m0[3], double  m1[3], double  closestPt1[3], double  closestPt2[3], double &  t1, double &  t2  )

static

Computes the shortest distance squared between two infinite lines, each defined by a pair of points (l0,l1) and (m0,m1). Upon return, the closest points on the two line segments will be stored in closestPt1 and closestPt2. Their parametric coords (-inf <= t0, t1 <= inf) will be stored in t0 and t1. The return value is the shortest distance squared between the two line-segments.

DistanceBetweenLineSegments()

static double vtkLine::DistanceBetweenLineSegments ( double  l0[3], double  l1[3], double  m0[3], double  m1[3], double  closestPt1[3], double  closestPt2[3], double &  t1, double &  t2  )

static

Computes the shortest distance squared between two finite line segments defined by their end points (l0,l1) and (m0,m1). Upon return, the closest points on the two line segments will be stored in closestPt1 and closestPt2. Their parametric coords (0 <= t0, t1 <= 1) will be stored in t0 and t1. The return value is the shortest distance squared between the two line-segments.

InterpolationFunctions()

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

static

Deprecated:

Replaced by vtkLine::InterpolateFunctions as of VTK 5.2

InterpolationDerivs()

static void vtkLine::InterpolationDerivs ( double  pcoords[3], double  derivs[2]  )

static

Deprecated:

Replaced by vtkLine::InterpolateDerivs as of VTK 5.2

InterpolateFunctions()

virtual void vtkLine::InterpolateFunctions ( double  pcoords[3], double  weights[2]  )

inlinevirtual

Compute the interpolation functions/derivatives (aka shape functions/derivatives)

Definition at line 151 of file vtkLine.h.

InterpolateDerivs()

virtual void vtkLine::InterpolateDerivs ( double  pcoords[3], double  derivs[2]  )

inlinevirtual

Definition at line 155 of file vtkLine.h.

---

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

• dox/opt/build/vtk6-6.3.0+dfsg2/Common/DataModel/vtkLine.h