VTK  9.2.5
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 =========================================================================*/
137 #ifndef vtkPolygon_h
138 #define vtkPolygon_h
139 
140 #include "vtkCell.h"
141 #include "vtkCommonDataModelModule.h" // For export macro
142 
143 class vtkDoubleArray;
144 class vtkIdTypeArray;
145 class vtkLine;
146 class vtkPoints;
147 class vtkQuad;
148 class vtkTriangle;
150 
151 class VTKCOMMONDATAMODEL_EXPORT vtkPolygon : public vtkCell
152 {
153 public:
154  static vtkPolygon* New();
155  vtkTypeMacro(vtkPolygon, vtkCell);
156  void PrintSelf(ostream& os, vtkIndent indent) override;
157 
159 
162  int GetCellType() override { return VTK_POLYGON; }
163  int GetCellDimension() override { return 2; }
164  int GetNumberOfEdges() override { return this->GetNumberOfPoints(); }
165  int GetNumberOfFaces() override { return 0; }
166  vtkCell* GetEdge(int edgeId) override;
167  vtkCell* GetFace(int) override { return nullptr; }
168  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
169  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
170  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
171  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
172  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
173  vtkCellArray* tris, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
174  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
175  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
176  double& dist2, double weights[]) override;
177  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
178  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
179  double pcoords[3], int& subId) override;
180  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
182  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
183  int IsPrimaryCell() override { return 0; }
185 
192  double ComputeArea();
193 
203  void InterpolateFunctions(const double x[3], double* sf) override;
204 
206 
210  static void ComputeNormal(vtkPoints* p, int numPts, const vtkIdType* pts, double n[3]);
211  static void ComputeNormal(vtkPoints* p, double n[3]);
212  static void ComputeNormal(vtkIdTypeArray* ids, vtkPoints* pts, double n[3]);
214 
219  static void ComputeNormal(int numPts, double* pts, double n[3]);
220 
227  bool IsConvex();
228 
230 
234  static bool IsConvex(vtkPoints* p, int numPts, const vtkIdType* pts);
235  static bool IsConvex(vtkIdTypeArray* ids, vtkPoints* p);
236  static bool IsConvex(vtkPoints* p);
238 
240 
244  static bool ComputeCentroid(vtkPoints* p, int numPts, const vtkIdType* pts, double centroid[3]);
245  static bool ComputeCentroid(vtkIdTypeArray* ids, vtkPoints* pts, double centroid[3]);
247 
256  static double ComputeArea(vtkPoints* p, vtkIdType numPts, const vtkIdType* pts, double normal[3]);
257 
266  double p0[3], double p10[3], double& l10, double p20[3], double& l20, double n[3]);
267 
279  static int PointInPolygon(double x[3], int numPts, double* pts, double bounds[6], double n[3]);
280 
289  int Triangulate(vtkIdList* outTris);
290 
296 
304  int BoundedTriangulate(vtkIdList* outTris, double tol);
305 
311  static double DistanceToPolygon(
312  double x[3], int numPts, double* pts, double bounds[6], double closest[3]);
313 
322  static int IntersectPolygonWithPolygon(int npts, double* pts, double bounds[6], int npts2,
323  double* pts2, double bounds2[3], double tol, double x[3]);
324 
337  vtkCell* cell1, vtkCell* cell2, double tol, double p0[3], double p1[3]);
338 
340 
346  vtkGetMacro(UseMVCInterpolation, bool);
347  vtkSetMacro(UseMVCInterpolation, bool);
349 
351 
359  vtkSetClampMacro(Tolerance, double, 0.0, 1.0);
360  vtkGetMacro(Tolerance, double);
362 
363 protected:
365  ~vtkPolygon() override;
366 
367  // Compute the interpolation functions using Mean Value Coordinate.
368  void InterpolateFunctionsUsingMVC(const double x[3], double* weights);
369 
370  // variables used by instances of this class
371  double Tolerance; // Intersection tolerance set by public API
372  double Tol; // Internal tolerance set by ComputeBounds()
373  void ComputeTolerance(); // Compute the internal tolerance Tol
374 
375  int SuccessfulTriangulation; // Stops recursive triangulation if necessary
376  vtkIdList* Tris; // Output triangulation placed here
377 
378  // These are used for internal computation.
383 
384  // Parameter indicating whether to use Mean Value Coordinate algorithm
385  // for interpolation. The parameter is false by default.
387 
388  // Helper methods for triangulation------------------------------
389  // Made public for external access
390 public:
391  // Ear cut triangulation options. The order in which vertices are
392  // removed are controlled by different measures. Changing this can
393  // make subtle differences in some cases. Historically the
394  // PERIMETER2_TO_AREA_RATIO has been used.
396  {
397  PERIMETER2_TO_AREA_RATIO = 0,
398  DOT_PRODUCT = 1,
399  BEST_QUALITY = 2
400  };
401 
403 
411  int EarCutTriangulation(int measure = PERIMETER2_TO_AREA_RATIO);
412  int EarCutTriangulation(vtkIdList* outTris, int measure = PERIMETER2_TO_AREA_RATIO);
414 
416 
423  int UnbiasedEarCutTriangulation(int seed, int measure = PERIMETER2_TO_AREA_RATIO);
425  int seed, vtkIdList* outTris, int measure = PERIMETER2_TO_AREA_RATIO);
427 
428 private:
429  vtkPolygon(const vtkPolygon&) = delete;
430  void operator=(const vtkPolygon&) = delete;
431 };
432 
433 #endif
object to represent cell connectivity
Definition: vtkCellArray.h:296
represent and manipulate cell attribute data
Definition: vtkCellData.h:151
abstract class to specify cell behavior
Definition: vtkCell.h:150
vtkIdType GetNumberOfPoints() const
Return the number of points in the cell.
Definition: vtkCell.h:230
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:165
dynamic, self-adjusting array of double
list of point or cell ids
Definition: vtkIdList.h:143
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:119
cell represents a 1D line
Definition: vtkLine.h:143
represent and manipulate point attribute data
Definition: vtkPointData.h:151
represent and manipulate 3D points
Definition: vtkPoints.h:149
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:152
int IsPrimaryCell() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPolygon.h:183
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:162
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:379
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.
vtkCell * GetFace(int) override
See the vtkCell API for descriptions of these methods.
Definition: vtkPolygon.h:167
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:164
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:386
static void ComputeNormal(vtkPoints *p, double n[3])
Computes the unit normal to the polygon.
double Tolerance
Definition: vtkPolygon.h:371
void InterpolateFunctionsUsingMVC(const double x[3], double *weights)
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPolygon.h:165
static vtkPolygon * New()
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:163
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:375
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:380
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:376
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:381
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 * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
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:382
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.
double Tol
Definition: vtkPolygon.h:372
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:98
a cell that represents a triangle
Definition: vtkTriangle.h:148
@ value
Definition: vtkX3D.h:226
@ index
Definition: vtkX3D.h:252
@ VTK_POLYGON
Definition: vtkCellType.h:92
int vtkIdType
Definition: vtkType.h:332