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=========================================================================*/
21
22#ifndef vtkLine_h
23#define vtkLine_h
24
25#include "vtkCell.h"
26#include "vtkCommonDataModelModule.h" // For export macro
27#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_1_0
29
30class VTKCOMMONDATAMODEL_EXPORT vtkLine : public vtkCell
31{
32public:
33 static vtkLine* New();
34 vtkTypeMacro(vtkLine, vtkCell);
35 void PrintSelf(ostream& os, vtkIndent indent) override;
36
38
41 int GetCellType() override { return VTK_LINE; }
42 int GetCellDimension() override { return 1; }
43 int GetNumberOfEdges() override { return 0; }
44 int GetNumberOfFaces() override { return 0; }
45 vtkCell* GetEdge(int) override { return nullptr; }
46 vtkCell* GetFace(int) override { return nullptr; }
47 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
48 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
49 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
50 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
51 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
52 double& dist2, double weights[]) override;
53 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
54 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
56 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
57 double* GetParametricCoords() override;
59
66 int Inflate(double dist) override;
67
72 void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
73 vtkCellArray* lines, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
74 vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
75
79 int GetParametricCenter(double pcoords[3]) override;
80
85 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
86 double pcoords[3], int& subId) override;
87
88 // Return result type for Intersection() and Intersection3D()
95
96 // Control the meaning of the provided tolerance. Fuzzy tolerances allow
97 // intersections to occur outside of the range (0<=u,v<=1) as long as they
98 // fall within the tolerance provided. Thus non-fuzzy tolerances must be
99 // within the (0,1) parametric range (inclusive)
107
124 static int Intersection(const double p1[3], const double p2[3], const double x1[3],
125 const double x2[3], double& u, double& v, const double tolerance = 1e-6,
126 int toleranceType = ToleranceType::Relative);
127
140 VTK_DEPRECATED_IN_9_1_0("Use vtkLine::Intersection(...) instead.")
141 static int Intersection3D(double p1[3], double p2[3], double x1[3], double x2[3], double& u,
142 double& v, const double tolerance = 1e-6);
143
152 static double DistanceToLine(const double x[3], const double p1[3], const double p2[3], double& t,
153 double closestPoint[3] = nullptr);
154
160 static double DistanceToLine(const double x[3], const double p1[3], const double p2[3]);
161
170 static double DistanceBetweenLines(double l0[3], double l1[3], double m0[3], double m1[3],
171 double closestPt1[3], double closestPt2[3], double& t1, double& t2);
172
181 static double DistanceBetweenLineSegments(double l0[3], double l1[3], double m0[3], double m1[3],
182 double closestPt1[3], double closestPt2[3], double& t1, double& t2);
183
184 static void InterpolationFunctions(const double pcoords[3], double weights[2]);
185 static void InterpolationDerivs(const double pcoords[3], double derivs[2]);
187
191 void InterpolateFunctions(const double pcoords[3], double weights[2]) override
192 {
193 vtkLine::InterpolationFunctions(pcoords, weights);
194 }
195 void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
196 {
197 vtkLine::InterpolationDerivs(pcoords, derivs);
198 }
199
200
201protected:
203 ~vtkLine() override = default;
204
205private:
206 vtkLine(const vtkLine&) = delete;
207 void operator=(const vtkLine&) = delete;
208};
209
210//----------------------------------------------------------------------------
211inline int vtkLine::GetParametricCenter(double pcoords[3])
212{
213 pcoords[0] = 0.5;
214 pcoords[1] = pcoords[2] = 0.0;
215 return 0;
216}
217
218#endif
object to represent cell connectivity
represent and manipulate cell attribute data
Definition vtkCellData.h:36
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
list of point or cell ids
Definition vtkIdList.h:31
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition vtkIndent.h:34
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.
static vtkLine * New()
int GetParametricCenter(double pcoords[3]) override
Return the center of the triangle in parametric coordinates.
Definition vtkLine.h:211
vtkCell * GetFace(int) override
See the vtkCell API for descriptions of these methods.
Definition vtkLine.h:46
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.
vtkCell * GetEdge(int) override
See the vtkCell API for descriptions of these methods.
Definition vtkLine.h:45
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 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:101
@ RelativeFuzzy
Definition vtkLine.h:104
@ AbsoluteFuzzy
Definition vtkLine.h:105
@ Absolute
Definition vtkLine.h:103
@ Relative
Definition vtkLine.h:102
double * GetParametricCoords() override
See the vtkCell API for descriptions of these methods.
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:90
@ NoIntersect
Definition vtkLine.h:91
@ OnLine
Definition vtkLine.h:93
@ Intersect
Definition vtkLine.h:92
void InterpolateFunctions(const double pcoords[3], double weights[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition vtkLine.h:191
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
static int Intersection3D(double p1[3], double p2[3], double x1[3], double x2[3], double &u, double &v, const double tolerance=1e-6)
Performs intersection of two finite 3D lines.
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:42
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition vtkLine.h:43
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition vtkLine.h:41
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:44
void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition vtkLine.h:195
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
represent and manipulate 3D points
Definition vtkPoints.h:34
@ VTK_LINE
Definition vtkCellType.h:49
#define vtkDataArray
#define VTK_DEPRECATED_IN_9_1_0(reason)
int vtkIdType
Definition vtkType.h:332