Skip to content

PolygonalArea3D

Canonical path: NemAll_Python_Geometry.PolygonalArea3D

Bases: PolygonalArea

3D polygonal area class for 3D polygonal area geometry

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.

  • Reverse –

    Reverse the point order of boundary polygons of the area.

  • SetRefPoint –

    Set reference point in world coordinate system.

  • __eq__ –

    Comparison of polygonalAreas without tolerance.

  • __getitem__ –

    Get point at position from index. Used world coordinates.

  • __iadd__ –

    Overloaded function. See individual overloads.

  • __init__ –

    Overloaded function. See individual overloads.

  • __mul__ –

    Overloaded function. See individual overloads.

  • __repr__ –

    Convert the list to a string

Attributes:

  • RefPoint (None) –

    Get and set the reference point in world coordinate system as property

RefPoint property 

RefPoint: None

Get and set the reference point in world coordinate system as property

:type: None

AppendRelVertex 

AppendRelVertex(vertex: Point3D) -> tuple

Append vertex in local coordinate system.

Warning: method does not update edges.

Parameters:

  • vertex (Point3D) –

    vertex in local coordinate system which will be appended.

Returns:

  • tuple –

    Error code.,

  • tuple –

    index of vertex

AppendVertex 

AppendVertex(vertex: Point3D) -> tuple

Append vertex in World coordinate system.

Warning: method does not update edges.

Parameters:

  • vertex (Point3D) –

    vertex in world coordinate system which will be appended.

Returns:

  • tuple –

    Error code.,

  • tuple –

    index of vertex

EqualRef 

EqualRef(polygon: PolygonalArea3D) -> bool

Test for equal reference points.

Parameters:

Returns:

  • bool –

    True if reference points are equal else return false.

GetEdgeVertices 

GetEdgeVertices(edgeIndex: int) -> tuple

Get edge vertices.

Parameters:

  • edgeIndex (int) –

    edge index.

Returns:

  • tuple –

    Error code.,

  • tuple –

    start point of the edge in world coordinate system.,

  • tuple –

    end point of the edge in world coordinate system.

GetPolygon 

GetPolygon() -> tuple

Get polygon.

Returns empty polygon, if it has zero edges.

Returns:

GetRefPoint 

GetRefPoint() -> Point3D

Get the reference point.

Returns:

  • Point3D –

    constant reference to point.

GetRelVertex 

GetRelVertex(vertexIndex: int) -> tuple

Get vertex in Local coordinate system.

Parameters:

  • vertexIndex (int) –

    vertex index.

Returns:

  • tuple –

    vertex in local coordinate system.

GetVertex 

GetVertex(vertexIndex: int) -> tuple

Get vertex in World coordinate system.

Parameters:

  • vertexIndex (int) –

    vertex index.

Returns:

  • tuple –

    Error code.,

  • tuple –

    vertex in world coordinate system.

Reverse 

Reverse() -> eGeometryErrorCode

Reverse the point order of boundary polygons of the area.

Returns:

SetRefPoint 

SetRefPoint(refPoint: Point3D) -> eGeometryErrorCode

Set reference point in world coordinate system.

Coordinates of points will be recalculated with new reference point.

Parameters:

  • refPoint (Point3D) –

    new reference point.

  • or –

    code.

__eq__ 

__eq__(polygonalArea: PolygonalArea3D) -> object

Comparison of polygonalAreas without tolerance.

Be careful, this method work without tolerance!

Parameters:

Returns:

  • object –

    True when polygonalAreas are equal, otherwise false.

__getitem__ 

__getitem__(arg2: int) -> Point3D

Get point at position from index. Used world coordinates.

Parameters:

  • vertexIndex –

    vertex index.

Returns:

  • Point3D –

    Copy of vertex[vertexIndex] in world coordinates.

__iadd__ overloaded 

__iadd__(polygonalarea: PolygonalArea3D) -> object

Append polygon.

Parameters:

  • polygonalarea (PolygonalArea3D) –

    polygonal area which will be appended.

Returns:

  • object –

    Reference to PolygonalArea3D.

__iadd__(polygon: Polygon3D) -> object

Append loop.

Parameters:

  • polygon (Polygon3D) –

    polygonal area which will be appended.

Returns:

  • object –

    Reference to PolygonalArea3D.

__init__ overloaded 

__init__()

Initialize

__init__(verticesCount: int, edgesCount: int)

Default constructor.

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

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

Default constructor.

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

__init__(polygon: PolygonalArea3D)

Copy constructor.

Parameters:

__mul__ overloaded 

__mul__(matrix: Matrix2D) -> object

2D matrix transformation.

Parameters:

  • matrix (Matrix2D) –

    2D transformation matrix.

Returns:

  • object –

    Transformed 3D polygon area.

__mul__(matrix: Matrix3D) -> object

3D matrix transformation.

Parameters:

  • matrix (Matrix3D) –

    3D transformation matrix.

Returns:

  • object –

    Transformed 3D polygon area.

__repr__ 

__repr__() -> str

Convert the list to a string

Returns:

  • str –

    List values as string

Placeholder