Skip to content

Point

Source code in gdsr/_gdsr.pyi 
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
class Point:
    @property
    def x(self) -> float:
        """Return the x coordinate."""
    @property
    def y(self) -> float:
        """Return the y coordinate."""
    def __init__(self, x: float, y: float) -> None:
        """Initialize the Point with x and y coordinates.

        :param float x: x coordinate
        :param float y: y coordinate
        """
    def distance_to(self, other: PointLike) -> float:
        """Return the distance to another point."""
    def cross(self, other: PointLike) -> float:
        """Return the cross product with another point."""
    def copy(self) -> Self:
        """Return a copy of the point."""
    def rotate(self, angle: float, centre: PointLike = Point(0, 0)) -> Self:
        """Rotates the point by an angle around a centre point.

        :param float angle: Counter-clockwise rotation angle in degrees.
        :param PointLike centre: Centre point of rotation, defaults to Point(0, 0).
        """
    def scale(self, factor: float, centre: PointLike = Point(0, 0)) -> Self:
        """Scales the point by a factor around a centre point.

        :param float factor: Scaling factor.
        :param PointLike centre: Centre point of scaling, defaults to Point(0, 0).
        """
    def round(self, digits: int = 0) -> Self:
        """Return the point with rounded coordinates.

        :param int digits: Number of digits to round to, defaults to None.
        """
    def angle_to(self, other: PointLike) -> float | None:
        """Return the angle to another point in degrees.

        The angle is measured counter-clockwise from the x-axis
        and is in the range of 0 to 360 degrees.

        Return None if the points are the same.

        :param PointLike other: The other point.
        """
    def is_close(
        self, other: PointLike, rel_tol: float = 1e-7, abs_tol: float = 1e-10
    ) -> bool:
        """Return True if the point is close to another point.

        :param PointLike other: The other point.
        :param float rel_tol: Relative tolerance, defaults to 1e-9.
        :param float abs_tol: Absolute tolerance, defaults to 0.0.
        """
    def epsilon_is_close(self, other: PointLike) -> bool:
        """Return True if the point is close to another point using epsilon.

        This is used in all equality checks in gdsr.

        :param PointLike other: The other point.
        """
    def reflect(self, angle: float, centre: PointLike = Point(0, 0)) -> Self:
        """Reflect the point across a line defined by an angle around a centre point.

        :param float angle: Angle of the line in degrees.
        :param PointLike centre: Centre point of reflection, defaults to Point(0, 0).
        """
    def __getitem__(self, index: Literal[0, 1]) -> float:
        """Return the x or y coordinate of the point."""
    def __bool__(self) -> bool:
        """Return True if the point is not the origin."""
    def __repr__(self) -> str:
        """Return a string representation of the point."""
    def __str__(self) -> str:
        """Return a string representation of the point."""
    def __add__(self, other: PointLike) -> Self:
        """Return the sum of the point and another point."""
    def __radd__(self, other: PointLike) -> Self:
        """Return the sum of the point and another point."""
    def __sub__(self, other: PointLike) -> Self:
        """Return the difference of the point and another point."""
    def __rsub__(self, other: PointLike) -> Self:
        """Return the difference of the point and another point."""
    def __mul__(self, value: float) -> Self:
        """Return the product of the point and a scalar."""
    def __rmul__(self, value: float) -> Self:
        """Return the product of the point and a scalar."""
    def __truediv__(self, value: float) -> Self:
        """Return the quotient of the point and a scalar."""
    def __floordiv__(self, value: float) -> Self:
        """Return the floored quotient of the point and a scalar."""
    def __neg__(self) -> Self:
        """Return the negative of the point."""
    def __round__(self, ndigits: int | None) -> Self:
        """Return the point with rounded coordinates."""
    def __eq__(self, other: object) -> bool:
        """Return True if the point is equal to another object."""
    def __ne__(self, value: object) -> bool:
        """Return True if the point is not equal to another object."""
    def __lt__(self, other: object) -> bool:
        """Return True if the point is less than another object."""
    def __le__(self, other: object) -> bool:
        """Return True if the point is less than or equal to another object."""
    def __gt__(self, other: object) -> bool:
        """Return True if the point is greater than another object."""
    def __ge__(self, other: object) -> bool:
        """Return True if the point is greater than or equal to another object."""
    def __hash__(self) -> int:
        """Return the hash of the point."""
    def __iter__(self) -> PointIterator:
        """Return an iterator over the coordinates of the point."""

x property 

x: float

Return the x coordinate.

y property 

y: float

Return the y coordinate.

__init__ 

__init__(x: float, y: float) -> None

Initialize the Point with x and y coordinates.

Parameters:

  • x (float) –

    x coordinate

  • y (float) –

    y coordinate

Source code in gdsr/_gdsr.pyi 
45
46
47
48
49
50
def __init__(self, x: float, y: float) -> None:
    """Initialize the Point with x and y coordinates.

    :param float x: x coordinate
    :param float y: y coordinate
    """

distance_to 

distance_to(other: PointLike) -> float

Return the distance to another point.

