Struct fixed_vectors::Vector3

pub struct Vector3<T> {
    pub x: T,
    pub y: T,
    pub z: T,
}

Vector Struct for representing a three-dimensional value.

Fields

x: T

Represents the first dimensional value.

y: T

Represents the second dimensional value.

z: T

Represents the third dimensional value.

Implementations

impl<T> Vector3<T>

pub const NAME: &'static str = "Vector3"

Name of the Vector Struct as a static str.

pub const SIZE: usize = core::mem::size_of::() * 3

Size of the Vector in Bytes, calculated based of size_of::<T>() * Vector::LEN.

pub const LEN: usize = 3usize

Number of fields in the Vector Struct as a usize.

pub const fn new(x: T, y: T, z: T) -> Vector3<T>

Creates a new Vector with the specified values for the fields.

Example

let vector = Vector2::new("Vector", "2");
assert_eq!(vector.x, "Vector");
assert_eq!(vector.y, "2");

impl<T: PartialOrd + Copy> Vector3<T>

pub fn max(&self) -> T

Returns the maximum value contained within the Vector.

Example

let vector = Vector3::new(1, 0, 2);
assert_eq!(vector.max(), 2);

pub fn min(&self) -> T

Returns the minimum value contained within the Vector.

Example

let vector = Vector3::new(1, 0, 2);
assert_eq!(vector.min(), 0);

Trait Implementations

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

type Output = Vector3<T>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<T: Add<Output = T> + Copy> AddAssign<Vector3<T>> for Vector3<T>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: BitAnd<Output = T>> BitAnd<Vector3<T>> for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self::Output

Performs the & operation.

impl<T: BitAnd<Output = T> + Copy> BitAndAssign<Vector3<T>> for Vector3<T>

fn bitand_assign(&mut self, other: Self)

Performs the &= operation.

impl<T: BitOr<Output = T>> BitOr<Vector3<T>> for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self::Output

Performs the | operation.

impl<T: BitOr<Output = T> + Copy> BitOrAssign<Vector3<T>> for Vector3<T>

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl<T: BitXor<Output = T>> BitXor<Vector3<T>> for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the ^ operator.

fn bitxor(self, other: Self) -> Self::Output

Performs the ^ operation.

impl<T: BitXor<Output = T> + Copy> BitXorAssign<Vector3<T>> for Vector3<T>

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

impl<T: Copy> Clone for Vector3<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Vector3<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Vector3<T>

fn default() -> Vector3<T>

Returns the “default value” for a type.

impl<T: Display> Display for Vector3<T>

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

Formats the value using the given formatter.

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

type Output = Vector3<T>

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl<T: Div<Output = T> + Copy> DivAssign<Vector3<T>> for Vector3<T>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T: Float> FloatingPointVector<T, 3_usize> for Vector3<T>

fn zero(self) -> Self

Converts all numbers within the FloatingPointVector to zero.

fn floor(self) -> Self

Converts all numbers within the FloatingPointVector to the largest integer less than or equal to the value.

fn ceil(self) -> Self

Converts all numbers within the FloatingPointVector to the largest integer greater than or equal to the value.

fn round(self) -> Self

Converts all numbers within the FloatingPointVector to the nearest integer.

fn abs(self) -> Self

Converts all numbers within the FloatingPointVector to their absolute value.

fn powi(self, n: i32) -> Self

Raises all numbers within the FloatingPointVector to an integer power.

fn powf(self, n: T) -> Self

Raises all numbers within the FloatingPointVector to a floating point power.

fn trunc(self) -> Self

Sets all numbers within the FloatingPointVector to their integer parts.

fn fract(self) -> Self

Sets all numbers within the FloatingPointVector to their fractional parts.

fn sqrt(self) -> Self

Sets all numbers within the FloatingPointVector to their square-root.

fn normalized(self) -> Self

Normalizes the FloatingPointVector.

fn lerp(self, to: Self, weight: T) -> Self

Linearly interpolates between two FloatingPointVectors by a normalized weight.

fn dot(self, b: Self) -> T

Returns the dot product of two FloatingPointVectors, this can be used to compare the angle between two FloatingPointVectors.

fn length_squared(self) -> T

Returns the squared magnitude of the FloatingPointVector. This will always run faster than [length], this method should prefered over it if applicable.

fn length(self) -> T where
    Self: Sized, 

Returns the magnitude of the FloatingPointVector.

fn direction(self, to: Self) -> Self where
    Self: Sized + Sub<Output = Self>, 

Returns a normalized FloatingPointVector pointing from it to to.

impl<T: Copy> From<[T; 3]> for Vector3<T>

fn from(arr: [T; 3]) -> Self

Converts to this type from the input type.

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

fn from(tup: (T, T, T)) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Vector3<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, 

Feeds a slice of this type into the given Hasher.

impl<T: PrimInt> IntegerVector<T, 3_usize> for Vector3<T>

fn pow(self, n: u32) -> Self

Raises all numbers within the IntegerVector to the specified power.

impl<T> IntoIterator for Vector3<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Output = Vector3<T>

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl<T: Mul<Output = T> + Copy> MulAssign<Vector3<T>> for Vector3<T>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

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

type Output = Vector3<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: PartialEq> PartialEq<Vector3<T>> for Vector3<T>

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

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

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

This method tests for !=.

impl<T: Rem<Output = T>> Rem<Vector3<T>> for Vector3<T>

type Output = Vector3<T>

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self::Output

Performs the % operation.

impl<T: Rem<Output = T> + Copy> RemAssign<Vector3<T>> for Vector3<T>

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

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

type Output = Vector3<T>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<T: Sub<Output = T> + Copy> SubAssign<Vector3<T>> for Vector3<T>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T: Copy> TryFrom<Vec<T, Global>> for Vector3<T>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(vec: Vec<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TuplableVector<T, { Vector3::<()>::LEN }> for Vector3<T>

type Output = (T, T, T)

fn as_tuple(self) -> Self::Output

Converts the TuplableVector into a tuple representing its values.

impl<T> Vector<T, 3_usize> for Vector3<T>

fn name(&self) -> &'static str

Returns the name of the Vector struct.

fn as_array(self) -> [T; 3]

Converts the given Vector into an array coresponding to the size of the Vector.

fn as_vec(self) -> Vec<T>

Converts the given Vector into a Vec coresponding to the size of the Vector.

fn size(&self) -> usize

Returns the size of the Vector struct in bytes.

fn fields(&self) -> usize

Returns the number of fields in the Vector struct.

impl<T: Copy> Copy for Vector3<T>

impl<T: Eq> Eq for Vector3<T>