Struct rstar::primitives::Line

pub struct Line<P> where
    P: Point,  {
    pub from: P,
    pub to: P,
}

A line defined by a start and and end point.

This struct can be inserted directly into an r-tree.

Type parameters

P: The line's Point type.

Example

use rstar::primitives::Line;
use rstar::{RTree, RTreeObject};

let line_1 = Line::new([0.0, 0.0], [1.0, 1.0]);
let line_2 = Line::new([0.0, 0.0], [-1.0, 1.0]);
let tree = RTree::bulk_load(vec![line_1, line_2]);

assert!(tree.contains(&line_1));

Fields

from: P

The line's start point

to: P

The line's end point.

Implementations

impl<P> Line<P> where
    P: Point, 

pub fn new(from: P, to: P) -> Self

Creates a new line between two points.

impl<P> Line<P> where
    P: Point, 

pub fn length_2(&self) -> P::Scalar

Returns the squared length of this line.

Example

use rstar::primitives::Line;

let line = Line::new([3, 3], [7, 6]);
assert_eq!(line.length_2(), 25);

pub fn nearest_point(&self, query_point: &P) -> P

Returns the nearest point on this line relative to a given point.

Example

use rstar::primitives::Line;

let line = Line::new([0.0, 0.0], [1., 1.]);
assert_eq!(line.nearest_point(&[0.0, 0.0]), [0.0, 0.0]);
assert_eq!(line.nearest_point(&[1.0, 0.0]), [0.5, 0.5]);
assert_eq!(line.nearest_point(&[10., 12.]), [1.0, 1.0]);

Trait Implementations

impl<P: Clone> Clone for Line<P> where
    P: Point, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Copy> Copy for Line<P> where
    P: Point, 

impl<P: Debug> Debug for Line<P> where
    P: Point, 

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

Formats the value using the given formatter.

impl<P: Eq> Eq for Line<P> where
    P: Point, 

impl<P: Ord> Ord for Line<P> where
    P: Point, 

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<P: PartialEq> PartialEq<Line<P>> for Line<P> where
    P: Point, 

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

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

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

This method tests for !=.

impl<P: PartialOrd> PartialOrd<Line<P>> for Line<P> where
    P: Point, 

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

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

fn lt(&self, other: &Line<P>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Line<P>) -> bool

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

fn gt(&self, other: &Line<P>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Line<P>) -> bool

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

impl<P> PointDistance for Line<P> where
    P: Point, 

fn distance_2(
    &self,
    point: &<Self::Envelope as Envelope>::Point
) -> <<Self::Envelope as Envelope>::Point as Point>::Scalar

Returns the squared euclidean distance of an object to a point.

fn contains_point(&self, point: &<Self::Envelope as Envelope>::Point) -> bool

Returns true if a point is contained within this object.

fn distance_2_if_less_or_equal(
    &self,
    point: &<Self::Envelope as Envelope>::Point,
    max_distance_2: <<Self::Envelope as Envelope>::Point as Point>::Scalar
) -> Option<<<Self::Envelope as Envelope>::Point as Point>::Scalar>

Returns the squared distance to this object or None if the distance is larger than a given maximum value.

impl<P> RTreeObject for Line<P> where
    P: Point, 

type Envelope = AABB<P>

The object's envelope type. Usually, AABB will be the right choice. This type also defines the objects dimensionality.

fn envelope(&self) -> Self::Envelope

Returns the object's envelope.

impl<P> StructuralEq for Line<P> where
    P: Point, 

impl<P> StructuralPartialEq for Line<P> where
    P: Point,