VTK
vtkLine.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkLine.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
22 #ifndef vtkLine_h
23 #define vtkLine_h
24 
25 #include "vtkCommonDataModelModule.h" // For export macro
26 #include "vtkCell.h"
28 
29 class VTKCOMMONDATAMODEL_EXPORT vtkLine : public vtkCell
30 {
31 public:
32  static vtkLine *New();
33  vtkTypeMacro(vtkLine,vtkCell);
34  void PrintSelf(ostream& os, vtkIndent indent) override;
35 
37 
40  int GetCellType() override {return VTK_LINE;};
41  int GetCellDimension() override {return 1;};
42  int GetNumberOfEdges() override {return 0;};
43  int GetNumberOfFaces() override {return 0;};
44  vtkCell *GetEdge(int) override {return nullptr;};
45  vtkCell *GetFace(int) override {return nullptr;};
46  int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override;
47  void Contour(double value, vtkDataArray *cellScalars,
49  vtkCellArray *lines, vtkCellArray *polys,
50  vtkPointData *inPd, vtkPointData *outPd,
51  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override;
52  int EvaluatePosition(const double x[3], double closestPoint[3],
53  int& subId, double pcoords[3],
54  double& dist2, double weights[]) override;
55  void EvaluateLocation(int& subId, const double pcoords[3], double x[3],
56  double *weights) override;
57  int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override;
58  void Derivatives(int subId, const double pcoords[3], const double *values,
59  int dim, double *derivs) override;
60  double *GetParametricCoords() override;
62 
67  void Clip(double value, vtkDataArray *cellScalars,
69  vtkPointData *inPd, vtkPointData *outPd,
70  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd,
71  int insideOut) override;
72 
76  int GetParametricCenter(double pcoords[3]) override;
77 
82  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t,
83  double x[3], double pcoords[3], int& subId) override;
84 
85 
93  static int Intersection(const double p1[3], const double p2[3],
94  const double x1[3], const double x2[3],
95  double& u, double& v);
96 
97 
110  static int Intersection3D(double p1[3], double p2[3],
111  double x1[3], double x2[3],
112  double& u, double& v);
113 
114 
123  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3],
124  double &t, double closestPoint[3]=nullptr);
125 
126 
132  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3]);
133 
142  static double DistanceBetweenLines(
143  double l0[3], double l1[3],
144  double m0[3], double m1[3],
145  double closestPt1[3], double closestPt2[3],
146  double &t1, double &t2 );
147 
156  static double DistanceBetweenLineSegments(
157  double l0[3], double l1[3],
158  double m0[3], double m1[3],
159  double closestPt1[3], double closestPt2[3],
160  double &t1, double &t2 );
161 
165  static void InterpolationFunctions(const double pcoords[3], double weights[2]);
169  static void InterpolationDerivs(const double pcoords[3], double derivs[2]);
171 
175  void InterpolateFunctions(const double pcoords[3], double weights[2]) override
176  {
177  vtkLine::InterpolationFunctions(pcoords,weights);
178  }
179  void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
180  {
181  vtkLine::InterpolationDerivs(pcoords,derivs);
182  }
184 
185 protected:
186  vtkLine();
187  ~vtkLine() override {}
188 
189 private:
190  vtkLine(const vtkLine&) = delete;
191  void operator=(const vtkLine&) = delete;
192 };
193 
194 //----------------------------------------------------------------------------
195 inline int vtkLine::GetParametricCenter(double pcoords[3])
196 {
197  pcoords[0] = 0.5;
198  pcoords[1] = pcoords[2] = 0.0;
199  return 0;
200 }
201 
202 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkLine::GetParametricCenter
int GetParametricCenter(double pcoords[3]) override
Return the center of the triangle in parametric coordinates.
Definition: vtkLine.h:195
vtkCell::IntersectWithLine
virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)=0
Intersect with a ray.
vtkCell::Contour
virtual void Contour(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)=0
Generate contouring primitives.
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:31
vtkX3D::value
Definition: vtkX3D.h:220
vtkIdType
int vtkIdType
Definition: vtkType.h:347
VTK_LINE
Definition: vtkCellType.h:48
vtkLine::InterpolateDerivs
void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
Definition: vtkLine.h:179
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:48
vtkCell::EvaluateLocation
virtual void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights)=0
Determine global coordinate (x[3]) from subId and parametric coordinates.
vtkLine
cell represents a 1D line
Definition: vtkLine.h:29
vtkCell.h
vtkLine::GetNumberOfFaces
int GetNumberOfFaces() override
Return the number of faces in the cell.
Definition: vtkLine.h:43
vtkLine::InterpolationFunctions
static void InterpolationFunctions(const double pcoords[3], double weights[2])
vtkCell::Triangulate
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:56
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
vtkLine::InterpolationDerivs
static void InterpolationDerivs(const double pcoords[3], double derivs[2])
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkCell::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:44
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:51
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:30
vtkLine::InterpolateFunctions
void InterpolateFunctions(const double pcoords[3], double weights[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkLine.h:175
vtkLine::GetNumberOfEdges
int GetNumberOfEdges() override
Return the number of edges in the cell.
Definition: vtkLine.h:42
vtkLine::GetFace
vtkCell * GetFace(int) override
Return the face cell from the faceId of the cell.
Definition: vtkLine.h:45
vtkLine::GetCellDimension
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
Definition: vtkLine.h:41
vtkCell::CellBoundary
virtual int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts)=0
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
vtkCell::EvaluatePosition
virtual int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[])=0
Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; ev...
vtkCell::GetParametricCoords
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this cell.
vtkCell::Clip
virtual void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)=0
Cut (or clip) the cell based on the input cellScalars and the specified value.
vtkCell::Derivatives
virtual void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs)=0
Compute derivatives given cell subId and parametric coordinates.
vtkCell::GetParametricCenter
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
vtkLine::~vtkLine
~vtkLine() override
Definition: vtkLine.h:187
vtkX3D::index
Definition: vtkX3D.h:246
vtkLine::GetEdge
vtkCell * GetEdge(int) override
Return the edge cell from the edgeId of the cell.
Definition: vtkLine.h:44
vtkLine::GetCellType
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:40