PolygonalArea

Canonical path: NemAll_Python_Geometry.PolygonalArea

The PolygonalArea class is the base class for PolygonalArea2D and PolygonalArea3D.

AppendEdge

AppendEdge(edge: GeometryEdge) -> eGeometryErrorCode

Append edge (appendPolygonEdge).

Parameters:

• edge (GeometryEdge) –

  Appended edge.

Returns:

• eGeometryErrorCode –

  Error code.

GetComponentsCount

GetComponentsCount() -> int

Get count of components.

Returns:

• int –

  Count of component.

GetEdge

GetEdge(edgeIndex: int) -> tuple[eGeometryErrorCode, GeometryEdge]

Get edge.

Parameters:

• edgeIndex (int) –

  index of the edge.

Returns:

• tuple[eGeometryErrorCode, GeometryEdge] –

  tuple(Error code., edge of polygon)

GetEdges

GetEdges() -> tuple[eGeometryErrorCode, list[GeometryEdge]]

Get copy of all edges.

Returns:

• tuple[eGeometryErrorCode, list[GeometryEdge]] –

  tuple(Error code., vector of all edges)

GetEdgesCount

GetEdgesCount() -> int

Get count of edges.

Returns:

• int –

  Count of edges.

GetLoopEndEdgeIndex

GetLoopEndEdgeIndex(loopIndex: int) -> int

Get the index of last edge of a loop.

Parameters:

• loopIndex (int) –

  index of loop.

Returns:

• int –

  Index of the last edge of the loop identified by the loopIndex value.

GetLoopsCount

GetLoopsCount() -> int

Get Count of loops.

Returns:

• int –

  Count of loops.

GetNeighborEdges

GetNeighborEdges(
    edgeIndex: int,
) -> tuple[eGeometryErrorCode, GeometryEdge, GeometryEdge]

Get neighbor edges.

Parameters:

• edgeIndex (int) –

  edge index.

Returns:

• tuple[eGeometryErrorCode, GeometryEdge, GeometryEdge] –

  tuple(Error code., previous edge (edge which is before edge[index] in the chain), next edge (edge which is after edge[index] in the chain))

GetNextEdge

GetNextEdge(edgeIndex: int) -> tuple[eGeometryErrorCode, GeometryEdge]

Get next edge.

Parameters:

• edgeIndex (int) –

  edge index.

Returns:

• tuple[eGeometryErrorCode, GeometryEdge] –

  tuple(Error code., next edge (edge which is after edge[index] in the chain))

GetPlane

GetPlane() -> tuple[eGeometryErrorCode, Plane3D]

Get plane if polygon is plane.

Returns:

• tuple[eGeometryErrorCode, Plane3D] –

  tuple(Error code., polygon plane)

GetPrevEdge

GetPrevEdge(edgeIndex: int) -> tuple[eGeometryErrorCode, GeometryEdge]

Get previous edge.

Parameters:

• edgeIndex (int) –

  edge index.

Returns:

• tuple[eGeometryErrorCode, GeometryEdge] –

  tuple(Error code., previous edge (edge which is before edge[index] in the chain))

GetVector

GetVector() -> tuple[eGeometryErrorCode, Vector3D]

Get Normal vector if polygon is plane.

Returns:

• tuple[eGeometryErrorCode, Vector3D] –

  tuple(Error code., normal vector to the polygon plane)

GetVerticesCount

GetVerticesCount() -> int

Get count of vertices.

Returns:

• int –

  Count of vertices.

IsValid

IsValid() -> bool

Checking validity

Returns:

• bool –

  True when valid, otherwise false.

SetPlane

SetPlane(plane: Plane3D)

Set plane.

Parameters:

• plane (Plane3D) –

  plane which will be set.

SetVector

SetVector(vec: Vector3D) -> eGeometryErrorCode

Set normal vector.

Parameters:

• vec (Vector3D) –

  vector which will be set.

Returns:

• eGeometryErrorCode –

  Error code.

Placeholder