Struct gamemath::Vec2

pub struct Vec2<T> {
    pub x: T,
    pub y: T,
}

A two-component Euclidean vector useful for linear algebra computation in game development and 3D rendering.

Fields

x: T

The X/first component of the vector.

y: T

The Y/second component of the vector.

Implementations

impl<T> Vec2<T> where
    T: Copy + Debug + PartialEq + Default + Mul<Output = T> + Add<Output = T> + Sub<Output = T> + Neg<Output = T> + PartialOrd, 

pub fn new(x: T, y: T) -> Vec2<T>

Constructs a new Vec2<T> from two initial values.

Examples

use gamemath::Vec2;

let v = Vec2::new(1.0, 5.0);

assert_eq!(v.x, 1.0);
assert_eq!(v.y, 5.0);

pub fn dot(&self, right: Vec2<T>) -> T

Calculates the dot/scalar product of two Vec2<T>s. The calling object is considered the left value and the argument object is considered the right value.

Examples

use gamemath::Vec2;

let v1 = Vec2::new(1.0, 2.0);
let v2 = Vec2::new(3.0, 4.0);

assert_eq!(v1.dot(v2), 11.0);
assert_eq!(v2.dot(v1), 11.0);

pub fn fill(&mut self, value: T)

Fills all components of the calling Vec2<T> with the provided value.

Examples

use gamemath::Vec2;

let mut v = Vec2::new(0.0, 0.0);

v.fill(6.0);

assert_eq!(v, Vec2::new(6.0, 6.0));

pub fn length_squared(&self) -> T

Calculates the squared length/magnitude/norm of a Vec2<T>. This saves an expensive square root calculation compared to calculating the actual length, and comparing two squared lengths can therefore often be cheaper than, and yield the same result as, computing two real lengths.

Also useful for data types that does not implement a square root function, i.e. non-floating-point data types.

Examples

use gamemath::Vec2;

let v = Vec2::new(1.0, 2.0);

assert_eq!(v.length_squared(), 5.0);

pub fn manhattan_distance(&self, right: Vec2<T>) -> T

Calculates and returns the manhattan distance between the two points pointed to by two Vec2<T> objects.

Examples

use gamemath::Vec2;

let v1 = Vec2::new(1.0, 2.0);
let v2 = Vec2::new(2.0, 4.0);

assert_eq!(v1.manhattan_distance(v2), 3.0);

impl Vec2<f32>

pub fn length(self) -> f32

Calculates the real length/magnitude/norm of a Vec2<f32>. This results in an expensive square root calculation, and you might want to consider using a squared length instead when possible.

Examples

use gamemath::Vec2;

let v = Vec2::new(3.0_f32, 4.0_f32);

assert_eq!(v.length(), 5.0_f32);

pub fn normalized(self) -> Vec2<f32>

Calculates and returns the unit vector representation of a Vec2<f32>. This results in an an expensive square root calculation.

Examples

use gamemath::Vec2;

let v = Vec2::new(3.0_f32, 4.0_f32);

assert_eq!(v.normalized(), Vec2::new(0.6_f32, 0.8_f32));

pub fn normalize(&mut self)

Normalizes a Vec2<f32> into its unit vector representation. This results in an an expensive square root calculation.

Examples

use gamemath::Vec2;

let mut v = Vec2::new(3.0_f32, 4.0_f32);

v.normalize();

assert_eq!(v, Vec2::new(0.6_f32, 0.8_f32));

impl Vec2<f64>

pub fn length(&self) -> f64

Calculates the real length/magnitude/norm of a Vec2<f64>. This results in an expensive square root calculation, and you might want to consider using a squared length instead when possible.

Examples

use gamemath::Vec2;

let v = Vec2::new(3.0_f64, 4.0_f64);

assert_eq!(v.length(), 5.0_f64);

pub fn normalized(&self) -> Vec2<f64>

