Struct GeographicPoint

pub struct GeographicPoint { /* private fields */ }

Represents a point using the geographic system of coordinates.

Implementations

impl GeographicPoint

pub fn new(longitude: f64, latitude: f64, altitude: f64) -> Self

pub fn from_cartesian(point: &CartesianPoint) -> Self

Returns the equivalent GeographicPoint of the given CartesianPoint

pub fn with_longitude(self, value: f64) -> Self

Calls set_longitude on self and returns it.

pub fn with_latitude(self, value: f64) -> Self

Calls set_latitude on self and returns it.

pub fn with_altitude(self, value: f64) -> Self

Calls set_altitude on self and returns it.

pub fn set_longitude(&mut self, value: f64)

Sets the given longitude (in radiants) to the point.

Definition

Since the longitude of a point on a sphere is the angle east (positive) or west (negative) in reference of the maridian zero, the longitude value must be in the range [-π, +π). Any other value will be recomputed in order to set its equivalent inside the range.

Longitude adjustment

Both boundaries of the longitude range are consecutive, which means that overflowing one is the same as continuing from the other in the same direction.

Example

use globe_rs::GeographicPoint;
use std::f64::consts::PI;
use float_cmp::approx_eq;

let mut point = GeographicPoint::default();
point.set_longitude(PI + 1_f64);

assert!(approx_eq!(f64, point.longitude(), -PI + 1_f64, ulps = 2));

pub fn set_latitude(&mut self, value: f64)

Sets the given latitude (in radiants) to the point.

Definition

Since the latitude of a point on a sphere is the angle between the equatorial plane and the straight line that passes through that point and through the center of the sphere, the latitude value must be in the range [-π/2, +π/2]. Any other value will be recomputed in order to set its equivalent inside the range. Notice that this action may recompute the longitude as well.

Latitude adjustment

Overflowing any of both boundaries of the latitude range behaves like moving away from that point and getting closer to the oposite one.

Longitude adjustment

Geometrically speaking, meridians are half of a circle going from the north pole to the south one. The position of each meridian in the perimeter of the sphere (horizontal axis) is set by the longitude itself. However, this value may change when the latitude overflows its normalized range. This happen since exceeding any of its established limits means moving from one to the other half of the circle on which the meridian is drawn. And therefore, the longitude gets increased by exactly π radiants.

Of course, this mutation on the longitude only applies when the overflow of the latitude is not enough to complete a full lap. If it is, the longitude does not change at all.

Example

use globe_rs::GeographicPoint;
use std::f64::consts::PI;
use float_cmp::approx_eq;

let mut point = GeographicPoint::default();
point.set_latitude(-5. * PI / 4.);

assert!(approx_eq!(f64, point.latitude(), PI / 4., ulps = 2));
assert!(approx_eq!(f64, point.longitude(), -PI, ulps = 2));

pub fn set_altitude(&mut self, value: f64)

Sets the given altitude to the point.

pub fn longitude(&self) -> f64

Returns the longitude (in radiants) of the point.

pub fn latitude(&self) -> f64

Returns the latitude (in radiants) of the point.

pub fn altitude(&self) -> f64

Returns the altitude (in radiants) of the point.

pub fn long_ratio(&self) -> f64

Returns the result of dividing π to the longitude of the point, resulting in a value in the range [-1.0, 1.0)

pub fn lat_ratio(&self) -> f64

Returns the result of dividing π/2 to the latitude of the point, resulting in a value in the range [-1.0, 1.0]

pub fn distance(&self, other: &GeographicPoint) -> f64

Computes the great-circle distance from self to the given point (in radiants).

Trait Implementations

impl Clone for GeographicPoint

fn clone(&self) -> GeographicPoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeographicPoint

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

Formats the value using the given formatter.

impl Default for GeographicPoint

fn default() -> GeographicPoint

Returns the “default value” for a type.

impl From<CartesianPoint> for GeographicPoint

fn from(value: CartesianPoint) -> Self

Converts to this type from the input type.

impl From<GeographicPoint> for CartesianPoint

fn from(value: GeographicPoint) -> Self

Converts to this type from the input type.

impl From<GeographicPoint> for JsValue

fn from(value: GeographicPoint) -> Self

Converts to this type from the input type.

impl FromWasmAbi for GeographicPoint

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for GeographicPoint

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for GeographicPoint

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<GeographicPoint>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for GeographicPoint

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for GeographicPoint

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq for GeographicPoint

fn eq(&self, other: &GeographicPoint) -> 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 RefFromWasmAbi for GeographicPoint

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<GeographicPoint>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for GeographicPoint

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<GeographicPoint>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for GeographicPoint

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for GeographicPoint

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[GeographicPoint]>

impl VectorIntoJsValue for GeographicPoint

fn vector_into_jsvalue(vector: Box<[GeographicPoint]>) -> JsValue

impl VectorIntoWasmAbi for GeographicPoint

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[GeographicPoint]>) -> Self::Abi

impl WasmDescribe for GeographicPoint

fn describe()

impl WasmDescribeVector for GeographicPoint

fn describe_vector()

impl Copy for GeographicPoint

impl StructuralPartialEq for GeographicPoint

impl SupportsConstructor for GeographicPoint

impl SupportsInstanceProperty for GeographicPoint

impl SupportsStaticProperty for GeographicPoint