diff options
Diffstat (limited to 'src/i32/ivec3.rs')
| -rw-r--r-- | src/i32/ivec3.rs | 343 |
1 files changed, 17 insertions, 326 deletions
diff --git a/src/i32/ivec3.rs b/src/i32/ivec3.rs index 1a8425b..2f71ac0 100644 --- a/src/i32/ivec3.rs +++ b/src/i32/ivec3.rs @@ -1,6 +1,6 @@ // Generated from vec.rs.tera template. Edit the template, not the generated file. -use crate::{BVec3, I16Vec3, I64Vec3, IVec2, IVec4, U16Vec3, U64Vec3, UVec3}; +use crate::{BVec3, IVec2, IVec4}; #[cfg(not(target_arch = "spirv"))] use core::fmt; @@ -9,7 +9,6 @@ use core::{f32, ops::*}; /// Creates a 3-dimensional vector. #[inline(always)] -#[must_use] pub const fn ivec3(x: i32, y: i32, z: i32) -> IVec3 { IVec3::new(x, y, z) } @@ -35,28 +34,22 @@ impl IVec3 { /// All negative ones. pub const NEG_ONE: Self = Self::splat(-1); - /// All `i32::MIN`. - pub const MIN: Self = Self::splat(i32::MIN); - - /// All `i32::MAX`. - pub const MAX: Self = Self::splat(i32::MAX); - - /// A unit vector pointing along the positive X axis. + /// A unit-length vector pointing along the positive X axis. pub const X: Self = Self::new(1, 0, 0); - /// A unit vector pointing along the positive Y axis. + /// A unit-length vector pointing along the positive Y axis. pub const Y: Self = Self::new(0, 1, 0); - /// A unit vector pointing along the positive Z axis. + /// A unit-length vector pointing along the positive Z axis. pub const Z: Self = Self::new(0, 0, 1); - /// A unit vector pointing along the negative X axis. + /// A unit-length vector pointing along the negative X axis. pub const NEG_X: Self = Self::new(-1, 0, 0); - /// A unit vector pointing along the negative Y axis. + /// A unit-length vector pointing along the negative Y axis. pub const NEG_Y: Self = Self::new(0, -1, 0); - /// A unit vector pointing along the negative Z axis. + /// A unit-length vector pointing along the negative Z axis. pub const NEG_Z: Self = Self::new(0, 0, -1); /// The unit axes. @@ -64,14 +57,12 @@ impl IVec3 { /// Creates a new vector. #[inline(always)] - #[must_use] pub const fn new(x: i32, y: i32, z: i32) -> Self { Self { x, y, z } } /// Creates a vector with all elements set to `v`. #[inline] - #[must_use] pub const fn splat(v: i32) -> Self { Self { x: v, y: v, z: v } } @@ -82,25 +73,22 @@ impl IVec3 { /// A true element in the mask uses the corresponding element from `if_true`, and false /// uses the element from `if_false`. #[inline] - #[must_use] pub fn select(mask: BVec3, if_true: Self, if_false: Self) -> Self { Self { - x: if mask.test(0) { if_true.x } else { if_false.x }, - y: if mask.test(1) { if_true.y } else { if_false.y }, - z: if mask.test(2) { if_true.z } else { if_false.z }, + x: if mask.x { if_true.x } else { if_false.x }, + y: if mask.y { if_true.y } else { if_false.y }, + z: if mask.z { if_true.z } else { if_false.z }, } } /// Creates a new vector from an array. #[inline] - #[must_use] pub const fn from_array(a: [i32; 3]) -> Self { Self::new(a[0], a[1], a[2]) } /// `[x, y, z]` #[inline] - #[must_use] pub const fn to_array(&self) -> [i32; 3] { [self.x, self.y, self.z] } @@ -111,7 +99,6 @@ impl IVec3 { /// /// Panics if `slice` is less than 3 elements long. #[inline] - #[must_use] pub const fn from_slice(slice: &[i32]) -> Self { Self::new(slice[0], slice[1], slice[2]) } @@ -131,7 +118,6 @@ impl IVec3 { /// Internal method for creating a 3D vector from a 4D vector, discarding `w`. #[allow(dead_code)] #[inline] - #[must_use] pub(crate) fn from_vec4(v: IVec4) -> Self { Self { x: v.x, @@ -142,16 +128,14 @@ impl IVec3 { /// Creates a 4D vector from `self` and the given `w` value. #[inline] - #[must_use] pub fn extend(self, w: i32) -> IVec4 { IVec4::new(self.x, self.y, self.z, w) } /// Creates a 2D vector from the `x` and `y` elements of `self`, discarding `z`. /// - /// Truncation may also be performed by using [`self.xy()`][crate::swizzles::Vec3Swizzles::xy()]. + /// Truncation may also be performed by using `self.xy()` or `IVec2::from()`. #[inline] - #[must_use] pub fn truncate(self) -> IVec2 { use crate::swizzles::Vec3Swizzles; self.xy() @@ -159,21 +143,18 @@ impl IVec3 { /// Computes the dot product of `self` and `rhs`. #[inline] - #[must_use] pub fn dot(self, rhs: Self) -> i32 { (self.x * rhs.x) + (self.y * rhs.y) + (self.z * rhs.z) } /// Returns a vector where every component is the dot product of `self` and `rhs`. #[inline] - #[must_use] pub fn dot_into_vec(self, rhs: Self) -> Self { Self::splat(self.dot(rhs)) } /// Computes the cross product of `self` and `rhs`. #[inline] - #[must_use] pub fn cross(self, rhs: Self) -> Self { Self { x: self.y * rhs.z - rhs.y * self.z, @@ -186,7 +167,6 @@ impl IVec3 { /// /// In other words this computes `[self.x.min(rhs.x), self.y.min(rhs.y), ..]`. #[inline] - #[must_use] pub fn min(self, rhs: Self) -> Self { Self { x: self.x.min(rhs.x), @@ -199,7 +179,6 @@ impl IVec3 { /// /// In other words this computes `[self.x.max(rhs.x), self.y.max(rhs.y), ..]`. #[inline] - #[must_use] pub fn max(self, rhs: Self) -> Self { Self { x: self.x.max(rhs.x), @@ -216,7 +195,6 @@ impl IVec3 { /// /// Will panic if `min` is greater than `max` when `glam_assert` is enabled. #[inline] - #[must_use] pub fn clamp(self, min: Self, max: Self) -> Self { glam_assert!(min.cmple(max).all(), "clamp: expected min <= max"); self.max(min).min(max) @@ -226,7 +204,6 @@ impl IVec3 { /// /// In other words this computes `min(x, y, ..)`. #[inline] - #[must_use] pub fn min_element(self) -> i32 { self.x.min(self.y.min(self.z)) } @@ -235,7 +212,6 @@ impl IVec3 { /// /// In other words this computes `max(x, y, ..)`. #[inline] - #[must_use] pub fn max_element(self) -> i32 { self.x.max(self.y.max(self.z)) } @@ -246,7 +222,6 @@ impl IVec3 { /// In other words, this computes `[self.x == rhs.x, self.y == rhs.y, ..]` for all /// elements. #[inline] - #[must_use] pub fn cmpeq(self, rhs: Self) -> BVec3 { BVec3::new(self.x.eq(&rhs.x), self.y.eq(&rhs.y), self.z.eq(&rhs.z)) } @@ -257,7 +232,6 @@ impl IVec3 { /// In other words this computes `[self.x != rhs.x, self.y != rhs.y, ..]` for all /// elements. #[inline] - #[must_use] pub fn cmpne(self, rhs: Self) -> BVec3 { BVec3::new(self.x.ne(&rhs.x), self.y.ne(&rhs.y), self.z.ne(&rhs.z)) } @@ -268,7 +242,6 @@ impl IVec3 { /// In other words this computes `[self.x >= rhs.x, self.y >= rhs.y, ..]` for all /// elements. #[inline] - #[must_use] pub fn cmpge(self, rhs: Self) -> BVec3 { BVec3::new(self.x.ge(&rhs.x), self.y.ge(&rhs.y), self.z.ge(&rhs.z)) } @@ -279,7 +252,6 @@ impl IVec3 { /// In other words this computes `[self.x > rhs.x, self.y > rhs.y, ..]` for all /// elements. #[inline] - #[must_use] pub fn cmpgt(self, rhs: Self) -> BVec3 { BVec3::new(self.x.gt(&rhs.x), self.y.gt(&rhs.y), self.z.gt(&rhs.z)) } @@ -290,7 +262,6 @@ impl IVec3 { /// In other words this computes `[self.x <= rhs.x, self.y <= rhs.y, ..]` for all /// elements. #[inline] - #[must_use] pub fn cmple(self, rhs: Self) -> BVec3 { BVec3::new(self.x.le(&rhs.x), self.y.le(&rhs.y), self.z.le(&rhs.z)) } @@ -301,14 +272,12 @@ impl IVec3 { /// In other words this computes `[self.x < rhs.x, self.y < rhs.y, ..]` for all /// elements. #[inline] - #[must_use] pub fn cmplt(self, rhs: Self) -> BVec3 { BVec3::new(self.x.lt(&rhs.x), self.y.lt(&rhs.y), self.z.lt(&rhs.z)) } /// Returns a vector containing the absolute value of each element of `self`. #[inline] - #[must_use] pub fn abs(self) -> Self { Self { x: self.x.abs(), @@ -323,7 +292,6 @@ impl IVec3 { /// - `1` if the number is positive /// - `-1` if the number is negative #[inline] - #[must_use] pub fn signum(self) -> Self { Self { x: self.x.signum(), @@ -332,222 +300,46 @@ impl IVec3 { } } + /// Returns a vector with signs of `rhs` and the magnitudes of `self`. + #[inline] + pub fn copysign(self, rhs: Self) -> Self { + Self::select(rhs.cmpge(Self::ZERO), self, -self) + } + /// Returns a bitmask with the lowest 3 bits set to the sign bits from the elements of `self`. /// /// A negative element results in a `1` bit and a positive element in a `0` bit. Element `x` goes /// into the first lowest bit, element `y` into the second, etc. #[inline] - #[must_use] pub fn is_negative_bitmask(self) -> u32 { (self.x.is_negative() as u32) | (self.y.is_negative() as u32) << 1 | (self.z.is_negative() as u32) << 2 } - /// Computes the squared length of `self`. - #[doc(alias = "magnitude2")] - #[inline] - #[must_use] - pub fn length_squared(self) -> i32 { - self.dot(self) - } - - /// Compute the squared euclidean distance between two points in space. - #[inline] - #[must_use] - pub fn distance_squared(self, rhs: Self) -> i32 { - (self - rhs).length_squared() - } - - /// Returns the element-wise quotient of [Euclidean division] of `self` by `rhs`. - /// - /// # Panics - /// This function will panic if any `rhs` element is 0 or the division results in overflow. - #[inline] - #[must_use] - pub fn div_euclid(self, rhs: Self) -> Self { - Self::new( - self.x.div_euclid(rhs.x), - self.y.div_euclid(rhs.y), - self.z.div_euclid(rhs.z), - ) - } - - /// Returns the element-wise remainder of [Euclidean division] of `self` by `rhs`. - /// - /// # Panics - /// This function will panic if any `rhs` element is 0 or the division results in overflow. - /// - /// [Euclidean division]: i32::rem_euclid - #[inline] - #[must_use] - pub fn rem_euclid(self, rhs: Self) -> Self { - Self::new( - self.x.rem_euclid(rhs.x), - self.y.rem_euclid(rhs.y), - self.z.rem_euclid(rhs.z), - ) - } - /// Casts all elements of `self` to `f32`. #[inline] - #[must_use] pub fn as_vec3(&self) -> crate::Vec3 { crate::Vec3::new(self.x as f32, self.y as f32, self.z as f32) } /// Casts all elements of `self` to `f32`. #[inline] - #[must_use] pub fn as_vec3a(&self) -> crate::Vec3A { crate::Vec3A::new(self.x as f32, self.y as f32, self.z as f32) } /// Casts all elements of `self` to `f64`. #[inline] - #[must_use] pub fn as_dvec3(&self) -> crate::DVec3 { crate::DVec3::new(self.x as f64, self.y as f64, self.z as f64) } - /// Casts all elements of `self` to `i16`. - #[inline] - #[must_use] - pub fn as_i16vec3(&self) -> crate::I16Vec3 { - crate::I16Vec3::new(self.x as i16, self.y as i16, self.z as i16) - } - - /// Casts all elements of `self` to `u16`. - #[inline] - #[must_use] - pub fn as_u16vec3(&self) -> crate::U16Vec3 { - crate::U16Vec3::new(self.x as u16, self.y as u16, self.z as u16) - } - /// Casts all elements of `self` to `u32`. #[inline] - #[must_use] pub fn as_uvec3(&self) -> crate::UVec3 { crate::UVec3::new(self.x as u32, self.y as u32, self.z as u32) } - - /// Casts all elements of `self` to `i64`. - #[inline] - #[must_use] - pub fn as_i64vec3(&self) -> crate::I64Vec3 { - crate::I64Vec3::new(self.x as i64, self.y as i64, self.z as i64) - } - - /// Casts all elements of `self` to `u64`. - #[inline] - #[must_use] - pub fn as_u64vec3(&self) -> crate::U64Vec3 { - crate::U64Vec3::new(self.x as u64, self.y as u64, self.z as u64) - } - - /// Returns a vector containing the wrapping addition of `self` and `rhs`. - /// - /// In other words this computes `[self.x.wrapping_add(rhs.x), self.y.wrapping_add(rhs.y), ..]`. - #[inline] - #[must_use] - pub const fn wrapping_add(self, rhs: Self) -> Self { - Self { - x: self.x.wrapping_add(rhs.x), - y: self.y.wrapping_add(rhs.y), - z: self.z.wrapping_add(rhs.z), - } - } - - /// Returns a vector containing the wrapping subtraction of `self` and `rhs`. - /// - /// In other words this computes `[self.x.wrapping_sub(rhs.x), self.y.wrapping_sub(rhs.y), ..]`. - #[inline] - #[must_use] - pub const fn wrapping_sub(self, rhs: Self) -> Self { - Self { - x: self.x.wrapping_sub(rhs.x), - y: self.y.wrapping_sub(rhs.y), - z: self.z.wrapping_sub(rhs.z), - } - } - - /// Returns a vector containing the wrapping multiplication of `self` and `rhs`. - /// - /// In other words this computes `[self.x.wrapping_mul(rhs.x), self.y.wrapping_mul(rhs.y), ..]`. - #[inline] - #[must_use] - pub const fn wrapping_mul(self, rhs: Self) -> Self { - Self { - x: self.x.wrapping_mul(rhs.x), - y: self.y.wrapping_mul(rhs.y), - z: self.z.wrapping_mul(rhs.z), - } - } - - /// Returns a vector containing the wrapping division of `self` and `rhs`. - /// - /// In other words this computes `[self.x.wrapping_div(rhs.x), self.y.wrapping_div(rhs.y), ..]`. - #[inline] - #[must_use] - pub const fn wrapping_div(self, rhs: Self) -> Self { - Self { - x: self.x.wrapping_div(rhs.x), - y: self.y.wrapping_div(rhs.y), - z: self.z.wrapping_div(rhs.z), - } - } - - /// Returns a vector containing the saturating addition of `self` and `rhs`. - /// - /// In other words this computes `[self.x.saturating_add(rhs.x), self.y.saturating_add(rhs.y), ..]`. - #[inline] - #[must_use] - pub const fn saturating_add(self, rhs: Self) -> Self { - Self { - x: self.x.saturating_add(rhs.x), - y: self.y.saturating_add(rhs.y), - z: self.z.saturating_add(rhs.z), - } - } - - /// Returns a vector containing the saturating subtraction of `self` and `rhs`. - /// - /// In other words this computes `[self.x.saturating_sub(rhs.x), self.y.saturating_sub(rhs.y), ..]`. - #[inline] - #[must_use] - pub const fn saturating_sub(self, rhs: Self) -> Self { - Self { - x: self.x.saturating_sub(rhs.x), - y: self.y.saturating_sub(rhs.y), - z: self.z.saturating_sub(rhs.z), - } - } - - /// Returns a vector containing the saturating multiplication of `self` and `rhs`. - /// - /// In other words this computes `[self.x.saturating_mul(rhs.x), self.y.saturating_mul(rhs.y), ..]`. - #[inline] - #[must_use] - pub const fn saturating_mul(self, rhs: Self) -> Self { - Self { - x: self.x.saturating_mul(rhs.x), - y: self.y.saturating_mul(rhs.y), - z: self.z.saturating_mul(rhs.z), - } - } - - /// Returns a vector containing the saturating division of `self` and `rhs`. - /// - /// In other words this computes `[self.x.saturating_div(rhs.x), self.y.saturating_div(rhs.y), ..]`. - #[inline] - #[must_use] - pub const fn saturating_div(self, rhs: Self) -> Self { - Self { - x: self.x.saturating_div(rhs.x), - y: self.y.saturating_div(rhs.y), - z: self.z.saturating_div(rhs.z), - } - } } impl Default for IVec3 { @@ -1051,30 +843,6 @@ impl Shr<i32> for IVec3 { } } -impl Shl<i64> for IVec3 { - type Output = Self; - #[inline] - fn shl(self, rhs: i64) -> Self::Output { - Self { - x: self.x.shl(rhs), - y: self.y.shl(rhs), - z: self.z.shl(rhs), - } - } -} - -impl Shr<i64> for IVec3 { - type Output = Self; - #[inline] - fn shr(self, rhs: i64) -> Self::Output { - Self { - x: self.x.shr(rhs), - y: self.y.shr(rhs), - z: self.z.shr(rhs), - } - } -} - impl Shl<u8> for IVec3 { type Output = Self; #[inline] @@ -1147,30 +915,6 @@ impl Shr<u32> for IVec3 { } } -impl Shl<u64> for IVec3 { - type Output = Self; - #[inline] - fn shl(self, rhs: u64) -> Self::Output { - Self { - x: self.x.shl(rhs), - y: self.y.shl(rhs), - z: self.z.shl(rhs), - } - } -} - -impl Shr<u64> for IVec3 { - type Output = Self; - #[inline] - fn shr(self, rhs: u64) -> Self::Output { - Self { - x: self.x.shr(rhs), - y: self.y.shr(rhs), - z: self.z.shr(rhs), - } - } -} - impl Shl<crate::IVec3> for IVec3 { type Output = Self; #[inline] @@ -1296,56 +1040,3 @@ impl From<(IVec2, i32)> for IVec3 { Self::new(v.x, v.y, z) } } - -impl From<I16Vec3> for IVec3 { - #[inline] - fn from(v: I16Vec3) -> Self { - Self::new(i32::from(v.x), i32::from(v.y), i32::from(v.z)) - } -} - -impl From<U16Vec3> for IVec3 { - #[inline] - fn from(v: U16Vec3) -> Self { - Self::new(i32::from(v.x), i32::from(v.y), i32::from(v.z)) - } -} - -impl TryFrom<UVec3> for IVec3 { - type Error = core::num::TryFromIntError; - - #[inline] - fn try_from(v: UVec3) -> Result<Self, Self::Error> { - Ok(Self::new( - i32::try_from(v.x)?, - i32::try_from(v.y)?, - i32::try_from(v.z)?, - )) - } -} - -impl TryFrom<I64Vec3> for IVec3 { - type Error = core::num::TryFromIntError; - - #[inline] - fn try_from(v: I64Vec3) -> Result<Self, Self::Error> { - Ok(Self::new( - i32::try_from(v.x)?, - i32::try_from(v.y)?, - i32::try_from(v.z)?, - )) - } -} - -impl TryFrom<U64Vec3> for IVec3 { - type Error = core::num::TryFromIntError; - - #[inline] - fn try_from(v: U64Vec3) -> Result<Self, Self::Error> { - Ok(Self::new( - i32::try_from(v.x)?, - i32::try_from(v.y)?, - i32::try_from(v.z)?, - )) - } -} |