Struct vec3 

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

3 dimensional vector.

Tuple Fields

0: T

1: T

2: T

Implementations

impl<T> vec3<T>

pub fn xy(self) -> vec2<T>

Get the first two components as a vec2

pub fn extend(self, w: T) -> vec4<T>

Extend with another component and get a vec4

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

Map every component (coordinate)

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

Zip two vectors together

impl<T: Clone> vec3<T>

pub fn splat(value: T) -> Self

Construct a vector with all components set to specified value

impl<T: UNum> vec3<T>

pub const ZERO: Self

A zero 3-d vector

pub const UNIT_X: Self

A unit X

pub const UNIT_Y: Self

A unit Y

pub const UNIT_Z: Self

A unit Z

impl<T: Copy + Num> vec3<T>

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

Calculate dot product of two vectors.

Examples

assert_eq!(vec3::dot(vec3(1, 2, 3), vec3(3, 4, 5)), 26);

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

Calculate cross product of two vectors.

Examples

assert_eq!(vec3::cross(vec3(1, 2, 3), vec3(3, 4, 5)), vec3(-2, 4, -2));

impl<T: Float> vec3<T>

pub fn normalize(self) -> Self

Normalize a vector.

Examples

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

pub fn normalize_or_zero(self) -> Self

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

Uses Approx::approx_eq to determine equality to zero

Examples

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

pub fn len(self) -> T

Calculate length of a vector.

pub fn len_sqr(self) -> T

Calculate squared length of this vector

pub fn into_2d(self) -> vec2<T>

Convert a homogenous 3d vector into 2d

Same as self.xy() / self.z

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 = vec3(1.0, 2.0, 3.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>, z_range: impl FixedRangeBounds<T>, ) -> Self

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

Examples

let v = vec3(1.0, 2.0, 3.0);
assert_eq!(v.clamp_coordinates(.., 0.0..=1.0, 5.0..), vec3(1.0, 1.0, 5.0));

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

Apply transformation matrix

Trait Implementations

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

type Output = vec3<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: AddAssign> AddAssign for vec3<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: Clone> Clone for vec3<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for vec3<T>

impl<T: Debug> Debug for vec3<T>

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

Formats the value using the given formatter.

impl<T> Deref for vec3<T>

type Target = XYZ<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for vec3<T>

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

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for vec3<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 vec3<T>

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

Formats the value using the given formatter.

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

type Output = vec3<T>

The resulting type after applying the / operator.

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

Performs the / operation.

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

type Output = vec3<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: DivAssign> DivAssign for vec3<T>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

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

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: Eq> Eq for vec3<T>

impl<T> From<[T; 3]> for vec3<T>

fn from(v: [T; 3]) -> vec3<T>

Converts to this type from the input type.

impl<T: Hash> Hash for vec3<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: Mul<Output = T>> Mul for vec3<T>

type Output = vec3<T>

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = vec3<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Num + Copy> Mul<vec3<T>> for mat3<T>

type Output = vec3<T>

The resulting type after applying the * operator.

fn mul(self, rhs: vec3<T>) -> vec3<T>

Performs the * operation.

impl Mul<vec3<f32>> for f32

type Output = vec3<f32>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<f64>> for f64

type Output = vec3<f64>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<i8>> for i8

type Output = vec3<i8>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<i16>> for i16

type Output = vec3<i16>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<i32>> for i32

type Output = vec3<i32>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<i64>> for i64

type Output = vec3<i64>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<isize>> for isize

type Output = vec3<isize>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<u8>> for u8

type Output = vec3<u8>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<u16>> for u16

type Output = vec3<u16>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<u32>> for u32

type Output = vec3<u32>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<u64>> for u64

type Output = vec3<u64>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<vec3<usize>> for usize

type Output = vec3<usize>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: MulAssign> MulAssign for vec3<T>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

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

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

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

type Output = vec3<T>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: PartialEq> PartialEq for vec3<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for vec3<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: PartialEq> StructuralPartialEq for vec3<T>

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

type Output = vec3<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: SubAssign> SubAssign for vec3<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.