simetri.frieze.frieze

  1"""Simetri graphics library's frieze patterns."""
  2
  3from typing import Sequence, Union
  4
  5from ..geometry.geometry import vec_along_line, point_to_line_vec, pi
  6from ..graphics.common import VecType, Line, Point
  7from ..graphics.batch import Batch
  8
  9from ..graphics.shape import Shape
 10
 11
 12def hop(design: Union[Batch, Shape], vector: VecType = (1, 0), reps: int = 3) -> Batch:
 13    """
 14    p1 symmetry group.
 15
 16    Args:
 17        design (Union[Batch, Shape]): The design to be repeated.
 18        vector (VecType, optional): The direction and distance of the hop. Defaults to (1, 0).
 19        reps (int, optional): The number of repetitions. Defaults to 3.
 20
 21    Returns:
 22        Batch: A Batch of Shapes with the p1 symmetry.
 23    """
 24    dx, dy = vector[:2]
 25    return design.translate(dx, dy, reps)
 26
 27
 28def p1(design: Union[Batch, Shape], vector: VecType = (1, 0), reps: int = 3) -> Batch:
 29    """
 30    p1 symmetry group.
 31
 32    Args:
 33        design (Union[Batch, Shape]): The design to be repeated.
 34        vector (VecType, optional): The direction and distance of the hop. Defaults to (1, 0).
 35        reps (int, optional): The number of repetitions. Defaults to 3.
 36
 37    Returns:
 38        Batch: A Batch of Shapes with the p1 symmetry.
 39    """
 40    return hop(design, vector, reps)
 41
 42
 43def jump(
 44    design: Union[Batch, Shape],
 45    mirror_line: Line,
 46    dist: float,
 47    reps: int = 3,
 48) -> Batch:
 49    """
 50    p11m symmetry group.
 51
 52    Args:
 53        design (Union[Batch, Shape]): The design to be repeated.
 54        mirror_line (Line): The line to mirror the design.
 55        dist (float): The distance between the shapes.
 56        reps (int, optional): The number of repetitions. Defaults to 3.
 57
 58    Returns:
 59        Batch: A Batch of shapes with the p11m symmetry.
 60    """
 61    dx, dy = vec_along_line(mirror_line, dist)[:2]
 62    design.mirror(mirror_line, reps=1)
 63    if reps > 0:
 64        design.translate(dx, dy, reps)
 65    return design
 66
 67
 68def jump_along(
 69    design: Batch,
 70    mirror_line: Line,
 71    path: Sequence[Point],
 72    reps: int = 3,
 73) -> Batch:
 74    """
 75    Jump along the given path.
 76
 77    Args:
 78        design (Batch): The design to be repeated.
 79        mirror_line (Line): The line to mirror the design.
 80        path (Sequence[Point]): The path along which to translate the design.
 81        reps (int, optional): The number of repetitions. Defaults to 3.
 82
 83    Returns:
 84        Batch: A Batch of shapes with the jump along symmetry.
 85    """
 86    design.mirror(mirror_line, reps=1)
 87    if reps > 0:
 88        design.translate_along(path, reps)
 89    return design
 90
 91
 92def sidle(design: Batch, mirror_line: Line, dist: float, reps: int = 3) -> Batch:
 93    """
 94    p1m1 symmetry group.
 95
 96    Args:
 97        design (Batch): The design to be repeated.
 98        mirror_line (Line): The line to mirror the design.
 99        dist (float): The distance between the shapes.
100        reps (int, optional): The number of repetitions. Defaults to 3.
101
102    Returns:
103        Batch: A Batch of Shapes with the sidle symmetry.
104    """
105    x, y = point_to_line_vec(design.midpoint, mirror_line, unit=True)[:2]
106    dx = x * dist
107    dy = y * dist
108    return design.mirror(mirror_line, reps=1).translate(dist, 0, reps)
109
110
111def sidle_along(
112    design: Batch, mirror_line: Line, path: Sequence[Point], reps: int = 3
113) -> Batch:
114    """
115    Sidle along the given path.
116
117    Args:
118        design (Batch): The design to be repeated.
119        mirror_line (Line): The line to mirror the design.
120        path (Sequence[Point]): The path along which to translate the design.
121        reps (int, optional): The number of repetitions. Defaults to 3.
122
123    Returns:
124        Batch: A Batch of shapes with the sidle along symmetry.
125    """
126    x, y = point_to_line_vec(design.midpoint, mirror_line, unit=True)[:2]
127    design.mirror(mirror_line, reps=1)
128    return design.translate_along(path, reps)
129
130
131def spinning_hop(
132    design: Batch, rotocenter: Point, dx: float, dy: float, reps: int = 3
133) -> Batch:
134    """
135    p2 symmetry group.
136
137    Args:
138        design (Batch): The design to be repeated.
139        rotocenter (Point): The center of rotation.
140        dx (float): The distance to translate in the x direction.
141        dy (float): The distance to translate in the y direction.
142        reps (int, optional): The number of repetitions. Defaults to 3.
143
144    Returns:
145        Batch: A Batch of Shapes with spinning hop symmetry.
146    """
147    design.rotate(pi, rotocenter, reps=1)
148    if reps > 0:
149        design.translate(dx, dy, reps)
150    return design
151
152
153def spinning_jump(
154    design: Batch, mirror1: Line, mirror2: Line, dist: float, reps: int = 3
155) -> Batch:
156    """
157    p2mm symmetry group.
158
159    Args:
160        design (Batch): The design to be repeated.
161        mirror1 (Line): The first mirror line.
162        mirror2 (Line): The second mirror line.
163        dist (float): The distance between the shapes along mirror1.
164        reps (int, optional): The number of repetitions. Defaults to 3.
165
166    Returns:
167        Batch: A Batch of Shapes with spinning jump symmetry.
168    """
169    dx, dy = vec_along_line(mirror1, dist)[:2]
170    design.mirror(mirror1, reps=1).mirror(mirror2, reps=1)
171    if reps > 0:
172        design.translate(dx, dy, reps)
173    return design
174
175
176def spinning_sidle(
177    design: Batch,
178    mirror_line: Line = None,
179    glide_line: Line = None,
180    glide_dist: float = None,
181    trans_dist: float = None,
182    reps: int = 3,
183) -> Batch:
184    """
185    p2mg symmetry group.
186
187    Args:
188        design (Batch): The design to be repeated.
189        mirror_line (Line, optional): The mirror line. Defaults to None.
190        glide_line (Line, optional): The glide line. Defaults to None.
191        glide_dist (float, optional): The distance of the glide. Defaults to None.
192        trans_dist (float, optional): The distance of the translation. Defaults to None.
193        reps (int, optional): The number of repetitions. Defaults to 3.
194
195    Returns:
196        Batch: A Batch of Shapes with spinning sidle symmetry.
197    """
198    dx, dy = vec_along_line(glide_line, trans_dist)[:2]
199    design.mirror(mirror_line, reps=1).glide(glide_line, glide_dist, reps=1)
200    if reps > 0:
201        design.translate(dx, dy, reps)
202    return design
203
204
205def step(
206    design: Batch,
207    glide_line: Line = None,
208    glide_dist: float = None,
209    reps: int = 3,
210) -> Batch:
211    """
212    p11g symmetry group.
213
214    Args:
215        design (Batch): The design to be repeated.
216        glide_line (Line, optional): The glide line. Defaults to None.
217        glide_dist (float, optional): The distance of the glide. Defaults to None.
218        reps (int, optional): The number of repetitions. Defaults to 3.
219
220    Returns:
221        Batch: A Batch of Shapes with step symmetry.
222    """
223    design.glide(glide_line, glide_dist, reps=1)
224    if reps > 0:
225        dx, dy = vec_along_line(glide_line, 2 * glide_dist)[:2]
226        design.translate(dx, dy, reps=reps)
227    return design
228
229
230def step_along(
231    design: Batch,
232    glide_line: Line = None,
233    glide_dist: float = None,
234    path: Sequence[Point] = None,
235    reps: int = 3,
236) -> Batch:
237    """
238    Step along a path.
239
240    Args:
241        design (Batch): The design to be repeated.
242        glide_line (Line, optional): The glide line. Defaults to None.
243        glide_dist (float, optional): The distance of the glide. Defaults to None.
244        path (Sequence[Point], optional): The path along which to translate the design. Defaults to None.
245        reps (int, optional): The number of repetitions. Defaults to 3.
246
247    Returns:
248        Batch: A Batch of shapes with the step along symmetry.
249    """
250    design.glide(glide_dist, glide_line, reps=1)
251    if reps > 0:
252        design.translate_along(path, reps)
253    return design