VTK
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=========================================================================*/
31#ifndef vtkPolygon_h
32#define vtkPolygon_h
33
34#include "vtkCommonDataModelModule.h" // For export macro
35#include "vtkCell.h"
36
37class vtkDoubleArray;
38class vtkIdTypeArray;
39class vtkLine;
40class vtkPoints;
41class vtkQuad;
42class vtkTriangle;
44
45class VTKCOMMONDATAMODEL_EXPORT vtkPolygon : public vtkCell
46{
47public:
48 static vtkPolygon *New();
49 vtkTypeMacro(vtkPolygon,vtkCell);
50 void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
51
53
56 int GetCellType() VTK_OVERRIDE {return VTK_POLYGON;};
57 int GetCellDimension() VTK_OVERRIDE {return 2;};
58 int GetNumberOfEdges() VTK_OVERRIDE {return this->GetNumberOfPoints();};
59 int GetNumberOfFaces() VTK_OVERRIDE {return 0;};
60 vtkCell *GetEdge(int edgeId) VTK_OVERRIDE;
61 vtkCell *GetFace(int) VTK_OVERRIDE {return 0;};
62 int CellBoundary(int subId, double pcoords[3], vtkIdList *pts) VTK_OVERRIDE;
63 void Contour(double value, vtkDataArray *cellScalars,
65 vtkCellArray *lines, vtkCellArray *polys,
66 vtkPointData *inPd, vtkPointData *outPd,
67 vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) VTK_OVERRIDE;
68 void Clip(double value, vtkDataArray *cellScalars,
70 vtkPointData *inPd, vtkPointData *outPd,
71 vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd,
72 int insideOut) VTK_OVERRIDE;
73 int EvaluatePosition(double x[3], double* closestPoint,
74 int& subId, double pcoords[3],
75 double& dist2, double *weights) VTK_OVERRIDE;
76 void EvaluateLocation(int& subId, double pcoords[3], double x[3],
77 double *weights) VTK_OVERRIDE;
78 int IntersectWithLine(double p1[3], double p2[3], double tol, double& t,
79 double x[3], double pcoords[3], int& subId) VTK_OVERRIDE;
80 int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) VTK_OVERRIDE;
81 void Derivatives(int subId, double pcoords[3], double *values,
82 int dim, double *derivs) VTK_OVERRIDE;
83 int IsPrimaryCell() VTK_OVERRIDE {return 0;}
85
92 double ComputeArea();
93
103 void InterpolateFunctions(double x[3], double *sf) VTK_OVERRIDE;
104
106
110 static void ComputeNormal(vtkPoints *p, int numPts, vtkIdType *pts,
111 double n[3]);
112 static void ComputeNormal(vtkPoints *p, double n[3]);
113 static void ComputeNormal(vtkIdTypeArray *ids, vtkPoints *pts, double n[3]);
115
120 static void ComputeNormal(int numPts, double *pts, double n[3]);
121
128 bool IsConvex();
129
131
135 static bool IsConvex(vtkPoints *p, int numPts, vtkIdType *pts);
136 static bool IsConvex(vtkIdTypeArray *ids, vtkPoints *p);
137 static bool IsConvex(vtkPoints *p);
139
141
145 static bool ComputeCentroid(vtkPoints *p, int numPts, vtkIdType *pts,
146 double centroid[3]);
148 double centroid[3]);
150
158 static double ComputeArea(vtkPoints *p, vtkIdType numPts, vtkIdType *pts,
159 double normal[3]);
160
168 int ParameterizePolygon(double p0[3], double p10[3], double &l10,
169 double p20[3], double &l20, double n[3]);
170
177 static int PointInPolygon(double x[3], int numPts, double *pts,
178 double bounds[6], double n[3]);
179
186 int Triangulate(vtkIdList *outTris);
187
193
199 static double DistanceToPolygon(double x[3], int numPts, double *pts,
200 double bounds[6], double closest[3]);
201
210 static int IntersectPolygonWithPolygon(int npts, double *pts, double bounds[6],
211 int npts2, double *pts2,
212 double bounds2[3], double tol,
213 double x[3]);
214
226 static int IntersectConvex2DCells(vtkCell *cell1, vtkCell *cell2,
227 double tol, double p0[3], double p1[3]);
228
230
236 vtkGetMacro(UseMVCInterpolation, bool);
237 vtkSetMacro(UseMVCInterpolation, bool);
239
240protected:
242 ~vtkPolygon() VTK_OVERRIDE;
243
244 // Compute the interpolation functions using Mean Value Coordinate.
245 void InterpolateFunctionsUsingMVC(double x[3], double *weights);
246
247 // variables used by instances of this class
248 double Tolerance; // Intersection tolerance
249 int SuccessfulTriangulation; // Stops recursive tri. if necessary
250 double Normal[3]; //polygon normal
252 vtkTriangle *Triangle;
253 vtkQuad *Quad;
254 vtkDoubleArray *TriScalars;
255 vtkLine *Line;
256
257 // Parameter indicating whether to use Mean Value Coordinate algorithm
258 // for interpolation. The parameter is false by default.
259 bool UseMVCInterpolation;
260
261 // Helper methods for triangulation------------------------------
268 int EarCutTriangulation();
269
270private:
271 vtkPolygon(const vtkPolygon&) VTK_DELETE_FUNCTION;
272 void operator=(const vtkPolygon&) VTK_DELETE_FUNCTION;
273};
274
275#endif
object to represent cell connectivity
Definition: vtkCellArray.h:51
represent and manipulate cell attribute data
Definition: vtkCellData.h:39
abstract class to specify cell behavior
Definition: vtkCell.h:60
vtkIdType GetNumberOfPoints()
Return the number of points in the cell.
Definition: vtkCell.h:132
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
dynamic, self-adjusting array of double
list of point or cell ids
Definition: vtkIdList.h:37
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:40
cell represents a 1D line
Definition: vtkLine.h:36
represent and manipulate point attribute data
Definition: vtkPointData.h:38
represent and manipulate 3D points
Definition: vtkPoints.h:40
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:46
int IsPrimaryCell() override
Return whether this cell type has a fixed topology or whether the topology varies depending on the da...
Definition: vtkPolygon.h:83
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:56
void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *tris, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
Cut (or clip) the cell based on the input cellScalars and the specified value.
static void ComputeNormal(int numPts, double *pts, double n[3])
Compute the polygon normal from an array of points.
int CellBoundary(int subId, double pcoords[3], vtkIdList *pts) override
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
int EvaluatePosition(double x[3], double *closestPoint, int &subId, double pcoords[3], double &dist2, double *weights) override
Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; ev...
int GetNumberOfEdges() override
Return the number of edges in the cell.
Definition: vtkPolygon.h:58
static bool IsConvex(vtkPoints *p)
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
static void ComputeNormal(vtkPoints *p, double n[3])
int GetNumberOfFaces() override
Return the number of faces in the cell.
Definition: vtkPolygon.h:59
int Triangulate(vtkIdList *outTris)
Triangulate this polygon.
void EvaluateLocation(int &subId, double pcoords[3], double x[3], double *weights) override
Determine global coordinate (x[3]) from subId and parametric coordinates.
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...
void InterpolateFunctions(double x[3], double *sf) override
Compute the interpolation functions/derivatives.
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
Definition: vtkPolygon.h:57
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.
vtkCell * GetEdge(int edgeId) override
Return the edge cell from the edgeId of the cell.
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.
int IntersectWithLine(double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
Intersect with a ray.
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
Generate contouring primitives.
~vtkPolygon() override
static bool IsConvex(vtkIdTypeArray *ids, vtkPoints *p)
static double ComputeArea(vtkPoints *p, vtkIdType numPts, vtkIdType *pts, double normal[3])
Compute the area of a polygon in 3D.
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.
static void ComputeNormal(vtkIdTypeArray *ids, vtkPoints *pts, double n[3])
static bool IsConvex(vtkPoints *p, int numPts, vtkIdType *pts)
Determine whether or not a polygon is convex.
vtkCell * GetFace(int) override
Return the face cell from the faceId of the cell.
Definition: vtkPolygon.h:61
void Derivatives(int subId, double pcoords[3], double *values, int dim, double *derivs) override
Compute derivatives given cell subId and parametric coordinates.
bool IsConvex()
Determine whether or not a polygon is convex.
static bool ComputeCentroid(vtkIdTypeArray *ids, vtkPoints *pts, double centroid[3])
static vtkPolygon * New()
static bool ComputeCentroid(vtkPoints *p, int numPts, vtkIdType *pts, double centroid[3])
Compute the centroid of a set of points.
static void ComputeNormal(vtkPoints *p, int numPts, 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:42
a cell that represents a triangle
Definition: vtkTriangle.h:42
@ Normal
Definition: vtkX3D.h:45
@ value
Definition: vtkX3D.h:220
@ index
Definition: vtkX3D.h:246
@ VTK_POLYGON
Definition: vtkCellType.h:52
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
int vtkIdType
Definition: vtkType.h:287