Struct geo_types::Line

pub struct Line<T>where
    T: CoordinateType,{
    pub start: Coordinate<T>,
    pub end: Coordinate<T>,
}

A line segment made up of exactly two Points

Fields

start: Coordinate<T>

end: Coordinate<T>

Implementations

impl<T> Line<T>where
    T: CoordinateType,

pub fn new<C>(start: C, end: C) -> Line<T>where
    C: Into<Coordinate<T>>,

Creates a new line segment.

Examples

use geo_types::{Coordinate, Line};

let line = Line::new(
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 1., y: 2. },
);

assert_eq!(line.start, Coordinate { x: 0., y: 0. });
assert_eq!(line.end, Coordinate { x: 1., y: 2. });

pub fn dx(&self) -> T

Calculate the difference in ‘x’ components (Δx).

Equivalent to:

line.end.x - line.start.x

pub fn dy(&self) -> T

Calculate the difference in ‘y’ components (Δy).

Equivalent to:

line.end.y - line.start.y

pub fn slope(&self) -> T

Calculate the slope (Δy/Δx).

Equivalent to:

line.dy() / line.dx()

Note that:

Line::new(a, b).slope() ==
    Line::new(b, a).slope()

pub fn determinant(&self) -> T

Calculate the determinant of the line.

Equivalent to:

line.start.x * line.end.y -
    line.start.y * line.end.x

Note that:

Line::new(a, b).determinant() ==
    -Line::new(b, a).determinant()

pub fn start_point(&self) -> Point<T>

pub fn end_point(&self) -> Point<T>

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

Trait Implementations

impl<T: Clone> Clone for Line<T>where
    T: CoordinateType,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Line<T>where
    T: CoordinateType,

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

Formats the value using the given formatter.

impl<T: CoordinateType> From<[(T, T); 2]> for Line<T>

fn from(coord: [(T, T); 2]) -> Line<T>

Converts to this type from the input type.

impl<T: PartialEq> PartialEq<Line<T>> for Line<T>where
    T: CoordinateType,

fn eq(&self, other: &Line<T>) -> 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: Copy> Copy for Line<T>where
    T: CoordinateType,

impl<T> StructuralPartialEq for Line<T>where
    T: CoordinateType,