Struct ultraviolet::vec::DVec4
source · #[repr(C)]pub struct DVec4 {
pub x: f64,
pub y: f64,
pub z: f64,
pub w: f64,
}
Expand description
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: f64
§y: f64
§z: f64
§w: f64
Implementations§
source§impl DVec4
impl DVec4
pub const fn new(x: f64, y: f64, z: f64, w: f64) -> Self
pub const fn broadcast(val: f64) -> 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: DVec4) -> f64
pub fn reflect(&mut self, normal: DVec4)
pub fn reflected(&self, normal: DVec4) -> Self
pub fn mag_sq(&self) -> f64
pub fn mag(&self) -> f64
pub fn normalize(&mut self)
pub fn normalized(&self) -> Self
sourcepub fn normalize_homogeneous_point(&mut 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.
sourcepub fn normalized_homogeneous_point(&self) -> Self
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 mul_add(&self, mul: DVec4, add: DVec4) -> 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) -> Selfwhere F: FnMut(f64) -> f64,
pub fn apply<F>(&mut self, f: F)where F: FnMut(f64) -> f64,
pub fn max_by_component(self, other: Self) -> Self
pub fn min_by_component(self, other: Self) -> Self
pub fn component_max(&self) -> f64
pub fn component_min(&self) -> f64
pub fn zero() -> Self
pub fn one() -> Self
pub const fn xy(&self) -> DVec2
pub const fn xyz(&self) -> DVec3
sourcepub fn layout() -> Layout
pub fn layout() -> Layout
Get the core::alloc::Layout
of Self
sourcepub fn as_array(&self) -> &[f64; 4]
pub fn as_array(&self) -> &[f64; 4]
Interpret self
as a statically-sized array of its base numeric type
sourcepub fn as_mut_array(&mut self) -> &mut [f64; 4]
pub fn as_mut_array(&mut self) -> &mut [f64; 4]
Interpret self
as a statically-sized array of its base numeric type
sourcepub fn as_mut_slice(&mut self) -> &mut [f64]
pub fn as_mut_slice(&mut self) -> &mut [f64]
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] ⓘ
sourcepub const fn as_ptr(&self) -> *const f64
pub const fn as_ptr(&self) -> *const f64
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.
sourcepub fn as_mut_ptr(&mut self) -> *mut f64
pub fn as_mut_ptr(&mut self) -> *mut f64
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.
Trait Implementations§
source§impl AddAssign<DVec4> for DVec4
impl AddAssign<DVec4> for DVec4
source§fn add_assign(&mut self, rhs: DVec4)
fn add_assign(&mut self, rhs: DVec4)
+=
operation. Read moresource§impl<'de> Deserialize<'de> for DVec4
impl<'de> Deserialize<'de> for DVec4
source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,
source§impl DivAssign<DVec4> for DVec4
impl DivAssign<DVec4> for DVec4
source§fn div_assign(&mut self, rhs: DVec4)
fn div_assign(&mut self, rhs: DVec4)
/=
operation. Read moresource§impl DivAssign<f64> for DVec4
impl DivAssign<f64> for DVec4
source§fn div_assign(&mut self, rhs: f64)
fn div_assign(&mut self, rhs: f64)
/=
operation. Read moresource§impl Lerp<f64> for DVec4
impl Lerp<f64> for DVec4
source§fn lerp(&self, end: Self, t: f64) -> Self
fn lerp(&self, end: Self, t: f64) -> 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 Rotor
s 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 Rotor
s to be of constant angular velocity. In this
case, check out Slerp
.
source§impl MulAssign<DVec4> for DVec4
impl MulAssign<DVec4> for DVec4
source§fn mul_assign(&mut self, rhs: DVec4)
fn mul_assign(&mut self, rhs: DVec4)
*=
operation. Read moresource§impl MulAssign<f64> for DVec4
impl MulAssign<f64> for DVec4
source§fn mul_assign(&mut self, rhs: f64)
fn mul_assign(&mut self, rhs: f64)
*=
operation. Read moresource§impl PartialEq<DVec4> for DVec4
impl PartialEq<DVec4> for DVec4
source§impl Slerp<f64> for DVec4
impl Slerp<f64> for DVec4
source§fn slerp(&self, end: Self, t: f64) -> Self
fn slerp(&self, end: Self, t: f64) -> 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 Rotor
s, 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 Rotor
s, etc!
source§impl SubAssign<DVec4> for DVec4
impl SubAssign<DVec4> for DVec4
source§fn sub_assign(&mut self, rhs: DVec4)
fn sub_assign(&mut self, rhs: DVec4)
-=
operation. Read moresource§impl TryFrom<DVec4> for IVec4
impl TryFrom<DVec4> for IVec4
source§fn try_from(v: DVec4) -> Result<Self, Self::Error>
fn try_from(v: DVec4) -> Result<Self, Self::Error>
Tries to convert the source to Self in a lossy way, flooring any float value.
Errors
NaN
- If a float value isNaN
.NotFinite
- If a float value is infinity or negative infinity.PosOverflow
- If a float value would be greater than the the self.component max value.NegOverflow
- If a float value would be less than the self.component min value.
§type Error = FloatConversionError
type Error = FloatConversionError
source§impl TryFrom<DVec4> for UVec4
impl TryFrom<DVec4> for UVec4
source§fn try_from(v: DVec4) -> Result<Self, Self::Error>
fn try_from(v: DVec4) -> Result<Self, Self::Error>
Tries to convert the source to Self in a lossy way, flooring any float value.
Errors
NaN
- If a float value isNaN
.NotFinite
- If a float value is infinity or negative infinity.PosOverflow
- If a float value would be greater than the the self.component max value.NegOverflow
- If a float value would be less than the self.component min value.
§type Error = FloatConversionError
type Error = FloatConversionError
impl Copy for DVec4
impl Pod for DVec4
impl StructuralPartialEq for DVec4
Auto Trait Implementations§
impl RefUnwindSafe for DVec4
impl Send for DVec4
impl Sync for DVec4
impl Unpin for DVec4
impl UnwindSafe for DVec4
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
impl<T> CheckedBitPattern for Twhere T: AnyBitPattern,
§type Bits = T
type Bits = T
Self
must have the same layout as the specified Bits
except for
the possible invalid bit patterns being checked during
is_valid_bit_pattern
.source§fn is_valid_bit_pattern(_bits: &T) -> bool
fn is_valid_bit_pattern(_bits: &T) -> bool
bits
as &Self
.