Struct Line 

#[repr(C)]
pub struct Line<T> {
    pub start: Vec2<T>,
    pub end: Vec2<T>,
}

A line segment connecting two points.

Fields

start: Vec2<T>

The start point.

end: Vec2<T>

The end point.

Implementations

impl<T: Pod + NoUninit> Line<T>

pub fn as_bytes(&self) -> &[u8]

This type re-interpreted as a slice of bytes.

pub fn as_bytes_mut(&mut self) -> &mut [u8]

This type re-interpreted as a mutable slice of bytes.

impl<T: Copy + AbsDiffEq<Epsilon = T>> Line<T>

pub fn abs_diff_eq(&self, other: &Self) -> bool

Returns true if the two values are approximately equal according to the absolute difference between their components.

impl<T: Copy + RelativeEq<Epsilon = T>> Line<T>

pub fn relative_eq(&self, other: &Self) -> bool

Returns true if the two values are approximately equal according to the absolute difference between their components, as well as relative-based comparisons.

impl<T: Copy + UlpsEq<Epsilon = T>> Line<T>

pub fn ulps_eq(&self, other: &Self) -> bool

Returns true if the two values are approximately equal according to the absolute difference between their components, as well as ULPs (Units in Last Place).

impl<T> Line<T>

pub const fn new(start: Vec2<T>, end: Vec2<T>) -> Self

Create a new line.

pub fn points(self) -> [Vec2<T>; 2]

The points of the line.

pub fn rev(self) -> Self

Reverse the line (swap the start and end points).

impl<T: Num> Line<T>

pub const ZERO: Self

A line with both start and end at (0, 0).

pub fn vector(&self) -> Vec2<T>

The vector from the line’s start to end point.

pub fn sqr_len(&self) -> T

Squared length of the line.

pub fn bounds(&self) -> Rect<T>

Rectangular bounds of the line.

pub fn center_x(&self) -> T

X-position of the line’s center.

pub fn center_y(&self) -> T

Y-position of the line’s center.

pub fn center(&self) -> Vec2<T>

The line’s center.

impl<T: Float> Line<T>

pub fn len(&self) -> T

Length of the line.

pub fn norm(&self) -> Vec2<T>

Axis of the line from a to b.

pub fn left_norm(&self) -> Vec2<T>

Left-perpendicular axis of the line.

pub fn right_norm(&self) -> Vec2<T>

Right-perpendicular axis of the line.

pub fn project_onto_axis(&self, axis: Vec2<T>) -> Projection<T>

Project this line onto the provided axis.

pub fn project_point(&self, p: Vec2<T>) -> Vec2<T>

Project the point onto this line.

pub fn rayhit(&self, ray: &Ray<T>) -> bool

Check if the ray hits this line.

pub fn raycast(&self, ray: &Ray<T>) -> Option<T>

Cast a ray against this line. If it intersects the line, return the distance along the ray that the intersection occurred.

pub fn transform_by(&self, f: impl FnMut(Vec2<T>) -> Vec2<T>) -> Self

Trait Implementations

impl<T> AbsDiffEq for Line<T>

where T: AbsDiffEq, T::Epsilon: Copy,

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Copy + Add<T, Output = T>> Add<&Vec2<T>> for &Line<T>

type Output = Line<T>

The resulting type after applying the + operator.

