Struct pix_engine::shape::Line

pub struct Line<T = i32, const N: usize = 2>(/* private fields */);

A Line with start and end Points.

Please see the module-level documentation for examples.

Implementations

impl<T, const N: usize> Line<T, N>

pub fn new<P1, P2>(start: P1, end: P2) -> Self

where P1: Into<Point<T, N>>, P2: Into<Point<T, N>>,

Constructs a Line from start to end Points.

Example

// 2D
let line = Line::new([10, 20], [30, 10]);

let p1 = point![10, 20];
let p2 = point![30, 10];
let line = Line::new(p1, p2);

// 3D
let line: Line<i32, 3> = Line::new([10, 20, 5], [30, 10, 5]);

impl<T> Line<T>

pub const fn from_xy(x1: T, y1: T, x2: T, y2: T) -> Self

Constructs a Line from individual x/y coordinates.

impl<T: Copy> Line<T>

pub fn coords(&self) -> [T; 4]

Returns Line coordinates as [x1, y1, x2, y2].

Example

let p1 = point!(5, 10);
let p2 = point!(100, 100);
let l = Line::new(p1, p2);
assert_eq!(l.coords(), [5, 10, 100, 100]);

impl<T> Line<T, 3>

pub const fn from_xyz(x1: T, y1: T, z1: T, x2: T, y2: T, z2: T) -> Self

Constructs a Line from individual x/y/z coordinates.

impl<T: Copy> Line<T, 3>

pub fn coords(&self) -> [T; 6]

Returns Line coordinates as [x1, y1, z1, x2, y2, z2].

Example

let p1 = point!(5, 10);
let p2 = point!(100, 100);
let l = Line::new(p1, p2);
assert_eq!(l.coords(), [5, 10, 100, 100]);

impl<T: Copy, const N: usize> Line<T, N>

pub fn start(&self) -> Point<T, N>

Returns the starting point of the line.

pub fn set_start<P: Into<Point<T, N>>>(&mut self, start: P)

Sets the starting point of the line.

pub fn end(&self) -> Point<T, N>

Returns the ending point of the line.

pub fn set_end<P: Into<Point<T, N>>>(&mut self, end: P)

Sets the ending point of the line.

pub fn points(&self) -> [Point<T, N>; 2]

Returns Line points as [Point<T, N>; 3].

Example

let p1 = point!(5, 10);
let p2 = point!(100, 100);
let l = Line::new(p1, p2);
assert_eq!(l.points(), [point!(5, 10), point!(100, 100)]);

pub fn points_mut(&mut self) -> &mut [Point<T, N>; 2]

Returns Line points as a mutable slice &mut [Point<T, N>; 3].

Example

let p1 = point!(5, 10);
let p2 = point!(100, 100);
let mut l = Line::new(p1, p2);
for p in l.points_mut() {
    *p += 5;
}
assert_eq!(l.points(), [point!(10, 15), point!(105, 105)]);

pub fn to_vec(self) -> Vec<Vec<T>>

Returns Line as a Vec.

Example

let p1 = point!(5, 10);
let p2 = point!(100, 100);
let l = Line::new(p1, p2);
assert_eq!(l.to_vec(), vec![[5, 10], [100, 100]]);

impl<T, const N: usize> Line<T, N>

pub fn as_<U>(&self) -> Line<U, N>

where U: 'static + Copy, T: AsPrimitive<U>,

Returns Self with the numbers cast using as operator. Converts Line < T, N > to Line < U, N >.

impl<T: Float, const N: usize> Line<T, N>

pub fn round(&self) -> Self

Returns Line < T, N > with the nearest integers to the numbers. Round half-way cases away from 0.0.

pub fn floor(&self) -> Self

Returns Line < T, N >with the largest integers less than or equal to the numbers.

pub fn ceil(&self) -> Self

Returns Line < T, N > with the smallest integers greater than or equal to the numbers.

Methods from Deref<Target = [Point<T, N>; 2]>

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

🔬This is a nightly-only experimental API. (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);

pub fn each_mut(&mut self) -> [&mut T; N]

🔬This is a nightly-only experimental API. (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]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (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, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

🔬This is a nightly-only experimental API. (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]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (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]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

🔬This is a nightly-only experimental API. (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]);

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

