Struct Vector2

Source

#[repr(C)]
pub struct Vector2<F: Float> {
    pub x: F,
    pub y: F,
}

Expand description

2 Dimensional vector.

Fields§

§x: F§y: F

Implementations§

Source §

pub const fn to_complex(self) -> Complex<F>

Converts a vector to a complex number with real = x, imag = y.

Source

pub const fn from_complex(complex: Complex<F>) -> Self

Converts a complex number to a vector with x = real, y = imag.

Source

pub const fn extend(self, z: F) -> Vector3<F>

Extends the vector with z component to create a Vector3.

Source

pub fn rotate_by(&mut self, angle: F)

Rotates angle around origin by some angle angle in radians counter-clockwise.

Source

pub fn rotated_by(self, angle: F) -> Self

Returns a rotated copy of a vector. See Self::rotate_by.

Source

pub fn rotate_by_clockwise(&mut self, angle: F)

Rotates angle around origin by some angle angle in radians clockwise.

Source

pub fn rotated_by_clockwise(self, angle: F) -> Self

Returns a rotated copy of a vector. See Self::rotate_by_clockwise.

Source

pub fn max_element(&self) -> F

Returns maximum element of the vector.

Source

pub fn min_element(&self) -> F

Returns minumum element of the vector.

Source

pub fn max_index(&self) -> usize

Returns index of the maximum element. Index is in 0..=1 range.

Source

pub fn min_index(&self) -> usize

Returns index of the minumum element. Index is in 0..=1 range.

Source

pub fn reflect(&self, axis: Self) -> Self

Source §

impl<F: Float> Vector2<F>

Source

pub fn normalize(&mut self)

Normalizes vector, preserving directing and making its magnitude equal to 1.

Source

pub fn normalized(&self) -> Self

Returns normalized copy of the vector. See Self::normalize.

Source

pub fn to_array(&self) -> [F; 2]

Converts the vector to an array.

Source

pub fn from_array(array: [F; 2]) -> Self

Converts array to a vector.

Source

pub fn as_array(&self) -> &[F; 2]

Converts the vector to an array slice.

Source

pub fn as_array_mut<'a>(&'a mut self) -> &'a [F; 2]

Converts the vector to a mutable array slice.

Source

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

Computes the dot(scalar) product between two vectors. Dot product for two normalized vector is equal to the cosine of the angle between them.

Source

pub fn dot_normalized(&self, other: Self) -> F

Computes the dot product between two vectors normalizing them beforehand.

Source

pub fn angle_to(&self, other: Self) -> F

Returns angle in radians between two vectors. Output range is: [0, pi].

Source

pub fn arc_angle_to(&self, other: Self) -> F

Returns angle in radians between two vectors that goes along circle arc counter-clockwise. Output range is: [0, 2pi].

let a = vector!(1, 1);
let b = vector!(-1, 1);
assert_eq!(a.arc_angle_to(b).to_degrees(), 90.0);
assert_eq!(b.arc_angle_to(a).to_degrees(), 270.0);
/*  (B). -- ~~~ -- .(A)
    .-~\    90.0   / ~-.
   /     \        /     \
  /        \    /        \
 |          \  /          |
 |           ()           |
 |                        |
  \         270.0        /
   \                    /
    `-.              .-'
        ~- . ___ . -~    */