PolygonalArea2D

Canonical path: NemAll_Python_Geometry.PolygonalArea2D

Bases: PolygonalArea

Representation class for 2D polygonal area.

Methods:

• AppendRelVertex –

  Append vertex in local coordinate system.

• AppendVertex –

  Append vertex in World coordinate system.

• EqualRef –

  Test for equal reference points.

• GetEdgeVertices –

  Get edge vertices.

• GetPolygon –

  Get polygon.

• GetRefPoint –

  Get the reference point.

• GetRelVertex –

  Get vertex in Local coordinate system.

• GetVertex –

  Get vertex in World coordinate system.

• SetRefPoint –

  Set reference point in world coordinate system.

• __eq__ –

  Comparison of areas.

• __getitem__ –

  Get point at position from index. Used world coordinates.

• __iadd__ –

  Overloaded function. See individual overloads.

• __init__ –

  Overloaded function. See individual overloads.

• __mul__ –

  Matrix transformation.

• __repr__ –

  Convert to string

Attributes:

• RefPoint (Point2D) –

  Get the reference point.

RefPoint property writable

RefPoint: Point2D

Get the reference point.

Coordinates of points will be recalculated with new reference point.

AppendRelVertex

AppendRelVertex(vertex: Point2D) -> tuple[eGeometryErrorCode, int]

Append vertex in local coordinate system.

Parameters:

• vertex (Point2D) –

  vertex in local coordinate system which will be appended.

Returns:

• tuple[eGeometryErrorCode, int] –

  tuple(Error code., index of vertex)

AppendVertex

AppendVertex(vertex: Point2D) -> tuple[eGeometryErrorCode, int]

Append vertex in World coordinate system.

Parameters:

• vertex (Point2D) –

  vertex in world coordinate system which will be appended.

Returns:

• tuple[eGeometryErrorCode, int] –

  tuple(Error code., index of vertex)

EqualRef

EqualRef(polygon: PolygonalArea2D) -> bool

Test for equal reference points.

Parameters:

• polygon (PolygonalArea2D) –

  polygon for comparision.

Returns:

• bool –

  True if reference points are equal else return false.

GetEdgeVertices

GetEdgeVertices(edgeIndex: int) -> tuple[eGeometryErrorCode, Point2D, Point2D]

Get edge vertices.

Old interface: getPolygon2DEdge.

Parameters:

• edgeIndex (int) –

  edge index.

Returns:

• tuple[eGeometryErrorCode, Point2D, Point2D] –

  tuple(Error code., start point of the edge in world coordinate system, end point of the edge in world coordinate system)

GetPolygon

GetPolygon() -> tuple[eGeometryErrorCode, Polygon2D]

Get polygon.

Old interface: pgon_to_punkte

Returns:

• tuple[eGeometryErrorCode, Polygon2D] –

  tuple(Error code., polygon)

GetRefPoint

GetRefPoint() -> Point2D

Get the reference point.

Returns:

• Point2D –

  point.

GetRelVertex

GetRelVertex(vertexIndex: int) -> tuple[eGeometryErrorCode, Point2D]

Get vertex in Local coordinate system.

Old interface: getPolygonVertex.

Parameters:

• vertexIndex (int) –

  vertex index.

Returns:

• tuple[eGeometryErrorCode, Point2D] –

  tuple(Error code., vertex in local coordinate system)

GetVertex

GetVertex(vertexIndex: int) -> tuple[eGeometryErrorCode, Point2D]

Get vertex in World coordinate system.

Old interface: getPolygonVertex.

Parameters:

• vertexIndex (int) –

  vertex index.

Returns:

• tuple[eGeometryErrorCode, Point2D] –

  tuple(Error code., vertex in world coordinate system)

SetRefPoint

SetRefPoint(refPoint: Point2D) -> eGeometryErrorCode

Set reference point in world coordinate system.

Coordinates of points will be recalculated with new reference point.

Parameters:

• refPoint (Point2D) –

  new reference point.

Returns:

• eGeometryErrorCode –

  Error code.

__eq__

__eq__(area: PolygonalArea2D) -> bool

Comparison of areas.

Be careful, this method work without tolerance!

Parameters:

• area (PolygonalArea2D) –

  area to be compared.

Returns:

• bool –

  True when areas are equal, otherwise false.

__getitem__

__getitem__(vertexIndex: int) -> Point2D

Get point at position from index. Used world coordinates.

Parameters:

• vertexIndex (int) –

  vertex index.

Returns:

• Point2D –

  Copy of vertex[vertexIndex] in world coordinates.

__iadd__ overloaded

__iadd__(polygonalarea: PolygonalArea2D) -> PolygonalArea2D

Append polygon.

Old interface: appendPolygonPolygon.

Parameters:

• polygonalarea (PolygonalArea2D) –

  polygonal area which will be appended.

Returns:

• PolygonalArea2D –

  Reference to PolygonalArea2D.

__iadd__(polygon: Polygon2D) -> PolygonalArea2D

Append loop.

Old interface: appendPolygonPolygon.

Parameters:

• polygon (Polygon2D) –

  polygon which will be appended.

Returns:

• PolygonalArea2D –

  Reference to PolygonalArea2D.

__init__ overloaded

__init__()

Initialize

__init__(verticesCount: int, edgesCount: int)

Default constructor.

Create initialized 2D polygonal area with expected vertices and edges count.

Parameters:

• verticesCount (int) –

  Vertices count

• edgesCount (int) –

  Edges count

__init__(refPoint: Point2D, verticesCount: int, edgesCount: int)

Default constructor.

Create initialized 2D polygonal area with expected vertices and edges count.

Parameters:

• refPoint (Point2D) –

  Reference point

• verticesCount (int) –

  Vertices count

• edgesCount (int) –

  Edges count

__init__(polygon: PolygonalArea2D)

Copy constructor.

Parameters:

• polygon (PolygonalArea2D) –

  2D polygon which will be copied.

__mul__

__mul__(matrix: Matrix2D) -> PolygonalArea2D

Matrix transformation.

Parameters:

• matrix (Matrix2D) –

  point index.

Returns:

• PolygonalArea2D –

  Transformed 2D polygonal area.

__repr__

__repr__() -> str

Convert to string

Placeholder