Struct pix_engine::shape::Line

#[repr(transparent)]
pub struct Line<T, const N: usize>(_);

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, 2>

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

Constructs a Line from individual x/y coordinates.

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, 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 as_array(&self) -> [Point<T, N>; 2]

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.as_array(), [point!(5, 10), point!(100, 100)]);

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

Returns Line coordinates as a byte slice &[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.as_bytes(), &[point!(5, 10), point!(100, 100)]);

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

Returns Line coordinates as a mutable byte slice &mut [x1, y1, z1, x2, y2, z2].

Example

let p1 = point!(5, 10);
let p2 = point!(100, 100);
let mut l = Line::new(p1, p2);
for p in l.as_bytes_mut() {
    *p += 5;
}
assert_eq!(l.as_bytes(), &[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.

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]

Performs the conversion.

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

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

Performs the conversion.

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<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, 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, 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, 

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<T, 2_usize> for Line<T, 2>

fn intersects_line<L>(&self, other: L) -> Option<(Point<T, 2>, T)> where
    L: Into<Line<T, 2>>, 

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

fn intersects_shape<O>(&self, other: O) -> bool where
    O: Into<Self::Shape>, 

Returns whether this line intersections with another line

type Shape = Line<T, 2>

The shape type. e.g. Rect<T>.

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<Self::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<Line<T, N>> 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: &Line<T, N>) -> bool

This method tests for !=.

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>