logo

Struct geo::Point

source · []
pub struct Point<T>(pub Coordinate<T>)
where
    T: CoordNum
;
Expand description

A single point in 2D space.

Points can be created using the Point::new constructor, the [point!] macro, or from a Coordinate, two-element tuples, or arrays – see the From impl section for a complete list.

Semantics

The interior of the point is itself (a singleton set), and its boundary is empty. A point is valid if and only if the Coordinate is valid.

Examples

use geo_types::{Coordinate, Point};
let p1: Point<f64> = (0., 1.).into();
let c = Coordinate { x: 10., y: 20. };
let p2: Point<f64> = c.into();

Tuple Fields

0: Coordinate<T>

Implementations

Creates a new point.

Examples
use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.x(), 1.234);
assert_eq!(p.y(), 2.345);

Returns the x/horizontal component of the point.

Examples
use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.x(), 1.234);

Sets the x/horizontal component of the point.

Examples
use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
p.set_x(9.876);

assert_eq!(p.x(), 9.876);

Returns the y/vertical component of the point.

Examples
use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.y(), 2.345);

Sets the y/vertical component of the point.

Examples
use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
p.set_y(9.876);

assert_eq!(p.y(), 9.876);

Returns a tuple that contains the x/horizontal & y/vertical component of the point.

Examples
use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
let (x, y) = p.x_y();

assert_eq!(y, 2.345);
assert_eq!(x, 1.234);
👎 Deprecated:

use Point::x instead, it’s less ambigous

Returns the longitude/horizontal component of the point.

Examples
use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.x(), 1.234);
👎 Deprecated:

use Point::set_x instead, it’s less ambigous

Sets the longitude/horizontal component of the point.

Examples
use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
#[allow(deprecated)]
p.set_lng(9.876);

assert_eq!(p.x(), 9.876);
👎 Deprecated:

use Point::y instead, it’s less ambigous

Returns the latitude/vertical component of the point.

Examples
use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.y(), 2.345);
👎 Deprecated:

use Point::set_y instead, it’s less ambigous

Sets the latitude/vertical component of the point.

Examples
use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
#[allow(deprecated)]
p.set_lat(9.876);

assert_eq!(p.y(), 9.876);

Returns the dot product of the two points: dot = x1 * x2 + y1 * y2

Examples
use geo_types::{Coordinate, Point};

let point = Point(Coordinate { x: 1.5, y: 0.5 });
let dot = point.dot(Point(Coordinate { x: 2.0, y: 4.5 }));

assert_eq!(dot, 5.25);

Returns the cross product of 3 points. A positive value implies selfpoint_bpoint_c is counter-clockwise, negative implies clockwise.

Examples
use geo_types::{Coordinate, Point};

let point_a = Point(Coordinate { x: 1., y: 2. });
let point_b = Point(Coordinate { x: 3., y: 5. });
let point_c = Point(Coordinate { x: 7., y: 12. });

let cross = point_a.cross_prod(point_b, point_c);

assert_eq!(cross, 2.0)

Converts the (x,y) components of Point to degrees

Example
use geo_types::Point;

let p = Point::new(1.234, 2.345);
let (x, y): (f32, f32) = p.to_degrees().x_y();
assert_eq!(x.round(), 71.0);
assert_eq!(y.round(), 134.0);

Converts the (x,y) components of Point to radians

Example
use geo_types::Point;

let p = Point::new(180.0, 341.5);
let (x, y): (f32, f32) = p.to_radians().x_y();
assert_eq!(x.round(), 3.0);
assert_eq!(y.round(), 6.0);

Trait Implementations

Equality assertion with an absolute limit.

Examples
use geo_types::Point;

let a = Point::new(2.0, 3.0);
let b = Point::new(2.0, 3.0000001);

approx::assert_relative_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].

Add a point to the given point.

Examples
use geo_types::Point;

let p = Point::new(1.25, 2.5) + Point::new(1.5, 2.5);

assert_eq!(p.x(), 2.75);
assert_eq!(p.y(), 5.0);

The resulting type after applying the + operator.

Add a point to the given point and assign it to the original point.

Examples
use geo_types::Point;

let mut p = Point::new(1.25, 2.5);
p += Point::new(1.5, 2.5);

assert_eq!(p.x(), 2.75);
assert_eq!(p.y(), 5.0);

Returns the bearing to another Point in degrees, where North is 0° and East is 90°. Read more

