Polygon Class Reference

interface to a 2.5d polygon of arbitrary complexity More...

Public Member Functions

def cloneAddInfoFullLayout
def cloneAddInfoView
def cloneAddInfoView
def eraseLayout
def faces
 iterate over all faces
def getAddInfo
def getArea
def getAsDoubleByView
def getPointAddInfoStatistics
def hasInfo
def info
def parts
 iterate over all level 0-parts
def points
 iterate over all points
def restoreAddInfoFullLayout
def setAddInfo
def setAddInfoView
def sizeFace
def sizePart
def sizePoint
def type

Detailed Description

interface to a 2.5d polygon of arbitrary complexity

The DM polygon object can handle arbitrary nested polygons (often called multi part polygons). The implementation is based on the CGAL nef polygons, a 2d polyhedron representation. Hence, positive regions (=part of the polygon) may contain an arbitrary number of negative regions (=not part of the polygon. also called holes) contains positive regions again and so on defining a hierarchy (=levels of polygons) Additionally the number of level 0 polygons (top level hierarchy) is not limited.Such polygon objects can only be constructed by a corresponding polygon factory object. However, it has to be considered that there are some prerequisites regarding the topological correctness of the input data. see the IPolylineFactory for detailsThe polygon object is structured in a hierarchy and can be traversed with the corresponding part iterators. To identify positive and negative region use the IFace::positveFace member function of the corresponding part object. The part object has no nested parts if the IPart::sizePart retruns zero or the distance of the part iterators is empty.For accessing the points of part object use the corresponding point iterator functions. Note that points of positive regions are sorted counterclockwise and points of negative regions clockwise.For listing all polygon points in a non-hierarchical manner use the point iterator function of the polygon object itself

Member Function Documentation

def cloneAddInfoFullLayout (   self)
Parameters
self(type: Polygon) self pointer
def cloneAddInfoView (   self,
  arg1,
  arg2 
)
Parameters
self(type: Polygon) self pointer
arg1(type: AddInfoLayout) mandatory parameter
arg2(type: bool) mandatory parameter

Referenced by Polygon.cloneAddInfoView().

def cloneAddInfoView (   self,
  arg1,
  arg2 
)
Parameters
self(type: Polygon) self pointer
arg1(type: AddInfoLayout) mandatory parameter
arg2(type: AddInfoLayout) mandatory parameter

References Polygon.cloneAddInfoView().

def eraseLayout (   self,
  arg1 
)
Parameters
self(type: Polygon) self pointer
arg1(type: AddInfoLayout) mandatory parameter
def faces (   self)

iterate over all faces

Parameters
self(type: Polygon) self pointer
Returns
(type: collections.Iterable[PolygonFace])
def getAddInfo (   self)
Parameters
self(type: Polygon) self pointer
Returns
(type: AddInfo)
def getArea (   self)
Parameters
self(type: Polygon) self pointer
Returns
(type: float)
def getAsDoubleByView (   self,
  arg1,
  arg2,
  arg3 
)
Parameters
self(type: Polygon) self pointer
arg1(type: AddInfoLayout) mandatory parameter
arg2(type: int) mandatory parameter
arg3(type: float) mandatory parameter
Returns
(type: bool)
def getPointAddInfoStatistics (   self)
Parameters
self(type: Polygon) self pointer
Returns
(type: AddInfoStatistics)
def hasInfo (   self)
Parameters
self(type: Polygon) self pointer
Returns
(type: bool)
def info (   self)
Parameters
self(type: Polygon) self pointer
Returns
(type: AddInfo)
def parts (   self)

iterate over all level 0-parts

Parameters
self(type: Polygon) self pointer
Returns
(type: collections.Iterable[PolygonFace])
def points (   self)

iterate over all points

Parameters
self(type: Polygon) self pointer
Returns
(type: collections.Iterable[Point])
def restoreAddInfoFullLayout (   self)
Parameters
self(type: Polygon) self pointer
def setAddInfo (   self,
  arg1 
)
Parameters
self(type: Polygon) self pointer
arg1(type: AddInfo) mandatory parameter
def setAddInfoView (   self,
  arg1,
  arg2 
)
Parameters
self(type: Polygon) self pointer
arg1(type: AddInfoLayout) mandatory parameter
arg2(type: bool) mandatory parameter
def sizeFace (   self)
Parameters
self(type: Polygon) self pointer
Returns
(type: int)
def sizePart (   self)
Parameters
self(type: Polygon) self pointer
Returns
(type: int)
def sizePoint (   self)
Parameters
self(type: Polygon) self pointer
Returns
(type: int)
def type (   self)
Parameters
self(type: Polygon) self pointer
Returns
(type: GeometryType)