Skip to content

Polyline2D

Canonical path: NemAll_Python_Geometry.Polyline2D

Bases: PolyPoints2D

Representation class for 2D Polyline.

Methods:

  • Clear –

    Remove all points from vector.

  • Count –

    Get count of points.

  • Empty –

    Return true if no points, otherwise false.

  • EqualRef –

    Test if reference points are equal.

  • GetEndPoint –

    Get the end point in world coordinate system.

  • GetEndRelPoint –

    Get the end point

  • GetLastPoint –

    Get the last point in world coordinate system.

  • GetLine –

    Extract a line

  • GetLines –

    Get all lines of the polyling

  • GetPoint –

    Get point in world coordinate system.

  • GetPointIndex –

    Get index of the given point

  • GetPointIndexes –

    Get indexes of the given point, in case that several points in the spline

  • GetRefPoint –

    Get reference point.

  • GetRelPoint –

    Get point in Local coordinate system.

  • GetStartPoint –

    Get the start point in world coordinate system.

  • GetStartRelPoint –

    Get the start point

  • Insert –

    Overloaded function. See individual overloads.

  • InsertRel –

    Insert relative point at specific position. Used local coordinates.

  • IsValid –

    Check if the polygon is valid ( has at least 2 points )

  • LineCount –

    Get the count of lines connecting the points

  • Remove –

    Remove point from specific position.

  • RemoveLastPoint –

    Remove the last point

  • Reserve –

    Reserve container capacity

  • Resize –

    Specifies a new size for the points vector.

  • Reverse –

    Reverse orientation of the Polyline

  • SetEndPoint –

    Set the end point in world coordinates

  • SetPoint –

    Set point at given position in world coordinate system.

  • SetRefPoint –

    Set reference point in world coordinate system.

  • SetRelPoint –

    Set point at given position in relative coordinate system.

  • SetStartPoint –

    Set the start point in world coordinates

  • ToLineChain –

    Get polyline as a chain of lines composed from 2 points.

  • __eq__ –

    Equal operator

  • __getitem__ –

    Get point at position from index. Used world coordinates.

  • __iadd__ –

    Overloaded function. See individual overloads.

  • __init__ –

    Overloaded function. See individual overloads.

  • __mul__ –

    2D matrix transformation

  • __ne__ –

    Not equal operator

  • __repr__ –

    Convert to string

  • __setitem__ –

    Set a value at position from index.

Attributes:

EndPoint property writable 

EndPoint: Point2D

Get the end point in world coordinate system.

EndRelPoint property 

EndRelPoint: Point2D

Get the end point

LastPoint property 

LastPoint: Point2D

Get the last point in world coordinate system.

Points property writable 

Points: list[Point2D]

Get the points

RefPoint property writable 

RefPoint: Point2D

Get reference point.

StartPoint property writable 

StartPoint: Point2D

Get the start point in world coordinate system.

StartRelPoint property 

StartRelPoint: Point2D

Get the start point

Clear 

Clear()

Remove all points from vector.

Count 

Count() -> int

Get count of points.

Returns:

  • int –

    bool.

Empty 

Empty() -> bool

Return true if no points, otherwise false.

Returns:

  • bool –

    bool.

EqualRef 

EqualRef(polyPoints: PolyPoints2D) -> bool

Test if reference points are equal.

Parameters:

Returns:

  • bool –

    Reference points are equal: true/false

GetEndPoint 

GetEndPoint() -> Point2D

Get the end point in world coordinate system.

Returns:

  • Point2D –

    end point in world coordinate system

GetEndRelPoint 

GetEndRelPoint() -> Point2D

Get the end point

Returns:

GetLastPoint 

GetLastPoint() -> Point2D

Get the last point in world coordinate system.

Returns:

  • Point2D –

    last point in world coordinate system

GetLine 

GetLine(index: int) -> Line2D

Extract a line

Parameters:

  • index (int) –

    Index of the line

Returns:

  • Line2D –

    Line from the index

GetLines 

GetLines() -> Line2DList

Get all lines of the polyling

Returns:

GetPoint 

GetPoint(index: int) -> Point2D

Get point in world coordinate system.

This method is checked and throwing Geometry::Exception when index is out of range.

Parameters:

  • index (int) –

    point index.

Returns:

  • Point2D –

    point point in world coordinate system.

GetPointIndex 

GetPointIndex(point: Point2D) -> tuple[bool, int]

Get index of the given point

Parameters:

  • point (Point2D) –

    Searched point

Returns:

  • tuple[bool, int] –

    tuple(True if a point was found, Found index)

GetPointIndexes 

GetPointIndexes(point: Point2D) -> tuple[bool, list[int]]

Get indexes of the given point, in case that several points in the spline will have the same coordinates

Parameters:

  • point (Point2D) –

    Searched point

Returns:

  • tuple[bool, list[int]] –

    tuple(True if at least one point was found, Found indexes)

GetRefPoint 

GetRefPoint() -> Point2D

Get reference point.

Returns:

  • Point2D –

    the reference point in the world coordinate system.

GetRelPoint 

GetRelPoint(index: int) -> Point2D

Get point in Local coordinate system.

This method is checked and throwing Geometry::Exception when index is out of range.

Parameters:

  • index (int) –

    point index.

Returns:

  • Point2D –

    point the point at position index.

GetStartPoint 

GetStartPoint() -> Point2D

Get the start point in world coordinate system.

Returns:

  • Point2D –

    start point in world coordinate system

GetStartRelPoint 

GetStartRelPoint() -> Point2D

Get the start point

Returns:

Insert overloaded 

