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

Inheritance diagram for Polygon:

Public Member Functions
def	cloneAddInfoFullLayout (self)

def	cloneAddInfoView (self, arg1, arg2)

def	eraseLayout (self, arg1)

def	faces (self)

def	getAddInfo (self)

def	getArea (self)

def	getAsDoubleByView (self, arg1, arg2, arg3)

def	getPointAddInfoStatistics (self)

def	hasInfo (self)

def	info (self)

def	parts (self)

def	points (self)

def	restoreAddInfoFullLayout (self)

def	setAddInfo (self, arg1)

def	setAddInfoView (self, arg1, arg2)

def	sizeFace (self)

def	sizePart (self)

def	sizePoint (self)

def	type (self)

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 details

The 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

◆ cloneAddInfoFullLayout()

def cloneAddInfoFullLayout ( self )

  @param self (type: Polygon) self pointer

◆ cloneAddInfoView()

def cloneAddInfoView	(	self,
		arg1,
		arg2
	)

  possible calls:
  cloneAddInfoView(self, arg1: AddInfoLayout, arg2: bool)
  cloneAddInfoView(self, arg1: AddInfoLayout, arg2: AddInfoLayout)

  @param self (type: Polygon) self pointer
  @param arg1 (type: AddInfoLayout) mandatory parameter
  @param arg2 (type: bool | AddInfoLayout) mandatory parameter

◆ eraseLayout()

def eraseLayout	(	self,
		arg1
	)

  @param self (type: Polygon) self pointer
  @param arg1 (type: AddInfoLayout) mandatory parameter

◆ faces()

def faces ( self )

  iterate over all faces
  @param self (type: Polygon) self pointer
  @return (type: collections.Iterable[PolygonFace])

◆ getAddInfo()

def getAddInfo ( self )

  @param self (type: Polygon) self pointer
  @return (type: AddInfo)

◆ getArea()

def getArea ( self )

  @param self (type: Polygon) self pointer
  @return (type: float)

◆ getAsDoubleByView()

def getAsDoubleByView	(	self,
		arg1,
		arg2,
		arg3
	)

  @param self (type: Polygon) self pointer
  @param arg1 (type: AddInfoLayout) mandatory parameter
  @param arg2 (type: int) mandatory parameter
  @param arg3 (type: float) mandatory parameter
  @return (type: bool)

◆ getPointAddInfoStatistics()

def getPointAddInfoStatistics ( self )

  @param self (type: Polygon) self pointer
  @return (type: AddInfoStatistics)

◆ hasInfo()

def hasInfo ( self )

  @param self (type: Polygon) self pointer
  @return (type: bool)

◆ info()

def info ( self )

  @param self (type: Polygon) self pointer
  @return (type: AddInfo)

◆ parts()

def parts ( self )

  iterate over all level 0-parts
  @param self (type: Polygon) self pointer
  @return (type: collections.Iterable[PolygonFace])

◆ points()

def points ( self )

  iterate over all points
  @param self (type: Polygon) self pointer
  @return (type: collections.Iterable[Point])

◆ restoreAddInfoFullLayout()

def restoreAddInfoFullLayout ( self )

  @param self (type: Polygon) self pointer

◆ setAddInfo()

def setAddInfo	(	self,
		arg1
	)

  @param self (type: Polygon) self pointer
  @param arg1 (type: AddInfo) mandatory parameter

◆ setAddInfoView()

def setAddInfoView	(	self,
		arg1,
		arg2
	)

  @param self (type: Polygon) self pointer
  @param arg1 (type: AddInfoLayout) mandatory parameter
  @param arg2 (type: bool) mandatory parameter

◆ sizeFace()

def sizeFace ( self )

  @param self (type: Polygon) self pointer
  @return (type: int)

◆ sizePart()

def sizePart ( self )

  @param self (type: Polygon) self pointer
  @return (type: int)

◆ sizePoint()

def sizePoint ( self )

  @param self (type: Polygon) self pointer
  @return (type: int)

◆ type()

def type ( self )

  @param self (type: Polygon) self pointer
  @return (type: GeometryType)

Public Member Functions