VTK  9.2.6
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
31class vtkDoubleArray;
32class vtkIdTypeArray;
33class vtkLine;
34class vtkPoints;
35class vtkQuad;
36class vtkTriangle;
38
39class VTKCOMMONDATAMODEL_EXPORT vtkPolygon : public vtkCell
40{
41public:
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;
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, const 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
154 double p0[3], double p10[3], double& l10, double p20[3], double& l20, double n[3]);
155
167 static int PointInPolygon(double x[3], int numPts, double* pts, double bounds[6], double n[3]);
168
177 int Triangulate(vtkIdList* outTris);
178
184
192 int BoundedTriangulate(vtkIdList* outTris, double tol);
193
199 static double DistanceToPolygon(
200 double x[3], int numPts, double* pts, double bounds[6], double closest[3]);
201
210 static int IntersectPolygonWithPolygon(int npts, double* pts, double bounds[6], int npts2,
211 double* pts2, double bounds2[3], double tol, double x[3]);
212
225 vtkCell* cell1, vtkCell* cell2, double tol, double p0[3], double p1[3]);
226
228
234 vtkGetMacro(UseMVCInterpolation, bool);
235 vtkSetMacro(UseMVCInterpolation, bool);
237
239
247 vtkSetClampMacro(Tolerance, double, 0.0, 1.0);
248 vtkGetMacro(Tolerance, double);
250
251protected:
253 ~vtkPolygon() override;
254
255 // Compute the interpolation functions using Mean Value Coordinate.
256 void InterpolateFunctionsUsingMVC(const double x[3], double* weights);
257
258 // variables used by instances of this class
259 double Tolerance; // Intersection tolerance set by public API
260 double Tol; // Internal tolerance set by ComputeBounds()
261 void ComputeTolerance(); // Compute the internal tolerance Tol
262
263 int SuccessfulTriangulation; // Stops recursive triangulation if necessary
264 vtkIdList* Tris; // Output triangulation placed here
265
266 // These are used for internal computation.
271
272 // Parameter indicating whether to use Mean Value Coordinate algorithm
273 // for interpolation. The parameter is false by default.
275
276 // Helper methods for triangulation------------------------------
277 // Made public for external access
278public:
279 // Ear cut triangulation options. The order in which vertices are
280 // removed are controlled by different measures. Changing this can
281 // make subtle differences in some cases. Historically the
282 // PERIMETER2_TO_AREA_RATIO has been used.
284 {
285 PERIMETER2_TO_AREA_RATIO = 0,
286 DOT_PRODUCT = 1,
287 BEST_QUALITY = 2
288 };
289
291
299 int EarCutTriangulation(int measure = PERIMETER2_TO_AREA_RATIO);
300 int EarCutTriangulation(vtkIdList* outTris, int measure = PERIMETER2_TO_AREA_RATIO);
302
304
311 int UnbiasedEarCutTriangulation(int seed, int measure = PERIMETER2_TO_AREA_RATIO);
313 int seed, vtkIdList* outTris, int measure = PERIMETER2_TO_AREA_RATIO);
315
316private:
317 vtkPolygon(const vtkPolygon&) = delete;
318 void operator=(const vtkPolygon&) = delete;
319};
320
321#endif
object to represent cell connectivity
represent and manipulate cell attribute data
Definition vtkCellData.h:36
abstract class to specify cell behavior
Definition vtkCell.h:58
vtkIdType GetNumberOfPoints() const
Return the number of points in the cell.
Definition vtkCell.h:138
abstract superclass for arrays of numeric data
dynamic, self-adjusting array of double
list of point or cell ids
Definition vtkIdList.h:31
dynamic, self-adjusting array of vtkIdType
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition vtkIndent.h:34
cell represents a 1D line
Definition vtkLine.h:31
represent and manipulate point attribute data
represent and manipulate 3D points
Definition vtkPoints.h:34
a cell that represents an n-sided polygon
Definition vtkPolygon.h:40
int IsPrimaryCell() override
See the vtkCell API for descriptions of these methods.
Definition vtkPolygon.h:71
static int PointInPolygon(double x[3], int numPts, double *pts, double bounds[6], double n[3])
Determine whether a point is inside the specified polygon.
double ComputeArea()
Compute the area of a polygon.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition vtkPolygon.h:50
void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *tris, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
See the vtkCell API for descriptions of these methods.
vtkTriangle * Triangle
Definition vtkPolygon.h:267
static bool IsConvex(vtkPoints *p, int numPts, const vtkIdType *pts)
Determine whether or not a polygon is convex.
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
static void ComputeNormal(int numPts, double *pts, double n[3])
Compute the polygon normal from an array of points.
int UnbiasedEarCutTriangulation(int seed, int measure=PERIMETER2_TO_AREA_RATIO)
A fast triangulation method.
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition vtkPolygon.h:52
static bool IsConvex(vtkPoints *p)
Determine whether or not a polygon is convex.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
See the vtkCell API for descriptions of these methods.
void ComputeTolerance()
bool UseMVCInterpolation
Definition vtkPolygon.h:274
static void ComputeNormal(vtkPoints *p, double n[3])
Computes the unit normal to the polygon.
double Tolerance
Definition vtkPolygon.h:259
void InterpolateFunctionsUsingMVC(const double x[3], double *weights)
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition vtkPolygon.h:53
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.
int Triangulate(vtkIdList *outTris)
Triangulate this polygon.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int NonDegenerateTriangulate(vtkIdList *outTris)
Same as Triangulate(vtkIdList *outTris) but with a first pass to split the polygon into non-degenerat...
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition vtkPolygon.h:51
static double DistanceToPolygon(double x[3], int numPts, double *pts, double bounds[6], double closest[3])
Compute the distance of a point to a polygon.
int SuccessfulTriangulation
Definition vtkPolygon.h:263
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions of these methods.
vtkQuad * Quad
Definition vtkPolygon.h:268
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.
vtkIdList * Tris
Definition vtkPolygon.h:264
static int IntersectPolygonWithPolygon(int npts, double *pts, double bounds[6], int npts2, double *pts2, double bounds2[3], double tol, double x[3])
Method intersects two polygons.
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.
~vtkPolygon() override
static bool IsConvex(vtkIdTypeArray *ids, vtkPoints *p)
Determine whether or not a polygon is convex.
int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
See the vtkCell API for descriptions of these methods.
int ParameterizePolygon(double p0[3], double p10[3], double &l10, double p20[3], double &l20, double n[3])
Create a local s-t coordinate system for a polygon.
int EarCutTriangulation(vtkIdList *outTris, int measure=PERIMETER2_TO_AREA_RATIO)
A fast triangulation method.
vtkDoubleArray * TriScalars
Definition vtkPolygon.h:269
static void ComputeNormal(vtkIdTypeArray *ids, vtkPoints *pts, double n[3])
Computes the unit normal to the polygon.
int BoundedTriangulate(vtkIdList *outTris, double tol)
Triangulate polygon and enforce that the ratio of the smallest triangle area to the polygon area is g...
int EarCutTriangulation(int measure=PERIMETER2_TO_AREA_RATIO)
A fast triangulation method.
vtkCell * GetFace(int) override
See the vtkCell API for descriptions of these methods.
Definition vtkPolygon.h:55
static bool ComputeCentroid(vtkPoints *p, int numPts, const vtkIdType *pts, double centroid[3])
Compute the centroid of a set of points.
static double ComputeArea(vtkPoints *p, vtkIdType numPts, const vtkIdType *pts, double normal[3])
Compute the area of a polygon in 3D.
void InterpolateFunctions(const double x[3], double *sf) override
Compute the interpolation functions/derivatives.
bool IsConvex()
Determine whether or not a polygon is convex.
vtkLine * Line
Definition vtkPolygon.h:270
static bool ComputeCentroid(vtkIdTypeArray *ids, vtkPoints *pts, double centroid[3])
Compute the centroid of a set of points.
int UnbiasedEarCutTriangulation(int seed, vtkIdList *outTris, int measure=PERIMETER2_TO_AREA_RATIO)
A fast triangulation method.
static vtkPolygon * New()
double Tol
Definition vtkPolygon.h:260
static void ComputeNormal(vtkPoints *p, int numPts, const vtkIdType *pts, double n[3])
Computes the unit normal to the polygon.
static int IntersectConvex2DCells(vtkCell *cell1, vtkCell *cell2, double tol, double p0[3], double p1[3])
Intersect two convex 2D polygons to produce a line segment as output.
a cell that represents a 2D quadrilateral
Definition vtkQuad.h:36
a cell that represents a triangle
Definition vtkTriangle.h:36
@ VTK_POLYGON
Definition vtkCellType.h:53
int vtkIdType
Definition vtkType.h:332