Source code in gdsr/_gdsr.pyi 
51
52
def distance_to(self, other: PointLike) -> float:
    """Return the distance to another point."""

cross 

cross(other: PointLike) -> float

Return the cross product with another point.

Source code in gdsr/_gdsr.pyi 
53
54
def cross(self, other: PointLike) -> float:
    """Return the cross product with another point."""

copy 

copy() -> Self

Return a copy of the point.

Source code in gdsr/_gdsr.pyi 
55
56
def copy(self) -> Self:
    """Return a copy of the point."""

rotate 

rotate(angle: float, centre: PointLike = Point(0, 0)) -> Self

Rotates the point by an angle around a centre point.

Parameters:

  • angle (float) –

    Counter-clockwise rotation angle in degrees.

  • centre (PointLike, default: Point(0, 0) ) –

    Centre point of rotation, defaults to Point(0, 0).

Source code in gdsr/_gdsr.pyi 
57
58
59
60
61
62
def rotate(self, angle: float, centre: PointLike = Point(0, 0)) -> Self:
    """Rotates the point by an angle around a centre point.

    :param float angle: Counter-clockwise rotation angle in degrees.
    :param PointLike centre: Centre point of rotation, defaults to Point(0, 0).
    """

scale 

scale(factor: float, centre: PointLike = Point(0, 0)) -> Self

Scales the point by a factor around a centre point.

Parameters:

  • factor (float) –

    Scaling factor.

  • centre (PointLike, default: Point(0, 0) ) –

    Centre point of scaling, defaults to Point(0, 0).

Source code in gdsr/_gdsr.pyi 
63
64
65
66
67
68
def scale(self, factor: float, centre: PointLike = Point(0, 0)) -> Self:
    """Scales the point by a factor around a centre point.

    :param float factor: Scaling factor.
    :param PointLike centre: Centre point of scaling, defaults to Point(0, 0).
    """

round 

round(digits: int = 0) -> Self

Return the point with rounded coordinates.

Parameters:

  • digits (int, default: 0 ) –

    Number of digits to round to, defaults to None.

Source code in gdsr/_gdsr.pyi 
69
70
71
72
73
def round(self, digits: int = 0) -> Self:
    """Return the point with rounded coordinates.

    :param int digits: Number of digits to round to, defaults to None.
    """

angle_to 

angle_to(other: PointLike) -> float | None

Return the angle to another point in degrees.

The angle is measured counter-clockwise from the x-axis and is in the range of 0 to 360 degrees.

Return None if the points are the same.

Parameters:

  • other (PointLike) –

    The other point.

Source code in gdsr/_gdsr.pyi 
74
75
76
77
78
79
80
81
82
83
def angle_to(self, other: PointLike) -> float | None:
    """Return the angle to another point in degrees.

    The angle is measured counter-clockwise from the x-axis
    and is in the range of 0 to 360 degrees.

    Return None if the points are the same.

    :param PointLike other: The other point.
    """

is_close 

is_close(other: PointLike, rel_tol: float = 1e-07, abs_tol: float = 1e-10) -> bool

Return True if the point is close to another point.

Parameters:

  • other (PointLike) –

    The other point.

  • rel_tol (float, default: 1e-07 ) –

    Relative tolerance, defaults to 1e-9.

  • abs_tol (float, default: 1e-10 ) –

    Absolute tolerance, defaults to 0.0.

Source code in gdsr/_gdsr.pyi 
84
85
86
87
88
89
90
91
92
def is_close(
    self, other: PointLike, rel_tol: float = 1e-7, abs_tol: float = 1e-10
) -> bool:
    """Return True if the point is close to another point.

    :param PointLike other: The other point.
    :param float rel_tol: Relative tolerance, defaults to 1e-9.
    :param float abs_tol: Absolute tolerance, defaults to 0.0.
    """

epsilon_is_close 

epsilon_is_close(other: PointLike) -> bool

Return True if the point is close to another point using epsilon.

This is used in all equality checks in gdsr.

Parameters:

  • other (PointLike) –

    The other point.

Source code in gdsr/_gdsr.pyi 
93
94
95
96
97
98
99
def epsilon_is_close(self, other: PointLike) -> bool:
    """Return True if the point is close to another point using epsilon.

    This is used in all equality checks in gdsr.

    :param PointLike other: The other point.
    """

reflect 

reflect(angle: float, centre: PointLike = Point(0, 0)) -> Self

Reflect the point across a line defined by an angle around a centre point.

Parameters:

  • angle (float) –

    Angle of the line in degrees.

  • centre (PointLike, default: Point(0, 0) ) –

    Centre point of reflection, defaults to Point(0, 0).

Source code in gdsr/_gdsr.pyi 
100
101
102
103
104
105
def reflect(self, angle: float, centre: PointLike = Point(0, 0)) -> Self:
    """Reflect the point across a line defined by an angle around a centre point.

    :param float angle: Angle of the line in degrees.
    :param PointLike centre: Centre point of reflection, defaults to Point(0, 0).
    """

__getitem__ 

__getitem__(index: Literal[0, 1]) -> float

Return the x or y coordinate of the point.

