Struct vector2::Vector2

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

Fields

x: f64

X component of the vector.

y: f64

Y component of the vector.

Implementations

impl Vector2

pub const DOWN: Self = _

Shorthand for writing Vector2::new(0.0, -1.0).

pub const LEFT: Self = _

Shorthand for writing Vector2::new(-1.0, 0.0).

pub const NEGATIVE_INFINITY: Self = _

Shorthand for writing Vector2::new(f64::NEG_INFINITY, f64::NEG_INFINITY).

pub const ONE: Self = _

Shorthand for writing Vector2::new(1.0, 1.0).

pub const POSITIVE_INFINITY: Self = _

Shorthand for writing Vector2::new(f64::INFINITY, f64::INFINITY).

pub const RIGHT: Self = _

Shorthand for writing Vector2::new(1.0, 0.0).

pub const UP: Self = _

Shorthand for writing Vector2::new(0.0, 1.0).

pub const ZERO: Self = _

Shorthand for writing Vector2::new(0.0, 0.0).

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

Constructs a new vector with given x, y components.

pub fn magnitude(&self) -> f64

Returns the length of this vector.

pub fn sqr_magnitude(&self) -> f64

Returns the squared length of this vector.

pub fn normalized(&self) -> Self

Returns this vector with a magnitude of 1.

pub fn normalize(&mut self)

Makes this vector have a magnitude of 1.

pub fn set(&mut self, new_x: f64, new_y: f64)

Set x and y components of an existing Vector2.

pub fn angle(from: Self, to: Self) -> f64

Gets the unsigned angle in degrees between from and to.

pub fn clamp_magnitude(vector: Self, max_length: f64) -> Self

Returns a copy of vector with its magnitude clamped to max_length.

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

Returns the distance between a and b.

pub fn dot(lhs: Self, rhs: Self) -> f64

Dot product of two vectors.

pub fn lerp(a: Self, b: Self, t: f64) -> Self

Linearly interpolates between vectors a and b by t.

pub fn lerp_unclamped(a: Self, b: Self, t: f64) -> Self

Linearly interpolates between vectors a and b by t.

pub fn max(lhs: Self, rhs: Self) -> Self

Returns a vector that is made from the largest components of two vectors.

pub fn min(lhs: Self, rhs: Self) -> Self

Returns a vector that is made from the smallest components of two vectors.

pub fn move_towards( current: Self, target: Self, max_distance_delta: f64 ) -> Self

Moves a point current towards target.

pub fn perpendicular(in_direction: Self) -> Self

Returns the 2D vector perpendicular to this 2D vector. The result is always rotated 90-degrees in a counter-clockwise direction for a 2D coordinate system where the positive Y axis goes up.

pub fn reflect(in_direction: Self, in_normal: Self) -> Self

Reflects a vector off the vector defined by a normal.

pub fn scale(a: Self, b: Self) -> Self

Multiplies two vectors component-wise.

pub fn signed_angle(from: Self, to: Self) -> f64

Gets the signed angle in degrees between from and to.

Trait Implementations

impl Add<Vector2> for Vector2

type Output = Vector2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vector2> for Vector2

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Vector2

fn clone(&self) -> Vector2

Returns a copy 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 Default for Vector2

fn default() -> Vector2

Returns the “default value” for a type.

impl Display 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, other: f64) -> Self

Performs the / operation.

impl DivAssign<f64> for Vector2

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl From<(f64, f64)> for Vector2

fn from(value: (f64, f64)) -> Self

Converts to this type from the input type.

impl From<Vector2> for (f64, f64)

fn from(value: Vector2) -> (f64, f64)

Converts to this type from the input type.

impl Mul<Vector2> for f64

type Output = Vector2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Vector2

type Output = Vector2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for Vector2

fn mul_assign(&mut self, other: 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<Vector2> for Vector2

fn eq(&self, other: &Vector2) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<Vector2> for Vector2

type Output = Vector2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Vector2> for Vector2

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Vector2

impl StructuralPartialEq for Vector2