Struct pix_engine::shape::Line

source · 
#[repr(transparent)]
pub struct Line<T = i32, const N: usize = 2>(_);
Expand description

A Line with start and end Points.

Please see the module-level documentation for examples.

Implementations§

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]);

Constructs a Line from individual x/y coordinates.

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]);

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

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]);

Returns the starting point of the line.

Sets the starting point of the line.

Returns the ending point of the line.

Sets the ending point of the line.

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)]);

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)]);

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]]);
source

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

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

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

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

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

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

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

🔬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);
🔬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]);
🔬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, &[]);
}
🔬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]);
🔬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]);
}
🔬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]);

Trait Implementations§

Converts this type into a mutable reference of the (usually inferred) input type.
Converts this type into a shared reference of the (usually inferred) input type.
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
The resulting type after dereferencing.
Dereferences the value.
Mutably dereferences the value.
Deserialize this value from the given Serde deserializer. Read more

Draw Line to the current PixState canvas.

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

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

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

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

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

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

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

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

Creates a value from an iterator. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
The returned type after indexing.
Performs the indexing (container[index]) operation. Read more
Performs the mutable indexing (container[index]) operation. Read more

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

The result of the intersection.

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

The result of the intersection.
The type of the elements being iterated over.
Which kind of iterator are we turning this into?
Creates an iterator from a value. Read more
The type of the elements being iterated over.
Which kind of iterator are we turning this into?
Creates an iterator from a value. Read more
The type of the elements being iterated over.
Which kind of iterator are we turning this into?
Creates an iterator from a value. Read more
This method tests for self and other values to be equal, and is used by ==.
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Checks if this value is equivalent to the given key. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.