Struct S2Point 

#[repr(C)]
pub struct S2Point {
    pub x: f64,
    pub y: f64,
    pub z: f64,
}

An S2Point represents a point on the unit sphere as a 3D vector. Usually points are normalized to be unit length, but some methods do not require this. See util/math/vector.h for the methods available. Among other things, there are overloaded operators that make it convenient to write arithmetic expressions (e.g. p1 + p2).

NOTE: asumes only f64 or greater is used.

Implements the GetXY and GetZ traits

Usage

Methods that are available:

• S2Point::new: Create a new S2Point
• S2Point::is_empty: Check if the S2Point is empty
• S2Point::face: Returns the S2 face assocated with this point
• S2Point::angle: Returns the angle between this point and another
• S2Point::cross: Get the cross product of two XYZ Points
• S2Point::to_face_st: Convert an S2Point to an S2Point in normalized vector coordinates
• S2Point::get_face: Returns the S2 face assocated with this point
• S2Point::dot: Get the dot product of two XYZ Points
• S2Point::abs: Returns the absolute value of the point
• S2Point::invert: Inverts the point
• S2Point::len: Returns the length of the point
• S2Point::norm: Returns the vector’s squared norm.
• S2Point::norm2: The dot product of the point with itself
• S2Point::normalize: Normalizes the point
• S2Point::distance: return the distance from this point to the other point
• S2Point::largest_abs_component: Returns the largest absolute component of the point
• S2Point::intermediate: Returns the intermediate point between this and the other point
• S2Point::from_face_uv: Convert an Face-U-V coordinate to an S2Point
• S2Point::from_face_st: Convert an Face-S-T coordinate to an S2Point

Fields

x: f64

The x component.

y: f64

The y component.

z: f64

The z component.

Implementations

impl S2Point

pub fn new(x: f64, y: f64, z: f64) -> Self

Creates a new S2Point.

pub fn is_empty(&self) -> bool

Returns true if the point is the zero vector.

pub fn face(&self, f: u8) -> f64

Returns the S2 face assocated with this point

pub fn angle(&self, b: &Self) -> f64

Returns the angle between “this” and v in radians, in the range [0, pi]. If either vector is zero-length, or nearly zero-length, the result will be zero, regardless of the other value.

pub fn cross(&self, b: &Self) -> Self

Get the cross product of two XYZ Points

pub fn to_face_st(&self) -> (u8, f64, f64)

Returns a Face-ST representation of this point

pub fn get_face(&self) -> u8

Returns the S2 face assocated with this point

pub fn dot(&self, b: &Self) -> f64

dot returns the standard dot product of v and ov.

pub fn abs(&self) -> Self

Returns the absolute value of the point.

pub fn invert(&self) -> Self

Returns the inverse of the point

pub fn len(&self) -> f64

Returns the length of the point.

pub fn norm(&self) -> f64

Returns the vector’s squared norm.

pub fn norm2(&self) -> f64

The dot product of the point with itself

pub fn normalize(&mut self)

Normalize this point to unit length.

pub fn distance(&self, b: &Self) -> f64

return the distance from this point to the other point in radians

pub fn largest_abs_component(&self) -> u8

Returns the largest absolute component of the point.

pub fn intermediate(&self, b: &Self, t: f64) -> Self

Returns the intermediate point between this and the other point.

pub fn from_face_uv(face: u8, u: f64, v: f64) -> Self

Convert a u-v coordinate to an XYZ Point.

pub fn from_face_st(face: u8, s: f64, t: f64) -> Self

Convert an s-t coordinate to an XYZ Point.

Trait Implementations

impl Add<f64> for S2Point

type Output = S2Point

The resulting type after applying the + operator.

fn add(self, other: f64) -> Self::Output

Performs the + operation.

impl Add for S2Point

type Output = S2Point

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl AddAssign<f64> for S2Point

fn add_assign(&mut self, other: f64)

Performs the += operation.

impl AddAssign for S2Point

fn add_assign(&mut self, other: S2Point)

Performs the += operation.

impl BoxIndexAccessor for S2Point

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 Clone for S2Point

fn clone(&self) -> S2Point

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for S2Point

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

Formats the value using the given formatter.

impl Default for S2Point

fn default() -> S2Point

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for S2Point

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<f64> for S2Point

type Output = S2Point

The resulting type after applying the / operator.

fn div(self, other: f64) -> Self::Output

Performs the / operation.

impl Div for S2Point

type Output = S2Point

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl DivAssign<f64> for S2Point

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl DivAssign for S2Point

fn div_assign(&mut self, other: S2Point)

Performs the /= operation.

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 From<&S2Point> for S2CellId

fn from(value: &S2Point) -> Self

Converts to this type from the input type.

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

fn from(v: &VectorPoint<M>) -> Self

Converts to this type from the input type.

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

fn from(v: &mut VectorPoint<M>) -> Self

Converts to this type from the input type.

impl From<S2CellId> for S2Point

fn from(cellid: S2CellId) -> Self

Converts to this type from the input type.

impl GetXY for S2Point

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 GetZ for S2Point

fn z(&self) -> Option<f64>

Returns the z value

impl Mul<f64> for S2Point

type Output = S2Point

The resulting type after applying the * operator.

fn mul(self, other: f64) -> Self::Output

Performs the * operation.

impl Mul for S2Point

type Output = S2Point

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl MulAssign<f64> for S2Point

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl MulAssign for S2Point

fn mul_assign(&mut self, other: S2Point)

Performs the *= operation.

impl Neg for S2Point

type Output = S2Point

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl NewXY for S2Point

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

Create a new point with xy

impl NewXYZ for S2Point

fn new_xyz(x: f64, y: f64, z: f64) -> Self

Create a new point with xyz

impl Ord for S2Point

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 PartialEq for S2Point

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

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 Rem<f64> for S2Point

type Output = S2Point

The resulting type after applying the % operator.

fn rem(self, other: f64) -> Self::Output

Performs the % operation.

impl RemAssign<f64> for S2Point

fn rem_assign(&mut self, other: f64)

Performs the %= operation.

impl Serialize for S2Point

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SetXY for S2Point

fn set_x(&mut self, x: f64)

Set the x value

fn set_y(&mut self, y: f64)

Set the y value

fn set_xy(&mut self, x: f64, y: f64)

Set both x and y

impl SetZ for S2Point

fn set_z(&mut self, z: f64)

Set the z value

impl Sub<f64> for S2Point

type Output = S2Point

The resulting type after applying the - operator.

fn sub(self, other: f64) -> Self::Output

Performs the - operation.

impl Sub for S2Point

type Output = S2Point

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl SubAssign<f64> for S2Point

fn sub_assign(&mut self, other: f64)

Performs the -= operation.

impl SubAssign for S2Point

fn sub_assign(&mut self, other: S2Point)

Performs the -= operation.

impl Copy for S2Point

impl Eq for S2Point

impl StructuralPartialEq for S2Point