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(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§
source§impl<P> Line<P>where
P: Point,
impl<P> Line<P>where P: Point,
sourcepub fn length_2(&self) -> P::Scalar
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);
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§
source§impl<P> Ord for Line<P>where
P: Point + Ord,
impl<P> Ord for Line<P>where P: Point + Ord,
source§impl<P> PartialEq<Line<P>> for Line<P>where
P: Point + PartialEq,
impl<P> PartialEq<Line<P>> for Line<P>where P: Point + PartialEq,
source§impl<P> PartialOrd<Line<P>> for Line<P>where
P: Point + PartialOrd,
impl<P> PartialOrd<Line<P>> for Line<P>where P: Point + PartialOrd,
1.0.0 · source§fn 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 moresource§impl<P> PointDistance for Line<P>where
P: Point,
impl<P> PointDistance for Line<P>where P: Point,
source§fn distance_2(
&self,
point: &<Self::Envelope as Envelope>::Point
) -> <<Self::Envelope as Envelope>::Point as Point>::Scalar
fn distance_2( &self, point: &<Self::Envelope as Envelope>::Point ) -> <<Self::Envelope as Envelope>::Point as Point>::Scalar
Returns the squared euclidean distance between an object to a point.
source§fn contains_point(&self, point: &<Self::Envelope as Envelope>::Point) -> bool
fn contains_point(&self, point: &<Self::Envelope as Envelope>::Point) -> bool
Returns
true
if a point is contained within this object. Read moresource§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>
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. Read moresource§impl<P> RTreeObject for Line<P>where
P: Point,
impl<P> RTreeObject for Line<P>where P: Point,
impl<P> Copy for Line<P>where P: Point + Copy,
impl<P> Eq for Line<P>where P: Point + Eq,
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more