Struct euclid::Vector3D

#[repr(C)]
pub struct Vector3D<T, U> {
    pub x: T,
    pub y: T,
    pub z: T,
    // some fields omitted
}

A 3d Vector tagged with a unit.

Fields

x: T

y: T

z: T

Methods

impl<T: Copy + Zero, U> Vector3D<T, U>

pub fn zero() -> Self

Constructor, setting all components to zero.

pub fn to_array_4d(&self) -> [T; 4]

pub fn to_tuple_4d(&self) -> (T, T, T, T)

impl<T, U> Vector3D<T, U>

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

Constructor taking scalar values directly.

impl<T: Copy, U> Vector3D<T, U>

pub fn from_lengths(
    x: Length<T, U>,
    y: Length<T, U>,
    z: Length<T, U>
) -> Vector3D<T, U>

Constructor taking properly Lengths instead of scalar values.

pub fn to_point(&self) -> Point3D<T, U>

Cast this vector into a point.

Equivalent to adding this vector to the origin.

pub fn xy(&self) -> Vector2D<T, U>

Returns a 2d vector using this vector's x and y coordinates

pub fn xz(&self) -> Vector2D<T, U>

Returns a 2d vector using this vector's x and z coordinates

pub fn yz(&self) -> Vector2D<T, U>

Returns a 2d vector using this vector's x and z coordinates

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

pub fn to_tuple(&self) -> (T, T, T)

pub fn to_untyped(&self) -> Vector3D<T, UnknownUnit>

Drop the units, preserving only the numeric value.

pub fn from_untyped(p: Vector3D<T, UnknownUnit>) -> Self

Tag a unitless value with units.

pub fn cast_unit<V>(&self) -> Vector3D<T, V>

Cast the unit

pub fn to_2d(&self) -> Vector2D<T, U>

Convert into a 2d vector.

impl<T, U> Vector3D<T, U> where
    T: Copy + Clone + Add<T, Output = T> + Mul<T, Output = T> + Div<T, Output = T> + Sub<T, Output = T> + Trig + PartialOrd + One + Zero + Neg<Output = T>, 

pub fn to_transform(&self) -> Transform3D<T, U, U>

impl<T, U> Vector3D<T, U> where
    T: Copy + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Trig + Float, 

pub fn angle_to(&self, other: Self) -> Angle<T>

Returns the positive angle between this vector and another vector.

The returned angle is between 0 and PI.

impl<T: Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + Copy, U> Vector3D<T, U>

pub fn dot(self, other: Self) -> T

pub fn cross(self, other: Self) -> Self

pub fn normalize(self) -> Self where
    T: Float, 

pub fn robust_normalize(self) -> Self where
    T: Float, 

Return the normalized vector even if the length is larger than the max value of Float.

pub fn square_length(&self) -> T

pub fn length(&self) -> T where
    T: Float, 

pub fn project_onto_vector(&self, onto: Self) -> Self where
    T: Div<T, Output = T>, 

Returns this vector projected onto another one.

Projecting onto a nil vector will cause a division by zero.

impl<T, U> Vector3D<T, U> where
    T: Copy + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T> + PartialOrd + Float, 

pub fn with_max_length(&self, max_length: T) -> Self

Return this vector capped to a maximum length.

pub fn with_min_length(&self, min_length: T) -> Self

Return this vector with a minimum length applied.

pub fn clamp_length(&self, min: T, max: T) -> Self

Return this vector with minimum and maximum lengths applied.

impl<T, U> Vector3D<T, U> where
    T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>, 

pub fn lerp(&self, other: Self, t: T) -> Self

Linearly interpolate between this vector and another vector.

t is expected to be between zero and one.

impl<T, U> Vector3D<T, U> where
    T: Copy + One + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T>, 

pub fn reflect(&self, normal: Self) -> Self

Returns a reflection vector using an incident ray and a surface normal.

impl<T: Float, U> Vector3D<T, U>

pub fn min(self, other: Self) -> Self

pub fn max(self, other: Self) -> Self

pub fn clamp(&self, start: Self, end: Self) -> Self

impl<T: Round, U> Vector3D<T, U>

#[must_use] pub fn round(&self) -> Self

Rounds each component to the nearest integer value.

This behavior is preserved for negative values (unlike the basic cast).

impl<T: Ceil, U> Vector3D<T, U>

#[must_use] pub fn ceil(&self) -> Self

Rounds each component to the smallest integer equal or greater than the original value.

This behavior is preserved for negative values (unlike the basic cast).

impl<T: Floor, U> Vector3D<T, U>

#[must_use] pub fn floor(&self) -> Self

Rounds each component to the biggest integer equal or lower than the original value.

This behavior is preserved for negative values (unlike the basic cast).

impl<T: NumCast + Copy, U> Vector3D<T, U>

pub fn cast<NewT: NumCast + Copy>(&self) -> Vector3D<NewT, U>

Cast from one numeric representation to another, preserving the units.

When casting from floating vector to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn try_cast<NewT: NumCast + Copy>(&self) -> Option<Vector3D<NewT, U>>

Fallible cast from one numeric representation to another, preserving the units.

When casting from floating vector to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn to_f32(&self) -> Vector3D<f32, U>

Cast into an f32 vector.

