simetri.graphics.dots

  1"""Dot and Dots classes for creating dots.
  2"""
  3
  4__all__ = ["Dot", "Dots"]
  5
  6import numpy as np
  7
  8from .shapes import Shape
  9from .batch import Batch
 10from ..helpers.validation import validate_args
 11from ..canvas.style_map import shape_args
 12from ..settings.settings import defaults
 13from .common import Point
 14from .all_enums import Types
 15from ..colors.colors import Color
 16from ..geometry.geometry import close_points2
 17from ..canvas.style_map import batch_args
 18
 19
 20class Dot(Shape):
 21    """A dot defined by a single point.
 22    The radius is for drawing. The only style property is the color."""
 23
 24    def __init__(
 25        self, pos: Point = (0, 0), radius: float = 1, color: Color = None, **kwargs
 26    ) -> None:
 27        """Initialize a Dot object.
 28
 29        Args:
 30            pos (Point, optional): The position of the dot. Defaults to (0, 0).
 31            radius (float, optional): The radius of the dot. Defaults to 1.
 32            color (Color, optional): The color of the dot. Defaults to None.
 33            **kwargs: Additional keyword arguments.
 34        """
 35        valid_args = shape_args
 36        validate_args(kwargs, valid_args)
 37        super().__init__([(0, 0)], **kwargs)
 38        self.move_to(pos)
 39        self.subtype = Types.DOT
 40        self.radius = radius  # for drawing
 41        if color is not None:
 42            self.color = color
 43        else:
 44            self.color = defaults["dot_color"]
 45
 46    @property
 47    def pos(self) -> Point:
 48        """Return the point of the dot.
 49
 50        Returns:
 51            Point: The point of the dot.
 52        """
 53        return self.vertices[0]
 54
 55    @pos.setter
 56    def pos(self, new_pos: Point):
 57        """Set the position of the dot.
 58
 59        Args:
 60            new_pos (Point): The new position of the dot.
 61
 62        Raises:
 63            TypeError: If the new position is not a list, tuple, or ndarray.
 64        """
 65        if not isinstance(new_pos, (list, tuple, np.ndarray)):
 66            raise TypeError("Name must be a string")
 67        self.move_to(new_pos)
 68
 69    def copy(self) -> Shape:
 70        """Return a copy of the dot.
 71
 72        Returns:
 73            Shape: A copy of the dot.
 74        """
 75        color = self.color.copy()
 76        return Dot(self.pos, self.radius, color)
 77
 78    def __str__(self):
 79        """Return a string representation of the dot.
 80
 81        Returns:
 82            str: The string representation of the dot.
 83        """
 84        return f"Dot({self.pos}, {self.radius}, {self.color})"
 85
 86    def __repr__(self):
 87        """Return a string representation of the dot.
 88
 89        Returns:
 90            str: The string representation of the dot.
 91        """
 92        return f"Dot({self.pos}, {self.radius}, {self.color})"
 93
 94    def __eq__(self, other):
 95        """Check if the dot is equal to another dot.
 96
 97        Args:
 98            other (Dot): The other dot to compare to.
 99
100        Returns:
101            bool: True if the dots are equal, False otherwise.
102        """
103        return other.type == Types.DOT and close_points2(
104            self.pos, other.pos, self.dtol2
105        )
106
107
108class Dots(Batch):
109    """For creating multiple dots. Initially there is only one dot."""
110
111    def __init__(
112        self, pos: Point = (0, 0), radius: float = 1, color: Color = None, **kwargs
113    ) -> None:
114        """Initialize a Dots object.
115
116        Args:
117            pos (Point, optional): The position of the dots. Defaults to (0, 0).
118            radius (float, optional): The radius of the dots. Defaults to 1.
119            color (Color, optional): The color of the dots. Defaults to None.
120            **kwargs: Additional keyword arguments.
121        """
122        valid_args = batch_args + shape_args + ["radius", "color", "pos"]
123        dot = Dot(pos=pos, radius=radius, color=color, **kwargs)
124        super().__init__([dot], subtype=Types.DOTS, **kwargs)