VTK
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 =========================================================================*/
28 #ifndef vtkLine_h
29 #define vtkLine_h
30 
31 #include "vtkCommonDataModelModule.h" // For export macro
32 #include "vtkCell.h"
34 
35 class VTKCOMMONDATAMODEL_EXPORT vtkLine : public vtkCell
36 {
37 public:
38  static vtkLine *New();
39  vtkTypeMacro(vtkLine,vtkCell);
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
43 
46  int GetCellType() override {return VTK_LINE;};
47  int GetCellDimension() override {return 1;};
48  int GetNumberOfEdges() override {return 0;};
49  int GetNumberOfFaces() override {return 0;};
50  vtkCell *GetEdge(int) override {return nullptr;};
51  vtkCell *GetFace(int) override {return nullptr;};
52  int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override;
53  void Contour(double value, vtkDataArray *cellScalars,
55  vtkCellArray *lines, vtkCellArray *polys,
56  vtkPointData *inPd, vtkPointData *outPd,
57  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override;
58  int EvaluatePosition(const double x[3], double closestPoint[3],
59  int& subId, double pcoords[3],
60  double& dist2, double weights[]) override;
61  void EvaluateLocation(int& subId, const double pcoords[3], double x[3],
62  double *weights) override;
63  int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override;
64  void Derivatives(int subId, const double pcoords[3], const double *values,
65  int dim, double *derivs) override;
66  double *GetParametricCoords() override;
68 
73  void Clip(double value, vtkDataArray *cellScalars,
75  vtkPointData *inPd, vtkPointData *outPd,
76  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd,
77  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,
89  double x[3], double pcoords[3], int& subId) override;
90 
91 
99  static int Intersection(const double p1[3], const double p2[3],
100  const double x1[3], const double x2[3],
101  double& u, double& v);
102 
103 
116  static int Intersection3D(double p1[3], double p2[3],
117  double x1[3], double x2[3],
118  double& u, double& v);
119 
120 
129  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3],
130  double &t, double closestPoint[3]=nullptr);
131 
132 
138  static double DistanceToLine(const double x[3], const double p1[3], const double p2[3]);
139 
148  static double DistanceBetweenLines(
149  double l0[3], double l1[3],
150  double m0[3], double m1[3],
151  double closestPt1[3], double closestPt2[3],
152  double &t1, double &t2 );
153 
162  static double DistanceBetweenLineSegments(
163  double l0[3], double l1[3],
164  double m0[3], double m1[3],
165  double closestPt1[3], double closestPt2[3],
166  double &t1, double &t2 );
167 
171  static void InterpolationFunctions(const double pcoords[3], double weights[2]);
175  static void InterpolationDerivs(const double pcoords[3], double derivs[2]);
177 
181  void InterpolateFunctions(const double pcoords[3], double weights[2]) override
182  {
183  vtkLine::InterpolationFunctions(pcoords,weights);
184  }
185  void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
186  {
187  vtkLine::InterpolationDerivs(pcoords,derivs);
188  }
190 
191 protected:
192  vtkLine();
193  ~vtkLine() override {}
194 
195 private:
196  vtkLine(const vtkLine&) = delete;
197  void operator=(const vtkLine&) = delete;
198 };
199 
200 //----------------------------------------------------------------------------
201 inline int vtkLine::GetParametricCenter(double pcoords[3])
202 {
203  pcoords[0] = 0.5;
204  pcoords[1] = pcoords[2] = 0.0;
205  return 0;
206 }
207 
208 #endif
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:48
void InterpolateDerivs(const double pcoords[3], double derivs[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkLine.h:185
represent and manipulate point attribute data
Definition: vtkPointData.h:37
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:46
~vtkLine() override
Definition: vtkLine.h:193
static void InterpolationDerivs(const double pcoords[3], double derivs[2])
represent and manipulate cell attribute data
Definition: vtkCellData.h:38
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:347
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:47
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:35
abstract class to specify cell behavior
Definition: vtkCell.h:59
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:50
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:51
list of point or cell ids
Definition: vtkIdList.h:36
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
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:50
void InterpolateFunctions(const double pcoords[3], double weights[2]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkLine.h:181
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkLine.h:49
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:201