Polygonal Area
Class full path: NemAll_Python_Geometry.PolygonalArea
Functions
AppendEdge(edge)
Append edge (appendPolygonEdge).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
edge
|
GeometryEdge
|
Appended edge. |
required |
Returns:
| Type | Description |
|---|---|
object
|
Error code. |
GetComponentsCount()
Get count of components.
Returns:
| Type | Description |
|---|---|
int
|
Count of component. |
GetEdge(edgeIndex)
Get edge.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
edgeIndex
|
int
|
index of the edge. |
required |
Returns:
| Type | Description |
|---|---|
tuple
|
Error code., |
tuple
|
edge of polygon. |
GetEdges()
Get copy of all edges.
Returns:
| Type | Description |
|---|---|
tuple
|
Error code., |
tuple
|
vector of all edges. |
GetEdgesCount()
Get count of edges.
Returns:
| Type | Description |
|---|---|
int
|
Count of edges. |
GetLoopEndEdgeIndex(loopIndex)
Get the index of last edge of a loop.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
loopIndex
|
int
|
index of loop. |
required |
Returns:
| Type | Description |
|---|---|
int
|
Index of the last edge of the loop identified by the loopIndex value. |
GetLoopsCount()
Get Count of loops.
Returns:
| Type | Description |
|---|---|
int
|
Count of loops. |
GetNeighborEdges(edgeIndex)
Get neighbor edges.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
edgeIndex
|
int
|
edge index. |
required |
Returns:
| Type | Description |
|---|---|
tuple
|
Error code., |
tuple
|
previous edge (edge which is before edge[index] in the chain)., |
tuple
|
next edge (edge which is after edge[index] in the chain). |
GetNextEdge(edgeIndex)
Get next edge.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
edgeIndex
|
int
|
edge index. |
required |
Returns:
| Type | Description |
|---|---|
tuple
|
Error code., |
tuple
|
next edge (edge which is after edge[index] in the chain). |
GetPlane()
Get plane if polygon is plane.
Returns:
| Type | Description |
|---|---|
tuple
|
Error code., |
tuple
|
polygon plane. |
GetPrevEdge(edgeIndex)
Get previous edge.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
edgeIndex
|
int
|
edge index. |
required |
Returns:
| Type | Description |
|---|---|
tuple
|
Error code., |
tuple
|
previous edge (edge which is before edge[index] in the chain). |
GetVector()
Get Normal vector if polygon is plane.
Returns:
| Type | Description |
|---|---|
tuple
|
Error code., |
tuple
|
normal vector to the polygon plane. |
GetVerticesCount()
Get count of vertices.
Returns:
| Type | Description |
|---|---|
int
|
Count of vertices. |
SetPlane(plane)
Set plane.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plane
|
Plane3D
|
plane which will be set. |
required |
SetVector(vec)
Set normal vector.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
vec
|
Vector3D
|
vector which will be set. |
required |
Returns:
| Type | Description |
|---|---|
object
|
Error code. |