Struct batbox::Vec3

#[repr(C)]pub struct Vec3<T> {
    pub x: T,
    pub y: T,
    pub z: T,
}

3 dimensional vector.

Fields

x: T

x coordinate of the vector

y: T

y coordinate of the vector

z: T

z coordinate of the vector

Implementations

impl<T> Vec3<T>

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

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

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

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

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

Calculate dot product of two vectors.

Examples

use batbox::*;
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

use batbox::*;
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

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

pub fn len(self) -> T

Calculate length of a vector.

pub fn clamp(self, max_len: T) -> Self

Methods from Deref<Target = [T; 3]>

pub fn as_slice(&self) -> &[T]

🔬 This is a nightly-only experimental API. (array_methods)

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

🔬 This is a nightly-only experimental API. (array_methods)

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

🔬 This is a nightly-only experimental API. (array_methods)

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods, array_map)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

🔬 This is a nightly-only experimental API. (array_methods)

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

#![feature(array_methods)]

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

Trait Implementations

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

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: AddAssign> AddAssign<Vec3<T>> 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 copy of the value.

pub 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 = [T; 3]

The resulting type after dereferencing.

fn deref(&self) -> &[T; 3]

Dereferences the value.

impl<T> DerefMut for Vec3<T>

fn deref_mut(&mut self) -> &mut [T; 3]

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: Copy + Div<Output = T>> Div<T> for Vec3<T>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

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

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> 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: DivAssign> DivAssign<Vec3<T>> for Vec3<T>

fn div_assign(&mut self, rhs: Self)

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>

Performs the conversion.

impl<T: Hash> Hash for Vec3<T>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> 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: MulAssign> MulAssign<Vec3<T>> for Vec3<T>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

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

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: PartialEq> PartialEq<Vec3<T>> for Vec3<T>

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

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

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

This method tests for !=.

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> StructuralEq for Vec3<T>

impl<T> StructuralPartialEq for Vec3<T>

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

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: SubAssign> SubAssign<Vec3<T>> for Vec3<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.