🔬This is a nightly-only experimental API. (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");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

🔬This is a nightly-only experimental API. (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

impl<T, const N: usize> AsMut<[Point<T, N>; 2]> for Line<T, N>

fn as_mut(&mut self) -> &mut [Point<T, N>; 2]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, const N: usize> AsRef<[Point<T, N>; 2]> for Line<T, N>

fn as_ref(&self) -> &[Point<T, N>; 2]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone, const N: usize> Clone for Line<T, N>

fn clone(&self) -> Line<T, N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, const N: usize> Debug for Line<T, N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, const N: usize> Deref for Line<T, N>

type Target = [Point<T, N>; 2]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, const N: usize> DerefMut for Line<T, N>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T, const N: usize> Deserialize<'de> for Line<T, N>

where T: Serialize + DeserializeOwned,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Draw for Line<i32>

fn draw(&self, s: &mut PixState) -> Result<()>

Draw Line to the current PixState canvas.

impl<T: Copy, const N: usize> From<&[Point<T, N>; 2]> for Line<T, N>

fn from(arr: &[Point<T, N>; 2]) -> Self

Converts &[T; M] to Line < T, N >.

impl<T: Copy, const N: usize> From<&Line<T, N>> for [Point<T, N>; 2]

fn from(t: &Line<T, N>) -> Self

Converts Line < T, N > to &[T; M].

impl<T: Copy> From<[[T; 2]; 2]> for Line<T>

fn from([[x1, y1], [x2, y2]]: [[T; 2]; 2]) -> Self

Converts [[T; 2]; 2] into Line<T>.

impl<T: Copy> From<[[T; 3]; 2]> for Line<T, 3>

fn from([[x1, y1, z1], [x2, y2, z2]]: [[T; 3]; 2]) -> Self

Converts [[T; 3]; 2] into Line<T, 3>.

impl<T, const N: usize> From<[Point<T, N>; 2]> for Line<T, N>

fn from(arr: [Point<T, N>; 2]) -> Self

Converts [T; M] to Line < T, N >.

impl<T: Copy> From<[T; 4]> for Line<T>

fn from([x1, y1, x2, y2]: [T; 4]) -> Self

Converts [T; 4] into Line<T>.

impl<T: Copy> From<[T; 6]> for Line<T, 3>

fn from([x1, y1, z1, x2, y2, z2]: [T; 6]) -> Self

Converts [T; 6] into Line<T, 3>.

impl<T, const N: usize> From<Line<T, N>> for [Point<T, N>; 2]

fn from(t: Line<T, N>) -> Self

Converts Line < T, N > to [T; M].

impl<T: Default, const N: usize> FromIterator<Point<T, N>> for Line<T, N>

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = Point<T, N>>,

Creates a value from an iterator.

impl<T: Hash, const N: usize> Hash for Line<T, N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, const N: usize> Index<usize> for Line<T, N>

type Output = Point<T, N>

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, const N: usize> IndexMut<usize> for Line<T, N>

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: Float> Intersects<Line<T>> for Line<T>

fn intersects(&self, line: Line<T>) -> Option<Self::Result>

Returns the closest intersection point with a given line and distance along the line or None if there is no intersection.

type Result = (Point<T>, T)

The result of the intersection.

impl<T: Float> Intersects<Line<T>> for Rect<T>

fn intersects(&self, line: Line<T>) -> Option<Self::Result>

Returns the closest intersection point with a given line and distance along the line or None if there is no intersection.

type Result = (Point<T>, T)

The result of the intersection.

impl<'a, T, const N: usize> IntoIterator for &'a Line<T, N>

type Item = &'a Point<T, N>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Point<T, N>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const N: usize> IntoIterator for &'a mut Line<T, N>

type Item = &'a mut Point<T, N>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Point<T, N>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, const N: usize> IntoIterator for Line<T, N>

type Item = Point<T, N>

The type of the elements being iterated over.

type IntoIter = IntoIter<<Line<T, N> as IntoIterator>::Item, 2>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq, const N: usize> PartialEq for Line<T, N>

fn eq(&self, other: &Line<T, N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, const N: usize> Serialize for Line<T, N>

where T: Serialize + DeserializeOwned,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy, const N: usize> Copy for Line<T, N>

impl<T: Eq, const N: usize> Eq for Line<T, N>

impl<T, const N: usize> StructuralEq for Line<T, N>

impl<T, const N: usize> StructuralPartialEq for Line<T, N>