Return the bounding rectangle for a Point. It will have zero width and zero height.

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Find the closest point between self and p.

Return the number of coordinates in the Point.

Iterate over all exterior and (if any) interior coordinates of a geometry. Read more

Iterate over all exterior coordinates of a geometry. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Scaler division of a point

Examples
use geo_types::Point;

let p = Point::new(2.0, 3.0) / 2.0;

assert_eq!(p.x(), 1.0);
assert_eq!(p.y(), 1.5);

The resulting type after applying the / operator.

Scaler division of a point in place

Examples
use geo_types::Point;

let mut p = Point::new(2.0, 3.0);
p /= 2.0;

assert_eq!(p.x(), 1.0);
assert_eq!(p.y(), 1.5);

Minimum distance from a Line to a Point

Minimum distance from a Point to a LineString

Minimum distance from a Point to a MultiLineString

Minimum distance from a Point to a MultiPoint

Minimum distance from a Point to a MultiPolygon

Minimum distance between two Points

Minimum distance from a MultiPoint to a Point

Minimum distance from a Line to a Point

Minimum distance from a LineString to a Point

Minimum distance from a MultiLineString to a Point

Minimum distance from a Polygon to a Point

Minimum distance from a MultiPolygon to a Point

Returns the distance between two geometries Read more

Minimum distance from a Point to a Polygon

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Determine the distance between two geometries on an ellipsoidal model of the earth. Read more

Returns a new Point along a route between two existing points on an ellipsoidal model of the earth Read more

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

Returns a new Point using distance to the existing Point and a bearing for the direction Read more

Determine the distance between two geometries using the haversine formula. Read more

Returns a new Point along a great circle route between two existing points. Read more

Apply a function to all the coordinates in a geometric object, returning a new object. Read more

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

Scaler multiplication of a point

Examples
use geo_types::Point;

let p = Point::new(2.0, 3.0) * 2.0;

assert_eq!(p.x(), 4.0);
assert_eq!(p.y(), 6.0);

The resulting type after applying the * operator.

Scaler multiplication of a point in place

Examples
use geo_types::Point;

let mut p = Point::new(2.0, 3.0);
p *= 2.0;

assert_eq!(p.x(), 4.0);
assert_eq!(p.y(), 6.0);

Returns a point with the x and y components negated.

Examples
use geo_types::Point;

let p = -Point::new(-1.25, 2.5);

assert_eq!(p.x(), 1.25);
assert_eq!(p.y(), -2.5);

The resulting type after applying the - operator.

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

The number type used by this point type.

The number of dimensions of this point type.

Creates a new point value with given values for each dimension. Read more

Returns a single coordinate of this point. Read more

Mutable variant of nth.

Equality assertion within a relative limit.

Examples
use geo_types::Point;

let a = Point::new(2.0, 3.0);
let b = Point::new(2.0, 3.01);

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].

👎 Deprecated:

Equivalent to rotate_around_centroid except for Polygon<T>, where it is equivalent to rotating around the polygon’s outer ring. Call that instead, or rotate_around_center if you’d like to rotate around the geometry’s bounding box center.

Rotate the Point about itself by the given number of degrees This operation leaves the point coordinates unchanged

Rotate a geometry around its centroid by an angle, in degrees Read more

Rotate a geometry around the center of its bounding box by an angle, in degrees. Read more

Subtract a point from the given point.

Examples
use geo_types::Point;

let p = Point::new(1.25, 3.0) - Point::new(1.5, 2.5);

assert_eq!(p.x(), -0.25);
assert_eq!(p.y(), 0.5);

The resulting type after applying the - operator.

Subtract a point from the given point and assign it to the original point.

Examples
use geo_types::Point;

let mut p = Point::new(1.25, 2.5);
p -= Point::new(1.5, 2.5);

assert_eq!(p.x(), -0.25);
assert_eq!(p.y(), 0.0);

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.

Map a fallible function over all the coordinates in a geometry, returning a Result Read more

Determine the distance between two geometries using Vincenty’s formulae. Read more

Auto Trait Implementations

Blanket Implementations

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.

Returns the squared euclidean distance of 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 objects dimensionality. Read more

Returns the object’s envelope. Read more

Rotate a Geometry around an arbitrary point by an angle, given in degrees Read more

Should always be Self

The resulting type after obtaining ownership.

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

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

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.