VTK  9.0.1
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 =========================================================================*/
22 #ifndef vtkLine_h
23 #define vtkLine_h
24 
25 #include "vtkCell.h"
26 #include "vtkCommonDataModelModule.h" // For export macro
28 
29 class VTKCOMMONDATAMODEL_EXPORT vtkLine : public vtkCell
30 {
31 public:
32  static vtkLine* New();
33  vtkTypeMacro(vtkLine, vtkCell);
34  void PrintSelf(ostream& os, vtkIndent indent) override;
35 
37 
40  int GetCellType() override { return VTK_LINE; }
41  int GetCellDimension() override { return 1; }
42  int GetNumberOfEdges() override { return 0; }
43  int GetNumberOfFaces() override { return 0; }
44  vtkCell* GetEdge(int) override { return nullptr; }
45  vtkCell* GetFace(int) override { return nullptr; }
46  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
47  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
48  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
49  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
50  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
51  double& dist2, double weights[]) override;
52  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
53  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
54  void Derivatives(
55  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
56  double* GetParametricCoords() override;
58 
63  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
64  vtkCellArray* lines, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
65  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
66 
70  int GetParametricCenter(double pcoords[3]) override;
71 
76  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
77  double pcoords[3], int& subId) override;
78 
86  static int Intersection(const double p1[3], const double p2[3], const double x1[3],
87  const double x2[3], double& u, double& v);
88 
101  static int Intersection3D(
102  double p1[3], double p2[3], double x1[3], double x2[3], double& u, double& v);
103 
112  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3], double& t,
113  double closestPoint[3] = nullptr);
114 
120  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3]);
121 
130  static double DistanceBetweenLines(double l0[3], double l1[3], double m0[3], double m1[3],
131  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
132 
141  static double DistanceBetweenLineSegments(double l0[3], double l1[3], double m0[3], double m1[3],
142  double closestPt1[3], double closestPt2[3], double& t1, double& t2);
143 
144  static void InterpolationFunctions(const double pcoords[3], double weights[2]);
145  static void InterpolationDerivs(const double pcoords[3], double derivs[2]);
147 
151  void InterpolateFunctions(const double pcoords[3], double weights[2]) override
152  {
153  vtkLine::InterpolationFunctions(pcoords, weights);
154  }
155  void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
156  {
157  vtkLine::InterpolationDerivs(pcoords, derivs);
158  }
160 
161 protected:
162  vtkLine();
163  ~vtkLine() override {}
164 
165 private:
166  vtkLine(const vtkLine&) = delete;
167  void operator=(const vtkLine&) = delete;
168 };
169 
170 //----------------------------------------------------------------------------
171 inline int vtkLine::GetParametricCenter(double pcoords[3])
172 {
173  pcoords[0] = 0.5;
174  pcoords[1] = pcoords[2] = 0.0;
175  return 0;
176 }
177 
178 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkLine::GetParametricCenter
int GetParametricCenter(double pcoords[3]) override
Return the center of the triangle in parametric coordinates.
Definition: vtkLine.h:171
vtkCell::IntersectWithLine
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.
vtkCell::Contour
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.
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:31
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkIdType
int vtkIdType
Definition: vtkType.h:338
VTK_LINE
@ VTK_LINE
Definition: vtkCellType.h:49
vtkLine::InterpolateDerivs
void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
Definition: vtkLine.h:155
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
vtkCell::EvaluateLocation
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.
vtkLine
cell represents a 1D line
Definition: vtkLine.h:29
vtkCell.h
vtkLine::GetNumberOfFaces
int GetNumberOfFaces() override
Return the number of faces in the cell.
Definition: vtkLine.h:43
vtkLine::InterpolationFunctions
static void InterpolationFunctions(const double pcoords[3], double weights[2])
vtkCell::Triangulate
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:56
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
vtkLine::InterpolationDerivs
static void InterpolationDerivs(const double pcoords[3], double derivs[2])
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkCell::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:179
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:51
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:30
vtkLine::InterpolateFunctions
void InterpolateFunctions(const double pcoords[3], double weights[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkLine.h:151
vtkLine::GetNumberOfEdges
int GetNumberOfEdges() override
Return the number of edges in the cell.
Definition: vtkLine.h:42
vtkLine::GetFace
vtkCell * GetFace(int) override
Return the face cell from the faceId of the cell.
Definition: vtkLine.h:45
vtkLine::GetCellDimension
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
Definition: vtkLine.h:41
vtkCell::CellBoundary
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...
vtkCell::EvaluatePosition
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...
vtkCell::GetParametricCoords
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this cell.
vtkCell::Clip
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.
vtkCell::Derivatives
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.
vtkCell::GetParametricCenter
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
vtkLine::~vtkLine
~vtkLine() override
Definition: vtkLine.h:163
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkLine::GetEdge
vtkCell * GetEdge(int) override
Return the edge cell from the edgeId of the cell.
Definition: vtkLine.h:44
vtkLine::GetCellType
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:40