Struct gramit::vec::Vec2

#[repr(C)]
pub struct Vec2 {
    pub x: f32,
    pub y: f32,
}

Fields

x: f32

y: f32

Methods

impl Vec2

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

Create a new vector with the given components.

pub fn x() -> Self

Create a unit vector along this axis.

pub fn y() -> Self

Create a unit vector along this axis.

pub fn angle_between(&self, other: &Vec2) -> Angle

Get the angle between this vector and another.

impl Vec2

pub fn extend(self, z: f32) -> Vec3

Extend this Vec2 to a Vec3, with the given z component.

Trait Implementations

impl ApproxEq<Vec2> for Vec2

fn approx_eq(self, rhs: Vec2) -> bool

Compare two values for approximate equality, using a default difference treshold.

fn within_threshold(self, rhs: Vec2, threshold: Vec2) -> bool

Compare two vectors for approximate equality.

Uses a third vector for component-wise thresholds.

impl Vector for Vec2

type Scalar = f32

The scalar type over which this vector type is defined.

const DIMS: usize

The dimension of this vector type.

fn length(&self) -> f32

The length (norm) of this vector.

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

The dot (scalar) product of this vector with another.

fn ones() -> Self

Returns a vector of all 1's.

fn zeros() -> Self

Returns a vector of all 0's.

fn unit(&self) -> Self

Returns the normalized (unit-length) version of this vector.

fn scalar_mul(&self, s: &f32) -> Self

The scalar multiplication operation.

fn vector_add(&self, v: &Self) -> Self

The vector addition operation.

impl AsMut<[f32]> for Vec2

fn as_mut(&mut self) -> &mut [f32]

Performs the conversion.

impl AsRef<[f32]> for Vec2

fn as_ref(&self) -> &[f32]

Performs the conversion.

impl Into<Vec<f32>> for Vec2

fn into(self) -> Vec<f32>

Performs the conversion.

impl Clone for Vec2

fn clone(&self) -> Vec2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec2

impl Default for Vec2

fn default() -> Vec2

Returns the "default value" for a type.

impl PartialEq<Vec2> for Vec2

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

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

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

This method tests for !=.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Div<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_> Div<&'_ Vec2> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: &Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_> Div<Vec2> for &'_ Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_, '_> Div<&'_ Vec2> for &'_ Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: &Vec2) -> Vec2

Component-wise arithemetic operation.

impl Div<f32> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Vec2

Performs the / operation.

impl<'_> Div<&'_ f32> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: &f32) -> Vec2

Performs the / operation.

impl<'_> Div<f32> for &'_ Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Vec2

Performs the / operation.

impl<'_, '_> Div<&'_ f32> for &'_ Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, rhs: &f32) -> Vec2

Performs the / operation.

impl Sub<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_> Sub<&'_ Vec2> for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_> Sub<Vec2> for &'_ Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_, '_> Sub<&'_ Vec2> for &'_ Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2) -> Vec2

Component-wise arithemetic operation.

impl Add<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the + operator.

fn add(self, rhs: Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_> Add<&'_ Vec2> for Vec2

type Output = Vec2

The resulting type after applying the + operator.

fn add(self, rhs: &Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_> Add<Vec2> for &'_ Vec2

type Output = Vec2

The resulting type after applying the + operator.

fn add(self, rhs: Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_, '_> Add<&'_ Vec2> for &'_ Vec2

type Output = Vec2

The resulting type after applying the + operator.

fn add(self, rhs: &Vec2) -> Vec2

Component-wise arithemetic operation.

impl Mul<Vec2> for Mat2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Vec2

Matrix-vector multiplication operation.

impl<'_> Mul<&'_ Vec2> for Mat2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec2) -> Vec2

Matrix-vector multiplication operation.

impl<'_> Mul<Vec2> for &'_ Mat2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Vec2

Matrix-vector multiplication operation.

impl<'_, '_> Mul<&'_ Vec2> for &'_ Mat2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec2) -> Vec2

Matrix-vector multiplication operation.

impl Mul<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_> Mul<&'_ Vec2> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_> Mul<Vec2> for &'_ Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Vec2

Component-wise arithemetic operation.

impl<'_, '_> Mul<&'_ Vec2> for &'_ Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec2) -> Vec2

Component-wise arithemetic operation.

impl Mul<f32> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Vec2

Performs the * operation.

impl Mul<Vec2> for f32

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Vec2

Performs the * operation.

impl<'_> Mul<&'_ f32> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: &f32) -> Vec2

Performs the * operation.

impl<'_> Mul<Vec2> for &'_ f32

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Vec2

Performs the * operation.

impl<'_> Mul<f32> for &'_ Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Vec2

Performs the * operation.

impl<'_> Mul<&'_ Vec2> for f32

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec2) -> Vec2

Performs the * operation.

impl<'_, '_> Mul<&'_ f32> for &'_ Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: &f32) -> Vec2

Performs the * operation.

impl<'_, '_> Mul<&'_ Vec2> for &'_ f32

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: &Vec2) -> Vec2

Performs the * operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Vec2

Performs the unary - operation.

impl<'_> Neg for &'_ Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Vec2

Performs the unary - operation.

impl AddAssign<Vec2> for Vec2

fn add_assign(&mut self, rhs: Vec2)

Component-wise arithmetic assignment operation.

impl<'_> AddAssign<&'_ Vec2> for Vec2

fn add_assign(&mut self, rhs: &Vec2)

Component-wise arithmetic assignment operation.

impl SubAssign<Vec2> for Vec2

fn sub_assign(&mut self, rhs: Vec2)

Component-wise arithmetic assignment operation.

impl<'_> SubAssign<&'_ Vec2> for Vec2

fn sub_assign(&mut self, rhs: &Vec2)

Component-wise arithmetic assignment operation.

impl MulAssign<Vec2> for Vec2

fn mul_assign(&mut self, rhs: Vec2)

Component-wise arithmetic assignment operation.

impl<'_> MulAssign<&'_ Vec2> for Vec2

fn mul_assign(&mut self, rhs: &Vec2)

Component-wise arithmetic assignment operation.

impl MulAssign<f32> for Vec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl<'_> MulAssign<&'_ f32> for Vec2

fn mul_assign(&mut self, rhs: &f32)

Performs the *= operation.

impl DivAssign<Vec2> for Vec2

fn div_assign(&mut self, rhs: Vec2)

Component-wise arithmetic assignment operation.

impl<'_> DivAssign<&'_ Vec2> for Vec2

fn div_assign(&mut self, rhs: &Vec2)

Component-wise arithmetic assignment operation.

impl DivAssign<f32> for Vec2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl<'_> DivAssign<&'_ f32> for Vec2

fn div_assign(&mut self, rhs: &f32)

Performs the /= operation.

impl Index<usize> for Vec2

type Output = f32

The returned type after indexing.

fn index(&self, idx: usize) -> &f32

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec2

fn index_mut(&mut self, idx: usize) -> &mut f32

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

impl StructuralPartialEq for Vec2