pub fn to_f64(&self) -> Vector3D<f64, U>

Cast into an f64 vector.

pub fn to_usize(&self) -> Vector3D<usize, U>

Cast into an usize vector, truncating decimals if any.

When casting from floating vector vectors, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_u32(&self) -> Vector3D<u32, U>

Cast into an u32 vector, truncating decimals if any.

When casting from floating vector vectors, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i32(&self) -> Vector3D<i32, U>

Cast into an i32 vector, truncating decimals if any.

When casting from floating vector vectors, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i64(&self) -> Vector3D<i64, U>

Cast into an i64 vector, truncating decimals if any.

When casting from floating vector vectors, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

impl<T, U> Vector3D<T, U> where
    T: Signed, 

pub fn abs(&self) -> Self

impl<T: PartialOrd, U> Vector3D<T, U>

pub fn greater_than(&self, other: Self) -> BoolVector3D

pub fn lower_than(&self, other: Self) -> BoolVector3D

impl<T: PartialEq, U> Vector3D<T, U>

pub fn equal(&self, other: Self) -> BoolVector3D

pub fn not_equal(&self, other: Self) -> BoolVector3D

Trait Implementations

impl<T: Copy + ApproxEq<T>, U> ApproxEq<Vector3D<T, U>> for Vector3D<T, U>

fn approx_epsilon() -> Self

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

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

impl<T: Zero, U> From<Vector3D<T, U>> for HomogeneousVector<T, U>

fn from(v: Vector3D<T, U>) -> Self

Performs the conversion.

impl<T: Float + ApproxEq<T>, Src, Dst> From<Vector3D<T, Dst>> for RigidTransform3D<T, Src, Dst>

fn from(t: Vector3D<T, Dst>) -> Self

Performs the conversion.

impl<T, Src, Dst> From<Vector3D<T, Src>> for Translation3D<T, Src, Dst> where
    T: Copy, 

fn from(v: Vector3D<T, Src>) -> Self

Performs the conversion.

impl<T: Copy, U> From<[T; 3]> for Vector3D<T, U>

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

Performs the conversion.

impl<T: Copy, U> From<(T, T, T)> for Vector3D<T, U>

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

Performs the conversion.

impl<T: Display, U> Display for Vector3D<T, U>

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

Formats the value using the given formatter.

impl<T: Debug, U> Debug for Vector3D<T, U>

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

Formats the value using the given formatter.

impl<T: Copy + Div<T, Output = T>, U> Div<T> for Vector3D<T, U>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Copy + Div<T, Output = T>, U1, U2> Div<Scale<T, U1, U2>> for Vector3D<T, U2>

type Output = Vector3D<T, U1>

The resulting type after applying the / operator.

fn div(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the / operation.

impl<T: Copy + Sub<T, Output = T>, U> Sub<Vector3D<T, U>> for Point3D<T, U>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Vector3D<T, U>) -> Self

Performs the - operation.

impl<T: Copy + Sub<T, Output = T>, U> Sub<Vector3D<T, U>> for Vector3D<T, U>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, U> PartialEq<Vector3D<T, U>> for Vector3D<T, U> where
    T: PartialEq, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T, U> Eq for Vector3D<T, U> where
    T: Eq, 

impl<T: Copy + Add<T, Output = T>, U> Add<Vector3D<T, U>> for Point3D<T, U>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Vector3D<T, U>) -> Self

Performs the + operation.

impl<T: Copy + Add<T, Output = T>, U> Add<Vector3D<T, U>> for Vector3D<T, U>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Copy + Mul<T, Output = T>, U> Mul<T> for Vector3D<T, U>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<Scale<T, U1, U2>> for Vector3D<T, U1>

type Output = Vector3D<T, U2>

The resulting type after applying the * operator.

fn mul(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the * operation.

impl<T: Copy + Neg<Output = T>, U> Neg for Vector3D<T, U>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector3D<T, U>> for Point3D<T, U>

fn add_assign(&mut self, other: Vector3D<T, U>)

Performs the += operation.

impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector3D<T, U>> for Vector3D<T, U>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector3D<T, U>> for Point3D<T, U>

fn sub_assign(&mut self, other: Vector3D<T, U>)

Performs the -= operation.

impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector3D<T, U>> for Vector3D<T, U>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for Vector3D<T, U>

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for Vector3D<T, U>

fn div_assign(&mut self, scale: T)

Performs the /= operation.

impl<T, U> Hash for Vector3D<T, U> where
    T: Hash, 

fn hash<H: Hasher>(&self, h: &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: Copy, U> Copy for Vector3D<T, U>

impl<T, Src, Dst> Into<Vector3D<T, Src>> for Translation3D<T, Src, Dst> where
    T: Copy, 

fn into(self) -> Vector3D<T, Src>

Performs the conversion.

impl<T: Copy, U> Into<[T; 3]> for Vector3D<T, U>

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

Performs the conversion.

impl<T: Copy, U> Into<(T, T, T)> for Vector3D<T, U>

fn into(self) -> (T, T, T)

Performs the conversion.

impl<T: Clone, U> Clone for Vector3D<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default, U> Default for Vector3D<T, U>

fn default() -> Self

Returns the "default value" for a type.