VTK  9.2.5
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 =========================================================================*/
134 #ifndef vtkLine_h
135 #define vtkLine_h
136 
137 #include "vtkCell.h"
138 #include "vtkCommonDataModelModule.h" // For export macro
139 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_1_0
141 
142 class VTKCOMMONDATAMODEL_EXPORT vtkLine : public vtkCell
143 {
144 public:
145  static vtkLine* New();
146  vtkTypeMacro(vtkLine, vtkCell);
147  void PrintSelf(ostream& os, vtkIndent indent) override;
148 
150 
153  int GetCellType() override { return VTK_LINE; }
154  int GetCellDimension() override { return 1; }
155  int GetNumberOfEdges() override { return 0; }
156  int GetNumberOfFaces() override { return 0; }
157  vtkCell* GetEdge(int) override { return nullptr; }
158  vtkCell* GetFace(int) override { return nullptr; }
159  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
160  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
161  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
162  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
163  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
164  double& dist2, double weights[]) override;
165  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
166  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
168  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
169  double* GetParametricCoords() override;
171 
178  int Inflate(double dist) override;
179 
184  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
185  vtkCellArray* lines, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
186  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
187 
191  int GetParametricCenter(double pcoords[3]) override;
192 
197  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
198  double pcoords[3], int& subId) override;
199 
200  // Return result type for Intersection() and Intersection3D()
202  {
203  NoIntersect = 0,
204  Intersect = 2,
205  OnLine = 3
206  };
207 
208  // Control the meaning of the provided tolerance. Fuzzy tolerances allow
209  // intersections to occur outside of the range (0<=u,v<=1) as long as they
210  // fall within the tolerance provided. Thus non-fuzzy tolerances must be
211  // within the (0,1) parametric range (inclusive)
213  {
214  Relative = 0,
215  Absolute = 1,
216  RelativeFuzzy = 2,
217  AbsoluteFuzzy = 3
218  };
219 
236  static int Intersection(const double p1[3], const double p2[3], const double x1[3],
237  const double x2[3], double& u, double& v, const double tolerance = 1e-6,
238  int toleranceType = ToleranceType::Relative);
239 
252  VTK_DEPRECATED_IN_9_1_0("Use vtkLine::Intersection(...) instead.")
253  static int Intersection3D(double p1[3], double p2[3], double x1[3], double x2[3], double& u,
254  double& v, const double tolerance = 1e-6);
255 
264  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3], double& t,
265  double closestPoint[3] = nullptr);
266 
272  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3]);
273 
282  static double DistanceBetweenLines(double l0[3], double l1[3], double m0[3], double m1[3],
283  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
284 
293  static double DistanceBetweenLineSegments(double l0[3], double l1[3], double m0[3], double m1[3],
294  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
295 
296  static void InterpolationFunctions(const double pcoords[3], double weights[2]);
297  static void InterpolationDerivs(const double pcoords[3], double derivs[2]);
299 
303  void InterpolateFunctions(const double pcoords[3], double weights[2]) override
304  {
305  vtkLine::InterpolationFunctions(pcoords, weights);
306  }
307  void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
308  {
309  vtkLine::InterpolationDerivs(pcoords, derivs);
310  }
312 
313 protected:
315  ~vtkLine() override = default;
316 
317 private:
318  vtkLine(const vtkLine&) = delete;
319  void operator=(const vtkLine&) = delete;
320 };
321 
322 //----------------------------------------------------------------------------
323 inline int vtkLine::GetParametricCenter(double pcoords[3])
324 {
325  pcoords[0] = 0.5;
326  pcoords[1] = pcoords[2] = 0.0;
327  return 0;
328 }
329 
330 #endif
object to represent cell connectivity
Definition: vtkCellArray.h:296
represent and manipulate cell attribute data
Definition: vtkCellData.h:151
abstract class to specify cell behavior
Definition: vtkCell.h:150
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:165
list of point or cell ids
Definition: vtkIdList.h:143
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:119
cell represents a 1D line
Definition: vtkLine.h:143
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])
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:323
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.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
~vtkLine() override=default
static int Intersection(const double p1[3], const double p2[3], const double x1[3], const double x2[3], double &u, double &v, const double tolerance=1e-6, int toleranceType=ToleranceType::Relative)
Performs intersection of the projection of two finite 3D lines onto a 2D plane.
ToleranceType
Definition: vtkLine.h:213
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:202
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
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:154
vtkCell * GetFace(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:158
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:155
static vtkLine * New()
vtkCell * GetEdge(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:157
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:153
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:156
void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkLine.h:307
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:151
represent and manipulate 3D points
Definition: vtkPoints.h:149
@ value
Definition: vtkX3D.h:226
@ index
Definition: vtkX3D.h:252
@ VTK_LINE
Definition: vtkCellType.h:88
#define VTK_DEPRECATED_IN_9_1_0(reason)
int vtkIdType
Definition: vtkType.h:332