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

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

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 ==. Read more

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. Read more

1.0.0 · source

fn lt(&self, other: &Rhs) -> bool

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

1.0.0 · source

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 more

1.0.0 · source

fn gt(&self, other: &Rhs) -> bool

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

1.0.0 · source

fn ge(&self, other: &Rhs) -> bool

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

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 between 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. Read more

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 more

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 object’s dimensionality. Read more

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

Returns the object’s envelope. Read more

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

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.