VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkLine Class Reference

cell represents a 1D line More...

#include <vtkLine.h>

Inheritance diagram for vtkLine:
[legend]
Collaboration diagram for vtkLine:
[legend]

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 const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int GetParametricCenter (double pcoords[3])
int GetCellType ()
int GetCellDimension ()
int GetNumberOfEdges ()
int GetNumberOfFaces ()
vtkCellGetEdge (int)
vtkCellGetFace (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 IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
- Public Member Functions inherited from vtkCell
void Initialize (int npts, vtkIdType *pts, vtkPoints *p)
virtual void ShallowCopy (vtkCell *c)
virtual void DeepCopy (vtkCell *c)
virtual int IsLinear ()
virtual int IsExplicitCell ()
vtkPointsGetPoints ()
vtkIdType GetNumberOfPoints ()
vtkIdListGetPointIds ()
vtkIdType GetPointId (int ptId)
void GetBounds (double bounds[6])
double * GetBounds ()
double GetLength2 ()
virtual double GetParametricDistance (double pcoords[3])
virtual int IsPrimaryCell ()
virtual int RequiresInitialization ()
virtual void Initialize ()
virtual int RequiresExplicitFaceRepresentation ()
virtual void SetFaces (vtkIdType *vtkNotUsed(faces))
virtual vtkIdTypeGetFaces ()
virtual void InterpolateFunctions (double pcoords[3], double weights[3])
virtual void InterpolateDerivs (double pcoords[3], double derivs[3])
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkLineNew ()
static int IsTypeOf (const char *type)
static vtkLineSafeDownCast (vtkObject *o)
static double DistanceToLine (double x[3], double p1[3], double p2[3])
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 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)

Protected Member Functions

 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)
static void InterpolationFunctions (double pcoords[3], double weights[2])
static void InterpolationDerivs (double pcoords[3], double derivs[2])
virtual void InterpolateFunctions (double pcoords[3], double weights[2])
virtual void InterpolateDerivs (double pcoords[3], double derivs[2])

Additional Inherited Members

- Public Attributes inherited from vtkCell
vtkPointsPoints
vtkIdListPointIds
- Protected Attributes inherited from vtkCell
double Bounds [6]
- Friends inherited from vtkObject

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 33 of file vtkLine.h.

Member Typedef Documentation

Definition at line 37 of file vtkLine.h.

Constructor & Destructor Documentation

vtkLine::vtkLine ( )
protected
vtkLine::~vtkLine ( )
inlineprotected

Definition at line 164 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 *  name)
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 *  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.

static 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 ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 42 of file vtkLine.h.

int vtkLine::GetCellDimension ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 43 of file vtkLine.h.

int vtkLine::GetNumberOfEdges ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 44 of file vtkLine.h.

int vtkLine::GetNumberOfFaces ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 45 of file vtkLine.h.

vtkCell* vtkLine::GetEdge ( int  )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 46 of file vtkLine.h.

vtkCell* vtkLine::GetFace ( int  )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 47 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,
vtkIncrementalPointLocator 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,
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.

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

Return the center of the triangle in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 172 of file vtkLine.h.

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.

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.

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

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.

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.

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.

static void vtkLine::InterpolationFunctions ( double  pcoords[3],
double  weights[2] 
)
static
Deprecated:
Replaced by vtkLine::InterpolateFunctions as of VTK 5.2
static void vtkLine::InterpolationDerivs ( double  pcoords[3],
double  derivs[2] 
)
static
Deprecated:
Replaced by vtkLine::InterpolateFunctions as of VTK 5.2
virtual void vtkLine::InterpolateFunctions ( double  pcoords[3],
double  weights[2] 
)
inlinevirtual
Deprecated:
Replaced by vtkLine::InterpolateFunctions as of VTK 5.2

Definition at line 152 of file vtkLine.h.

virtual void vtkLine::InterpolateDerivs ( double  pcoords[3],
double  derivs[2] 
)
inlinevirtual
Deprecated:
Replaced by vtkLine::InterpolateFunctions as of VTK 5.2

Definition at line 156 of file vtkLine.h.


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