VTK  9.3.1
vtkLine.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
13 #ifndef vtkLine_h
14 #define vtkLine_h
15 
16 #include "vtkCell.h"
17 #include "vtkCommonDataModelModule.h" // For export macro
18 
19 VTK_ABI_NAMESPACE_BEGIN
21 
22 class VTKCOMMONDATAMODEL_EXPORT vtkLine : public vtkCell
23 {
24 public:
25  static vtkLine* New();
26  vtkTypeMacro(vtkLine, vtkCell);
27  void PrintSelf(ostream& os, vtkIndent indent) override;
28 
30 
33  int GetCellType() override { return VTK_LINE; }
34  int GetCellDimension() override { return 1; }
35  int GetNumberOfEdges() override { return 0; }
36  int GetNumberOfFaces() override { return 0; }
37  vtkCell* GetEdge(int) override { return nullptr; }
38  vtkCell* GetFace(int) override { return nullptr; }
39  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
40  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
41  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
42  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
43  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
44  double& dist2, double weights[]) override;
45  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
46  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
47  void Derivatives(
48  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
49  double* GetParametricCoords() override;
51 
58  int Inflate(double dist) override;
59 
64  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
65  vtkCellArray* lines, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
66  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
67 
71  int GetParametricCenter(double pcoords[3]) override;
72 
77  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
78  double pcoords[3], int& subId) override;
79 
80  // Return result type for Intersection() and Intersection3D()
82  {
83  NoIntersect = 0,
84  Intersect = 2,
85  OnLine = 3
86  };
87 
88  // Control the meaning of the provided tolerance. Fuzzy tolerances allow
89  // intersections to occur outside of the range (0<=u,v<=1) as long as they
90  // fall within the tolerance provided. Thus non-fuzzy tolerances must be
91  // within the (0,1) parametric range (inclusive)
93  {
94  Relative = 0,
95  Absolute = 1,
96  RelativeFuzzy = 2,
97  AbsoluteFuzzy = 3
98  };
99 
116  static int Intersection(const double p1[3], const double p2[3], const double x1[3],
117  const double x2[3], double& u, double& v, double tolerance = 1e-6,
118  int toleranceType = ToleranceType::Relative);
119 
128  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3], double& t,
129  double closestPoint[3] = nullptr);
130 
136  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3]);
137 
146  static double DistanceBetweenLines(double l0[3], double l1[3], double m0[3], double m1[3],
147  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
148 
157  static double DistanceBetweenLineSegments(double l0[3], double l1[3], double m0[3], double m1[3],
158  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
159 
160  static void InterpolationFunctions(const double pcoords[3], double weights[2]);
161  static void InterpolationDerivs(const double pcoords[3], double derivs[2]);
163 
167  void InterpolateFunctions(const double pcoords[3], double weights[2]) override
168  {
169  vtkLine::InterpolationFunctions(pcoords, weights);
170  }
171  void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
172  {
173  vtkLine::InterpolationDerivs(pcoords, derivs);
174  }
176 
177 protected:
178  vtkLine();
179  ~vtkLine() override = default;
180 
181 private:
182  vtkLine(const vtkLine&) = delete;
183  void operator=(const vtkLine&) = delete;
184 };
185 
186 //----------------------------------------------------------------------------
187 inline int vtkLine::GetParametricCenter(double pcoords[3])
188 {
189  pcoords[0] = 0.5;
190  pcoords[1] = pcoords[2] = 0.0;
191  return 0;
192 }
193 
194 VTK_ABI_NAMESPACE_END
195 #endif
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:35
void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkLine.h:171
represent and manipulate point attribute data
Definition: vtkPointData.h:29
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:33
static void InterpolationDerivs(const double pcoords[3], double derivs[2])
represent and manipulate cell attribute data
Definition: vtkCellData.h:30
Abstract class in support of both point location and point insertion.
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
int vtkIdType
Definition: vtkType.h:315
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:34
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...
cell represents a 1D line
Definition: vtkLine.h:22
abstract class to specify cell behavior
Definition: vtkCell.h:49
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.
vtkCell * GetEdge(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:37
a simple class to control print indentation
Definition: vtkIndent.h:28
vtkCell * GetFace(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:38
list of point or cell ids
Definition: vtkIdList.h:22
ToleranceType
Definition: vtkLine.h:92
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:44
IntersectionType
Definition: vtkLine.h:81
virtual int Inflate(double dist)
Inflates the cell.
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.
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...
object to represent cell connectivity
Definition: vtkCellArray.h:175
void InterpolateFunctions(const double pcoords[3], double weights[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkLine.h:167
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:36
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.
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.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this cell.
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
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.
static void InterpolationFunctions(const double pcoords[3], double weights[2])
represent and manipulate 3D points
Definition: vtkPoints.h:28
int GetParametricCenter(double pcoords[3]) override
Return the center of the triangle in parametric coordinates.
Definition: vtkLine.h:187