Struct geo::geometry::Line

source ·
pub struct Line<T = f64>where
    T: CoordNum,
{ pub start: Coord<T>, pub end: Coord<T>, }
Expand description

A line segment made up of exactly two Coords.

Semantics

The interior and boundary are defined as with a LineString with the two end points.

Fields§

§start: Coord<T>§end: Coord<T>

Implementations§

Creates a new line segment.

Examples
use geo_types::{coord, Line};

let line = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1., y: 2. });

assert_eq!(line.start, coord! { x: 0., y: 0. });
assert_eq!(line.end, coord! { x: 1., y: 2. });

Calculate the difference in coordinates (Δx, Δy).

Calculate the difference in ‘x’ components (Δx).

Equivalent to:

line.end.x - line.start.x

Calculate the difference in ‘y’ components (Δy).

Equivalent to:

line.end.y - line.start.y

Calculate the slope (Δy/Δx).

Equivalent to:

line.dy() / line.dx()

Note that:

Line::new(a, b).slope() == Line::new(b, a).slope()

Calculate the determinant of the line.

Equivalent to:

line.start.x * line.end.y - line.start.y * line.end.x

Note that:

Line::new(a, b).determinant() == -Line::new(b, a).determinant()

Trait Implementations§

Equality assertion with an absolute limit.

Examples
use geo_types::{coord, Line};

let a = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1., y: 1. });
let b = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1.001, y: 1. });

approx::assert_abs_diff_eq!(a, b, epsilon=0.1);
Used for specifying relative comparisons.
The default tolerance to use when testing values that are close together. Read more
The inverse of AbsDiffEq::abs_diff_eq.
Return the bounding rectangle of a geometry Read more
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Find the closest point between self and p.

Return the number of coordinates in the Line.

Iterate over all exterior and (if any) interior coordinates of a geometry. Read more
Iterate over all exterior coordinates of a geometry. Read more
Scalar used the coordinates.
The geometry associated with this type. Use a Line with the start and end coordinates to represent a point. Read more
Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more

Minimum distance from a Line to a Coord

Minimum distance from a Coord to a Line

Line to Line distance

Returns the distance between two geometries Read more

LineString to Line

Returns the distance between two geometries Read more

MultiPolygon to Line distance

Returns the distance between two geometries Read more

Minimum distance from a Line to a Point

Returns the distance between two geometries Read more

Line to LineString

Returns the distance between two geometries Read more

Line to MultiPolygon distance

Returns the distance between two geometries Read more

Minimum distance from a Line to a Point

Returns the distance between two geometries Read more
Calculation of the length of a Line Read more
Converts to this type from the input type.
Converts to this type from the input type.

Convert from a Line ensuring end point ordering.

Converts to this type from the input type.
Converts to this type from the input type.

The units of the returned value is meters.

Some geometries, like a MultiPoint, can have zero coordinates - we call these empty. Read more
The dimensions of some geometries are fixed, e.g. a Point always has 0 dimensions. However for others, the dimensionality depends on the specific geometry instance - for example typical Rects are 2-dimensional, but it’s possible to create degenerate Rects which have either 1 or 0 dimensions. Read more
The dimensions of the Geometry’s boundary, as used by OGC-SFA. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
Determine the length of a geometry using the haversine formula. Read more
Calculates a representative point inside the Geometry Read more
Iterate over all exterior and (if any) interior lines of a geometry. Read more
Apply a function to all the coordinates in a geometric object, returning a new object. Read more
Map a fallible function over all the coordinates in a geometry, returning a Result Read more
Apply a function to all the coordinates in a geometric object, in place Read more
Map a fallible function over all the coordinates in a geometry, in place, returning a Result. Read more
👎Deprecated since 0.21.0: use MapCoordsInPlace::map_coords_in_place instead which takes a Coord instead of an (x,y) tuple

Apply a function to all the coordinates in a geometric object, in place

Examples
#[allow(deprecated)]
use geo::MapCoordsInplace;
use geo::Point;
use approx::assert_relative_eq;

let mut p = Point::new(10., 20.);
#[allow(deprecated)]
p.map_coords_inplace(|(x, y)| (x + 1000., y * 2.));

assert_relative_eq!(p, Point::new(1010., 40.), epsilon = 1e-6);
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
Returns the squared euclidean distance between an object to a point.
Returns true if a point is contained within this object. Read more
Returns the squared distance to this object, or None if the distance is larger than a given maximum value. Read more
The object’s envelope type. Usually, AABB will be the right choice. This type also defines the object’s dimensionality. Read more
Returns the object’s envelope. Read more

Equality assertion within a relative limit.

Examples
use geo_types::{coord, Line};

let a = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1., y: 1. });
let b = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1.001, y: 1. });

approx::assert_relative_eq!(a, b, max_relative=0.1);
The default relative tolerance for testing values that are far-apart. Read more
The inverse of RelativeEq::relative_eq.
Create a new geometry with (consecutive) repeated points removed.
Remove (consecutive) repeated points inplace.
Serialize this value into the given Serde serializer. Read more

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

The type returned in the event of a conversion error.
Performs the conversion.
👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple
👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple
Map a fallible function over all the coordinates in a geometry, returning a Result Read more
👎Deprecated since 0.21.0: use MapCoordsInPlace::try_map_coords_in_place which takes a Coord instead of an (x,y) tuple
Map a fallible function over all the coordinates in a geometry, in place, returning a Result. Read more

The units of the returned value is meters.

Auto Trait Implementations§

Blanket Implementations§

Apply transform immutably, outputting a new geometry.
Apply transform to mutate self.
Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

Rotate a geometry around its centroid by an angle, in degrees Read more
Mutable version of Self::rotate_around_centroid
Rotate a geometry around the center of its bounding box by an angle, in degrees. Read more
Mutable version of Self::rotate_around_center
Rotate a Geometry around an arbitrary point by an angle, given in degrees Read more
Mutable version of Self::rotate_around_point
Scale a geometry from it’s bounding box center. Read more
Mutable version of scale
Scale a geometry from it’s bounding box center, using different values for x_factor and y_factor to distort the geometry’s aspect ratio. Read more
Mutable version of scale_xy.
Scale a geometry around a point of origin. Read more
Mutable version of scale_around_point.
An affine transformation which skews a geometry, sheared by a uniform angle along the x and y dimensions. Read more
Mutable version of skew.
An affine transformation which skews a geometry, sheared by an angle along the x and y dimensions. Read more
Mutable version of skew_xy.
An affine transformation which skews a geometry around a point of origin, sheared by an angle along the x and y dimensions. Read more
Mutable version of skew_around_point.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Translate a Geometry along its axes by the given offsets Read more
Translate a Geometry along its axes, but in place.
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.