1"""
68 | 2utils
69 | 3
70 | 4contains general purpose functions for use within or outside module
71 | 5"""
72 | 6from typing import Tuple, Union
73 | 7from random import randint
74 | 8
75 | 9
76 | 10def color_clamp(color: Tuple[int, int, int]) -> Tuple[int, int, int]:
77 | 11 """
78 | 12 Ensures a three part iterable is a properly formatted color
79 | 13 (i.e. all numbers between 0 and 255)
80 | 14 """
81 | 15 clamped_color = [max(min(int(i), 255), 0) for i in color]
82 | 16 return tuple(clamped_color)
83 | 17
84 | 18
85 | 19def distance_between_points(xy1: Tuple[int, int], xy2: Tuple[int, int]) -> float:
86 | 20 """
87 | 21 Returns the euclidean distance between two points.
88 | 22 https://en.wikipedia.org/wiki/Euclidean_distance
89 | 23 """
90 | 24 return (((xy1[0] - xy2[0]) ** 2) + ((xy1[1] - xy2[1]) ** 2)) ** 0.5
91 | 25
92 | 26
93 | 27def randomly_shift_point(
94 | 28 xy_coords: Tuple[int, int],
95 | 29 movement_range: Union[Tuple[int, int], Tuple[Tuple[int, int], Tuple[int, int]]],
96 | 30 ) -> Tuple[int, int]:
97 | 31 """
98 | 32 Randomly shifts a point within defined range
99 | 33
100 | 34 movement range of form:
101 | 35 (min amount, max amount)
102 | 36
103 | 37 you can give two movement ranges for:
104 | 38 [(min amount on x axis, max amount on x axis),
105 | 39 (min amount on y axis, max amount on y axis)]
106 | 40 or just one, if you want equal ranges
107 | 41 """
108 | 42 if type(movement_range[0]) not in [list, tuple]:
109 | 43 movement_range = [movement_range, movement_range]
110 | 44
111 | 45 shifted_xy = [
112 | 46 xy_coords[i] +
113 | 47 randint(movement_range[i][0], movement_range[i][1])
114 | 48 for i in range(2)
115 | 49 ]
116 | 50 return tuple(shifted_xy)
117 |