Struct pix_engine::shape::point::Point
source · pub struct Point<T = i32, const N: usize = 2>(/* private fields */);
Expand description
A Point
in N-dimensional space.
Please see the module-level documentation for examples.
Implementations§
source§impl<T, const N: usize> Point<T, N>
impl<T, const N: usize> Point<T, N>
source§impl<T: Copy, const N: usize> Point<T, N>
impl<T: Copy, const N: usize> Point<T, N>
sourcepub fn from_vector(v: Vector<T, N>) -> Self
pub fn from_vector(v: Vector<T, N>) -> Self
sourcepub fn coords(&self) -> [T; N]
pub fn coords(&self) -> [T; N]
Returns Point
coordinates as [T; N]
.
Example
let p = point!(2, 1, 3);
assert_eq!(p.coords(), [2, 1, 3]);
sourcepub fn coords_mut(&mut self) -> &mut [T; N]
pub fn coords_mut(&mut self) -> &mut [T; N]
Returns Point
coordinates as a mutable slice &mut [T; N]
.
Example
let mut p = point!(2, 1, 3);
for v in p.coords_mut() {
*v *= 2;
}
assert_eq!(p.coords(), [4, 2, 6]);
source§impl<T: Num, const N: usize> Point<T, N>
impl<T: Num, const N: usize> Point<T, N>
sourcepub fn offset<P, const M: usize>(&mut self, offsets: P)
pub fn offset<P, const M: usize>(&mut self, offsets: P)
Offsets a Point
by shifting coordinates by given amount.
Examples
let mut p = point!(2, 3, 1);
p.offset([2, -4]);
assert_eq!(p.coords(), [4, -1, 1]);
sourcepub fn offset_y(&mut self, offset: T)
pub fn offset_y(&mut self, offset: T)
Offsets the y-coordinate
of the point by a given amount.
Panics
If Vector
has less than 2 dimensions.
sourcepub fn offset_z(&mut self, offset: T)
pub fn offset_z(&mut self, offset: T)
Offsets the z-coordinate
of the point by a given amount.
Panics
If Vector
has less than 3 dimensions.
source§impl<T: Num + Float, const N: usize> Point<T, N>
impl<T: Num + Float, const N: usize> Point<T, N>
sourcepub fn dist<P>(&self, p: P) -> T
pub fn dist<P>(&self, p: P) -> T
Returns the Euclidean distance between two Point
s.
Example
let p1 = point!(1.0, 0.0, 0.0);
let p2 = point!(0.0, 1.0, 0.0);
let dist = p1.dist(p2);
let abs_difference: f64 = (dist - std::f64::consts::SQRT_2).abs();
assert!(abs_difference <= 1e-4);
source§impl<T, const N: usize> Point<T, N>
impl<T, const N: usize> Point<T, N>
sourcepub fn as_<U>(&self) -> Point<U, N>where
U: 'static + Copy,
T: AsPrimitive<U>,
pub fn as_<U>(&self) -> Point<U, N>where
U: 'static + Copy,
T: AsPrimitive<U>,
Converts Point < T, N > to Point < U, N >.
Methods from Deref<Target = [T; N]>§
1.57.0 · sourcepub fn as_slice(&self) -> &[T]
pub fn as_slice(&self) -> &[T]
Returns a slice containing the entire array. Equivalent to &s[..]
.
1.57.0 · sourcepub fn as_mut_slice(&mut self) -> &mut [T]
pub fn as_mut_slice(&mut self) -> &mut [T]
Returns a mutable slice containing the entire array. Equivalent to
&mut s[..]
.
sourcepub fn each_ref(&self) -> [&T; N]
🔬This is a nightly-only experimental API. (array_methods
)
pub fn each_ref(&self) -> [&T; N]
array_methods
)Borrows each element and returns an array of references with the same
size as self
.
Example
#![feature(array_methods)]
let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);
This method is particularly useful if combined with other methods, like
map
. This way, you can avoid moving the original
array if its elements are not Copy
.
#![feature(array_methods)]
let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);
// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);
sourcepub fn each_mut(&mut self) -> [&mut T; N]
🔬This is a nightly-only experimental API. (array_methods
)
pub fn each_mut(&mut self) -> [&mut T; N]
array_methods
)Borrows each element mutably and returns an array of mutable references
with the same size as self
.
Example
#![feature(array_methods)]
let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);
sourcepub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])
🔬This is a nightly-only experimental API. (split_array
)
pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])
split_array
)Divides one array reference into two at an index.
The first will contain all indices from [0, M)
(excluding
the index M
itself) and the second will contain all
indices from [M, N)
(excluding the index N
itself).
Panics
Panics if M > N
.
Examples
#![feature(split_array)]
let v = [1, 2, 3, 4, 5, 6];
{
let (left, right) = v.split_array_ref::<0>();
assert_eq!(left, &[]);
assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}
{
let (left, right) = v.split_array_ref::<2>();
assert_eq!(left, &[1, 2]);
assert_eq!(right, &[3, 4, 5, 6]);
}
{
let (left, right) = v.split_array_ref::<6>();
assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
assert_eq!(right, &[]);
}
sourcepub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])
🔬This is a nightly-only experimental API. (split_array
)
pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])
split_array
)Divides one mutable array reference into two at an index.
The first will contain all indices from [0, M)
(excluding
the index M
itself) and the second will contain all
indices from [M, N)
(excluding the index N
itself).
Panics
Panics if M > N
.
Examples
#![feature(split_array)]
let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);
sourcepub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])
🔬This is a nightly-only experimental API. (split_array
)
pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])
split_array
)Divides one array reference into two at an index from the end.
The first will contain all indices from [0, N - M)
(excluding
the index N - M
itself) and the second will contain all
indices from [N - M, N)
(excluding the index N
itself).
Panics
Panics if M > N
.
Examples
#![feature(split_array)]
let v = [1, 2, 3, 4, 5, 6];
{
let (left, right) = v.rsplit_array_ref::<0>();
assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
assert_eq!(right, &[]);
}
{
let (left, right) = v.rsplit_array_ref::<2>();
assert_eq!(left, &[1, 2, 3, 4]);
assert_eq!(right, &[5, 6]);
}
{
let (left, right) = v.rsplit_array_ref::<6>();
assert_eq!(left, &[]);
assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}
sourcepub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])
🔬This is a nightly-only experimental API. (split_array
)
pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])
split_array
)Divides one mutable array reference into two at an index from the end.
The first will contain all indices from [0, N - M)
(excluding
the index N - M
itself) and the second will contain all
indices from [N - M, N)
(excluding the index N
itself).
Panics
Panics if M > N
.
Examples
#![feature(split_array)]
let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);
sourcepub fn as_ascii(&self) -> Option<&[AsciiChar; N]>
🔬This is a nightly-only experimental API. (ascii_char
)
pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>
ascii_char
)Converts this array of bytes into a array of ASCII characters,
or returns None
if any of the characters is non-ASCII.
Examples
#![feature(ascii_char)]
#![feature(const_option)]
const HEX_DIGITS: [std::ascii::Char; 16] =
*b"0123456789abcdef".as_ascii().unwrap();
assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");
sourcepub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]
🔬This is a nightly-only experimental API. (ascii_char
)
pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]
ascii_char
)Converts this array of bytes into a array of ASCII characters, without checking whether they’re valid.
Safety
Every byte in the array must be in 0..=127
, or else this is UB.
Trait Implementations§
source§impl<T, U, const N: usize> AddAssign<U> for Point<T, N>
impl<T, U, const N: usize> AddAssign<U> for Point<T, N>
source§fn add_assign(&mut self, val: U)
fn add_assign(&mut self, val: U)
+=
operation. Read moresource§impl<T: Num, const N: usize> AddAssign<Vector<T, N>> for Point<T, N>
impl<T: Num, const N: usize> AddAssign<Vector<T, N>> for Point<T, N>
source§fn add_assign(&mut self, other: Vector<T, N>)
fn add_assign(&mut self, other: Vector<T, N>)
+=
operation. Read moresource§impl<T: Num, const N: usize> AddAssign for Point<T, N>
impl<T: Num, const N: usize> AddAssign for Point<T, N>
source§fn add_assign(&mut self, other: Point<T, N>)
fn add_assign(&mut self, other: Point<T, N>)
+=
operation. Read moresource§impl<'de, T, const N: usize> Deserialize<'de> for Point<T, N>where
T: Serialize + DeserializeOwned,
impl<'de, T, const N: usize> Deserialize<'de> for Point<T, N>where
T: Serialize + DeserializeOwned,
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl<T, U, const N: usize> DivAssign<U> for Point<T, N>
impl<T, U, const N: usize> DivAssign<U> for Point<T, N>
source§fn div_assign(&mut self, val: U)
fn div_assign(&mut self, val: U)
/=
operation. Read moresource§impl<T: Default, const N: usize> FromIterator<T> for Point<T, N>
impl<T: Default, const N: usize> FromIterator<T> for Point<T, N>
source§fn from_iter<I>(iter: I) -> Selfwhere
I: IntoIterator<Item = T>,
fn from_iter<I>(iter: I) -> Selfwhere
I: IntoIterator<Item = T>,
source§impl<'a, T, const N: usize> IntoIterator for &'a Point<T, N>
impl<'a, T, const N: usize> IntoIterator for &'a Point<T, N>
source§impl<'a, T, const N: usize> IntoIterator for &'a mut Point<T, N>
impl<'a, T, const N: usize> IntoIterator for &'a mut Point<T, N>
source§impl<T, const N: usize> IntoIterator for Point<T, N>
impl<T, const N: usize> IntoIterator for Point<T, N>
source§impl<T, U, const N: usize> MulAssign<U> for Point<T, N>
impl<T, U, const N: usize> MulAssign<U> for Point<T, N>
source§fn mul_assign(&mut self, val: U)
fn mul_assign(&mut self, val: U)
*=
operation. Read moresource§impl<T: Ord, const N: usize> Ord for Point<T, N>
impl<T: Ord, const N: usize> Ord for Point<T, N>
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<T: PartialEq, const N: usize> PartialEq for Point<T, N>
impl<T: PartialEq, const N: usize> PartialEq for Point<T, N>
source§impl<T: PartialOrd, const N: usize> PartialOrd for Point<T, N>
impl<T: PartialOrd, const N: usize> PartialOrd for Point<T, N>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<T, U, const N: usize> SubAssign<U> for Point<T, N>
impl<T, U, const N: usize> SubAssign<U> for Point<T, N>
source§fn sub_assign(&mut self, val: U)
fn sub_assign(&mut self, val: U)
-=
operation. Read moresource§impl<T: Num, const N: usize> SubAssign<Vector<T, N>> for Point<T, N>
impl<T: Num, const N: usize> SubAssign<Vector<T, N>> for Point<T, N>
source§fn sub_assign(&mut self, other: Vector<T, N>)
fn sub_assign(&mut self, other: Vector<T, N>)
-=
operation. Read moresource§impl<T: Num, const N: usize> SubAssign for Point<T, N>
impl<T: Num, const N: usize> SubAssign for Point<T, N>
source§fn sub_assign(&mut self, other: Point<T, N>)
fn sub_assign(&mut self, other: Point<T, N>)
-=
operation. Read more