Struct VectorPoint 

#[repr(C)]
pub struct VectorPoint<M = Map<String, ValueType>>
where
    M: Clone,
{
    pub x: f64,
    pub y: f64,
    pub z: Option<f64>,
    pub m: Option<M>,
    pub t: Option<f64>,
}

Vector Points

Description

A Vector Point uses a structure for 2D or 3D points. Useful for geometry that also has m-values

Implements the ops Add, AddAssign, Sub, SubAssign, Mul, MulAssign, Div, DivAssign, Rem, RemAssign, Neg, PartialEq, and Eq.

Also implements local traits GetXY, GetZ, GetM, SetXY, SetZ, SetM, NewXY, NewXYM, NewXYZ, NewXYZM, MValueCompatible, MValue, and Interpolate.

Fields

• x: X coordinate
• y: Y coordinate
• z: Z coordinate or “altitude”. May be None
• m: M-Value
• t: T for tolerance. A tmp value often used for simplification if needed.

Usage

• VectorPoint::new: Creates a new VectorPoint
• VectorPoint::to_m_value: Convert to an MValue VectorPoint using to_m_value
• VectorPoint::project: Project the point into the 0->1 coordinate system
• VectorPoint::unproject: Unproject the point from the 0->1 coordinate system
• VectorPoint::is_empty: Returns true if the point is the zero vector
• VectorPoint::face: Returns the S2 face assocated with this point
• `VectorPoint::modulo: Apply modular arithmetic
• VectorPoint::angle: 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
• VectorPoint::cross: Get the cross product of two Vector Points
• VectorPoint::dot: dot returns the standard dot product of v and ov.
• VectorPoint::abs: Returns the absolute value of the point.
• VectorPoint::invert: Returns the inverse of the point
• VectorPoint::len: Returns the length of the point
• VectorPoint::norm: norm returns the vector’s norm. (sqrt of norm2)
• VectorPoint::norm2: norm2 returns the vector’s squared norm (self.dot(self))
• VectorPoint::normalize: Normalize this point to unit length
• VectorPoint::distance: return the distance from this point to the other point
• VectorPoint::largest_abs_component: Returns the largest absolute component of the point
• VectorPoint::interpolate: Interpolate between two points with a given t value

Fields

x: f64

X coordinate

y: f64

Y coordinate

z: Option<f64>

Z coordinate or “altitude”. May be None

m: Option<M>

M-Value

t: Option<f64>

T for tolerance. A tmp value used for simplification

Implementations

impl VectorPoint

pub fn from_xy(x: f64, y: f64) -> VectorPoint

Helper function for tests. Create a new point quickly from an xy coordinate

pub fn from_xyz(x: f64, y: f64, z: f64) -> VectorPoint

Helper function for tests. Create a new point quickly from an xyz coordinate

impl<M> VectorPoint<M>

where M: Clone,

pub fn new(x: f64, y: f64, z: Option<f64>, m: Option<M>) -> VectorPoint<M>

Create a new point

pub fn new_xy(x: f64, y: f64, m: Option<M>) -> VectorPoint<M>

Create a new point with xy

pub fn new_xyz(x: f64, y: f64, z: f64, m: Option<M>) -> VectorPoint<M>

Create a new point with xyz

pub fn to_m_value(&self) -> VectorPoint

where M: Into<Map<String, ValueType>>,

Convert to an MValue VectorPoint

pub fn project(&mut self, bbox: Option<&mut BBox3D>)

Project the point into the 0->1 coordinate system

pub fn unproject(&mut self)

Unproject the point from the 0->1 coordinate system back to a lon-lat coordinate

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 modulo(self, modulus: f64) -> VectorPoint<M>

Apply modular arithmetic to x, y, and z using modulus

pub fn angle<M2>(&self, b: &VectorPoint<M2>) -> f64

where M2: Clone,

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<M2>(&self, b: &VectorPoint<M2>) -> VectorPoint<M>

where M2: Clone,

Get the cross product of two Vector Points

pub fn dot<M2>(&self, b: &VectorPoint<M2>) -> f64

where M2: Clone,

dot returns the standard dot product of v and ov.

pub fn abs(&self) -> VectorPoint<M>

Returns the absolute value of the point.

pub fn invert(&self) -> VectorPoint<M>

Returns the inverse of the point

pub fn len(&self) -> f64

Returns the length of the point.

pub fn norm(&self) -> f64

norm returns the vector’s norm.

pub fn norm2(&self) -> f64

norm2 returns the vector’s squared norm.

pub fn normalize(&mut self)

Normalize this point to unit length.

pub fn distance<M2>(&self, b: &VectorPoint<M2>) -> f64

where M2: Clone,

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<M2>(&self, b: &VectorPoint<M2>, t: f64) -> VectorPoint<M>

where M2: Clone,

Returns the intermediate point between this and the other point.

pub fn perpendicular(&self) -> VectorPoint<M>

Returns the perpendicular vector

Trait Implementations

impl<M1, M2> Add<&VectorPoint<M2>> for &VectorPoint<M1>

where M1: Clone, M2: Clone,

type Output = VectorPoint<M1>

The resulting type after applying the + operator.

fn add( self, other: &VectorPoint<M2>, ) -> <&VectorPoint<M1> as Add<&VectorPoint<M2>>>::Output

Performs the + operation.

impl<M> Add<f64> for &VectorPoint<M>

where M: Clone,

type Output = VectorPoint<M>

The resulting type after applying the + operator.

fn add(self, other: f64) -> <&VectorPoint<M> as Add<f64>>::Output

Performs the + operation.

impl<M1, M2> AddAssign<&VectorPoint<M2>> for VectorPoint<M1>

where M1: Clone, M2: Clone,

fn add_assign(&mut self, other: &VectorPoint<M2>)

Performs the += operation.

impl<M> AddAssign<f64> for VectorPoint<M>

where M: Clone,

fn add_assign(&mut self, other: f64)

Performs the += operation.

impl<M> Clone for VectorPoint<M>

where M: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Debug for VectorPoint<M>

where M: Debug + Clone,

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

Formats the value using the given formatter.

impl<M> Default for VectorPoint<M>

where M: Default + Clone,

fn default() -> VectorPoint<M>

Returns the “default value” for a type.

impl<'de, M> Deserialize<'de> for VectorPoint<M>

where M: Clone + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<VectorPoint<M>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<M1, M2> Div<&VectorPoint<M2>> for &VectorPoint<M1>

where M1: Clone, M2: Clone,

type Output = VectorPoint<M1>

The resulting type after applying the / operator.

fn div( self, other: &VectorPoint<M2>, ) -> <&VectorPoint<M1> as Div<&VectorPoint<M2>>>::Output

Performs the / operation.

impl<M> Div<f64> for &VectorPoint<M>

where M: Clone,

type Output = VectorPoint<M>

The resulting type after applying the / operator.

fn div(self, other: f64) -> <&VectorPoint<M> as Div<f64>>::Output

Performs the / operation.

impl<M1, M2> DivAssign<&VectorPoint<M2>> for VectorPoint<M1>

where M1: Clone, M2: Clone,

fn div_assign(&mut self, other: &VectorPoint<M2>)

Performs the /= operation.

impl<M> DivAssign<f64> for VectorPoint<M>

where M: Clone,

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl<M, P> From<&P> for VectorPoint<M>

where M: Clone, P: GetXYZ,

fn from(p: &P) -> VectorPoint<M>

Converts to this type from the input type.

impl<M> From<Point> for VectorPoint<M>

where M: Clone,

fn from(p: Point) -> VectorPoint<M>

Converts to this type from the input type.

impl<M> From<Point3D> for VectorPoint<M>

where M: Clone,

fn from(p: Point3D) -> VectorPoint<M>

Converts to this type from the input type.

impl<M> GetM<M> for VectorPoint<M>

where M: Clone,

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

Returns the m value

impl<M> GetXY for VectorPoint<M>

where M: Clone,

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<M> GetZ for VectorPoint<M>

where M: Clone,

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

Returns the z value

impl<M> Interpolate for VectorPoint<M>

where M: Interpolate + Clone,

fn interpolate(&self, other: &VectorPoint<M>, t: f64) -> VectorPoint<M>

Interpolate between two of the same type

impl<M1, M2> Mul<&VectorPoint<M2>> for &VectorPoint<M1>

where M1: Clone, M2: Clone,

type Output = VectorPoint<M1>

The resulting type after applying the * operator.

fn mul( self, other: &VectorPoint<M2>, ) -> <&VectorPoint<M1> as Mul<&VectorPoint<M2>>>::Output

Performs the * operation.

impl<M> Mul<f64> for &VectorPoint<M>

where M: Clone,

type Output = VectorPoint<M>

The resulting type after applying the * operator.

fn mul(self, other: f64) -> <&VectorPoint<M> as Mul<f64>>::Output

Performs the * operation.

impl<M1, M2> MulAssign<&VectorPoint<M2>> for VectorPoint<M1>

where M1: Clone, M2: Clone,

fn mul_assign(&mut self, other: &VectorPoint<M2>)

Performs the *= operation.

impl<M> MulAssign<f64> for VectorPoint<M>

where M: Clone,

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl<M> Neg for &VectorPoint<M>

where M: Clone,

type Output = VectorPoint<M>

The resulting type after applying the - operator.

fn neg(self) -> <&VectorPoint<M> as Neg>::Output

Performs the unary - operation.

impl<M> NewXY for VectorPoint<M>

where M: Clone,

fn new_xy(x: f64, y: f64) -> VectorPoint<M>

Create a new point with xy

impl<M> NewXYM<M> for VectorPoint<M>

where M: Clone,

fn new_xym(x: f64, y: f64, m: M) -> VectorPoint<M>

Create a new point with xy

impl<M> NewXYZ for VectorPoint<M>

where M: Clone,

fn new_xyz(x: f64, y: f64, z: f64) -> VectorPoint<M>

Create a new point with xyz

impl<M> NewXYZM<M> for VectorPoint<M>

where M: Clone,

fn new_xyzm(x: f64, y: f64, z: f64, m: M) -> VectorPoint<M>

Create a new point with xyzm

impl<M> Ord for VectorPoint<M>

where M: Clone,

fn cmp(&self, other: &VectorPoint<M>) -> 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 for VectorPoint<M>

where M: Clone,

fn eq(&self, other: &VectorPoint<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<M> PartialOrd for VectorPoint<M>

where M: Clone,

fn partial_cmp(&self, other: &VectorPoint<M>) -> 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<M> Rem<f64> for VectorPoint<M>

where M: Clone,

type Output = VectorPoint<M>

The resulting type after applying the % operator.

fn rem(self, modulus: f64) -> <VectorPoint<M> as Rem<f64>>::Output

Performs the % operation.

impl<M> RemAssign<f64> for VectorPoint<M>

where M: Clone,

fn rem_assign(&mut self, modulus: f64)

Performs the %= operation.

impl<M> Serialize for VectorPoint<M>

where M: Clone + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<M> SetM<M> for VectorPoint<M>

where M: Clone,

fn set_m(&mut self, m: M)

Set the m value

impl<M> SetXY for VectorPoint<M>

where M: Clone,

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

Set both x and y

fn set_x(&mut self, x: f64)

Set the x value

fn set_y(&mut self, y: f64)

Set the y value

impl<M> SetZ for VectorPoint<M>

where M: Clone,

fn set_z(&mut self, z: f64)

Set the z value

impl<M1, M2> Sub<&VectorPoint<M2>> for &VectorPoint<M1>

where M1: Clone, M2: Clone,

type Output = VectorPoint<M1>

The resulting type after applying the - operator.

fn sub( self, other: &VectorPoint<M2>, ) -> <&VectorPoint<M1> as Sub<&VectorPoint<M2>>>::Output

Performs the - operation.

impl<M> Sub<f64> for &VectorPoint<M>

where M: Clone,

type Output = VectorPoint<M>

The resulting type after applying the - operator.

fn sub(self, other: f64) -> <&VectorPoint<M> as Sub<f64>>::Output

Performs the - operation.

impl<M1, M2> SubAssign<&VectorPoint<M2>> for VectorPoint<M1>

where M1: Clone, M2: Clone,

fn sub_assign(&mut self, other: &VectorPoint<M2>)

Performs the -= operation.

impl<M> SubAssign<f64> for VectorPoint<M>

where M: Clone,

fn sub_assign(&mut self, other: f64)

Performs the -= operation.

impl<M> Eq for VectorPoint<M>

where M: Clone,