Struct rstar::primitives::Line
source · pub struct Line<P>where
P: Point,{
pub from: P,
pub to: P,
}
Expand description
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(&mut [line_1, line_2]);
assert_eq!(tree.locate_in_envelope(&line_1.envelope()).next(), Some(&line_1));
Fields
from: P
The line’s start point
to: P
The line’s end point.
Implementations
sourceimpl<P> Line<P>where
P: Point,
impl<P> Line<P>where
P: Point,
sourcepub fn nearest_point(&self, query_point: &P) -> P
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
sourceimpl<P: Ord> Ord for Line<P>where
P: Point,
impl<P: Ord> Ord for Line<P>where
P: Point,
1.21.0 · sourcefn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl<P: PartialEq> PartialEq<Line<P>> for Line<P>where
P: Point,
impl<P: PartialEq> PartialEq<Line<P>> for Line<P>where
P: Point,
sourceimpl<P: PartialOrd> PartialOrd<Line<P>> for Line<P>where
P: Point,
impl<P: PartialOrd> PartialOrd<Line<P>> for Line<P>where
P: Point,
sourcefn partial_cmp(&self, other: &Line<P>) -> Option<Ordering>
fn partial_cmp(&self, other: &Line<P>) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moresourceimpl<P> PointDistance for Line<P>where
P: Point,
impl<P> PointDistance for Line<P>where
P: Point,
sourceimpl<P> RTreeObject for Line<P>where
P: Point,
impl<P> RTreeObject for Line<P>where
P: Point,
impl<P: Copy> Copy for Line<P>where
P: Point,
impl<P: Eq> Eq for Line<P>where
P: Point,
impl<P> StructuralEq for Line<P>where
P: Point,
impl<P> StructuralPartialEq for Line<P>where
P: Point,
Auto Trait Implementations
impl<P> RefUnwindSafe for Line<P>where
P: RefUnwindSafe,
impl<P> Send for Line<P>where
P: Send,
impl<P> Sync for Line<P>where
P: Sync,
impl<P> Unpin for Line<P>where
P: Unpin,
impl<P> UnwindSafe for Line<P>where
P: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more