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
//! A shape type representing spheres used for drawing.
//!
//! # Examples
//!
//! You can create a [Sphere] using [`Sphere::new`]:
//!
//! ```
//! # use pix_engine::prelude::*;
//! let s = Sphere::new(10, 20, 100, 200);
//! ```
//!
//! ...or by using the [sphere!] macro:
//!
//! ```
//! # use pix_engine::prelude::*;
//! let s = sphere!(10, 20, 15, 200);
//!
//! // using a point
//! let s = sphere!([10, 20, 15], 200);
//! let s = sphere!(point![10, 20, 15], 200);
//! ```
use crate::prelude::*;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
/// A `Sphere` positioned at `(x, y, z)` with `radius`.
///
/// Please see the [module-level documentation] for examples.
///
/// [module-level documentation]: crate::shape::sphere
#[derive(Default, Debug, Copy, Clone, Eq, PartialEq, Hash)]
#[repr(transparent)]
#[must_use]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Sphere<T = i32>(pub(crate) [T; 4]);
/// Constructs a [Sphere] at position `(x, y, z)` with `radius`.
///
/// ```
/// # use pix_engine::prelude::*;
/// let p = point!(10, 20, 10);
/// let s = sphere!(p, 100);
/// assert_eq!(s.x(), 10);
/// assert_eq!(s.y(), 20);
/// assert_eq!(s.z(), 10);
/// assert_eq!(s.radius(), 100);
///
/// let s = sphere!(10, 20, 10, 100);
/// assert_eq!(s.x(), 10);
/// assert_eq!(s.y(), 20);
/// assert_eq!(s.z(), 10);
/// assert_eq!(s.radius(), 100);
/// ```
#[macro_export]
macro_rules! sphere {
($p:expr, $r:expr$(,)?) => {
$crate::prelude::Sphere::with_position($p, $r)
};
($x:expr, $y:expr, $z:expr, $r:expr$(,)?) => {
$crate::prelude::Sphere::new($x, $y, $z, $r)
};
}
impl<T> Sphere<T> {
/// Constructs a `Sphere` at position `(x, y, z)` with `radius`.
pub const fn new(x: T, y: T, z: T, radius: T) -> Self {
Self([x, y, z, radius])
}
}
impl<T: Copy> Sphere<T> {
/// Returns `Sphere` coordinates as `[x, y, z, radius]`.
#[inline]
pub fn coords(&self) -> [T; 4] {
self.0
}
/// Returns `Sphere` coordinates as a mutable slice `&mut [x, y, z, radius]`.
#[inline]
pub fn coords_mut(&mut self) -> &mut [T; 4] {
&mut self.0
}
}
impl<T: Num> Sphere<T> {
/// Constructs a `Sphere` at position [Point] with `radius`.
pub fn with_position<P: Into<Point<T, 3>>>(p: P, radius: T) -> Self {
let p = p.into();
Self::new(p.x(), p.y(), p.z(), radius)
}
/// Returns the `x-coordinate` of the sphere.
#[inline]
pub fn x(&self) -> T {
self.0[0]
}
/// Sets the `x-coordinate` of the sphere.
#[inline]
pub fn set_x(&mut self, x: T) {
self.0[0] = x;
}
/// Returns the `y-coordinate` of the sphere.
#[inline]
pub fn y(&self) -> T {
self.0[1]
}
/// Sets the `y-coordinate` of the sphere.
#[inline]
pub fn set_y(&mut self, y: T) {
self.0[1] = y;
}
/// Returns the `z-coordinate` of the sphere.
#[inline]
pub fn z(&self) -> T {
self.0[2]
}
/// Sets the `z-coordinate` of the sphere.
#[inline]
pub fn set_z(&mut self, z: T) {
self.0[2] = z;
}
/// Returns the `radius` of the sphere.
#[inline]
pub fn radius(&self) -> T {
self.0[3]
}
/// Sets the `radius` of the sphere.
#[inline]
pub fn set_radius(&mut self, radius: T) {
self.0[3] = radius;
}
/// Returns the center [Point].
pub fn center(&self) -> Point<T, 3> {
point!(self.x(), self.y(), self.z())
}
}
impl<T: Num> Contains<Point<T>> for Sphere<T> {
/// Returns whether this sphere contains a given [Point].
fn contains(&self, p: Point<T>) -> bool {
let px = p.x() - self.x();
let py = p.y() - self.y();
let pz = p.z() - self.z();
let r = self.radius() * self.radius();
(px * px + py * py + pz * pz) < r
}
}
impl<T: Num> Contains<Sphere<T>> for Sphere<T> {
/// Returns whether this sphere completely contains another sphere.
fn contains(&self, sphere: Sphere<T>) -> bool {
let px = sphere.x() - self.x();
let py = sphere.y() - self.y();
let pz = sphere.z() - self.z();
let r = self.radius() * self.radius();
(px * px + py * py + pz * pz) < r
}
}
impl<T: Num> Intersects<Sphere<T>> for Sphere<T> {
// FIXME: Provide a better intersection result
type Result = ();
/// Returns whether this sphere intersects another sphere.
fn intersects(&self, sphere: Sphere<T>) -> Option<Self::Result> {
let px = sphere.x() - self.x();
let py = sphere.y() - self.y();
let pz = sphere.z() - self.z();
let r = sphere.radius() + self.radius();
if (px * px + py * py + pz * pz) < r * r {
Some(())
} else {
None
}
}
}