a cell that represents an n-sided polygon More...

#include <vtkPolygon.h>

Inheritance diagram for vtkPolygon:

Collaboration diagram for vtkPolygon:

Public Types
enum	EarCutMeasureTypes { PERIMETER2_TO_AREA_RATIO = 0 , DOT_PRODUCT = 1 , BEST_QUALITY = 2 }

typedef vtkCell	Superclass

Public Types inherited from vtkCell
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkPolygon *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

double	ComputeArea ()
	Compute the area of a polygon.

void	InterpolateFunctions (const double x[3], double *sf) override
	Compute the interpolation functions/derivatives.

bool	IsConvex ()
	Determine whether or not a polygon is convex.

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	Triangulate (int index, vtkIdList ptIds, vtkPoints pts) override
	Generate simplices of proper dimension.

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

int	BoundedTriangulate (vtkIdList *outTris, double tol)
	Triangulate polygon and enforce that the ratio of the smallest triangle area to the polygon area is greater than a user-defined tolerance.


int	GetCellType () override
	See the vtkCell API for descriptions of these methods.

int	GetCellDimension () override
	See the vtkCell API for descriptions of these methods.

int	GetNumberOfEdges () override
	See the vtkCell API for descriptions of these methods.

int	GetNumberOfFaces () override
	See the vtkCell API for descriptions of these methods.

vtkCell *	GetEdge (int edgeId) override
	See the vtkCell API for descriptions of these methods.

vtkCell *	GetFace (int) override
	See the vtkCell API for descriptions of these methods.

int	CellBoundary (int subId, const double pcoords[3], vtkIdList *pts) override
	See the vtkCell API for descriptions of these methods.

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.

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.

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.

void	EvaluateLocation (int &subId, const double pcoords[3], double x[3], double *weights) override
	See the vtkCell API for descriptions of these methods.

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	TriangulateLocalIds (int index, vtkIdList *ptIds) override
	See the vtkCell API for descriptions of these methods.

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.

int	IsPrimaryCell () VTK_FUTURE_CONST override
	See the vtkCell API for descriptions of these methods.


virtual bool	GetUseMVCInterpolation ()
	Set/Get the flag indicating whether to use Mean Value Coordinate for the interpolation.

virtual void	SetUseMVCInterpolation (bool)
	Set/Get the flag indicating whether to use Mean Value Coordinate for the interpolation.


virtual void	SetTolerance (double)
	Specify an internal tolerance for operations requiring polygon triangulation.

virtual double	GetTolerance ()
	Specify an internal tolerance for operations requiring polygon triangulation.


int	EarCutTriangulation (int measure=PERIMETER2_TO_AREA_RATIO)
	A fast triangulation method.

int	EarCutTriangulation (vtkIdList *outTris, int measure=PERIMETER2_TO_AREA_RATIO)
	A fast triangulation method.


int	UnbiasedEarCutTriangulation (int seed, int measure=PERIMETER2_TO_AREA_RATIO)
	A fast triangulation method.

int	UnbiasedEarCutTriangulation (int seed, vtkIdList *outTris, int measure=PERIMETER2_TO_AREA_RATIO)
	A fast triangulation method.

Public Member Functions inherited from vtkCell
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkCell *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	Initialize (int npts, const vtkIdType pts, vtkPoints p)
	Initialize cell from outside with point ids and point coordinates specified.

void	Initialize (int npts, vtkPoints *p)
	Initialize the cell with point coordinates specified.

virtual void	ShallowCopy (vtkCell *c)
	Copy this cell by reference counting the internal data structures.

virtual void	DeepCopy (vtkCell *c)
	Copy this cell by completely copying internal data structures.

virtual int	GetCellType ()=0
	Return the type of cell.

virtual int	GetCellDimension ()=0
	Return the topological dimensional of the cell (0,1,2, or 3).

virtual int	IsLinear () VTK_FUTURE_CONST
	Non-linear cells require special treatment beyond the usual cell type and connectivity list information.

