Struct Vector2 

pub struct Vector2 {
    pub x: f64,
    pub y: f64,
}

A free vector in the plane.

Fields

x: f64

X component.

y: f64

Y component.

Implementations

impl Vector2

pub const ZERO: Self

The zero vector.

pub const X: Self

Unit vector along +X.

pub const Y: Self

Unit vector along +Y.

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

A vector from components.

pub const fn to_array(self) -> [f64; 2]

Components as an array.

pub const fn from_array([x, y]: [f64; 2]) -> Self

A vector from an array.

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

Dot product.

Two terms, so no fused multiply-add; see Vector::cross for why.

pub fn cross(self, other: Self) -> f64

The scalar cross product: the signed area of the parallelogram the two vectors span. Positive when other is counter-clockwise from self.

pub fn square_magnitude(self) -> f64

Squared magnitude.

pub fn magnitude(self) -> f64

Magnitude.

pub const fn perpendicular(self) -> Self

This vector rotated a quarter turn counter-clockwise. Exact: no trigonometry involved.

pub fn normalized(self, tol: Tolerances) -> OgeomResult<Self>

This vector scaled to unit length.

Errors

OgeomError::Construction if the magnitude is below tol.confusion(), or if any component is non-finite.

pub fn is_finite(self) -> bool

Whether both components are finite.

pub fn is_zero(self, tol: Tolerances) -> bool

Whether the magnitude is within tol.confusion() of zero.

pub fn is_equal(self, other: Self, tol: Tolerances) -> bool

Whether two vectors agree component-wise within tol.confusion().

pub fn angle(self, other: Self, tol: Tolerances) -> OgeomResult<f64>

Angle to other, in (-π, π], positive counter-clockwise.

Errors

OgeomError::Construction if either vector is degenerate.

pub fn lerp(self, other: Self, t: f64) -> Self

Linear interpolation, t = 0 giving self.

pub const fn to_3d(self) -> Vector

This vector with a Z component of zero.

Trait Implementations

impl Add for Vector2

type Output = Vector2

The resulting type after applying the + operator.

fn add(self, o: Self) -> Self

Performs the + operation.

impl Add<Vector2> for Point2

type Output = Point2

The resulting type after applying the + operator.

fn add(self, v: Vector2) -> Self

Performs the + operation.

impl AddAssign for Vector2

fn add_assign(&mut self, o: Self)

Performs the += operation.

impl AddAssign<Vector2> for Point2

fn add_assign(&mut self, v: Vector2)

Performs the += operation.

impl Blend for Vector2

fn zero() -> Self

The additive identity.

fn scale(self, k: f64) -> Self

Scale by a factor.

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

Add another value.

fn lerp(self, other: Self, t: f64) -> Self

self * (1 - t) + other * t.

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

Subtract, via scaling by -1.

impl Clone for Vector2

fn clone(&self) -> Vector2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Vector2

impl Debug for Vector2

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

Formats the value using the given formatter.

impl Default for Vector2

fn default() -> Vector2

Returns the “default value” for a type.

impl Div<f64> for Vector2

type Output = Vector2

The resulting type after applying the / operator.

fn div(self, s: f64) -> Self

Performs the / operation.

impl DivAssign<f64> for Vector2

fn div_assign(&mut self, s: f64)

Performs the /= operation.

impl From<Direction2> for Vector2

fn from(d: Direction2) -> Self

Converts to this type from the input type.

impl Mul<Vector2> for Matrix2

type Output = Vector2

The resulting type after applying the * operator.

fn mul(self, v: Vector2) -> Vector2

Performs the * operation.

impl Mul<Vector2> for f64

type Output = Vector2

The resulting type after applying the * operator.

fn mul(self, v: Vector2) -> Vector2

Performs the * operation.

impl Mul<f64> for Vector2

type Output = Vector2

The resulting type after applying the * operator.

fn mul(self, s: f64) -> Self

Performs the * operation.

impl MulAssign<f64> for Vector2

fn mul_assign(&mut self, s: f64)

Performs the *= operation.

impl Neg for Vector2

type Output = Vector2

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Vector2

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

impl Sub for Vector2

type Output = Vector2

The resulting type after applying the - operator.

fn sub(self, o: Self) -> Self

Performs the - operation.

impl Sub<Vector2> for Point2

type Output = Point2

The resulting type after applying the - operator.

fn sub(self, v: Vector2) -> Self

Performs the - operation.

impl SubAssign for Vector2

fn sub_assign(&mut self, o: Self)

Performs the -= operation.

impl SubAssign<Vector2> for Point2

fn sub_assign(&mut self, v: Vector2)

Performs the -= operation.