Struct vec2 

#[repr(C)]
pub struct vec2<T>(pub T, pub T);

2 dimensional vector.

Tuple Fields

0: T

1: T

Implementations

impl<T> vec2<T>

pub fn extend(self, z: T) -> vec3<T>

Extend into a 3-d vector.

Examples

assert_eq!(vec2(1, 2).extend(3), vec3(1, 2, 3));

pub fn map<U, F: Fn(T) -> U>(self, f: F) -> vec2<U>

Map every component (coordinate)

pub fn zip<U>(self, v: vec2<U>) -> vec2<(T, U)>

Zip two vectors together

impl<T: Clone> vec2<T>

pub fn splat(value: T) -> Self

Construct a vector with all components set to specified value

impl<T: UNum> vec2<T>

pub const ZERO: Self

A zero 2-d vector

pub const UNIT_X: Self

A unit X

pub const UNIT_Y: Self

A unit Y

impl<T: Num> vec2<T>

pub fn dot(a: Self, b: Self) -> T

Calculate dot product of two vectors.

Examples

assert_eq!(vec2::dot(vec2(1, 2), vec2(3, 4)), 11);

pub fn skew(a: Self, b: Self) -> T

Calculate skew product of two vectors.

Examples

assert_eq!(vec2::skew(vec2(1, 2), vec2(3, 4)), -2);

impl<T: Neg<Output = T>> vec2<T>

pub fn rotate_90(self) -> Self

Rotate a vector by 90 degrees counter clockwise.

Examples

let v = vec2(3.0, 4.0);
assert_eq!(v.rotate_90(), vec2(-4.0, 3.0));

impl<T: Float> vec2<T>

pub fn normalize(self) -> Self

Normalize a vector.

Examples

let v: vec2<f64> = vec2(1.0, 2.0);
assert!((v.normalize().len() - 1.0).abs() < 1e-5);

pub fn normalize_or_zero(self) -> Self

Normalizes a vector unless its length its approximately 0. Can be used to avoid division by 0.

Examples

let v = vec2(1.0, 2.0);
assert_eq!(v.normalize_or_zero(), v.normalize());
let v = vec2(1e-10, 1e-10);
assert_eq!(v.normalize_or_zero(), vec2::ZERO);

pub fn len(self) -> T

Calculate length of a vector.

Examples

let v = vec2(3.0, 4.0);
assert_eq!(v.len(), 5.0);

pub fn len_sqr(self) -> T

Calculate squared length of this vector

pub fn rotate(self, angle: Angle<T>) -> Self

Rotate a vector by a given angle.

Examples

let v = vec2(1.0, 2.0);
assert!((v.rotate(Angle::from_radians(std::f32::consts::FRAC_PI_2)) - vec2(-2.0, 1.0)).len() < 1e-5);

pub fn clamp_len(self, len_range: impl FixedRangeBounds<T>) -> Self

Clamp vector’s length. Note that the range must be inclusive.

Examples

let v = vec2(1.0, 2.0);
assert_eq!(v.clamp_len(..=1.0), v.normalize());

pub fn clamp_coordinates( self, x_range: impl FixedRangeBounds<T>, y_range: impl FixedRangeBounds<T>, ) -> Self

Clamp vector in range. Note the range must be inclusive.

Examples

let v = vec2(1.0, 2.0);
assert_eq!(v.clamp_coordinates(.., 0.0..=1.0), vec2(1.0, 1.0));

pub fn clamp_aabb(self, aabb: Aabb2<T>) -> Self

Clamp vector by aabb corners.

Examples

let v = vec2(0.5, 2.0);
let min = vec2(0.0, 0.0);
let max = vec2(1.0, 1.0);
let aabb = Aabb2::from_corners(min, max);
assert_eq!(v.clamp_aabb(aabb), vec2(0.5, 1.0));

pub fn arg(self) -> Angle<T>

Get an angle between the positive direction of the x-axis.

Examples

let v = vec2(0.0, 1.0);
assert_eq!(v.arg().as_radians(), std::f32::consts::FRAC_PI_2);

pub fn transform(self, transform: mat3<T>) -> Self

Apply transformation matrix

pub fn aspect(self) -> T

Calculate aspect ratio (x / y)

Trait Implementations

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

type Output = vec2<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: AddAssign> AddAssign for vec2<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: Clone> Clone for vec2<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for vec2<T>

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

Formats the value using the given formatter.

impl<T> Deref for vec2<T>

type Target = XY<T>

The resulting type after dereferencing.

fn deref(&self) -> &XY<T>

Dereferences the value.

impl<T> DerefMut for vec2<T>

fn deref_mut(&mut self) -> &mut XY<T>

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for vec2<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for vec2<T>

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

Formats the value using the given formatter.

impl<T: Copy + Div<Output = T>> Div<T> for vec2<T>

type Output = vec2<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self

Performs the / operation.

impl<T: Div<Output = T>> Div for vec2<T>

type Output = vec2<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Copy + DivAssign> DivAssign<T> for vec2<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: DivAssign> DivAssign for vec2<T>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<T> From<[T; 2]> for vec2<T>

fn from(v: [T; 2]) -> vec2<T>

Converts to this type from the input type.

impl<T: Hash> Hash for vec2<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

type Output = vec2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self

Performs the * operation.

impl Mul<vec2<f32>> for f32

type Output = vec2<f32>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<f32>) -> vec2<f32>

Performs the * operation.

impl Mul<vec2<f64>> for f64

type Output = vec2<f64>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<f64>) -> vec2<f64>

Performs the * operation.

impl Mul<vec2<i16>> for i16

type Output = vec2<i16>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<i16>) -> vec2<i16>

Performs the * operation.

impl Mul<vec2<i32>> for i32

type Output = vec2<i32>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<i32>) -> vec2<i32>

Performs the * operation.

impl Mul<vec2<i64>> for i64

type Output = vec2<i64>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<i64>) -> vec2<i64>

Performs the * operation.

impl Mul<vec2<i8>> for i8

type Output = vec2<i8>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<i8>) -> vec2<i8>

Performs the * operation.

impl Mul<vec2<isize>> for isize

type Output = vec2<isize>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<isize>) -> vec2<isize>

Performs the * operation.

impl Mul<vec2<u16>> for u16

type Output = vec2<u16>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<u16>) -> vec2<u16>

Performs the * operation.

impl Mul<vec2<u32>> for u32

type Output = vec2<u32>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<u32>) -> vec2<u32>

Performs the * operation.

impl Mul<vec2<u64>> for u64

type Output = vec2<u64>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<u64>) -> vec2<u64>

Performs the * operation.

impl Mul<vec2<u8>> for u8

type Output = vec2<u8>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<u8>) -> vec2<u8>

Performs the * operation.

impl Mul<vec2<usize>> for usize

type Output = vec2<usize>

The resulting type after applying the * operator.

fn mul(self, rhs: vec2<usize>) -> vec2<usize>

Performs the * operation.

impl<T: Mul<Output = T>> Mul for vec2<T>

type Output = vec2<T>

The resulting type after applying the * operator.

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

Performs the * operation.

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

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: MulAssign> MulAssign for vec2<T>

fn mul_assign(&mut self, rhs: Self)

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) -> Self

Performs the unary - operation.

impl<T: PartialEq> PartialEq for vec2<T>

fn eq(&self, other: &vec2<T>) -> 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<T> Serialize for vec2<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

type Output = vec2<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: SubAssign> SubAssign for vec2<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<T: Copy> Copy for vec2<T>

impl<T: Eq> Eq for vec2<T>

impl<T> StructuralPartialEq for vec2<T>