VTK  9.2.6
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 =========================================================================*/
25 #ifndef vtkLine_h
26 #define vtkLine_h
27 
28 #include "vtkCell.h"
29 #include "vtkCommonDataModelModule.h" // For export macro
30 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_1_0
32 
33 class VTKCOMMONDATAMODEL_EXPORT vtkLine : public vtkCell
34 {
35 public:
36  static vtkLine* New();
37  vtkTypeMacro(vtkLine, vtkCell);
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39 
41 
44  int GetCellType() override { return VTK_LINE; }
45  int GetCellDimension() override { return 1; }
46  int GetNumberOfEdges() override { return 0; }
47  int GetNumberOfFaces() override { return 0; }
48  vtkCell* GetEdge(int) override { return nullptr; }
49  vtkCell* GetFace(int) override { return nullptr; }
50  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
51  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
52  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
53  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
54  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
55  double& dist2, double weights[]) override;
56  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
57  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
58  void Derivatives(
59  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
60  double* GetParametricCoords() override;
62 
69  int Inflate(double dist) override;
70 
75  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
76  vtkCellArray* lines, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
77  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
78 
82  int GetParametricCenter(double pcoords[3]) override;
83 
88  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
89  double pcoords[3], int& subId) override;
90 
91  // Return result type for Intersection() and Intersection3D()
93  {
94  NoIntersect = 0,
95  Intersect = 2,
96  OnLine = 3
97  };
98 
99  // Control the meaning of the provided tolerance. Fuzzy tolerances allow
100  // intersections to occur outside of the range (0<=u,v<=1) as long as they
101  // fall within the tolerance provided. Thus non-fuzzy tolerances must be
102  // within the (0,1) parametric range (inclusive)
104  {
105  Relative = 0,
106  Absolute = 1,
107  RelativeFuzzy = 2,
108  AbsoluteFuzzy = 3
109  };
110 
127  static int Intersection(const double p1[3], const double p2[3], const double x1[3],
128  const double x2[3], double& u, double& v, const double tolerance = 1e-6,
129  int toleranceType = ToleranceType::Relative);
130 
143  VTK_DEPRECATED_IN_9_1_0("Use vtkLine::Intersection(...) instead.")
144  static int Intersection3D(double p1[3], double p2[3], double x1[3], double x2[3], double& u,
145  double& v, const double tolerance = 1e-6);
146 
155  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3], double& t,
156  double closestPoint[3] = nullptr);
157 
163  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3]);
164 
173  static double DistanceBetweenLines(double l0[3], double l1[3], double m0[3], double m1[3],
174  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
175 
184  static double DistanceBetweenLineSegments(double l0[3], double l1[3], double m0[3], double m1[3],
185  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
186 
187  static void InterpolationFunctions(const double pcoords[3], double weights[2]);
188  static void InterpolationDerivs(const double pcoords[3], double derivs[2]);
190 
194  void InterpolateFunctions(const double pcoords[3], double weights[2]) override
195  {
196  vtkLine::InterpolationFunctions(pcoords, weights);
197  }
198  void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
199  {
200  vtkLine::InterpolationDerivs(pcoords, derivs);
201  }
203 
204 protected:
205  vtkLine();
206  ~vtkLine() override = default;
207 
208 private:
209  vtkLine(const vtkLine&) = delete;
210  void operator=(const vtkLine&) = delete;
211 };
212 
213 //----------------------------------------------------------------------------
214 inline int vtkLine::GetParametricCenter(double pcoords[3])
215 {
216  pcoords[0] = 0.5;
217  pcoords[1] = pcoords[2] = 0.0;
218  return 0;
219 }
220 
221 #endif
#define VTK_DEPRECATED_IN_9_1_0(reason)
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:46
void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkLine.h:198
represent and manipulate point attribute data
Definition: vtkPointData.h:41
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:44
static void InterpolationDerivs(const double pcoords[3], double derivs[2])
represent and manipulate cell attribute data
Definition: vtkCellData.h:41
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:332
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:45
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:33
abstract class to specify cell behavior
Definition: vtkCell.h:60
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:48
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkCell * GetFace(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:49
list of point or cell ids
Definition: vtkIdList.h:33
ToleranceType
Definition: vtkLine.h:103
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
IntersectionType
Definition: vtkLine.h:92
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:186
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:47
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:39
int GetParametricCenter(double pcoords[3]) override
Return the center of the triangle in parametric coordinates.
Definition: vtkLine.h:214