Struct ultraviolet::vec::Vec4

#[repr(C)]
pub struct Vec4 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
    pub w: f32,
}

A set of four coordinates which may be interpreted as a point or vector in 4d space, or as a homogeneous 3d vector or point.

Generally this distinction between a point and vector is more of a pain than it is worth to distinguish on a type level, however when converting to and from homogeneous coordinates it is quite important.

Fields

x: f32

y: f32

z: f32

w: f32

Implementations

impl Vec4

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

pub const fn broadcast(val: f32) -> Self

pub fn unit_x() -> Self

pub fn unit_y() -> Self

pub fn unit_z() -> Self

pub fn unit_w() -> Self

pub fn dot(&self, other: Vec4) -> f32

pub fn reflect(&mut self, normal: Vec4)

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

pub fn mag_sq(&self) -> f32

pub fn mag(&self) -> f32

pub fn normalize(&mut self)

pub fn normalized(&self) -> Self

pub fn normalize_homogeneous_point(&mut self)

Normalize self in-place by interpreting it as a homogeneous point, i.e. scaling the vector to ensure the homogeneous component has length 1.

pub fn normalized_homogeneous_point(&self) -> Self

Normalize self by interpreting it as a homogeneous point, i.e. scaling the vector to ensure the homogeneous component has length 1.

pub fn truncated(&self) -> Vec3

Convert self into a Vec3 by simply removing its w component.

pub fn mul_add(&self, mul: Vec4, add: Vec4) -> Self

pub fn abs(&self) -> Self

pub fn clamp(&mut self, min: Self, max: Self)

pub fn clamped(self, min: Self, max: Self) -> Self

pub fn map<F>(&self, f: F) -> Self

where F: FnMut(f32) -> f32,

pub fn apply<F>(&mut self, f: F)

where F: FnMut(f32) -> f32,

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

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

pub fn component_max(&self) -> f32

pub fn component_min(&self) -> f32

pub fn zero() -> Self

pub fn one() -> Self

pub const fn xy(&self) -> Vec2

pub const fn xyz(&self) -> Vec3

pub fn layout() -> Layout

Get the core::alloc::Layout of Self

pub fn as_array(&self) -> &[f32; 4]

Interpret self as a statically-sized array of its base numeric type

pub fn as_mut_array(&mut self) -> &mut [f32; 4]

Interpret self as a statically-sized array of its base numeric type

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

Interpret self as a slice of its base numeric type

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

Interpret self as a slice of its base numeric type

pub fn as_byte_slice(&self) -> &[u8]

pub fn as_mut_byte_slice(&mut self) -> &mut [u8]

pub const fn as_ptr(&self) -> *const f32

Returns a constant unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

pub fn as_mut_ptr(&mut self) -> *mut f32

Returns a mutable unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

impl Vec4

pub fn refract(&mut self, normal: Self, eta: f32)

pub fn refracted(&self, normal: Self, eta: f32) -> Self

Trait Implementations

impl Add for Vec4

type Output = Vec4

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vec4

fn add_assign(&mut self, rhs: Vec4)

Performs the += operation.

impl Clone for Vec4

fn clone(&self) -> Vec4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec4

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

Formats the value using the given formatter.

impl Default for Vec4

fn default() -> Vec4

Returns the “default value” for a type.

impl Div<f32> for Vec4

type Output = Vec4

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Vec4

Performs the / operation.

impl Div for Vec4

type Output = Vec4

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vec4

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl DivAssign for Vec4

fn div_assign(&mut self, rhs: Vec4)

Performs the /= operation.

impl From<&[f32; 4]> for Vec4

fn from(comps: &[f32; 4]) -> Self

Converts to this type from the input type.

impl From<&(f32, f32, f32, f32)> for Vec4

fn from(comps: &(f32, f32, f32, f32)) -> Self

Converts to this type from the input type.

impl From<&mut [f32; 4]> for Vec4

fn from(comps: &mut [f32; 4]) -> Self

Converts to this type from the input type.

impl From<[f32; 4]> for Vec4

fn from(comps: [f32; 4]) -> Self

Converts to this type from the input type.

impl From<(f32, f32, f32, f32)> for Vec4

fn from(comps: (f32, f32, f32, f32)) -> Self

Converts to this type from the input type.

impl From<Vec3> for Vec4

fn from(vec: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec4> for [f32; 4]

fn from(v: Vec4) -> Self

Converts to this type from the input type.

impl From<Vec4> for (f32, f32, f32, f32)

fn from(v: Vec4) -> Self

Converts to this type from the input type.

impl From<Vec4> for Vec3

fn from(vec: Vec4) -> Self

Converts to this type from the input type.

impl From<Vec4> for Vec4x4

fn from(vec: Vec4) -> Self

Converts to this type from the input type.

impl From<Vec4> for Vec4x8

fn from(vec: Vec4) -> Self

Converts to this type from the input type.

impl Index<usize> for Vec4

type Output = f32

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec4

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Lerp<f32> for Vec4

fn lerp(&self, end: Self, t: f32) -> Self

Linearly interpolate between self and end by t between 0.0 and 1.0. i.e. (1.0 - t) * self + (t) * end.

For interpolating Rotors with linear interpolation, you almost certainly want to normalize the returned Rotor. For example,

let interpolated_rotor = rotor1.lerp(rotor2, 0.5).normalized();

For most cases (especially where performance is the primary concern, like in animation interpolation for games, this ‘normalized lerp’ or ‘nlerp’ is probably what you want to use. However, there are situations in which you really want the interpolation between two Rotors to be of constant angular velocity. In this case, check out Slerp.

impl Mul<Vec4> for Mat4

type Output = Vec4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec4> for f32

type Output = Vec4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vec4

type Output = Vec4

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Vec4

Performs the * operation.

impl Mul for Vec4

type Output = Vec4

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vec4

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign for Vec4

fn mul_assign(&mut self, rhs: Vec4)

Performs the *= operation.

impl Neg for Vec4

type Output = Vec4

The resulting type after applying the - operator.

fn neg(self) -> Vec4

Performs the unary - operation.

impl PartialEq for Vec4

fn eq(&self, other: &Vec4) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Slerp<f32> for Vec4

fn slerp(&self, end: Self, t: f32) -> Self

Spherical-linear interpolation between self and end based on t from 0.0 to 1.0.

self and end should both be normalized or something bad will happen!

The implementation for SIMD types also requires that the two things being interpolated between are not exactly aligned, or else the result is undefined.

Basically, interpolation that maintains a constant angular velocity from one orientation on a unit hypersphere to another. This is sorta the “high quality” interpolation for Rotors, and it can also be used to interpolate other things, one example being interpolation of 3d normal vectors.

Note that you should often normalize the result returned by this operation, when working with Rotors, etc!

impl Sub for Vec4

type Output = Vec4

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Vec4

fn sub_assign(&mut self, rhs: Vec4)

Performs the -= operation.

impl Sum for Vec4

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Vec4

impl StructuralPartialEq for Vec4