fn add(self, rhs: &Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + Add<T, Output = T>> Add<&Vec2<T>> for Line<T>

type Output = Line<T>

The resulting type after applying the + operator.

fn add(self, rhs: &Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + Add<T, Output = T>> Add<Vec2<T>> for &Line<T>

type Output = Line<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + Add<T, Output = T>> Add<Vec2<T>> for Line<T>

type Output = Line<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + AddAssign<T>> AddAssign<&Vec2<T>> for Line<T>

fn add_assign(&mut self, rhs: &Vec2<T>)

Performs the += operation.

impl<T: Copy + AddAssign<T>> AddAssign<Vec2<T>> for Line<T>

fn add_assign(&mut self, rhs: Vec2<T>)

Performs the += operation.

impl<T: Clone> Clone for Line<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Line<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Line<T>

fn default() -> Line<T>

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Line<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<[Vec2<T>; 2]> for Line<T>

fn from([start, end]: [Vec2<T>; 2]) -> Self

Converts to this type from the input type.

impl<T> From<(T, T, T, T)> for Line<T>

fn from((x1, y1, x2, y2): (T, T, T, T)) -> Self

Converts to this type from the input type.

impl<T> From<(Vec2<T>, Vec2<T>)> for Line<T>

fn from((start, end): (Vec2<T>, Vec2<T>)) -> Self

Converts to this type from the input type.

impl<T> From<Line<T>> for [Vec2<T>; 2]

fn from(_: Line<T>) -> Self

Converts to this type from the input type.

impl<T> From<Line<T>> for (Vec2<T>, Vec2<T>)

fn from(_: Line<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Line<T>

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: Float> Interp for Line<T>

where Vec2<T>: Interp<Factor = T>,

type Factor = T

The factor by which this type is interpolated.

fn lerp(self, target: Self, t: Self::Factor) -> Self

Linear interpolation.

fn quad_bezier(self, control: Self, target: Self, t: Self::Factor) -> Self

Quadratic bezier interpolation.

fn cubic_bezier( self, control1: Self, control2: Self, target: Self, t: Self::Factor, ) -> Self

Cubic bezier interpolation.

fn hermite( self, tangent1: Self::Factor, target: Self, tangent2: Self::Factor, t: Self::Factor, ) -> Self

Cubic Hermite interpolation.

fn catmull_rom( self, control1: Self, control2: Self, target: Self, t: Self::Factor, ) -> Self

Catmull-Rom interpolation.

fn smooth_step(self, target: Self, t: Self::Factor) -> Self

Smooth-step interpolation.

impl<T: Numeric<AsU8 = u8, AsU16 = u16, AsU32 = u32, AsU64 = u64, AsU128 = u128, AsUSize = usize, AsI8 = i8, AsI16 = i16, AsI32 = i32, AsI64 = i64, AsI128 = i128, AsISize = isize, AsF32 = f32, AsF64 = f64>> Numeric for Line<T>

type AsU8 = Line<u8>

type AsU16 = Line<u16>

type AsU32 = Line<u32>

type AsU64 = Line<u64>

type AsU128 = Line<u128>

type AsUSize = Line<usize>

type AsI8 = Line<i8>

type AsI16 = Line<i16>

type AsI32 = Line<i32>

type AsI64 = Line<i64>

type AsI128 = Line<i128>

type AsISize = Line<isize>

type AsF32 = Line<f32>

type AsF64 = Line<f64>

fn to_u8(self) -> Line<u8>

fn to_u16(self) -> Line<u16>

fn to_u32(self) -> Line<u32>

fn to_u64(self) -> Line<u64>

fn to_u128(self) -> Line<u128>

fn to_usize(self) -> Line<usize>

fn to_i8(self) -> Line<i8>

fn to_i16(self) -> Line<i16>

fn to_i32(self) -> Line<i32>

fn to_i64(self) -> Line<i64>

fn to_i128(self) -> Line<i128>

fn to_isize(self) -> Line<isize>

fn to_f32(self) -> Line<f32>

fn to_f64(self) -> Line<f64>

impl<T: Ord> Ord for Line<T>

fn cmp(&self, other: &Line<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Line<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd> PartialOrd for Line<T>

fn partial_cmp(&self, other: &Line<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> RelativeEq for Line<T>

where T: RelativeEq, T::Epsilon: Copy,

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T: Serialize> Serialize for Line<T>

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 + Sub<T, Output = T>> Sub<&Vec2<T>> for &Line<T>

type Output = Line<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + Sub<T, Output = T>> Sub<&Vec2<T>> for Line<T>

type Output = Line<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + Sub<T, Output = T>> Sub<Vec2<T>> for &Line<T>

type Output = Line<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + Sub<T, Output = T>> Sub<Vec2<T>> for Line<T>

type Output = Line<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + SubAssign<T>> SubAssign<&Vec2<T>> for Line<T>

fn sub_assign(&mut self, rhs: &Vec2<T>)

Performs the -= operation.

impl<T: Copy + SubAssign<T>> SubAssign<Vec2<T>> for Line<T>

fn sub_assign(&mut self, rhs: Vec2<T>)

Performs the -= operation.

impl<T> UlpsEq for Line<T>

where T: UlpsEq, T::Epsilon: Copy,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T: Zeroable> Zeroable for Line<T>

fn zeroed() -> Self

Calls zeroed.

impl<T: Copy> Copy for Line<T>

impl<T: Eq> Eq for Line<T>

impl<T: Pod> Pod for Line<T>

impl<T> StructuralPartialEq for Line<T>