Source code in gdsr/_gdsr.pyi 
106
107
def __getitem__(self, index: Literal[0, 1]) -> float:
    """Return the x or y coordinate of the point."""

__bool__ 

__bool__() -> bool

Return True if the point is not the origin.

Source code in gdsr/_gdsr.pyi 
108
109
def __bool__(self) -> bool:
    """Return True if the point is not the origin."""

__repr__ 

__repr__() -> str

Return a string representation of the point.

Source code in gdsr/_gdsr.pyi 
110
111
def __repr__(self) -> str:
    """Return a string representation of the point."""

__str__ 

__str__() -> str

Return a string representation of the point.

Source code in gdsr/_gdsr.pyi 
112
113
def __str__(self) -> str:
    """Return a string representation of the point."""

__add__ 

__add__(other: PointLike) -> Self

Return the sum of the point and another point.

Source code in gdsr/_gdsr.pyi 
114
115
def __add__(self, other: PointLike) -> Self:
    """Return the sum of the point and another point."""

__radd__ 

__radd__(other: PointLike) -> Self

Return the sum of the point and another point.

Source code in gdsr/_gdsr.pyi 
116
117
def __radd__(self, other: PointLike) -> Self:
    """Return the sum of the point and another point."""

__sub__ 

__sub__(other: PointLike) -> Self

Return the difference of the point and another point.

Source code in gdsr/_gdsr.pyi 
118
119
def __sub__(self, other: PointLike) -> Self:
    """Return the difference of the point and another point."""

__rsub__ 

__rsub__(other: PointLike) -> Self

Return the difference of the point and another point.

Source code in gdsr/_gdsr.pyi 
120
121
def __rsub__(self, other: PointLike) -> Self:
    """Return the difference of the point and another point."""

__mul__ 

__mul__(value: float) -> Self

Return the product of the point and a scalar.

Source code in gdsr/_gdsr.pyi 
122
123
def __mul__(self, value: float) -> Self:
    """Return the product of the point and a scalar."""

__rmul__ 

__rmul__(value: float) -> Self

Return the product of the point and a scalar.

Source code in gdsr/_gdsr.pyi 
124
125
def __rmul__(self, value: float) -> Self:
    """Return the product of the point and a scalar."""

__truediv__ 

__truediv__(value: float) -> Self

Return the quotient of the point and a scalar.

Source code in gdsr/_gdsr.pyi 
126
127
def __truediv__(self, value: float) -> Self:
    """Return the quotient of the point and a scalar."""

__floordiv__ 

__floordiv__(value: float) -> Self

Return the floored quotient of the point and a scalar.

Source code in gdsr/_gdsr.pyi 
128
129
def __floordiv__(self, value: float) -> Self:
    """Return the floored quotient of the point and a scalar."""

__neg__ 

__neg__() -> Self

Return the negative of the point.

Source code in gdsr/_gdsr.pyi 
130
131
def __neg__(self) -> Self:
    """Return the negative of the point."""

__round__ 

__round__(ndigits: int | None) -> Self

Return the point with rounded coordinates.

Source code in gdsr/_gdsr.pyi 
132
133
def __round__(self, ndigits: int | None) -> Self:
    """Return the point with rounded coordinates."""

__eq__ 

__eq__(other: object) -> bool

Return True if the point is equal to another object.

Source code in gdsr/_gdsr.pyi 
134
135
def __eq__(self, other: object) -> bool:
    """Return True if the point is equal to another object."""

__ne__ 

__ne__(value: object) -> bool

Return True if the point is not equal to another object.

Source code in gdsr/_gdsr.pyi 
136
137
def __ne__(self, value: object) -> bool:
    """Return True if the point is not equal to another object."""

__lt__ 

__lt__(other: object) -> bool

Return True if the point is less than another object.

Source code in gdsr/_gdsr.pyi 
138
139
def __lt__(self, other: object) -> bool:
    """Return True if the point is less than another object."""

__le__ 

__le__(other: object) -> bool

Return True if the point is less than or equal to another object.

Source code in gdsr/_gdsr.pyi 
140
141
def __le__(self, other: object) -> bool:
    """Return True if the point is less than or equal to another object."""

__gt__ 

__gt__(other: object) -> bool

Return True if the point is greater than another object.

Source code in gdsr/_gdsr.pyi 
142
143
def __gt__(self, other: object) -> bool:
    """Return True if the point is greater than another object."""

__ge__ 

__ge__(other: object) -> bool

Return True if the point is greater than or equal to another object.

Source code in gdsr/_gdsr.pyi 
144
145
def __ge__(self, other: object) -> bool:
    """Return True if the point is greater than or equal to another object."""

__hash__ 

__hash__() -> int

Return the hash of the point.

Source code in gdsr/_gdsr.pyi 
146
147
def __hash__(self) -> int:
    """Return the hash of the point."""

__iter__ 

__iter__() -> PointIterator

Return an iterator over the coordinates of the point.

Source code in gdsr/_gdsr.pyi 
148
149
def __iter__(self) -> PointIterator:
    """Return an iterator over the coordinates of the point."""