Calculates and returns the unit vector representation of a Vec2<f64>. This results in an an expensive square root calculation.

Examples

use gamemath::Vec2;

let v = Vec2::new(3.0_f64, 4.0_f64);

assert_eq!(v.normalized(), Vec2::new(0.6_f64, 0.8_f64));

pub fn normalize(&mut self)

Normalizes a Vec2<f32> into its unit vector representation. This results in an an expensive square root calculation.

Examples

use gamemath::Vec2;

let mut v = Vec2::new(3.0_f64, 4.0_f64);

v.normalize();

assert_eq!(v, Vec2::new(0.6_f64, 0.8_f64));

Trait Implementations

impl<T: Add<Output = T>> Add<Vec2<T>> for Vec2<T>

type Output = Vec2<T>

The resulting type after applying the + operator.

fn add(self, right: Vec2<T>) -> Vec2<T>

Performs the + operation.

impl<T: AddAssign> AddAssign<Vec2<T>> for Vec2<T>

fn add_assign(&mut self, right: Vec2<T>)

Performs the += operation.

impl<T: Clone> Clone for Vec2<T>

fn clone(&self) -> Vec2<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Vec2<T>

impl<T: Debug> Debug for Vec2<T>

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

Formats the value using the given formatter.

impl<T> Default for Vec2<T> where
    T: Default, 

fn default() -> Vec2<T>

Returns the "default value" for a type.

impl<T: Copy> From<[T; 2]> for Vec2<T>

fn from(slice: [T; 2]) -> Vec2<T>

Performs the conversion.

impl<T> From<(T, T)> for Vec2<T>

fn from(tuple: (T, T)) -> Vec2<T>

Performs the conversion.

impl<T: Copy> From<T> for Vec2<T>

fn from(value: T) -> Vec2<T>

Performs the conversion.

impl<T: Default> From<Vec2<T>> for Vec3<T>

fn from(vec: Vec2<T>) -> Vec3<T>

Performs the conversion.

impl<T: Default> From<Vec2<T>> for Vec4<T>

fn from(vec: Vec2<T>) -> Vec4<T>

Performs the conversion.

impl<T> From<Vec3<T>> for Vec2<T>

fn from(vector: Vec3<T>) -> Vec2<T>

Performs the conversion.

impl<T> From<Vec4<T>> for Vec2<T>

fn from(vector: Vec4<T>) -> Vec2<T>

Performs the conversion.

impl<T> Index<usize> for Vec2<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Vec2<T>

fn index_mut(&mut self, index: usize) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T: Mul<Output = T> + Copy> Mul<T> for Vec2<T>

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, right: T) -> Vec2<T>

Performs the * operation.

impl Mul<Vec2<f32>> for Mat2

type Output = Vec2<f32>

The resulting type after applying the * operator.

fn mul(self, vec: Vec2<f32>) -> Vec2<f32>

Performs the * operation.

impl<T: MulAssign + Copy> MulAssign<T> for Vec2<T>

fn mul_assign(&mut self, right: T)

Performs the *= operation.

impl<T: Neg<Output = T>> Neg for Vec2<T>

type Output = Vec2<T>

The resulting type after applying the - operator.

fn neg(self) -> Vec2<T>

Performs the unary - operation.

impl<T: PartialEq> PartialEq<Vec2<T>> for Vec2<T>

fn eq(&self, other: &Vec2<T>) -> bool

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

fn ne(&self, other: &Vec2<T>) -> bool

This method tests for !=.

impl<T> StructuralPartialEq for Vec2<T>

impl<T: Sub<Output = T>> Sub<Vec2<T>> for Vec2<T>

type Output = Vec2<T>

The resulting type after applying the - operator.

fn sub(self, right: Vec2<T>) -> Vec2<T>

Performs the - operation.

impl<T: SubAssign> SubAssign<Vec2<T>> for Vec2<T>

fn sub_assign(&mut self, right: Vec2<T>)

Performs the -= operation.