VTK  9.1.0
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=========================================================================*/
134#ifndef vtkPolygon_h
135#define vtkPolygon_h
136
137#include "vtkCell.h"
138#include "vtkCommonDataModelModule.h" // For export macro
139
140class vtkDoubleArray;
141class vtkIdTypeArray;
142class vtkLine;
143class vtkPoints;
144class vtkQuad;
145class vtkTriangle;
147
148class VTKCOMMONDATAMODEL_EXPORT vtkPolygon : public vtkCell
149{
150public:
151 static vtkPolygon* New();
152 vtkTypeMacro(vtkPolygon, vtkCell);
153 void PrintSelf(ostream& os, vtkIndent indent) override;
154
156
159 int GetCellType() override { return VTK_POLYGON; }
160 int GetCellDimension() override { return 2; }
161 int GetNumberOfEdges() override { return this->GetNumberOfPoints(); }
162 int GetNumberOfFaces() override { return 0; }
163 vtkCell* GetEdge(int edgeId) override;
164 vtkCell* GetFace(int) override { return nullptr; }
165 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
166 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
167 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
168 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
169 void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
170 vtkCellArray* tris, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
171 vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
172 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
173 double& dist2, double weights[]) override;
174 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
175 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
176 double pcoords[3], int& subId) override;
177 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
179 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
180 int IsPrimaryCell() override { return 0; }
182
189 double ComputeArea();
190
200 void InterpolateFunctions(const double x[3], double* sf) override;
201
203
207 static void ComputeNormal(vtkPoints* p, int numPts, const vtkIdType* pts, double n[3]);
208 static void ComputeNormal(vtkPoints* p, double n[3]);
209 static void ComputeNormal(vtkIdTypeArray* ids, vtkPoints* pts, double n[3]);
211
216 static void ComputeNormal(int numPts, double* pts, double n[3]);
217
224 bool IsConvex();
225
227
231 static bool IsConvex(vtkPoints* p, int numPts, vtkIdType* pts);
232 static bool IsConvex(vtkIdTypeArray* ids, vtkPoints* p);
233 static bool IsConvex(vtkPoints* p);
235
237
241 static bool ComputeCentroid(vtkPoints* p, int numPts, const vtkIdType* pts, double centroid[3]);
242 static bool ComputeCentroid(vtkIdTypeArray* ids, vtkPoints* pts, double centroid[3]);
244
253 static double ComputeArea(vtkPoints* p, vtkIdType numPts, const vtkIdType* pts, double normal[3]);
254
263 double p0[3], double p10[3], double& l10, double p20[3], double& l20, double n[3]);
264
271 static int PointInPolygon(double x[3], int numPts, double* pts, double bounds[6], double n[3]);
272
281 int Triangulate(vtkIdList* outTris);
282
288
296 int BoundedTriangulate(vtkIdList* outTris, double tol);
297
303 static double DistanceToPolygon(
304 double x[3], int numPts, double* pts, double bounds[6], double closest[3]);
305
314 static int IntersectPolygonWithPolygon(int npts, double* pts, double bounds[6], int npts2,
315 double* pts2, double bounds2[3], double tol, double x[3]);
316
329 vtkCell* cell1, vtkCell* cell2, double tol, double p0[3], double p1[3]);
330
332
338 vtkGetMacro(UseMVCInterpolation, bool);
339 vtkSetMacro(UseMVCInterpolation, bool);
341
343
351 vtkSetClampMacro(Tolerance, double, 0.0, 1.0);
352 vtkGetMacro(Tolerance, double);
354
355protected:
357 ~vtkPolygon() override;
358
359 // Compute the interpolation functions using Mean Value Coordinate.
360 void InterpolateFunctionsUsingMVC(const double x[3], double* weights);
361
362 // variables used by instances of this class
363 double Tolerance; // Intersection tolerance set by public API
364 double Tol; // Internal tolerance set by ComputeBounds()
365 void ComputeTolerance(); // Compute the internal tolerance Tol
366
367 int SuccessfulTriangulation; // Stops recursive triangulation if necessary
368 vtkIdList* Tris; // Output triangulation placed here
369
370 // These are used for internal computation.
375
376 // Parameter indicating whether to use Mean Value Coordinate algorithm
377 // for interpolation. The parameter is false by default.
379
380 // Helper methods for triangulation------------------------------
381 // Made public for extenal access
382public:
383 // Ear cut triangulation options. The order in which vertices are
384 // removed are controlled by different measures. Changing this can
385 // make subtle differences in some cases. Historically the
386 // PERIMETER2_TO_AREA_RATIO has been used.
388 {
389 PERIMETER2_TO_AREA_RATIO = 0,
390 DOT_PRODUCT = 1,
391 BEST_QUALITY = 2
392 };
393
395
403 int EarCutTriangulation(int measure = PERIMETER2_TO_AREA_RATIO);
404 int EarCutTriangulation(vtkIdList* outTris, int measure = PERIMETER2_TO_AREA_RATIO);
406
408
415 int UnbiasedEarCutTriangulation(int seed, int measure = PERIMETER2_TO_AREA_RATIO);
417 int seed, vtkIdList* outTris, int measure = PERIMETER2_TO_AREA_RATIO);
419
420private:
421 vtkPolygon(const vtkPolygon&) = delete;
422 void operator=(const vtkPolygon&) = delete;
423};
424
425#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
vtkIdType GetNumberOfPoints() const
Return the number of points in the cell.
Definition: vtkCell.h:227
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
dynamic, self-adjusting array of double
list of point or cell ids
Definition: vtkIdList.h:140
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:113
cell represents a 1D line
Definition: vtkLine.h:140
represent and manipulate point attribute data
Definition: vtkPointData.h:142
represent and manipulate 3D points
Definition: vtkPoints.h:143
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:149
int IsPrimaryCell() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPolygon.h:180
static int PointInPolygon(double x[3], int numPts, double *pts, double bounds[6], double n[3])
Determine whether point is inside polygon.
double ComputeArea()
Compute the area of a polygon.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPolygon.h:159
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:371
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:161
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:378
static void ComputeNormal(vtkPoints *p, double n[3])
Computes the unit normal to the polygon.
double Tolerance
Definition: vtkPolygon.h:363
void InterpolateFunctionsUsingMVC(const double x[3], double *weights)
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPolygon.h:162
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:160
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:367
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:372
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:368
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:373
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.
static bool IsConvex(vtkPoints *p, int numPts, vtkIdType *pts)
Determine whether or not a polygon is convex.
vtkCell * GetFace(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkPolygon.h:164
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:374
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:364
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:95
a cell that represents a triangle
Definition: vtkTriangle.h:145
@ VTK_POLYGON
Definition: vtkCellType.h:92
int vtkIdType
Definition: vtkType.h:332