Struct S2Point

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. (1-x)p1 + xp2). NOTE: asumes only f64 or greater is used.

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 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 len(&self) -> f64

Returns the length of the point.

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

return the distance from this point to the other point

pub fn largest_abs_component(&self) -> u8

Returns the largest absolute component of the point.

pub fn normalize(&mut self)

Normalize this point to unit length.

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

fn from(lonlat: &LonLat) -> 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 From<&S2Point> for LonLat

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

type Output = S2Point

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

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

impl Eq for S2Point

impl StructuralPartialEq for S2Point