Renamed Grid.cell_size -> scale
[kaka/rust-sdl-test.git] / src / common / geometry.rs
CommitLineData
2836f506 1use std::ops::{Add, AddAssign, Sub, SubAssign, Mul, MulAssign, Div, DivAssign, Neg};
296187ca 2
60058b91
TW
3////////// POINT ///////////////////////////////////////////////////////////////
4
787dbfb4 5#[macro_export]
296187ca 6macro_rules! point {
6ba7aef1 7 ( $x:expr, $y:expr ) => {
e570927a 8 Point { x: $x, y: $y }
6ba7aef1 9 };
296187ca
TW
10}
11
b0566120 12#[derive(Debug, Default, Copy, Clone, PartialEq)]
e570927a 13pub struct Point<T> {
296187ca
TW
14 pub x: T,
15 pub y: T,
16}
17
e570927a 18impl Point<f64> {
eca25591 19 pub fn length(&self) -> f64 {
296187ca
TW
20 ((self.x * self.x) + (self.y * self.y)).sqrt()
21 }
bf7b5671 22
93fc5734 23 pub fn normalized(&self) -> Self {
eca25591
TW
24 let l = self.length();
25 Self {
26 x: self.x / l,
27 y: self.y / l,
28 }
29 }
30
ee533e13 31 pub fn to_radians(&self) -> Radians {
eca25591
TW
32 Radians(self.y.atan2(self.x))
33 }
34
ee533e13
TW
35 pub fn to_degrees(&self) -> Degrees {
36 self.to_radians().to_degrees()
eca25591
TW
37 }
38
e570927a
TW
39 pub fn to_i32(self) -> Point<i32> {
40 Point {
bf7b5671
TW
41 x: self.x as i32,
42 y: self.y as i32,
43 }
44 }
296187ca
TW
45}
46
6cd86b94
TW
47macro_rules! point_op {
48 ($op:tt, $trait:ident($fn:ident), $trait_assign:ident($fn_assign:ident), $rhs:ident = $Rhs:ty => $x:expr, $y:expr) => {
e570927a 49 impl<T: $trait<Output = T>> $trait<$Rhs> for Point<T> {
6cd86b94
TW
50 type Output = Self;
51
52 fn $fn(self, $rhs: $Rhs) -> Self {
53 Self {
54 x: self.x $op $x,
55 y: self.y $op $y,
56 }
57 }
2836f506 58 }
2836f506 59
e570927a 60 impl<T: $trait<Output = T> + Copy> $trait_assign<$Rhs> for Point<T> {
6cd86b94
TW
61 fn $fn_assign(&mut self, $rhs: $Rhs) {
62 *self = Self {
63 x: self.x $op $x,
64 y: self.y $op $y,
65 }
66 }
2836f506
TW
67 }
68 }
69}
70
e570927a
TW
71point_op!(+, Add(add), AddAssign(add_assign), rhs = Point<T> => rhs.x, rhs.y);
72point_op!(-, Sub(sub), SubAssign(sub_assign), rhs = Point<T> => rhs.x, rhs.y);
73point_op!(*, Mul(mul), MulAssign(mul_assign), rhs = Point<T> => rhs.x, rhs.y);
74point_op!(/, Div(div), DivAssign(div_assign), rhs = Point<T> => rhs.x, rhs.y);
6cd86b94
TW
75point_op!(+, Add(add), AddAssign(add_assign), rhs = (T, T) => rhs.0, rhs.1);
76point_op!(-, Sub(sub), SubAssign(sub_assign), rhs = (T, T) => rhs.0, rhs.1);
77point_op!(*, Mul(mul), MulAssign(mul_assign), rhs = (T, T) => rhs.0, rhs.1);
78point_op!(/, Div(div), DivAssign(div_assign), rhs = (T, T) => rhs.0, rhs.1);
d59c7f04
TW
79point_op!(*, Mul(mul), MulAssign(mul_assign), rhs = Dimension<T> => rhs.width, rhs.height);
80point_op!(/, Div(div), DivAssign(div_assign), rhs = Dimension<T> => rhs.width, rhs.height);
2836f506
TW
81
82////////// multiply point with scalar //////////////////////////////////////////
e570927a 83impl<T: Mul<Output = T> + Copy> Mul<T> for Point<T> {
2836f506
TW
84 type Output = Self;
85
86 fn mul(self, rhs: T) -> Self {
87 Self {
88 x: self.x * rhs,
89 y: self.y * rhs,
90 }
91 }
92}
93
e570927a 94impl<T: Mul<Output = T> + Copy> MulAssign<T> for Point<T> {
2836f506
TW
95 fn mul_assign(&mut self, rhs: T) {
96 *self = Self {
97 x: self.x * rhs,
98 y: self.y * rhs,
99 }
100 }
101}
102
2836f506 103////////// divide point with scalar ////////////////////////////////////////////
e570927a 104impl<T: Div<Output = T> + Copy> Div<T> for Point<T> {
2836f506
TW
105 type Output = Self;
106
107 fn div(self, rhs: T) -> Self {
108 Self {
109 x: self.x / rhs,
110 y: self.y / rhs,
111 }
112 }
113}
114
e570927a 115impl<T: Div<Output = T> + Copy> DivAssign<T> for Point<T> {
2836f506
TW
116 fn div_assign(&mut self, rhs: T) {
117 *self = Self {
118 x: self.x / rhs,
119 y: self.y / rhs,
120 }
121 }
122}
123
e570927a 124impl<T: Neg<Output = T>> Neg for Point<T> {
2836f506
TW
125 type Output = Self;
126
127 fn neg(self) -> Self {
128 Self {
129 x: -self.x,
130 y: -self.y,
131 }
296187ca
TW
132 }
133}
134
e570927a 135impl<T> From<(T, T)> for Point<T> {
b0566120 136 fn from(item: (T, T)) -> Self {
e570927a 137 Point {
b0566120
TW
138 x: item.0,
139 y: item.1,
140 }
141 }
142}
143
e570927a
TW
144impl<T> From<Point<T>> for (T, T) {
145 fn from(item: Point<T>) -> Self {
bf7b5671
TW
146 (item.x, item.y)
147 }
148}
149
e570927a 150impl From<Degrees> for Point<f64> {
e58a1769 151 fn from(item: Degrees) -> Self {
ee533e13 152 let r = item.0.to_radians();
e570927a 153 Point {
ee533e13
TW
154 x: r.cos(),
155 y: r.sin(),
e58a1769
TW
156 }
157 }
158}
159
e570927a 160impl From<Radians> for Point<f64> {
e58a1769 161 fn from(item: Radians) -> Self {
e570927a 162 Point {
e58a1769
TW
163 x: item.0.cos(),
164 y: item.0.sin(),
165 }
166 }
167}
168
bf7b5671
TW
169#[derive(Debug, Default, PartialEq, Clone, Copy)]
170pub struct Degrees(pub f64);
171#[derive(Debug, Default, PartialEq, Clone, Copy)]
172pub struct Radians(pub f64);
e58a1769
TW
173
174impl Degrees {
bf7b5671 175 #[allow(dead_code)]
e58a1769 176 fn to_radians(&self) -> Radians {
ee533e13 177 Radians(self.0.to_radians())
e58a1769
TW
178 }
179}
180
181impl Radians {
bf7b5671 182 #[allow(dead_code)]
e58a1769 183 fn to_degrees(&self) -> Degrees {
ee533e13 184 Degrees(self.0.to_degrees())
e58a1769
TW
185 }
186}
187
60058b91
TW
188////////// INTERSECTION ////////////////////////////////////////////////////////
189
190#[derive(Debug)]
191pub enum Intersection {
192 Point(Point<f64>),
193 //Line(Point<f64>, Point<f64>), // TODO: overlapping collinear
194 None,
195}
196
197impl Intersection {
198 pub fn lines(p1: Point<f64>, p2: Point<f64>, p3: Point<f64>, p4: Point<f64>) -> Intersection {
199 let s1 = p2 - p1;
200 let s2 = p4 - p3;
201
202 let denomimator = -s2.x * s1.y + s1.x * s2.y;
203 if denomimator != 0.0 {
204 let s = (-s1.y * (p1.x - p3.x) + s1.x * (p1.y - p3.y)) / denomimator;
205 let t = ( s2.x * (p1.y - p3.y) - s2.y * (p1.x - p3.x)) / denomimator;
206
207 if s >= 0.0 && s <= 1.0 && t >= 0.0 && t <= 1.0 {
208 return Intersection::Point(p1 + (s1 * t))
209 }
210 }
211
212 Intersection::None
213 }
214}
215
216////////// DIMENSION ///////////////////////////////////////////////////////////
217
0b5024d1 218#[macro_export]
1f42d724
TW
219macro_rules! dimen {
220 ( $w:expr, $h:expr ) => {
221 Dimension { width: $w, height: $h }
0b5024d1
TW
222 };
223}
224
8012f86b 225#[derive(Debug, Default, Copy, Clone, PartialEq)]
1f42d724 226pub struct Dimension<T> {
6edafdc0
TW
227 pub width: T,
228 pub height: T,
229}
230
1f42d724 231impl<T: Mul<Output = T> + Copy> Dimension<T> {
6edafdc0
TW
232 #[allow(dead_code)]
233 pub fn area(&self) -> T {
6ba7aef1 234 self.width * self.height
6edafdc0
TW
235 }
236}
237
1f42d724 238impl<T> From<(T, T)> for Dimension<T> {
6edafdc0 239 fn from(item: (T, T)) -> Self {
1f42d724 240 Dimension {
6ba7aef1
TW
241 width: item.0,
242 height: item.1,
243 }
6edafdc0
TW
244 }
245}
246
8012f86b
TW
247impl<T> From<Dimension<T>> for (T, T) {
248 fn from(item: Dimension<T>) -> Self {
249 (item.width, item.height)
250 }
251}
252
253////////////////////////////////////////////////////////////////////////////////
254
255#[allow(dead_code)]
256pub fn supercover_line_int(p1: Point<isize>, p2: Point<isize>) -> Vec<Point<isize>> {
257 let d = p2 - p1;
258 let n = point!(d.x.abs(), d.y.abs());
259 let step = point!(
260 if d.x > 0 { 1 } else { -1 },
261 if d.y > 0 { 1 } else { -1 }
262 );
263
264 let mut p = p1.clone();
265 let mut points = vec!(point!(p.x as isize, p.y as isize));
266 let mut i = point!(0, 0);
267 while i.x < n.x || i.y < n.y {
268 let decision = (1 + 2 * i.x) * n.y - (1 + 2 * i.y) * n.x;
269 if decision == 0 { // next step is diagonal
270 p.x += step.x;
271 p.y += step.y;
272 i.x += 1;
273 i.y += 1;
274 } else if decision < 0 { // next step is horizontal
275 p.x += step.x;
276 i.x += 1;
277 } else { // next step is vertical
278 p.y += step.y;
279 i.y += 1;
280 }
281 points.push(point!(p.x as isize, p.y as isize));
282 }
283
284 points
285}
286
287/// Calculates all points a line crosses, unlike Bresenham's line algorithm.
288/// There might be room for a lot of improvement here.
289pub fn supercover_line(mut p1: Point<f64>, mut p2: Point<f64>) -> Vec<Point<isize>> {
290 let mut delta = p2 - p1;
291 if (delta.x.abs() > delta.y.abs() && delta.x.is_sign_negative()) || (delta.x.abs() <= delta.y.abs() && delta.y.is_sign_negative()) {
292 std::mem::swap(&mut p1, &mut p2);
293 delta = -delta;
294 }
295
296 let mut last = point!(p1.x as isize, p1.y as isize);
297 let mut coords: Vec<Point<isize>> = vec!();
298 coords.push(last);
299
300 if delta.x.abs() > delta.y.abs() {
301 let k = delta.y / delta.x;
302 let m = p1.y as f64 - p1.x as f64 * k;
303 for x in (p1.x as isize + 1)..=(p2.x as isize) {
304 let y = (k * x as f64 + m).floor();
305 let next = point!(x as isize - 1, y as isize);
306 if next != last {
307 coords.push(next);
308 }
309 let next = point!(x as isize, y as isize);
310 coords.push(next);
311 last = next;
312 }
313 } else {
314 let k = delta.x / delta.y;
315 let m = p1.x as f64 - p1.y as f64 * k;
316 for y in (p1.y as isize + 1)..=(p2.y as isize) {
317 let x = (k * y as f64 + m).floor();
318 let next = point!(x as isize, y as isize - 1);
319 if next != last {
320 coords.push(next);
321 }
322 let next = point!(x as isize, y as isize);
323 coords.push(next);
324 last = next;
325 }
326 }
327
328 let next = point!(p2.x as isize, p2.y as isize);
329 if next != last {
330 coords.push(next);
331 }
332
333 coords
334}
335
60058b91 336////////// TESTS ///////////////////////////////////////////////////////////////
249d43ea 337
296187ca
TW
338#[cfg(test)]
339mod tests {
340 use super::*;
341
342 #[test]
343 fn immutable_copy_of_point() {
344 let a = point!(0, 0);
345 let mut b = a; // Copy
346 assert_eq!(a, b); // PartialEq
347 b.x = 1;
348 assert_ne!(a, b); // PartialEq
349 }
350
351 #[test]
352 fn add_points() {
353 let mut a = point!(1, 0);
354 assert_eq!(a + point!(2, 2), point!(3, 2)); // Add
355 a += point!(2, 2); // AddAssign
356 assert_eq!(a, point!(3, 2));
2836f506
TW
357 assert_eq!(point!(1, 0) + (2, 3), point!(3, 3));
358 }
359
360 #[test]
361 fn sub_points() {
362 let mut a = point!(1, 0);
363 assert_eq!(a - point!(2, 2), point!(-1, -2));
364 a -= point!(2, 2);
365 assert_eq!(a, point!(-1, -2));
6cd86b94 366 assert_eq!(point!(1, 0) - (2, 3), point!(-1, -3));
2836f506
TW
367 }
368
369 #[test]
370 fn mul_points() {
371 let mut a = point!(1, 2);
372 assert_eq!(a * 2, point!(2, 4));
373 assert_eq!(a * point!(2, 3), point!(2, 6));
374 a *= 2;
375 assert_eq!(a, point!(2, 4));
376 a *= point!(3, 1);
377 assert_eq!(a, point!(6, 4));
6cd86b94 378 assert_eq!(point!(1, 0) * (2, 3), point!(2, 0));
2836f506
TW
379 }
380
381 #[test]
382 fn div_points() {
383 let mut a = point!(4, 8);
384 assert_eq!(a / 2, point!(2, 4));
385 assert_eq!(a / point!(2, 4), point!(2, 2));
386 a /= 2;
387 assert_eq!(a, point!(2, 4));
388 a /= point!(2, 4);
389 assert_eq!(a, point!(1, 1));
6cd86b94 390 assert_eq!(point!(6, 3) / (2, 3), point!(3, 1));
2836f506
TW
391 }
392
393 #[test]
394 fn neg_point() {
395 assert_eq!(point!(1, 1), -point!(-1, -1));
296187ca 396 }
6edafdc0
TW
397
398 #[test]
e58a1769
TW
399 fn angles() {
400 assert_eq!(Radians(0.0).to_degrees(), Degrees(0.0));
401 assert_eq!(Radians(std::f64::consts::PI).to_degrees(), Degrees(180.0));
402 assert_eq!(Degrees(180.0).to_radians(), Radians(std::f64::consts::PI));
e570927a
TW
403 assert!((Point::from(Degrees(90.0)) - point!(0.0, 1.0)).length() < 0.001);
404 assert!((Point::from(Radians(std::f64::consts::FRAC_PI_2)) - point!(0.0, 1.0)).length() < 0.001);
e58a1769
TW
405 }
406
407 #[test]
1f42d724
TW
408 fn area_for_dimension_of_multipliable_type() {
409 let r: Dimension<_> = (30, 20).into(); // the Into trait uses the From trait
6ba7aef1 410 assert_eq!(r.area(), 30 * 20);
1f42d724 411 // let a = Dimension::from(("a".to_string(), "b".to_string())).area(); // this doesn't work, because area() is not implemented for String
6edafdc0 412 }
60058b91
TW
413
414 #[test]
415 fn intersection_of_lines() {
416 let p1 = point!(0.0, 0.0);
417 let p2 = point!(2.0, 2.0);
418 let p3 = point!(0.0, 2.0);
419 let p4 = point!(2.0, 0.0);
420 let r = Intersection::lines(p1, p2, p3, p4);
421 if let Intersection::Point(p) = r {
422 assert_eq!(p, point!(1.0, 1.0));
423 } else {
424 panic!();
425 }
426 }
8012f86b
TW
427
428 #[test]
429 fn some_coordinates_on_line() {
430 // horizontally up
431 let coords = supercover_line(point!(0.0, 0.0), point!(3.3, 2.2));
432 assert_eq!(coords.as_slice(), &[point!(0, 0), point!(1, 0), point!(1, 1), point!(2, 1), point!(2, 2), point!(3, 2)]);
433
434 // horizontally down
435 let coords = supercover_line(point!(0.0, 5.0), point!(3.3, 2.2));
436 assert_eq!(coords.as_slice(), &[point!(0, 5), point!(0, 4), point!(1, 4), point!(1, 3), point!(2, 3), point!(2, 2), point!(3, 2)]);
437
438 // vertically right
439 let coords = supercover_line(point!(0.0, 0.0), point!(2.2, 3.3));
440 assert_eq!(coords.as_slice(), &[point!(0, 0), point!(0, 1), point!(1, 1), point!(1, 2), point!(2, 2), point!(2, 3)]);
441
442 // vertically left
443 let coords = supercover_line(point!(5.0, 0.0), point!(3.0, 3.0));
444 assert_eq!(coords.as_slice(), &[point!(5, 0), point!(4, 0), point!(4, 1), point!(3, 1), point!(3, 2), point!(3, 3)]);
445
446 // negative
447 let coords = supercover_line(point!(0.0, 0.0), point!(-3.0, -2.0));
448 assert_eq!(coords.as_slice(), &[point!(-3, -2), point!(-2, -2), point!(-2, -1), point!(-1, -1), point!(-1, 0), point!(0, 0)]);
449
450 //
451 let coords = supercover_line(point!(0.0, 0.0), point!(2.3, 1.1));
452 assert_eq!(coords.as_slice(), &[point!(0, 0), point!(1, 0), point!(2, 0), point!(2, 1)]);
453 }
296187ca 454}