Insert(polyPoints: PolyPoints2D, position: int = 18446744073709551615) -> bool

Insert vector of points at specific position.

If return false then points weren't inserted.

Parameters:

  • polyPoints (PolyPoints2D) –

    the PolyPoints.

  • position (int, default: 18446744073709551615 ) –

    position where points will be inserted.

Returns:

  • bool –

    bool true if successful.

Insert(point: Point2D, position: int = 18446744073709551615) -> bool

Insert point at specific position. Used world coordinates.

If return false then points weren't Inserted.

Parameters:

  • point (Point2D) –

    the Point.

  • position (int, default: 18446744073709551615 ) –

    position where points will be inserted.

Returns:

  • bool –

    bool true if successful.

InsertRel 

InsertRel(point: Point2D, position: int = 18446744073709551615) -> bool

Insert relative point at specific position. Used local coordinates.

If return false then points weren't Inserted.

Parameters:

  • point (Point2D) –

    the Point.

  • position (int, default: 18446744073709551615 ) –

    position where points will be inserted.

Returns:

  • bool –

    bool true if successful.

IsValid 

IsValid() -> bool

Check if the polygon is valid ( has at least 2 points )

For additional point validation use Service::Validate.

Returns:

  • bool –

    true if is valid

LineCount 

LineCount() -> int

Get the count of lines connecting the points

Returns:

  • int –

    count of lines

Remove 

Remove(position: int) -> bool

Remove point from specific position.

If return false then points weren't removed.

Parameters:

  • position (int) –

    position of point which will be removed.

Returns:

  • bool –

    Point removed: true/false

RemoveLastPoint 

RemoveLastPoint() -> bool

Remove the last point

Returns:

  • bool –

    Point removed: true/false

Reserve 

Reserve(newCount: int)

Reserve container capacity

Parameters:

  • newCount (int) –

    Expected size of container [count of points]

Resize 

Resize(newSize: int)

Specifies a new size for the points vector.

Parameters:

  • newSize (int) –

    The new size of the points vector.

Reverse 

Reverse()

Reverse orientation of the Polyline

SetEndPoint 

SetEndPoint(endpoint: Point2D)

Set the end point in world coordinates

Parameters:

  • endpoint (Point2D) –

    new end point

SetPoint 

SetPoint(point: Point2D, index: int)

Set point at given position in world coordinate system.

Parameters:

  • point (Point2D) –

    point in the world coordinate system.

  • index (int) –

    index of point which will be set

SetRefPoint 

SetRefPoint(refPoint: Point2D)

Set reference point in world coordinate system.

Parameters:

  • refPoint (Point2D) –

    reference point in the world coordinate system.

SetRelPoint 

SetRelPoint(point: Point2D, index: int)

Set point at given position in relative coordinate system.

Parameters:

  • point (Point2D) –

    point in the relative coordinate system.

  • index (int) –

    index of point which will be set

SetStartPoint 

SetStartPoint(startpoint: Point2D)

Set the start point in world coordinates

Parameters:

  • startpoint (Point2D) –

    new start point

ToLineChain 

ToLineChain() -> Point2DList

Get polyline as a chain of lines composed from 2 points.

Returns:

  • Point2DList –

    vector of lines composed from 2 points (start and end point of a line)

__eq__ 

__eq__(polyline2: Polyline2D) -> bool

Equal operator

Parameters:

Returns:

  • bool –

    Polyline3D are equal

__getitem__ 

__getitem__(index: int) -> Point2D

Get point at position from index. Used world coordinates.

This method is checked and throwing Geometry::Exception when index is out of range.

Parameters:

  • index (int) –

    point index.

Returns:

__iadd__ overloaded 

__iadd__(polyline: Polyline2D) -> Polyline2D

Addition assignment operator

Parameters:

  • polyline (Polyline2D) –

    Polyline which will be added

Returns:

__iadd__(point: Point2D) -> Polyline2D

Addition assignment operator

Parameters:

  • point (Point2D) –

    New Point2D which will be added to the polyline

Returns:

__init__ overloaded 

__init__()

Initialize

__init__(pntList: list[Point2D])

Constructor with an initializer list

Parameters:

  • pntList (list[Point2D]) –

    Point list

__init__(polyline: Polyline2D)

Copy constructor.

Parameters:

  • polyline (Polyline2D) –

    Polyline which will be copied

__init__(points: Point2DList)

Vector points constructor.

Parameters:

  • points (Point2DList) –

    Vector of points which will be moved to polyline

__init__(polyline: Polyline2D, skip: int, count: int)

Copy constructor with limited scope

Parameters:

  • polyline (Polyline2D) –

    Polyline which will be copied

  • skip (int) –

    count of points ignored at start.

  • count (int) –

    count of points copied.

__init__(polygon: Polygon2D)

Constructor.

If polygon have two or more components, then constructor throw Geometry exception.

Parameters:

  • polygon (Polygon2D) –

    Polygon2D whose points and reference point will build the new polyline

__mul__ 

__mul__(matrix: Matrix2D) -> Polyline2D

2D matrix transformation

Parameters:

  • matrix (Matrix2D) –

    2D transformation matrix

Returns:

__ne__ 

__ne__(polyline2: Polyline2D) -> bool

Not equal operator

Parameters:

Returns:

  • bool –

    Polyline3D are equal

__repr__ 

__repr__() -> str

Convert to string

__setitem__ 

__setitem__(index: int | slice, value: Point2D | list[Point2D])

Set a value at position from index.

Parameters:

  • index (int | slice) –

    index of the value.

  • value (Point2D | list[Point2D]) –

    value to insert.

Placeholder