virtual int	RequiresInitialization ()
	Some cells require initialization prior to access.

virtual void	Initialize ()

virtual int	IsExplicitCell () VTK_FUTURE_CONST
	Explicit cells require additional representational information beyond the usual cell type and connectivity list information.

virtual int	RequiresExplicitFaceRepresentation () VTK_FUTURE_CONST
	Determine whether the cell requires explicit face representation, and methods for setting and getting the faces (see vtkPolyhedron for example usage of these methods).

vtkPoints *	GetPoints ()
	Get the point coordinates for the cell.

vtkIdType	GetNumberOfPoints () const
	Return the number of points in the cell.

virtual int	GetNumberOfEdges ()=0
	Return the number of edges in the cell.

virtual int	GetNumberOfFaces ()=0
	Return the number of faces in the cell.

vtkIdList *	GetPointIds ()
	Return the list of point ids defining the cell.

vtkIdType	GetPointId (int ptId)
	For cell point i, return the actual point id.

virtual vtkCell *	GetEdge (int edgeId)=0
	Return the edge cell from the edgeId of the cell.

virtual vtkCell *	GetFace (int faceId)=0
	Return the face cell from the faceId of the cell.

virtual int	CellBoundary (int subId, const double pcoords[3], vtkIdList *pts)=0
	Given parametric coordinates of a point, return the closest cell boundary, and whether the point is inside or outside of the cell.

virtual int	EvaluatePosition (const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[])=0
	Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; evaluate parametric coordinates, sub-cell id (!=0 only if cell is composite), distance squared of point x[3] to cell (in particular, the sub-cell indicated), closest point on cell to x[3] (unless closestPoint is null, in which case, the closest point and dist2 are not found), and interpolation weights in cell.

virtual void	EvaluateLocation (int &subId, const double pcoords[3], double x[3], double *weights)=0
	Determine global coordinate (x[3]) from subId and parametric coordinates.

virtual void	Contour (double value, vtkDataArray cellScalars, vtkIncrementalPointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData *outCd)=0
	Generate contouring primitives.

virtual void	Clip (double value, vtkDataArray cellScalars, vtkIncrementalPointLocator locator, vtkCellArray connectivity, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)=0
	Cut (or clip) the cell based on the input cellScalars and the specified value.

virtual int	Inflate (double dist)
	Inflates the cell.

virtual double	ComputeBoundingSphere (double center[3]) const
	Computes the bounding sphere of the cell.

virtual int	IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)=0
	Intersect with a ray.

virtual int	Triangulate (int index, vtkIdList ptIds, vtkPoints pts)
	Generate simplices of proper dimension.

virtual int	TriangulateIds (int index, vtkIdList *ptIds)
	Generate simplices of proper dimension.

virtual int	TriangulateLocalIds (int index, vtkIdList *ptIds)=0
	Generate simplices of proper dimension.

virtual void	Derivatives (int subId, const double pcoords[3], const double values, int dim, double derivs)=0
	Compute derivatives given cell subId and parametric coordinates.

void	GetBounds (double bounds[6])
	Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).

double *	GetBounds ()
	Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).

double	GetLength2 ()
	Compute Length squared of cell (i.e., bounding box diagonal squared).

virtual int	GetParametricCenter (double pcoords[3])
	Return center of the cell in parametric coordinates.

virtual double	GetParametricDistance (const double pcoords[3])
	Return the distance of the parametric coordinate provided to the cell.

virtual int	IsPrimaryCell () VTK_FUTURE_CONST
	Return whether this cell type has a fixed topology or whether the topology varies depending on the data (e.g., vtkConvexPointSet).

virtual double *	GetParametricCoords ()
	Return a contiguous array of parametric coordinates of the points defining this cell.

virtual void	InterpolateFunctions (const double pcoords[3], double *weight)
	Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this level.

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

virtual int	IntersectWithCell (vtkCell *other, double tol=0.0)
	Intersects with an other cell.

