Struct Vector2 

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

A two-dimensional vector.

Examples

use use_vector::Vector2;

let vector = Vector2::new(3.0, 4.0);

assert_eq!(vector.magnitude(), 5.0);

Fields

x: f64

The x component.

y: f64

The y component.

Implementations

impl Vector2

pub const ZERO: Self

The zero vector.

pub const ONE: Self

A vector with every component set to 1.0.

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

Creates a vector from its components.

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

Returns the dot product with other.

Examples

use use_vector::Vector2;

let a = Vector2::new(1.0, 2.0);
let b = Vector2::new(3.0, 4.0);

assert_eq!(a.dot(b), 11.0);

pub fn magnitude_squared(self) -> f64

Returns the squared Euclidean magnitude.

pub fn magnitude(self) -> f64

Returns the Euclidean magnitude.

pub fn normalize(self) -> Option<Self>

Returns a normalized vector when the magnitude is finite and non-zero.

Returns None for zero vectors or vectors with non-finite magnitude.

Examples

use use_vector::Vector2;

let unit = Vector2::new(3.0, 4.0)
    .normalize()
    .expect("non-zero finite vector should normalize");

assert!((unit.x - 0.6).abs() < 1.0e-12);
assert!((unit.y - 0.8).abs() < 1.0e-12);

pub fn scale(self, scalar: f64) -> Self

Returns the vector scaled by scalar.

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

Returns the Euclidean distance to other.

Examples

use use_vector::Vector2;

let start = Vector2::ZERO;
let end = Vector2::new(3.0, 4.0);

assert_eq!(start.distance(end), 5.0);

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

Returns the squared Euclidean distance to other.

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

Returns the linear interpolation between self and other for t.

Trait Implementations

impl Add for Vector2

type Output = Vector2

The resulting type after applying the + operator.

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

Performs the + operation.

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 Debug for Vector2

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

Formats the value using the given formatter.

impl Div<f64> for Vector2

type Output = Vector2

The resulting type after applying the / operator.

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

Performs the / operation.

impl Mul<f64> for Vector2

type Output = Vector2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Vector2

type Output = Vector2

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

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 Sub for Vector2

type Output = Vector2

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Vector2

impl StructuralPartialEq for Vector2