Struct LonLat 

pub struct LonLat<M: Clone + Default = MValue>(pub VectorPoint<M>);

Longitude-Latitude Point container

Description

This class represents a point on the unit sphere as a pair of latitude-longitude coordinates. Like the rest of the “geometry” package, the intent is to represent spherical geometry as a mathematical abstraction, so functions that are specifically related to the Earth’s geometry (e.g. easting/northing conversions) should be put elsewhere.

This struct implements the GetXY and GetM traits.

Usage

Methods that are available:

• LonLat::new: Create a new LonLat
• LonLat::take: Take ownership of the underlying VectorPoint
• LonLat::lon: Return the longitude in degrees
• LonLat::lat: Return the latitude in degrees
• LonLat::from_s2cellid: Convert a S2CellId to an LonLat
• LonLat::from_s2_point: Convert a S2Point to an LonLat
• LonLat::normalize: Normalize the coordinates to the range [-180, 180] and [-90, 90] deg.
• LonLat::coords: Return the latitude or longitude coordinates in degrees.
• LonLat::to_angles: Return the latitude and longitude coordinates in radians.
• LonLat::is_valid: Return true if the latitude is between -90 and 90 degrees inclusive and the longitude is between -180 and 180 degrees inclusive.
• LonLat::to_point: Converts an LonLat to the equivalent unit-length vector.
• LonLat::to_point_gl: An alternative to LonLat::to_point that returns a GPU compatible vector.
• LonLat::get_distance:Returns the distance (measured along the surface of the sphere) to the given LonLat.
• LonLat::get_bearing: Returns the bearing from the first point to the second point.

Tuple Fields

0: VectorPoint<M>

Implementations

impl<M: Clone + Default> LonLat<M>

pub fn new(lon: f64, lat: f64, m: Option<M>) -> LonLat<M>

Build a new LonLat

pub fn take(&mut self) -> VectorPoint<M>

Take the underlying VectorPoint

pub fn lon(&self) -> f64

Return the longitude in degrees

pub fn lat(&self) -> f64

Return the latitude in degrees

pub fn from_s2cellid(cellid: S2CellId) -> Self

Convert a S2CellId to an LonLat

pub fn from_s2_point(p: &S2Point) -> Self

Convert a direction vector (not necessarily unit length) to an LonLat.

pub fn normalize(&mut self)

Normalize the coordinates to the range [-180, 180] and [-90, 90] deg.

pub fn coords(self) -> (f64, f64)

Return the latitude or longitude coordinates in degrees.

pub fn to_angles(&self) -> (S1Angle, S1Angle)

Return the latitude and longitude coordinates in radians.

pub fn is_valid(&self) -> bool

Return true if the latitude is between -90 and 90 degrees inclusive and the longitude is between -180 and 180 degrees inclusive.

pub fn to_point(&self) -> S2Point

Converts an LonLat to the equivalent unit-length vector. Unnormalized values (see Normalize()) are wrapped around the sphere as would be expected based on their definition as spherical angles. So for example the following pairs yield equivalent points (modulo numerical error): (90.5, 10) =~ (89.5, -170) (a, b) =~ (a + 360 * n, b) The maximum error in the result is 1.5 * DBL_EPSILON. (This does not include the error of converting degrees, E5, E6, or E7 to radians.)

Can be used just like an S2Point constructor. For example: S2Cap cap; cap.AddPoint(S2Point(latlon));

pub fn to_point_gl(&self) -> S2Point

An alternative to to_point() that returns a GPU compatible vector.

pub fn get_distance<M2: Clone + Default>(&self, b: &LonLat<M2>) -> f64

Returns the distance (measured along the surface of the sphere) to the given LonLat, implemented using the Haversine formula. This is equivalent to

S1Angle(ToPoint(), o.ToPoint())

except that this function is slightly faster, and is also somewhat less accurate for distances approaching 180 degrees (see s1angle.h for details). Both LngLats must be normalized.

pub fn get_bearing<M2: Clone + Default>(&self, b: &LonLat<M2>) -> f64

Returns the bearing from the first point to the second point.

Trait Implementations

impl<M1: Clone + Default, M2: Clone + Default> Add<LonLat<M2>> for LonLat<M1>

type Output = LonLat<M1>

The resulting type after applying the + operator.

fn add(self, rhs: LonLat<M2>) -> Self::Output

Performs the + operation.

impl<M: Clone + Default> BoxIndexAccessor for LonLat<M>

fn bbox(&self) -> BBox

Get the bounding box of the item

fn hilbert(&self, _index_bbox: &BBox) -> u64

Get the hilbert value of the item

impl<M: Clone + Clone + Default> Clone for LonLat<M>

fn clone(&self) -> LonLat<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug + Clone + Default> Debug for LonLat<M>

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

Formats the value using the given formatter.

impl<M1: Clone + Default, M2: Clone + Default> Div<LonLat<M2>> for LonLat<M1>

type Output = LonLat<M1>

The resulting type after applying the / operator.

fn div(self, rhs: LonLat<M2>) -> Self::Output

Performs the / operation.

impl<M: Clone + Default> From<&LonLat<M>> for S2CellId

fn from(value: &LonLat<M>) -> Self

Converts to this type from the input type.

impl<M: Clone + Default> From<&LonLat<M>> for S2Point

fn from(lonlat: &LonLat<M>) -> Self

Converts to this type from the input type.

impl<M: Clone + Default> From<&S2Point> for LonLat<M>

fn from(p: &S2Point) -> Self

Converts to this type from the input type.

impl<M: Clone + Default> From<S2CellId> for LonLat<M>

fn from(c: S2CellId) -> Self

Converts to this type from the input type.

impl<M: Clone + Default> GetM<M> for LonLat<M>

fn m(&self) -> Option<&M>

Returns the m value

impl GetXY for LonLat

fn x(&self) -> f64

Returns the x value

fn y(&self) -> f64

Returns the y value

fn xy(&self) -> (f64, f64)

Returns the x and y values

impl<M1: Clone + Default, M2: Clone + Default> Mul<LonLat<M2>> for LonLat<M1>

type Output = LonLat<M1>

The resulting type after applying the * operator.

fn mul(self, rhs: LonLat<M2>) -> Self::Output

Performs the * operation.

impl Neg for LonLat

type Output = LonLat

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl NewXY for LonLat

fn new_xy(x: f64, y: f64) -> LonLat

Create a new point with xy

impl Ord for LonLat

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<M: PartialEq + Clone + Default> PartialEq for LonLat<M>

fn eq(&self, other: &LonLat<M>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LonLat

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<M1: Clone + Default, M2: Clone + Default> Sub<LonLat<M2>> for LonLat<M1>

type Output = LonLat<M1>

The resulting type after applying the - operator.

fn sub(self, rhs: LonLat<M2>) -> Self::Output

Performs the - operation.

impl Eq for LonLat

impl<M: Clone + Default> StructuralPartialEq for LonLat<M>