Enum geo::algorithm::sweep::LineOrPoint

pub enum LineOrPoint<T: GeoNum> {
    Point(SweepPoint<T>),
    Line {
        left: SweepPoint<T>,
        right: SweepPoint<T>,
    },
}

Either a line segment or a point.

The coordinates are ordered (see SweepPoint) and a line segment must have distinct points (use the Point variant if the coordinates are the equal).

Variants

Point(SweepPoint<T>)

Line

Fields

left: SweepPoint<T>

right: SweepPoint<T>

Implementations

impl<T: GeoNum> LineOrPoint<T>

pub fn is_line(&self) -> bool

Checks if the variant is a line.

pub fn line(&self) -> Line<T>

Return a Line representation of self.

pub fn left(&self) -> SweepPoint<T>

pub fn right(&self) -> SweepPoint<T>

pub fn end_points(&self) -> (SweepPoint<T>, SweepPoint<T>)

pub fn new(left: SweepPoint<T>, right: SweepPoint<T>) -> Self

pub fn orient2d(&self, other: Coord<T>) -> Orientation

impl<T: GeoFloat> LineOrPoint<T>

pub fn intersect_line(&self, other: &Self) -> Option<Self>

Intersect a line with self and return a point, a overlapping segment or None.

The other argument must be a line variant (debug builds will panic otherwise).

pub fn intersect_line_ordered(&self, other: &Self) -> Option<Self>

Trait Implementations

impl<T: Clone + GeoNum> Clone for LineOrPoint<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: GeoFloat> Cross for LineOrPoint<T>

type Scalar = T

Scalar used the coordinates.

fn line(&self) -> LineOrPoint<Self::Scalar>

The geometry associated with this type. Use a Line with the start and end coordinates to represent a point.

impl<T: GeoNum> Debug for LineOrPoint<T>

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

Formats the value using the given formatter.

impl<T: GeoNum> From<(SweepPoint<T>, SweepPoint<T>)> for LineOrPoint<T>

fn from((start, end): (SweepPoint<T>, SweepPoint<T>)) -> Self

Converts to this type from the input type.

impl<T: GeoNum> From<Coord<T>> for LineOrPoint<T>

Convert from a Coord

fn from(c: Coord<T>) -> Self

Converts to this type from the input type.

impl<T: GeoNum> From<Line<T>> for LineOrPoint<T>

Convert from a Line ensuring end point ordering.

fn from(l: Line<T>) -> Self

Converts to this type from the input type.

impl<T: GeoNum> From<SweepPoint<T>> for LineOrPoint<T>

fn from(pt: SweepPoint<T>) -> Self

Converts to this type from the input type.

impl<T: GeoNum> PartialEq for LineOrPoint<T>

Equality based on ordering defined for segments as per algorithm.

fn eq(&self, other: &Self) -> 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: GeoNum> PartialOrd for LineOrPoint<T>

Ordering defined for segments as per algorithm.

Requires the following conditions:

1. If comparing two lines, both the left ends must be strictly smaller than both right ends.

2. A point is treated as a infinitesimal small vertical segment centered at its coordinates.

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

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

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

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

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

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

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

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

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

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

impl<T: Copy + GeoNum> Copy for LineOrPoint<T>