Skip to content

Waypoint

Module: terminaltexteffects.engine.motion

A Waypoint comprises an identifier, a coordinate, and, optionally, bezier control point(s).

Attributes:

Name Type Description
waypoint_id str

Unique identifier for the waypoint.
coord Coord

Coordinate of the waypoint.
bezier_control tuple[Coord, ...] | None

Optional bezier control point(s). Defaults to None.
Source code in terminaltexteffects/engine/motion.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
@dataclass(frozen=True)
class Waypoint:
    """A Waypoint comprises an identifier, a coordinate, and, optionally, bezier control point(s).

    Attributes:
        waypoint_id (str): Unique identifier for the waypoint.
        coord (Coord): Coordinate of the waypoint.
        bezier_control (tuple[Coord, ...] | None): Optional bezier control point(s). Defaults to None.

    """

    waypoint_id: str
    coord: Coord
    bezier_control: tuple[Coord, ...] | None = None