VTK  9.3.0
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
22 #ifndef vtkLine_h
23 #define vtkLine_h
24 
25 #include "vtkCell.h"
26 #include "vtkCommonDataModelModule.h" // For export macro
27 
28 VTK_ABI_NAMESPACE_BEGIN
30 
31 class VTKCOMMONDATAMODEL_EXPORT vtkLine : public vtkCell
32 {
33 public:
34  static vtkLine* New();
35  vtkTypeMacro(vtkLine, vtkCell);
36  void PrintSelf(ostream& os, vtkIndent indent) override;
37 
39 
42  int GetCellType() override { return VTK_LINE; }
43  int GetCellDimension() override { return 1; }
44  int GetNumberOfEdges() override { return 0; }
45  int GetNumberOfFaces() override { return 0; }
46  vtkCell* GetEdge(int) override { return nullptr; }
47  vtkCell* GetFace(int) override { return nullptr; }
48  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
49  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
50  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
51  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
52  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
53  double& dist2, double weights[]) override;
54  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
55  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
57  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
58  double* GetParametricCoords() override;
60 
67  int Inflate(double dist) override;
68 
73  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
74  vtkCellArray* lines, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
75  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
76 
80  int GetParametricCenter(double pcoords[3]) override;
81 
86  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
87  double pcoords[3], int& subId) override;
88 
89  // Return result type for Intersection() and Intersection3D()
91  {
92  NoIntersect = 0,
93  Intersect = 2,
94  OnLine = 3
95  };
96 
97  // Control the meaning of the provided tolerance. Fuzzy tolerances allow
98  // intersections to occur outside of the range (0<=u,v<=1) as long as they
99  // fall within the tolerance provided. Thus non-fuzzy tolerances must be
100  // within the (0,1) parametric range (inclusive)
102  {
103  Relative = 0,
104  Absolute = 1,
105  RelativeFuzzy = 2,
106  AbsoluteFuzzy = 3
107  };
108 
125  static int Intersection(const double p1[3], const double p2[3], const double x1[3],
126  const double x2[3], double& u, double& v, double tolerance = 1e-6,
127  int toleranceType = ToleranceType::Relative);
128 
137  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3], double& t,
138  double closestPoint[3] = nullptr);
139 
145  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3]);
146 
155  static double DistanceBetweenLines(double l0[3], double l1[3], double m0[3], double m1[3],
156  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
157 
166  static double DistanceBetweenLineSegments(double l0[3], double l1[3], double m0[3], double m1[3],
167  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
168 
169  static void InterpolationFunctions(const double pcoords[3], double weights[2]);
170  static void InterpolationDerivs(const double pcoords[3], double derivs[2]);
172 
176  void InterpolateFunctions(const double pcoords[3], double weights[2]) override
177  {
178  vtkLine::InterpolationFunctions(pcoords, weights);
179  }
180  void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
181  {
182  vtkLine::InterpolationDerivs(pcoords, derivs);
183  }
185 
186 protected:
188  ~vtkLine() override = default;
189 
190 private:
191  vtkLine(const vtkLine&) = delete;
192  void operator=(const vtkLine&) = delete;
193 };
194 
195 //----------------------------------------------------------------------------
196 inline int vtkLine::GetParametricCenter(double pcoords[3])
197 {
198  pcoords[0] = 0.5;
199  pcoords[1] = pcoords[2] = 0.0;
200  return 0;
201 }
202 
203 VTK_ABI_NAMESPACE_END
204 #endif
object to represent cell connectivity
Definition: vtkCellArray.h:185
represent and manipulate cell attribute data
Definition: vtkCellData.h:40
abstract class to specify cell behavior
Definition: vtkCell.h:59
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
list of point or cell ids
Definition: vtkIdList.h:32
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:38
cell represents a 1D line
Definition: vtkLine.h:32
double * GetParametricCoords() override
See the vtkCell API for descriptions of these methods.
int Inflate(double dist) override
Inflates this line by extending both end by dist.
static void InterpolationFunctions(const double pcoords[3], double weights[2])
static int Intersection(const double p1[3], const double p2[3], const double x1[3], const double x2[3], double &u, double &v, double tolerance=1e-6, int toleranceType=ToleranceType::Relative)
Performs intersection of the projection of two finite 3D lines onto a 2D plane.
int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
See the vtkCell API for descriptions of these methods.
int GetParametricCenter(double pcoords[3]) override
Return the center of the triangle in parametric coordinates.
Definition: vtkLine.h:196
static void InterpolationDerivs(const double pcoords[3], double derivs[2])
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions of these methods.
static double DistanceToLine(const double x[3], const double p1[3], const double p2[3], double &t, double closestPoint[3]=nullptr)
Compute the distance of a point x to a finite line (p1,p2).
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
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)
Computes the shortest distance squared between two finite line segments defined by their end points (...
~vtkLine() override=default
static double DistanceToLine(const double x[3], const double p1[3], const double p2[3])
Determine the distance of the current vertex to the edge defined by the vertices provided.
ToleranceType
Definition: vtkLine.h:102
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
See the vtkCell API for descriptions of these methods.
void Contour(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override
See the vtkCell API for descriptions of these methods.
IntersectionType
Definition: vtkLine.h:91
void InterpolateFunctions(const double pcoords[3], double weights[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkLine.h:176
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
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)
Computes the shortest distance squared between two infinite lines, each defined by a pair of points (...
int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
Line-line intersection.
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:43
vtkCell * GetFace(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:47
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:44
static vtkLine * New()
vtkCell * GetEdge(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:46
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:42
void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *lines, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
Clip this line using scalar value provided.
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:45
void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkLine.h:180
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
See the vtkCell API for descriptions of these methods.
represent and manipulate point attribute data
Definition: vtkPointData.h:39
represent and manipulate 3D points
Definition: vtkPoints.h:38
@ value
Definition: vtkX3D.h:220
@ index
Definition: vtkX3D.h:246
@ VTK_LINE
Definition: vtkCellType.h:49
int vtkIdType
Definition: vtkType.h:315