virtual int	IntersectWithCell (vtkCell *other, const vtkBoundingBox &boudingBox, const vtkBoundingBox &otherBoundingBox, double tol=0.0)
	Intersects with an other cell.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkPolygon *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPolygon *	SafeDownCast (vtkObjectBase *o)

static vtkCellStatus	ComputeNormal (int numPts, double *pts, double n[3])
	Compute the polygon normal from an array of points.

static double	ComputeArea (vtkPoints p, vtkIdType numPts, const vtkIdType pts, double normal[3])
	Compute the area of a polygon in 3D.

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.

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.

static int	IntersectPolygonWithPolygon (int npts, double pts, double bounds[6], int npts2, double pts2, double bounds2[6], double tol, double x[3])
	Method intersects two polygons.

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.


static vtkCellStatus	ComputeNormal (vtkPoints p, int numPts, const vtkIdType pts, double n[3])
	Computes the unit normal to the polygon.

static vtkCellStatus	ComputeNormal (vtkPoints *p, double n[3])
	Computes the unit normal to the polygon.

static vtkCellStatus	ComputeNormal (vtkIdTypeArray ids, vtkPoints pts, double n[3])
	Computes the unit normal to the polygon.


static bool	IsConvex (vtkPoints p, int numPts, const vtkIdType pts)
	Determine whether or not a polygon is convex.

static bool	IsConvex (vtkIdTypeArray ids, vtkPoints p)
	Determine whether or not a polygon is convex.

static bool	IsConvex (vtkPoints *p)
	Determine whether or not a polygon is convex.


static vtkCellStatus	ComputeCentroid (vtkPoints p, int numPts, const vtkIdType pts, double centroid[3], double tolerance)
	Compute the centroid of a set of points.

static bool	ComputeCentroid (vtkPoints p, int numPts, const vtkIdType pts, double centroid[3])
	Compute the centroid of a set of points.

static bool	ComputeCentroid (vtkIdTypeArray ids, vtkPoints pts, double centroid[3])
	Compute the centroid of a set of points.

Static Public Member Functions inherited from vtkCell
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCell *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPolygon ()

	~vtkPolygon () override

void	InterpolateFunctionsUsingMVC (const double x[3], double *weights)

void	ComputeTolerance ()

Protected Member Functions inherited from vtkCell
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCell ()

	~vtkCell () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Tolerance

double	Tol

int	SuccessfulTriangulation

vtkIdList *	Tris

vtkTriangle *	Triangle

vtkQuad *	Quad

vtkDoubleArray *	TriScalars

vtkLine *	Line

bool	UseMVCInterpolation

Protected Attributes inherited from vtkCell
double	Bounds [6]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkCell
vtkPoints *	Points

vtkIdList *	PointIds

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

Online Examples:

ConstrainedDelaunay2D

LinearCellsDemo

Polygon

PolygonIntersection

WriteLegacyLinearCells

WriteXMLLinearCells

PointInPolygon

TextureMapQuad

ImageTracerWidgetInsideContour

Tests:: vtkPolygon (Tests)

Definition at line 131 of file vtkPolygon.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCell vtkPolygon::Superclass

Definition at line 135 of file vtkPolygon.h.

Member Enumeration Documentation

◆ EarCutMeasureTypes

enum vtkPolygon::EarCutMeasureTypes

Enumerator
PERIMETER2_TO_AREA_RATIO
DOT_PRODUCT
BEST_QUALITY

Definition at line 402 of file vtkPolygon.h.

Constructor & Destructor Documentation

◆ vtkPolygon()

vtkPolygon::vtkPolygon ( )

protected

◆ ~vtkPolygon()

vtkPolygon::~vtkPolygon ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPolygon * vtkPolygon::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkPolygon::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkPolygon * vtkPolygon::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPolygon::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCell.

◆ NewInstance()

vtkPolygon * vtkPolygon::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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.