VTK  9.1.0
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=========================================================================*/
131#ifndef vtkLine_h
132#define vtkLine_h
133
134#include "vtkCell.h"
135#include "vtkCommonDataModelModule.h" // For export macro
136#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_1_0
138
139class VTKCOMMONDATAMODEL_EXPORT vtkLine : public vtkCell
140{
141public:
142 static vtkLine* New();
143 vtkTypeMacro(vtkLine, vtkCell);
144 void PrintSelf(ostream& os, vtkIndent indent) override;
145
147
150 int GetCellType() override { return VTK_LINE; }
151 int GetCellDimension() override { return 1; }
152 int GetNumberOfEdges() override { return 0; }
153 int GetNumberOfFaces() override { return 0; }
154 vtkCell* GetEdge(int) override { return nullptr; }
155 vtkCell* GetFace(int) override { return nullptr; }
156 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
157 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
158 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
159 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
160 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
161 double& dist2, double weights[]) override;
162 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
163 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
165 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
166 double* GetParametricCoords() override;
168
175 int Inflate(double dist) override;
176
181 void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
182 vtkCellArray* lines, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
183 vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
184
188 int GetParametricCenter(double pcoords[3]) override;
189
194 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
195 double pcoords[3], int& subId) override;
196
197 // Return result type for Intersection() and Intersection3D()
199 {
200 NoIntersect = 0,
201 Intersect = 2,
202 OnLine = 3
203 };
204
205 // Control the meaning of the provided tolerance. Fuzzy tolerances allow
206 // intersections to occur outside of the range (0<=u,v<=1) as long as they
207 // fall within the tolerance provided. Thus non-fuzzy tolerances must be
208 // within the (0,1) parametric range (inclusive)
210 {
211 Relative = 0,
212 Absolute = 1,
213 RelativeFuzzy = 2,
214 AbsoluteFuzzy = 3
215 };
216
233 static int Intersection(const double p1[3], const double p2[3], const double x1[3],
234 const double x2[3], double& u, double& v, const double tolerance = 1e-6,
235 int toleranceType = ToleranceType::Relative);
236
249 VTK_DEPRECATED_IN_9_1_0("Use vtkLine::Intersection(...) instead.")
250 static int Intersection3D(double p1[3], double p2[3], double x1[3], double x2[3], double& u,
251 double& v, const double tolerance = 1e-6);
252
261 static double DistanceToLine(const double x[3], const double p1[3], const double p2[3], double& t,
262 double closestPoint[3] = nullptr);
263
269 static double DistanceToLine(const double x[3], const double p1[3], const double p2[3]);
270
279 static double DistanceBetweenLines(double l0[3], double l1[3], double m0[3], double m1[3],
280 double closestPt1[3], double closestPt2[3], double& t1, double& t2);
281
290 static double DistanceBetweenLineSegments(double l0[3], double l1[3], double m0[3], double m1[3],
291 double closestPt1[3], double closestPt2[3], double& t1, double& t2);
292
293 static void InterpolationFunctions(const double pcoords[3], double weights[2]);
294 static void InterpolationDerivs(const double pcoords[3], double derivs[2]);
296
300 void InterpolateFunctions(const double pcoords[3], double weights[2]) override
301 {
302 vtkLine::InterpolationFunctions(pcoords, weights);
303 }
304 void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
305 {
306 vtkLine::InterpolationDerivs(pcoords, derivs);
307 }
309
310protected:
312 ~vtkLine() override = default;
313
314private:
315 vtkLine(const vtkLine&) = delete;
316 void operator=(const vtkLine&) = delete;
317};
318
319//----------------------------------------------------------------------------
320inline int vtkLine::GetParametricCenter(double pcoords[3])
321{
322 pcoords[0] = 0.5;
323 pcoords[1] = pcoords[2] = 0.0;
324 return 0;
325}
326
327#endif
object to represent cell connectivity
Definition: vtkCellArray.h:290
represent and manipulate cell attribute data
Definition: vtkCellData.h:142
abstract class to specify cell behavior
Definition: vtkCell.h:147
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
list of point or cell ids
Definition: vtkIdList.h:140
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:113
cell represents a 1D line
Definition: vtkLine.h:140
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:320
vtkCell * GetFace(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:155
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.
vtkCell * GetEdge(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:154
~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:210
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:199
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:151
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:152
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:150
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:153
void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkLine.h:304
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:142
represent and manipulate 3D points
Definition: vtkPoints.h:143
@ VTK_LINE
Definition: vtkCellType.h:88
#define VTK_DEPRECATED_IN_9_1_0(reason)
int vtkIdType
Definition: vtkType.h:332