1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
//! A shape type representing quadrilaterals used for drawing.
//!
//! `Quad` is similar to [Rect] but the angles between edges are not constrained to 90 degrees and
//! can also be used to represent a `Plane` in 3D space.
//!
//! # Examples
//!
//! You can create a [Quad] using [`Quad::new`]:
//!
//! ```
//! use pix_engine::prelude::*;
//!
//! let quad = Quad::new(
//! [10, 20],
//! [30, 10],
//! [20, 25],
//! [15, 15]
//! );
//!
//! let plane = Quad::new(
//! [10, 20, 10],
//! [30, 10, 5],
//! [20, 25, 20],
//! [15, 15, 10],
//! );
//! ```
use crate::{error::Result, prelude::*};
#[cfg(feature = "serde")]
use serde::{de::DeserializeOwned, Deserialize, Serialize};
/// A `Quad` or quadrilateral, a four-sided polygon.
///
/// `Quad` is similar to [Rect] but the angles between edges are not constrained to 90 degrees.
///
/// Please see the [module-level documentation] for examples.
///
/// [module-level documentation]: crate::shape::quad
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
#[repr(transparent)]
#[must_use]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(bound = "T: Serialize + DeserializeOwned"))]
pub struct Quad<T = i32, const N: usize = 2>(pub(crate) [Point<T, N>; 4]);
/// Constructs a [Quad] with four points.
///
/// ```
/// # use pix_engine::prelude::*;
/// let p1: Point<i32> = [10, 10].into();
/// let p2 = point!(100, 10);
/// let q = quad!(p1, p2, [90, 50], [10, 80]);
/// assert_eq!(q.points(), [
/// point!(10, 10),
/// point!(100, 10),
/// point!(90, 50),
/// point!(10, 80),
/// ]);
///
/// let q = quad!(10, 10, 100, 10, 90, 50, 10, 80);
/// assert_eq!(q.points(), [
/// point!(10, 10),
/// point!(100, 10),
/// point!(90, 50),
/// point!(10, 80),
/// ]);
/// ```
#[macro_export]
macro_rules! quad {
($p1:expr, $p2:expr, $p3:expr, $p4:expr$(,)?) => {
$crate::prelude::Quad::new($p1, $p2, $p3, $p4)
};
($x1:expr, $y1:expr, $x2:expr, $y2:expr, $x3:expr, $y3:expr, $x4:expr, $y4:expr$(,)?) => {
$crate::prelude::Quad::from_xy($x1, $y1, $x2, $y2, $x3, $y3, $x4, $y4)
};
($x1:expr, $y1:expr, $z1:expr, $x2:expr, $y2:expr, $z2:expr, $x3:expr, $y3:expr, $z3:expr, $x4:expr, $y4:expr, $z4:expr$(,)?) => {
$crate::prelude::Quad::from_xy($x1, $y1, $z1, $x2, $y2, $z2, $x3, $y3, $z3, $x4, $y4, $z4)
};
}
impl<T, const N: usize> Quad<T, N> {
/// Constructs a `Quad` with the given [Point]s.
///
/// ```
/// use pix_engine::prelude::*;
/// let quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
/// assert_eq!(quad.p1().coords(), [10, 20]);
/// assert_eq!(quad.p2().coords(), [30, 10]);
/// assert_eq!(quad.p3().coords(), [20, 25]);
/// assert_eq!(quad.p4().coords(), [15, 15]);
/// ```
pub fn new<P1, P2, P3, P4>(p1: P1, p2: P2, p3: P3, p4: P4) -> Self
where
P1: Into<Point<T, N>>,
P2: Into<Point<T, N>>,
P3: Into<Point<T, N>>,
P4: Into<Point<T, N>>,
{
Self([p1.into(), p2.into(), p3.into(), p4.into()])
}
}
impl<T> Quad<T> {
/// Constructs a `Quad` from individual x/y coordinates.
#[allow(clippy::too_many_arguments)]
#[inline]
pub const fn from_xy(x1: T, y1: T, x2: T, y2: T, x3: T, y3: T, x4: T, y4: T) -> Self {
Self([
point!(x1, y1),
point!(x2, y2),
point!(x3, y3),
point!(x4, y4),
])
}
}
impl<T: Copy> Quad<T> {
/// Returns `Quad` coordinates as `[x1, y1, x2, y2, x3, y3, x4, y4]`.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// let quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
/// assert_eq!(quad.coords(), [10, 20, 30, 10, 20, 25, 15, 15]);
/// ```
#[inline]
pub fn coords(&self) -> [T; 8] {
let [p1, p2, p3, p4] = self.points();
let [x1, y1] = p1.coords();
let [x2, y2] = p2.coords();
let [x3, y3] = p3.coords();
let [x4, y4] = p4.coords();
[x1, y1, x2, y2, x3, y3, x4, y4]
}
}
impl<T> Quad<T, 3> {
/// Constructs a `Quad` from individual x/y/z coordinates.
#[allow(clippy::too_many_arguments)]
#[inline]
pub const fn from_xyz(
x1: T,
y1: T,
z1: T,
x2: T,
y2: T,
z2: T,
x3: T,
y3: T,
z3: T,
x4: T,
y4: T,
z4: T,
) -> Self {
Self([
point!(x1, y1, z1),
point!(x2, y2, z2),
point!(x3, y3, z3),
point!(x4, y4, z4),
])
}
}
impl<T: Copy> Quad<T, 3> {
/// Returns `Quad` coordinates as `[x1, y1, z1, x2, y2, z2, x3, y3, z3, x4, y4, z4]`.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// let quad = Quad::new([10, 20, 5], [30, 10, 5], [20, 25, 5], [15, 15, 5]);
/// assert_eq!(quad.coords(), [10, 20, 5, 30, 10, 5, 20, 25, 5, 15, 15, 5]);
/// ```
#[inline]
pub fn coords(&self) -> [T; 12] {
let [p1, p2, p3, p4] = self.points();
let [x1, y1, z1] = p1.coords();
let [x2, y2, z2] = p2.coords();
let [x3, y3, z3] = p3.coords();
let [x4, y4, z4] = p4.coords();
[x1, y1, z1, x2, y2, z2, x3, y3, z3, x4, y4, z4]
}
}
impl<T: Copy, const N: usize> Quad<T, N> {
/// Returns the first point of the quad.
#[inline]
pub fn p1(&self) -> Point<T, N> {
self.0[0]
}
/// Sets the first point of the quad.
#[inline]
pub fn set_p1<P>(&mut self, p: P)
where
P: Into<Point<T, N>>,
{
self.0[0] = p.into();
}
/// Returns the second point of the quad.
#[inline]
pub fn p2(&self) -> Point<T, N> {
self.0[1]
}
/// Sets the second point of the quad.
#[inline]
pub fn set_p2<P>(&mut self, p: P)
where
P: Into<Point<T, N>>,
{
self.0[1] = p.into();
}
/// Returns the third point of the quad.
#[inline]
pub fn p3(&self) -> Point<T, N> {
self.0[2]
}
/// Sets the third point of the quad.
#[inline]
pub fn set_p3<P>(&mut self, p: P)
where
P: Into<Point<T, N>>,
{
self.0[2] = p.into();
}
/// Returns the fourth point of the quad.
#[inline]
pub fn p4(&self) -> Point<T, N> {
self.0[3]
}
/// Sets the fourth point of the quad.
#[inline]
pub fn set_p4<P>(&mut self, p: P)
where
P: Into<Point<T, N>>,
{
self.0[3] = p.into();
}
/// Returns `Quad` points as `[Point<T, N>; 4]`.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// let quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
/// assert_eq!(quad.points(), [
/// point!(10, 20),
/// point!(30, 10),
/// point!(20, 25),
/// point!(15, 15)
/// ]);
/// ```
#[inline]
pub fn points(&self) -> [Point<T, N>; 4] {
self.0
}
/// Returns `Quad` points as a mutable slice `&mut [Point<T, N>; 4]`.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// let mut quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
/// for p in quad.points_mut() {
/// *p += 5;
/// }
/// assert_eq!(quad.points(), [
/// point!(15, 25),
/// point!(35, 15),
/// point!(25, 30),
/// point!(20, 20)
/// ]);
/// ```
#[inline]
pub fn points_mut(&mut self) -> &mut [Point<T, N>; 4] {
&mut self.0
}
/// Returns `Quad` points as a [Vec].
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// let quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
/// assert_eq!(quad.to_vec(), vec![
/// point!(10, 20),
/// point!(30, 10),
/// point!(20, 25),
/// point!(15, 15)
/// ]);
/// ```
pub fn to_vec(self) -> Vec<Point<T, N>> {
self.0.to_vec()
}
}
impl Draw for Quad<i32> {
/// Draw `Quad` to the current [`PixState`] canvas.
fn draw(&self, s: &mut PixState) -> Result<()> {
s.quad(*self)
}
}
impl<T: Copy> From<[T; 8]> for Quad<T> {
/// Converts `[T; 8]` into `Quad<T>`.
#[inline]
fn from([x1, y1, x2, y2, x3, y3, x4, y4]: [T; 8]) -> Self {
Self::from_xy(x1, y1, x2, y2, x3, y3, x4, y4)
}
}
impl<T: Copy> From<[T; 12]> for Quad<T, 3> {
/// Converts `[T; 12]` into `Quad<T, 3>`.
#[inline]
fn from([x1, y1, z1, x2, y2, z2, x3, y3, z3, x4, y4, z4]: [T; 12]) -> Self {
Self::from_xyz(x1, y1, z1, x2, y2, z2, x3, y3, z3, x4, y4, z4)
}
}
impl<T: Copy> From<[[T; 2]; 4]> for Quad<T> {
/// Converts `[[T; 2]; 4]` into `Quad<T>`.
#[inline]
fn from([[x1, y1], [x2, y2], [x3, y3], [x4, y4]]: [[T; 2]; 4]) -> Self {
Self::from_xy(x1, y1, x2, y2, x3, y3, x4, y4)
}
}
impl<T: Copy> From<[[T; 3]; 4]> for Quad<T, 3> {
/// Converts `[[T; 3]; 4]` into `Quad<T, 3>`.
#[inline]
fn from([[x1, y1, z1], [x2, y2, z2], [x3, y3, z3], [x4, y4, z4]]: [[T; 3]; 4]) -> Self {
Self::from_xyz(x1, y1, z1, x2, y2, z2, x3, y3, z3, x4, y4, z4)
}
}
#[cfg(test)]
mod tests {
use crate::prelude::*;
macro_rules! assert_approx_eq {
($i1:expr, $i2:expr, $e:expr) => {{
match ($i1, $i2) {
(Some((p1, t1)), Some((p2, t2))) => {
let [x1, y1]: [f64; 2] = p1.coords();
let [x2, y2]: [f64; 2] = p2.coords();
let xd = (x1 - x2).abs();
let yd = (y1 - y2).abs();
let td = (t1 - t2).abs();
assert!(xd < $e, "x: ({} - {}) < {}", x1, x2, $e);
assert!(yd < $e, "y: ({} - {}) < {}", y1, y2, $e);
assert!(td < $e, "t: ({} - {}) < {}", t1, t2, $e);
}
_ => assert_eq!($i1, $i2),
}
}};
}
#[test]
fn test_intersects_line() {
let rect = rect!(10.0, 10.0, 100.0, 100.0);
// Left
let line: Line<f64> = line_!([3.0, 7.0], [20.0, 30.0]);
assert_approx_eq!(
rect.intersects(line),
Some((point!(10.0, 16.471), 0.411)),
0.001
);
// Right
let line: Line<f64> = line_!([150.0, 50.0], [90.0, 30.0]);
assert_approx_eq!(
rect.intersects(line),
Some((point!(110.0, 36.667), 0.667)),
0.001
);
// Top
let line: Line<f64> = line_!([50.0, 5.0], [70.0, 30.0]);
assert_approx_eq!(
rect.intersects(line),
Some((point!(54.0, 10.0), 0.2)),
0.001
);
// Bottom
let line: Line<f64> = line_!([50.0, 150.0], [30.0, 30.0]);
assert_approx_eq!(
rect.intersects(line),
Some((point!(43.3333, 110.0), 0.333)),
0.001
);
}
}