Struct TypedVector3D

Source

#[repr(C)]pub struct TypedVector3D<T, U> {
    pub x: T,
    pub y: T,
    pub z: T,
    /* private fields */
}

Expand description

A 3d Vector tagged with a unit.

Fields§

§x: T§y: T§z: T

Implementations§

Source §

impl<T, U> TypedVector3D<T, U>
where T: Copy + Zero,

Source

pub fn zero() -> TypedVector3D<T, U>

Constructor, setting all components to zero.

Source

pub fn new(x: T, y: T, z: T) -> TypedVector3D<T, U>

Constructor taking scalar values directly.

Source §

impl<T, U> TypedVector3D<T, U>
where T: Copy,

Source

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

Constructor taking properly typed Lengths instead of scalar values.

Source

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

Cast this vector into a point.

Equivalent to adding this vector to the origin.

Source

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

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

Source

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

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

Source

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

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

Source

pub fn x_typed(&self) -> Length<T, U>

Returns self.x as a Length carrying the unit.

Source

pub fn y_typed(&self) -> Length<T, U>

Returns self.y as a Length carrying the unit.

Source

pub fn z_typed(&self) -> Length<T, U>

Returns self.z as a Length carrying the unit.

Source

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

Source

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

Source

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

Drop the units, preserving only the numeric value.

Source

pub fn from_untyped(p: &TypedVector3D<T, UnknownUnit>) -> TypedVector3D<T, U>

Tag a unitless value with units.

Source

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

Convert into a 2d vector.

Source §

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

Source

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

Source §

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

Source

pub fn dot(self, other: TypedVector3D<T, U>) -> T

Source

pub fn cross(self, other: TypedVector3D<T, U>) -> TypedVector3D<T, U>

Source

pub fn normalize(self) -> TypedVector3D<T, U>
where T: Float,

Source

pub fn robust_normalize(self) -> TypedVector3D<T, U>
where T: Float,

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

Source

pub fn square_length(&self) -> T

Source

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

Source §

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

Source

pub fn lerp(&self, other: TypedVector3D<T, U>, t: T) -> TypedVector3D<T, U>

Linearly interpolate between this vector and another vector.

t is expected to be between zero and one.

Source §

impl<T, U> TypedVector3D<T, U>
where T: Float,

Source

pub fn min(self, other: TypedVector3D<T, U>) -> TypedVector3D<T, U>

Source

pub fn max(self, other: TypedVector3D<T, U>) -> TypedVector3D<T, U>

Source

pub fn clamp( &self, start: TypedVector3D<T, U>, end: TypedVector3D<T, U>, ) -> TypedVector3D<T, U>

Source §

impl<T, U> TypedVector3D<T, U>
where T: Round,

Source

pub fn round(&self) -> TypedVector3D<T, U>

Rounds each component to the nearest integer value.

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

Source §

impl<T, U> TypedVector3D<T, U>
where T: Ceil,

Source

pub fn ceil(&self) -> TypedVector3D<T, U>

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

Source §

impl<T, U> TypedVector3D<T, U>
where T: Floor,

Source

pub fn floor(&self) -> TypedVector3D<T, U>

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

Source §

impl<T, U> TypedVector3D<T, U>
where T: NumCast + Copy,

Source

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

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.

Source

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

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.

Source

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

Cast into an f32 vector.

Source

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

Cast into an f64 vector.

Source

pub fn to_usize(&self) -> TypedVector3D<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.

Source

pub fn to_u32(&self) -> TypedVector3D<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.

Source

pub fn to_i32(&self) -> TypedVector3D<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.

Source

pub fn to_i64(&self) -> TypedVector3D<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.

Source §