vtkPolygon Class Reference

#include <vtkPolygon.h>

Inheritance diagram for vtkPolygon:

Inheritance graph
[legend]
Collaboration diagram for vtkPolygon:

Collaboration graph
[legend]

List of all members.


Detailed Description

a cell that represents an n-sided polygon

vtkPolygon is a concrete implementation of vtkCell to represent a 2D n-sided polygon. The polygons cannot have any internal holes, and cannot self-intersect. Define the polygon with n-points ordered in the counter- clockwise direction; do not repeat the last point.

Examples:
vtkPolygon (Examples)
Tests:
vtkPolygon (Tests)

Definition at line 43 of file vtkPolygon.h.


Public Types

typedef vtkCell Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
double ComputeArea ()
void ComputeWeights (double x[3], double *weights)
int Triangulate (vtkIdList *outTris)
int NonDegenerateTriangulate (vtkIdList *outTris)
int GetCellType ()
int GetCellDimension ()
int GetNumberOfEdges ()
int GetNumberOfFaces ()
vtkCellGetEdge (int edgeId)
vtkCellGetFace (int)
int CellBoundary (int subId, double pcoords[3], vtkIdList *pts)
void Contour (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)
void Clip (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *tris, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)
int EvaluatePosition (double x[3], double *closestPoint, int &subId, double pcoords[3], double &dist2, double *weights)
void EvaluateLocation (int &subId, double pcoords[3], double x[3], double *weights)
int IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)
void Derivatives (int subId, double pcoords[3], double *values, int dim, double *derivs)
int IsPrimaryCell ()
virtual void InterpolateFunctions (double pcoords[3], double *sf)
virtual void InterpolateDerivs (double pcoords[3], double *derivs)
int ParameterizePolygon (double p0[3], double p10[3], double &l10, double p20[3], double &l20, double n[3])

Static Public Member Functions

static vtkPolygonNew ()
static int IsTypeOf (const char *type)
static vtkPolygonSafeDownCast (vtkObject *o)
static void ComputeNormal (int numPts, double *pts, double n[3])
static int IntersectConvex2DCells (vtkCell *cell1, vtkCell *cell2, double tol, double p0[3], double p1[3])
static void ComputeNormal (vtkPoints *p, int numPts, vtkIdType *pts, double n[3])
static void ComputeNormal (vtkPoints *p, double n[3])
static void ComputeNormal (vtkIdTypeArray *ids, vtkPoints *pts, double n[3])
static void ComputeCentroid (vtkIdTypeArray *ids, vtkPoints *pts, double centroid[3])
static double ComputeArea (vtkPoints *p, vtkIdType numPts, vtkIdType *pts, double normal[3])
static int PointInPolygon (double x[3], int numPts, double *pts, double bounds[6], double n[3])
static double DistanceToPolygon (double x[3], int numPts, double *pts, double bounds[6], double closest[3])
static int IntersectPolygonWithPolygon (int npts, double *pts, double bounds[6], int npts2, double *pts2, double bounds2[3], double tol, double x[3])

Protected Member Functions

 vtkPolygon ()
 ~vtkPolygon ()
int EarCutTriangulation ()

Protected Attributes

double Tolerance
int SuccessfulTriangulation
double Normal [3]
vtkIdListTris
vtkTriangleTriangle
vtkQuadQuad
vtkDoubleArrayTriScalars
vtkLineLine

Member Typedef Documentation

Reimplemented from vtkCell.

Definition at line 47 of file vtkPolygon.h.


Constructor & Destructor Documentation

vtkPolygon::vtkPolygon (  )  [protected]

vtkPolygon::~vtkPolygon (  )  [protected]


Member Function Documentation

static vtkPolygon* vtkPolygon::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkPolygon::GetClassName (  )  [virtual]

Reimplemented from vtkCell.

static int vtkPolygon::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCell.

virtual int vtkPolygon::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCell.

static vtkPolygon* vtkPolygon::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkCell.

void vtkPolygon::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkCell.

