Struct ultraviolet::bivec::Bivec3
source · [−]Expand description
A bivector in 3d space.
In 3d, a bivector has 3 components, each one representing the signed projected area of the bivector onto one of the 3 basis bivectors, which can be thought of as corresponding to each of the three basis planes. This is analogous to the components of a 3d vector, which correspond to the projected length of the vector onto the three basis *vectors. Since in 3d, there are three components for both vectors and bivectors, 3d bivectors have been historically confused with 3d vectors quite a lot.
Please see the module level documentation for more information on bivectors generally!
Fields
xy: f32
xz: f32
yz: f32
Implementations
sourceimpl Bivec3
impl Bivec3
pub const fn new(xy: f32, xz: f32, yz: f32) -> Self
pub fn zero() -> Self
sourcepub fn from_normalized_axis(v: Vec3) -> Self
pub fn from_normalized_axis(v: Vec3) -> Self
Create the bivector which represents the same plane of rotation as a given normalized ‘axis vector’
pub fn unit_xy() -> Self
pub fn unit_xz() -> Self
pub fn unit_yz() -> Self
pub fn mag_sq(&self) -> f32
pub fn mag(&self) -> f32
pub fn normalize(&mut self)
pub fn normalized(&self) -> Self
pub fn dot(&self, rhs: Self) -> f32
pub fn layout() -> Layout
pub fn as_slice(&self) -> &[f32]
pub fn as_byte_slice(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
pub fn as_mut_slice(&mut self) -> &mut [f32]
pub fn as_mut_byte_slice(&mut self) -> &mut [u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
sourcepub const fn as_ptr(&self) -> *const f32
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.
sourcepub fn as_mut_ptr(&mut self) -> *mut f32
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.
Trait Implementations
sourceimpl AddAssign<Bivec3> for Bivec3
impl AddAssign<Bivec3> for Bivec3
sourcefn add_assign(&mut self, rhs: Bivec3)
fn add_assign(&mut self, rhs: Bivec3)
Performs the +=
operation. Read more
sourceimpl<'de> Deserialize<'de> for Bivec3
impl<'de> Deserialize<'de> for Bivec3
sourcefn 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>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl DivAssign<Bivec3> for Bivec3
impl DivAssign<Bivec3> for Bivec3
sourcefn div_assign(&mut self, rhs: Bivec3)
fn div_assign(&mut self, rhs: Bivec3)
Performs the /=
operation. Read more
sourceimpl DivAssign<f32> for Bivec3
impl DivAssign<f32> for Bivec3
sourcefn div_assign(&mut self, rhs: f32)
fn div_assign(&mut self, rhs: f32)
Performs the /=
operation. Read more
sourceimpl Lerp<f32> for Bivec3
impl Lerp<f32> for Bivec3
sourcefn lerp(&self, end: Self, t: f32) -> Self
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 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
.
sourceimpl MulAssign<Bivec3> for Bivec3
impl MulAssign<Bivec3> for Bivec3
sourcefn mul_assign(&mut self, rhs: Self)
fn mul_assign(&mut self, rhs: Self)
Performs the *=
operation. Read more
sourceimpl MulAssign<f32> for Bivec3
impl MulAssign<f32> for Bivec3
sourcefn mul_assign(&mut self, rhs: f32)
fn mul_assign(&mut self, rhs: f32)
Performs the *=
operation. Read more
sourceimpl Slerp<f32> for Bivec3
impl Slerp<f32> for Bivec3
sourcefn slerp(&self, end: Self, t: f32) -> Self
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 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!
sourceimpl SubAssign<Bivec3> for Bivec3
impl SubAssign<Bivec3> for Bivec3
sourcefn sub_assign(&mut self, rhs: Bivec3)
fn sub_assign(&mut self, rhs: Bivec3)
Performs the -=
operation. Read more
impl Copy for Bivec3
impl Pod for Bivec3
impl StructuralPartialEq for Bivec3
Auto Trait Implementations
impl RefUnwindSafe for Bivec3
impl Send for Bivec3
impl Sync for Bivec3
impl Unpin for Bivec3
impl UnwindSafe for Bivec3
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more