Struct mutils::geom::Line

pub struct Line<N: Num = f32>(pub Point<N>, pub Point<N>);

Implementations

impl<N: Num> Line<N>

pub fn start(self) -> Point<N>

pub fn end(self) -> Point<N>

pub fn left_x(self) -> N

pub fn right_x(self) -> N

pub fn bottom_y(self) -> N

pub fn top_y(self) -> N

pub fn is_horizontal(self) -> bool

pub fn is_vertical(self) -> bool

pub fn is_straight(self) -> bool

pub fn to<T: Num + From<N>>(&self) -> Line<T>

This is to allow creating a new Point, with a new type, from the type given. i.e. Point::new(1 as u8, 1 as u8)::to::<u32>()

pub fn to_rect(self) -> Rect<N>

pub fn transition_point(self, n: N) -> Point<N>

Where n is a valid from 0.0 to 1.0, this will return a point on the length of the line.

pub fn reverse(self) -> Self

This swaps the start and end points.

pub fn is_direction_negative_x(self) -> bool

pub fn is_direction_positive_x(self) -> bool

pub fn is_direction_negative_y(self) -> bool

pub fn is_direction_positive_y(self) -> bool

impl<N: Num + Signed> Line<N>

pub fn direction_sign(&self) -> Point<N>

impl<N: Num + ToSignedClamped> Line<N>

pub fn to_signed_clamped(self) -> Line<<N as ToSignedClamped>::Output>

pub fn diff(self) -> Size<<N as ToSignedClamped>::Output>

pub fn x_diff(self) -> <N as ToSignedClamped>::Output

pub fn y_diff(self) -> <N as ToSignedClamped>::Output

pub fn slope(self) -> <N as ToSignedClamped>::Output

pub fn inverse_slope(self) -> <N as ToSignedClamped>::Output

impl<N: Num + ToRounded<f32>> Line<N> where
    f32: ToRounded<N>, 

pub fn overlaps_line(self, other: Line<N>) -> bool

pub fn intersect_line(self, other: Line<N>) -> Option<Point<N>>

pub fn intersect_rect(self, rect: Rect<N>) -> Option<Line<N>>

Calculates if this overlaps another rectangle. If it does, it will return the part of the line that intersects within that rectangle.

None is returned when no intersection is found.

impl Line<f32>

pub fn rotate(self, angle: f32) -> Self

pub fn rotate_around_zero(self, angle: f32) -> Self

pub fn rotate_around_point(self, angle: f32, target: Point<f32>) -> Self

impl Line

pub fn midpoint(self) -> Point

pub fn angle(self) -> f32

Returns the atan2( y dist, x dist )

pub fn hypot(self) -> f32

pub fn hypot_sqrd(self) -> f32

Trait Implementations

impl<N: Num> Add<Line<N>> for Line<N>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Line<N>) -> Self

Performs the + operation.

impl Add<Line<f32>> for Random

type Output = Line

The resulting type after applying the + operator.

fn add(self, Line: Line) -> Line

Performs the + operation.

impl Add<Line<f32>> for Transform

type Output = Line

The resulting type after applying the + operator.

fn add(self, line: Self::Output) -> Self::Output

Performs the + operation.

impl<N: Num> Add<Point<N>> for Line<N>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Point<N>) -> Self

Performs the + operation.

impl Add<Random> for Line

type Output = Self

The resulting type after applying the + operator.

fn add(self, rnd: Random) -> Self

Performs the + operation.

impl Add<Transform> for Line

type Output = Line

The resulting type after applying the + operator.

fn add(self, transform: Transform) -> Self::Output

Performs the + operation.

impl<N: Num> AddAssign<Line<N>> for Line<N>

fn add_assign(&mut self, other: Line<N>)

Performs the += operation.

impl<N: Num> AddAssign<Point<N>> for Line<N>

fn add_assign(&mut self, other: Point<N>)

Performs the += operation.

impl<N: Clone + Num> Clone for Line<N>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + Num> Debug for Line<N>

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

Formats the value using the given formatter.

impl<N: Num> Div<Line<N>> for Line<N>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Line<N>) -> Self

Performs the / operation.

impl<N: Num> Div<N> for Line<N>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: N) -> Self