int vtkPolygon::GetCellType (  )  [inline, virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 52 of file vtkPolygon.h.

int vtkPolygon::GetCellDimension (  )  [inline, virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 53 of file vtkPolygon.h.

int vtkPolygon::GetNumberOfEdges (  )  [inline, virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 54 of file vtkPolygon.h.

int vtkPolygon::GetNumberOfFaces (  )  [inline, virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 55 of file vtkPolygon.h.

vtkCell* vtkPolygon::GetEdge ( int  edgeId  )  [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

vtkCell* vtkPolygon::GetFace ( int   )  [inline, virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 57 of file vtkPolygon.h.

int vtkPolygon::CellBoundary ( int  subId,
double  pcoords[3],
vtkIdList pts 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

void vtkPolygon::Contour ( double  value,
vtkDataArray cellScalars,
vtkIncrementalPointLocator locator,
vtkCellArray verts,
vtkCellArray lines,
vtkCellArray polys,
vtkPointData inPd,
vtkPointData outPd,
vtkCellData inCd,
vtkIdType  cellId,
vtkCellData outCd 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

void vtkPolygon::Clip ( double  value,
vtkDataArray cellScalars,
vtkIncrementalPointLocator locator,
vtkCellArray tris,
vtkPointData inPd,
vtkPointData outPd,
vtkCellData inCd,
vtkIdType  cellId,
vtkCellData outCd,
int  insideOut 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkPolygon::EvaluatePosition ( double  x[3],
double *  closestPoint,
int &  subId,
double  pcoords[3],
double &  dist2,
double *  weights 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

void vtkPolygon::EvaluateLocation ( int &  subId,
double  pcoords[3],
double  x[3],
double *  weights 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkPolygon::IntersectWithLine ( double  p1[3],
double  p2[3],
double  tol,
double &  t,
double  x[3],
double  pcoords[3],
int &  subId 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkPolygon::Triangulate ( int  index,
vtkIdList ptIds,
vtkPoints pts 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

void vtkPolygon::Derivatives ( int  subId,
double  pcoords[3],
double *  values,
int  dim,
double *  derivs 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkPolygon::IsPrimaryCell (  )  [inline, virtual]

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

Definition at line 79 of file vtkPolygon.h.

double vtkPolygon::ComputeArea (  ) 

Compute the area of a polygon. This is a convenience function which simply calls static double ComputeArea(vtkPoints *p, vtkIdType numPts, vtkIdType *pts, double normal[3]); with the appropriate parameters from the instantiated vtkPolygon.

virtual void vtkPolygon::InterpolateFunctions ( double  pcoords[3],
double *  sf 
) [virtual]

Compute the interpolation functions/derivatives (aka shape functions/derivatives)

virtual void vtkPolygon::InterpolateDerivs ( double  pcoords[3],
double *  derivs 
) [virtual]

Compute the interpolation functions/derivatives (aka shape functions/derivatives)

static void vtkPolygon::ComputeNormal ( vtkPoints p,
int  numPts,
vtkIdType pts,
double  n[3] 
) [static]

Polygon specific methods.

static void vtkPolygon::ComputeNormal ( vtkPoints p,
double  n[3] 
) [static]

Polygon specific methods.

static void vtkPolygon::ComputeNormal ( vtkIdTypeArray ids,
vtkPoints pts,
double  n[3] 
) [static]

Polygon specific methods.

static void vtkPolygon::ComputeNormal ( int  numPts,
double *  pts,
double  n[3] 
) [static]

Compute the polygon normal from an array of points. This version assumes that the polygon is convex, and looks for the first valid normal.

static void vtkPolygon::ComputeCentroid ( vtkIdTypeArray ids,
vtkPoints pts,
double  centroid[3] 
) [static]

Compute the centroid of a set of points.

void vtkPolygon::ComputeWeights ( double  x[3],
double *  weights 
)

Compute interpolation weights using 1/r**2 normalized sum.

Deprecated:
Replaced by vtkPolygon::InterpolateFunctions as of VTK 5.2

static double vtkPolygon::ComputeArea ( vtkPoints p,
vtkIdType  numPts,
vtkIdType pts,
double  normal[3] 
) [static]

Compute the area of a polygon in 3D. The area is returned, as well as the normal (a side effect of using this method). If you desire to compute the area of a triangle, use vtkTriangleArea which is faster. If you already have a vtkPolygon instantiated, a convenience function, ComputeArea() is provided.

int vtkPolygon::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. The point p0 is the origin of the local system, p10 is s-axis vector, and p20 is the t-axis vector. (These are expressed in the modeling coordinate system and are vectors of dimension [3].) The values l20 and l20 are the lengths of the vectors p10 and p20, and n is the polygon normal.

static int vtkPolygon::PointInPolygon ( double  x[3],
int  numPts,
double *  pts,
double  bounds[6],
double  n[3] 
) [static]

Determine whether point is inside polygon. Function uses ray-casting to determine if point is inside polygon. Works for arbitrary polygon shape (e.g., non-convex). Returns 0 if point is not in polygon; 1 if it is. Can also return -1 to indicate degenerate polygon.

int vtkPolygon::Triangulate ( vtkIdList outTris  ) 

Triangulate this polygon. The user must provide the vtkIdList outTris. On output, the outTris list contains the ids of the points defining the triangulation. The ids are ordered into groups of three: each three-group defines one triangle.

int vtkPolygon::NonDegenerateTriangulate ( vtkIdList outTris  ) 

Same as Triangulate(vtkIdList *outTris) but with a first pass to split the polygon into non-degenerate polygons.

static double vtkPolygon::DistanceToPolygon ( double  x[3],
int  numPts,
double *  pts,
double  bounds[6],
double  closest[3] 
) [static]

Compute the distance of a point to a polygon. The closest point on the polygon is also returned. The bounds should be provided to accelerate the computation.

static int vtkPolygon::IntersectPolygonWithPolygon ( int  npts,
double *  pts,
double  bounds[6],
int  npts2,
double *  pts2,
double  bounds2[3],
double  tol,
double  x[3] 
) [static]

Method intersects two polygons. You must supply the number of points and point coordinates (npts, *pts) and the bounding box (bounds) of the two polygons. Also supply a tolerance squared for controlling error. The method returns 1 if there is an intersection, and 0 if not. A single point of intersection x[3] is also returned if there is an intersection.

static int vtkPolygon::IntersectConvex2DCells ( vtkCell cell1,
vtkCell cell2,
double  tol,
double  p0[3],
double  p1[3] 
) [static]

int vtkPolygon::EarCutTriangulation (  )  [protected]

A fast triangulation method. Uses recursive divide and conquer based on plane splitting to reduce loop into triangles. The cell (e.g., triangle) is presumed properly initialized (i.e., Points and PointIds).


Member Data Documentation

double vtkPolygon::Tolerance [protected]

Definition at line 197 of file vtkPolygon.h.

Definition at line 198 of file vtkPolygon.h.

double vtkPolygon::Normal[3] [protected]

Definition at line 199 of file vtkPolygon.h.

Definition at line 200 of file vtkPolygon.h.

Definition at line 201 of file vtkPolygon.h.

vtkQuad* vtkPolygon::Quad [protected]

Definition at line 202 of file vtkPolygon.h.

Definition at line 203 of file vtkPolygon.h.

vtkLine* vtkPolygon::Line [protected]

Definition at line 204 of file vtkPolygon.h.


The documentation for this class was generated from the following file:

Generated on Mon Sep 27 18:42:24 2010 for VTK by  doxygen 1.5.6