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 
37 class vtkDoubleArray;
38 class vtkIdTypeArray;
39 class vtkLine;
40 class vtkPoints;
41 class vtkQuad;
42 class vtkTriangle;
44 
45 class VTKCOMMONDATAMODEL_EXPORT vtkPolygon : public vtkCell
46 {
47 public:
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]);
147  static bool ComputeCentroid(vtkIdTypeArray *ids, vtkPoints *pts,
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 
240 protected:
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
251  vtkIdList *Tris;
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 
270 private:
271  vtkPolygon(const vtkPolygon&) VTK_DELETE_FUNCTION;
272  void operator=(const vtkPolygon&) VTK_DELETE_FUNCTION;
273 };
274 
275 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:40
vtkPolygon::EvaluatePosition
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...
vtkPolygon::IsConvex
static bool IsConvex(vtkPoints *p)
vtkPolygon::NonDegenerateTriangulate
int NonDegenerateTriangulate(vtkIdList *outTris)
Same as Triangulate(vtkIdList *outTris) but with a first pass to split the polygon into non-degenerat...
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:38
vtkPolygon::GetNumberOfFaces
int GetNumberOfFaces() override
Return the number of faces in the cell.
Definition: vtkPolygon.h:59
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkPolygon::ComputeArea
double ComputeArea()
Compute the area of a polygon.
vtkPolygon::GetFace
vtkCell * GetFace(int) override
Return the face cell from the faceId of the cell.
Definition: vtkPolygon.h:61
vtkPolygon::ComputeCentroid
static bool ComputeCentroid(vtkIdTypeArray *ids, vtkPoints *pts, double centroid[3])
vtkPolygon
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:46
vtkPolygon::Derivatives
void Derivatives(int subId, double pcoords[3], double *values, int dim, double *derivs) override
Compute derivatives given cell subId and parametric coordinates.
vtkPolygon::Triangulate
int Triangulate(vtkIdList *outTris)
Triangulate this polygon.
vtkPolygon::ComputeNormal
static void ComputeNormal(vtkIdTypeArray *ids, vtkPoints *pts, double n[3])
vtkX3D::Normal
@ Normal
Definition: vtkX3D.h:45
vtkPolygon::Contour
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::IntersectConvex2DCells
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.
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
vtkPolygon::EvaluateLocation
void EvaluateLocation(int &subId, double pcoords[3], double x[3], double *weights) override
Determine global coordinate (x[3]) from subId and parametric coordinates.
vtkPolygon::IsConvex
static bool IsConvex(vtkPoints *p, int numPts, vtkIdType *pts)
Determine whether or not a polygon is convex.
vtkPolygon::ComputeArea
static double ComputeArea(vtkPoints *p, vtkIdType numPts, vtkIdType *pts, double normal[3])
Compute the area of a polygon in 3D.
vtkPolygon::GetCellType
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPolygon.h:56
vtkPolygon::Clip
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.
vtkPolygon::IntersectWithLine
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.
vtkLine
cell represents a 1D line
Definition: vtkLine.h:36
vtkPolygon::IsConvex
static bool IsConvex(vtkIdTypeArray *ids, vtkPoints *p)
vtkCell.h
vtkPolygon::ComputeCentroid
static bool ComputeCentroid(vtkPoints *p, int numPts, vtkIdType *pts, double centroid[3])
Compute the centroid of a set of points.
vtkPolygon::ComputeNormal
static void ComputeNormal(vtkPoints *p, int numPts, vtkIdType *pts, double n[3])
Computes the unit normal to the polygon.
vtkPolygon::~vtkPolygon
~vtkPolygon() override
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:60
vtkPolygon::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPolygon::PointInPolygon
static int PointInPolygon(double x[3], int numPts, double *pts, double bounds[6], double n[3])
Determine whether point is inside polygon.
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkPolygon::DistanceToPolygon
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.
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:51
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:52
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:37
vtkPolygon::GetEdge
vtkCell * GetEdge(int edgeId) override
Return the edge cell from the edgeId of the cell.
vtkPolygon::GetNumberOfEdges
int GetNumberOfEdges() override
Return the number of edges in the cell.
Definition: vtkPolygon.h:58
vtkPolygon::InterpolateFunctions
void InterpolateFunctions(double x[3], double *sf) override
Compute the interpolation functions/derivatives.
vtkCell::GetNumberOfPoints
vtkIdType GetNumberOfPoints()
Return the number of points in the cell.
Definition: vtkCell.h:132
vtkTriangle
a cell that represents a triangle
Definition: vtkTriangle.h:42
vtkPolygon::vtkPolygon
vtkPolygon()
vtkPolygon::ParameterizePolygon
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.
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkPolygon::IntersectPolygonWithPolygon
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.
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:42
vtkPolygon::ComputeNormal
static void ComputeNormal(int numPts, double *pts, double n[3])
Compute the polygon normal from an array of points.
VTK_POLYGON
@ VTK_POLYGON
Definition: vtkCellType.h:52
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:83
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:42
vtkPolygon::GetCellDimension
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
Definition: vtkPolygon.h:57
vtkPolygon::CellBoundary
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...
vtkPolygon::Triangulate
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
vtkPolygon::New
static vtkPolygon * New()
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkPolygon::ComputeNormal
static void ComputeNormal(vtkPoints *p, double n[3])
vtkQuad
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:42
vtkPolygon::IsConvex
bool IsConvex()
Determine whether or not a polygon is convex.