Performs the / operation.

impl<N: Num> Div<Point<N>> for Line<N>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Point<N>) -> Self

Performs the / operation.

impl<N: Num> Div<Size<N>> for Line<N>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Size<N>) -> Self

Performs the / operation.

impl<N: Num> DivAssign<Line<N>> for Line<N>

fn div_assign(&mut self, other: Line<N>)

Performs the /= operation.

impl<N: Num> DivAssign<N> for Line<N>

fn div_assign(&mut self, other: N)

Performs the /= operation.

impl<N: Num> DivAssign<Point<N>> for Line<N>

fn div_assign(&mut self, other: Point<N>)

Performs the /= operation.

impl<N: Num> DivAssign<Size<N>> for Line<N>

fn div_assign(&mut self, other: Size<N>)

Performs the /= operation.

impl<N: Num> From<(Point<N>, Point<N>)> for Line<N>

fn from((start, end): (Point<N>, Point<N>)) -> Self

Performs the conversion.

impl<N: Num> Into<(Point<N>, Point<N>)> for Line<N>

fn into(self) -> (Point<N>, Point<N>)

Performs the conversion.

impl<N: Num> Mul<Line<N>> for Line<N>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Line<N>) -> Self

Performs the * operation.

impl<N: Num> Mul<N> for Line<N>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: N) -> Self

Performs the * operation.

impl<N: Num> Mul<Point<N>> for Line<N>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Point<N>) -> Self

Performs the * operation.

impl<N: Num> Mul<Size<N>> for Line<N>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Size<N>) -> Self

Performs the * operation.

impl<N: Num> MulAssign<Line<N>> for Line<N>

fn mul_assign(&mut self, other: Line<N>)

Performs the *= operation.

impl<N: Num> MulAssign<N> for Line<N>

fn mul_assign(&mut self, other: N)

Performs the *= operation.

impl<N: Num> MulAssign<Point<N>> for Line<N>

fn mul_assign(&mut self, other: Point<N>)

Performs the *= operation.

impl<N: Num> MulAssign<Size<N>> for Line<N>

fn mul_assign(&mut self, other: Size<N>)

Performs the *= operation.

impl<N: Num + Signed> Neg for Line<N>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<N: PartialEq + Num> PartialEq<Line<N>> for Line<N>

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

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

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

This method tests for !=.

impl<N: Num> Rem<Line<N>> for Line<N>

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: Line<N>) -> Self

Performs the % operation.

impl<N: Num> Rem<Point<N>> for Line<N>

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: Point<N>) -> Self

Performs the % operation.

impl<N: INum> Shl<N> for Line<N>

type Output = Self

The resulting type after applying the << operator.

fn shl(self, other: N) -> Self

Performs the << operation.

impl<N: INum> ShlAssign<N> for Line<N>

fn shl_assign(&mut self, other: N)

Performs the <<= operation.

impl<N: INum> Shr<N> for Line<N>

type Output = Self

The resulting type after applying the >> operator.

fn shr(self, other: N) -> Self

Performs the >> operation.

impl<N: INum> ShrAssign<N> for Line<N>

fn shr_assign(&mut self, other: N)

Performs the >>= operation.

impl<N: Num> Sub<Line<N>> for Line<N>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Line<N>) -> Self

Performs the - operation.

impl Sub<Line<f32>> for Random

type Output = Line

The resulting type after applying the - operator.

fn sub(self, Line: Line) -> Line

Performs the - operation.

impl<N: Num> Sub<Point<N>> for Line<N>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Point<N>) -> Self

Performs the - operation.

impl<N: Num> SubAssign<Line<N>> for Line<N>

fn sub_assign(&mut self, other: Line<N>)

Performs the -= operation.

impl<N: Num> SubAssign<Point<N>> for Line<N>

fn sub_assign(&mut self, other: Point<N>)

Performs the -= operation.

impl<O: Num, N: Num + ToRounded<O>> ToRounded<Line<O>> for Line<N>

fn to_rounded(self) -> Line<O>

Returns the value in the new type, but clamped.

impl<N: Copy + Num> Copy for Line<N>

impl<N: Num> StructuralPartialEq for Line<N>