Struct ultraviolet::bivec::Bivec2
source · #[repr(C)]pub struct Bivec2 {
pub xy: f32,
}
Expand description
A bivector in 2d space.
Since in 2d there is only one plane in the whole of 2d space, a 2d bivector has only one component.
Please see the module level documentation for more information on bivectors generally!
Fields§
§xy: f32
Implementations§
source§impl Bivec2
impl Bivec2
pub const fn new(xy: f32) -> Self
pub fn zero() -> Self
pub fn unit_xy() -> 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] ⓘ
pub fn as_mut_slice(&mut self) -> &mut [f32]
pub fn as_mut_byte_slice(&mut self) -> &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§
source§impl AddAssign<Bivec2> for Bivec2
impl AddAssign<Bivec2> for Bivec2
source§fn add_assign(&mut self, rhs: Bivec2)
fn add_assign(&mut self, rhs: Bivec2)
+=
operation. Read moresource§impl<'de> Deserialize<'de> for Bivec2
impl<'de> Deserialize<'de> for Bivec2
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<Bivec2> for Bivec2
impl DivAssign<Bivec2> for Bivec2
source§fn div_assign(&mut self, rhs: Bivec2)
fn div_assign(&mut self, rhs: Bivec2)
/=
operation. Read moresource§impl DivAssign<f32> for Bivec2
impl DivAssign<f32> for Bivec2
source§fn div_assign(&mut self, rhs: f32)
fn div_assign(&mut self, rhs: f32)
/=
operation. Read moresource§impl Lerp<f32> for Bivec2
impl Lerp<f32> for Bivec2
source§fn 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
.
source§impl MulAssign<Bivec2> for Bivec2
impl MulAssign<Bivec2> for Bivec2
source§fn mul_assign(&mut self, rhs: Self)
fn mul_assign(&mut self, rhs: Self)
*=
operation. Read moresource§impl MulAssign<f32> for Bivec2
impl MulAssign<f32> for Bivec2
source§fn mul_assign(&mut self, rhs: f32)
fn mul_assign(&mut self, rhs: f32)
*=
operation. Read moresource§impl PartialEq<Bivec2> for Bivec2
impl PartialEq<Bivec2> for Bivec2
source§impl Slerp<f32> for Bivec2
impl Slerp<f32> for Bivec2
source§fn 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!
source§impl SubAssign<Bivec2> for Bivec2
impl SubAssign<Bivec2> for Bivec2
source§fn sub_assign(&mut self, rhs: Bivec2)
fn sub_assign(&mut self, rhs: Bivec2)
-=
operation. Read moreimpl Copy for Bivec2
impl Pod for Bivec2
impl StructuralPartialEq for Bivec2
Auto Trait Implementations§
impl RefUnwindSafe for Bivec2
impl Send for Bivec2
impl Sync for Bivec2
impl Unpin for Bivec2
impl UnwindSafe for Bivec2
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
.