VTK  9.0.20200930
vtkPolygon.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPolygon.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 =========================================================================*/
25 #ifndef vtkPolygon_h
26 #define vtkPolygon_h
27 
28 #include "vtkCell.h"
29 #include "vtkCommonDataModelModule.h" // For export macro
30 
31 class vtkDoubleArray;
32 class vtkIdTypeArray;
33 class vtkLine;
34 class vtkPoints;
35 class vtkQuad;
36 class vtkTriangle;
38 
39 class VTKCOMMONDATAMODEL_EXPORT vtkPolygon : public vtkCell
40 {
41 public:
42  static vtkPolygon* New();
43  vtkTypeMacro(vtkPolygon, vtkCell);
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
47 
50  int GetCellType() override { return VTK_POLYGON; }
51  int GetCellDimension() override { return 2; }
52  int GetNumberOfEdges() override { return this->GetNumberOfPoints(); }
53  int GetNumberOfFaces() override { return 0; }
54  vtkCell* GetEdge(int edgeId) override;
55  vtkCell* GetFace(int) override { return nullptr; }
56  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
57  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
58  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
59  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
60  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
61  vtkCellArray* tris, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
62  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
63  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
64  double& dist2, double weights[]) override;
65  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
66  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
67  double pcoords[3], int& subId) override;
68  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
69  void Derivatives(
70  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
71  int IsPrimaryCell() override { return 0; }
73 
80  double ComputeArea();
81 
91  void InterpolateFunctions(const double x[3], double* sf) override;
92 
94 
98  static void ComputeNormal(vtkPoints* p, int numPts, const vtkIdType* pts, double n[3]);
99  static void ComputeNormal(vtkPoints* p, double n[3]);
100  static void ComputeNormal(vtkIdTypeArray* ids, vtkPoints* pts, double n[3]);
102 
107  static void ComputeNormal(int numPts, double* pts, double n[3]);
108 
115  bool IsConvex();
116 
118 
122  static bool IsConvex(vtkPoints* p, int numPts, vtkIdType* pts);
123  static bool IsConvex(vtkIdTypeArray* ids, vtkPoints* p);
124  static bool IsConvex(vtkPoints* p);
126 
128 
132  static bool ComputeCentroid(vtkPoints* p, int numPts, const vtkIdType* pts, double centroid[3]);
133  static bool ComputeCentroid(vtkIdTypeArray* ids, vtkPoints* pts, double centroid[3]);
135 
144  static double ComputeArea(vtkPoints* p, vtkIdType numPts, const vtkIdType* pts, double normal[3]);
145 
153  int ParameterizePolygon(
154  double p0[3], double p10[3], double& l10, double p20[3], double& l20, double n[3]);
155 
162  static int PointInPolygon(double x[3], int numPts, double* pts, double bounds[6], double n[3]);
163 
170  int Triangulate(vtkIdList* outTris);
171 
176  int NonDegenerateTriangulate(vtkIdList* outTris);
177 
185  int BoundedTriangulate(vtkIdList* outTris, double tol);
186 
192  static double DistanceToPolygon(
193  double x[3], int numPts, double* pts, double bounds[6], double closest[3]);
194 
203  static int IntersectPolygonWithPolygon(int npts, double* pts, double bounds[6], int npts2,
204  double* pts2, double bounds2[3], double tol, double x[3]);
205 
217  static int IntersectConvex2DCells(
218  vtkCell* cell1, vtkCell* cell2, double tol, double p0[3], double p1[3]);
219 
221 
227  vtkGetMacro(UseMVCInterpolation, bool);
228  vtkSetMacro(UseMVCInterpolation, bool);
230 
231 protected:
232  vtkPolygon();
233  ~vtkPolygon() override;
234 
235  // Compute the interpolation functions using Mean Value Coordinate.
236  void InterpolateFunctionsUsingMVC(const double x[3], double* weights);
237 
238  // variables used by instances of this class
239  double Tolerance; // Intersection tolerance
240  int SuccessfulTriangulation; // Stops recursive tri. if necessary
241  double Normal[3]; // polygon normal
247 
248  // Parameter indicating whether to use Mean Value Coordinate algorithm
249  // for interpolation. The parameter is false by default.
251 
252  // Helper methods for triangulation------------------------------
259  int EarCutTriangulation();
260 
268  int UnbiasedEarCutTriangulation(int seed);
269 
270 private:
271  vtkPolygon(const vtkPolygon&) = delete;
272  void operator=(const vtkPolygon&) = delete;
273 };
274 
275 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
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:32
vtkPolygon::GetNumberOfFaces
int GetNumberOfFaces() override
Return the number of faces in the cell.
Definition: vtkPolygon.h:53
vtkX3D::value
Definition: vtkX3D.h:226
vtkIdType
int vtkIdType
Definition: vtkType.h:330
vtkPolygon::GetFace
vtkCell * GetFace(int) override
Return the face cell from the faceId of the cell.
Definition: vtkPolygon.h:55
vtkPolygon
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:39
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkX3D::Normal
Definition: vtkX3D.h:51
vtkPolygon::Tolerance
double Tolerance
Definition: vtkPolygon.h:239
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.
vtkPolygon::Triangle
vtkTriangle * Triangle
Definition: vtkPolygon.h:243
vtkPolygon::GetCellType
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPolygon.h:50
vtkLine
cell represents a 1D line
Definition: vtkLine.h:29
vtkCell.h
vtkPolygon::SuccessfulTriangulation
int SuccessfulTriangulation
Definition: vtkPolygon.h:240
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:57
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
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:180
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
vtkPolygon::TriScalars
vtkDoubleArray * TriScalars
Definition: vtkPolygon.h:245
vtkPolygon::Tris
vtkIdList * Tris
Definition: vtkPolygon.h:242
vtkPolygon::GetNumberOfEdges
int GetNumberOfEdges() override
Return the number of edges in the cell.
Definition: vtkPolygon.h:52
vtkPolygon::UseMVCInterpolation
bool UseMVCInterpolation
Definition: vtkPolygon.h:250
vtkCell::GetNumberOfPoints
vtkIdType GetNumberOfPoints()
Return the number of points in the cell.
Definition: vtkCell.h:138
vtkTriangle
a cell that represents a triangle
Definition: vtkTriangle.h:35
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...
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:35
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::GetEdge
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
vtkCell::InterpolateFunctions
virtual void InterpolateFunctions(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this leve...
Definition: vtkCell.h:388
VTK_POLYGON
Definition: vtkCellType.h:53
vtkPolygon::IsPrimaryCell
int IsPrimaryCell() override
Return whether this cell type has a fixed topology or whether the topology varies depending on the da...
Definition: vtkPolygon.h:71
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.
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:35
vtkPolygon::GetCellDimension
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
Definition: vtkPolygon.h:51
vtkPolygon::Line
vtkLine * Line
Definition: vtkPolygon.h:246
vtkX3D::index
Definition: vtkX3D.h:252
vtkQuad
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:35
vtkPolygon::Quad
vtkQuad * Quad
Definition: vtkPolygon.h:244