Files
specklepy/src/specklepy/objects/geometry/polyline.py
T
2025-02-08 15:42:54 +01:00

72 lines
2.2 KiB
Python

from dataclasses import dataclass
from typing import List
from specklepy.objects.base import Base
from specklepy.objects.geometry.point import Point
from specklepy.objects.interfaces import ICurve, IHasUnits
@dataclass(kw_only=True)
class Polyline(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Polyline"):
"""
a polyline curve, defined by a set of vertices.
"""
value: List[float]
def __repr__(self) -> str:
return f"{self.__class__.__name__}(value: {self.value}, units: {self.units})"
def is_closed(self, tolerance: float = 1e-6) -> bool:
"""
check if the polyline is closed (start point equals end point within tolerance)
"""
if len(self.value) < 6: # need at least 2 points to be closed
return False
# compare first and last points
start = Point(
x=self.value[0], y=self.value[1], z=self.value[2], units=self.units
)
end = Point(
x=self.value[-3], y=self.value[-2], z=self.value[-1], units=self.units
)
return start.distance_to(end) <= tolerance
@property
def length(self) -> float:
return self.__dict__.get("_length", 0.0)
@length.setter
def length(self, value: float) -> None:
self.__dict__["_length"] = value
def calculate_length(self) -> float:
points = self.get_points()
total_length = 0.0
for i in range(len(points) - 1):
total_length += points[i].distance_to(points[i + 1])
if self.is_closed() and points:
total_length += points[-1].distance_to(points[0])
return total_length
def get_points(self) -> List[Point]:
"""
converts the raw coordinate list into Point objects
"""
if len(self.value) % 3 != 0:
raise ValueError(
"Polyline value list is malformed: expected length to be multiple of 3"
)
points = []
for i in range(0, len(self.value), 3):
point = Point(
x=self.value[i],
y=self.value[i + 1],
z=self.value[i + 2],
units=self.units,
)
points.append(point)
return points