glam/f32/
vec3.rs

1// Generated from vec.rs.tera template. Edit the template, not the generated file.
2
3use crate::{f32::math, BVec3, BVec3A, Vec2, Vec4};
4
5#[cfg(not(target_arch = "spirv"))]
6use core::fmt;
7use core::iter::{Product, Sum};
8use core::{f32, ops::*};
9
10/// Creates a 3-dimensional vector.
11#[inline(always)]
12#[must_use]
13pub const fn vec3(x: f32, y: f32, z: f32) -> Vec3 {
14    Vec3::new(x, y, z)
15}
16
17/// A 3-dimensional vector.
18#[derive(Clone, Copy, PartialEq)]
19#[cfg_attr(not(target_arch = "spirv"), repr(C))]
20#[cfg_attr(target_arch = "spirv", repr(simd))]
21pub struct Vec3 {
22    pub x: f32,
23    pub y: f32,
24    pub z: f32,
25}
26
27impl Vec3 {
28    /// All zeroes.
29    pub const ZERO: Self = Self::splat(0.0);
30
31    /// All ones.
32    pub const ONE: Self = Self::splat(1.0);
33
34    /// All negative ones.
35    pub const NEG_ONE: Self = Self::splat(-1.0);
36
37    /// All `f32::MIN`.
38    pub const MIN: Self = Self::splat(f32::MIN);
39
40    /// All `f32::MAX`.
41    pub const MAX: Self = Self::splat(f32::MAX);
42
43    /// All `f32::NAN`.
44    pub const NAN: Self = Self::splat(f32::NAN);
45
46    /// All `f32::INFINITY`.
47    pub const INFINITY: Self = Self::splat(f32::INFINITY);
48
49    /// All `f32::NEG_INFINITY`.
50    pub const NEG_INFINITY: Self = Self::splat(f32::NEG_INFINITY);
51
52    /// A unit vector pointing along the positive X axis.
53    pub const X: Self = Self::new(1.0, 0.0, 0.0);
54
55    /// A unit vector pointing along the positive Y axis.
56    pub const Y: Self = Self::new(0.0, 1.0, 0.0);
57
58    /// A unit vector pointing along the positive Z axis.
59    pub const Z: Self = Self::new(0.0, 0.0, 1.0);
60
61    /// A unit vector pointing along the negative X axis.
62    pub const NEG_X: Self = Self::new(-1.0, 0.0, 0.0);
63
64    /// A unit vector pointing along the negative Y axis.
65    pub const NEG_Y: Self = Self::new(0.0, -1.0, 0.0);
66
67    /// A unit vector pointing along the negative Z axis.
68    pub const NEG_Z: Self = Self::new(0.0, 0.0, -1.0);
69
70    /// The unit axes.
71    pub const AXES: [Self; 3] = [Self::X, Self::Y, Self::Z];
72
73    /// Creates a new vector.
74    #[inline(always)]
75    #[must_use]
76    pub const fn new(x: f32, y: f32, z: f32) -> Self {
77        Self { x, y, z }
78    }
79
80    /// Creates a vector with all elements set to `v`.
81    #[inline]
82    #[must_use]
83    pub const fn splat(v: f32) -> Self {
84        Self { x: v, y: v, z: v }
85    }
86
87    /// Creates a vector from the elements in `if_true` and `if_false`, selecting which to use
88    /// for each element of `self`.
89    ///
90    /// A true element in the mask uses the corresponding element from `if_true`, and false
91    /// uses the element from `if_false`.
92    #[inline]
93    #[must_use]
94    pub fn select(mask: BVec3, if_true: Self, if_false: Self) -> Self {
95        Self {
96            x: if mask.test(0) { if_true.x } else { if_false.x },
97            y: if mask.test(1) { if_true.y } else { if_false.y },
98            z: if mask.test(2) { if_true.z } else { if_false.z },
99        }
100    }
101
102    /// Creates a new vector from an array.
103    #[inline]
104    #[must_use]
105    pub const fn from_array(a: [f32; 3]) -> Self {
106        Self::new(a[0], a[1], a[2])
107    }
108
109    /// `[x, y, z]`
110    #[inline]
111    #[must_use]
112    pub const fn to_array(&self) -> [f32; 3] {
113        [self.x, self.y, self.z]
114    }
115
116    /// Creates a vector from the first 3 values in `slice`.
117    ///
118    /// # Panics
119    ///
120    /// Panics if `slice` is less than 3 elements long.
121    #[inline]
122    #[must_use]
123    pub const fn from_slice(slice: &[f32]) -> Self {
124        Self::new(slice[0], slice[1], slice[2])
125    }
126
127    /// Writes the elements of `self` to the first 3 elements in `slice`.
128    ///
129    /// # Panics
130    ///
131    /// Panics if `slice` is less than 3 elements long.
132    #[inline]
133    pub fn write_to_slice(self, slice: &mut [f32]) {
134        slice[0] = self.x;
135        slice[1] = self.y;
136        slice[2] = self.z;
137    }
138
139    /// Internal method for creating a 3D vector from a 4D vector, discarding `w`.
140    #[allow(dead_code)]
141    #[inline]
142    #[must_use]
143    pub(crate) fn from_vec4(v: Vec4) -> Self {
144        Self {
145            x: v.x,
146            y: v.y,
147            z: v.z,
148        }
149    }
150
151    /// Creates a 4D vector from `self` and the given `w` value.
152    #[inline]
153    #[must_use]
154    pub fn extend(self, w: f32) -> Vec4 {
155        Vec4::new(self.x, self.y, self.z, w)
156    }
157
158    /// Creates a 2D vector from the `x` and `y` elements of `self`, discarding `z`.
159    ///
160    /// Truncation may also be performed by using [`self.xy()`][crate::swizzles::Vec3Swizzles::xy()].
161    #[inline]
162    #[must_use]
163    pub fn truncate(self) -> Vec2 {
164        use crate::swizzles::Vec3Swizzles;
165        self.xy()
166    }
167
168    /// Creates a 3D vector from `self` with the given value of `x`.
169    #[inline]
170    #[must_use]
171    pub fn with_x(mut self, x: f32) -> Self {
172        self.x = x;
173        self
174    }
175
176    /// Creates a 3D vector from `self` with the given value of `y`.
177    #[inline]
178    #[must_use]
179    pub fn with_y(mut self, y: f32) -> Self {
180        self.y = y;
181        self
182    }
183
184    /// Creates a 3D vector from `self` with the given value of `z`.
185    #[inline]
186    #[must_use]
187    pub fn with_z(mut self, z: f32) -> Self {
188        self.z = z;
189        self
190    }
191
192    /// Computes the dot product of `self` and `rhs`.
193    #[inline]
194    #[must_use]
195    pub fn dot(self, rhs: Self) -> f32 {
196        (self.x * rhs.x) + (self.y * rhs.y) + (self.z * rhs.z)
197    }
198
199    /// Returns a vector where every component is the dot product of `self` and `rhs`.
200    #[inline]
201    #[must_use]
202    pub fn dot_into_vec(self, rhs: Self) -> Self {
203        Self::splat(self.dot(rhs))
204    }
205
206    /// Computes the cross product of `self` and `rhs`.
207    #[inline]
208    #[must_use]
209    pub fn cross(self, rhs: Self) -> Self {
210        Self {
211            x: self.y * rhs.z - rhs.y * self.z,
212            y: self.z * rhs.x - rhs.z * self.x,
213            z: self.x * rhs.y - rhs.x * self.y,
214        }
215    }
216
217    /// Returns a vector containing the minimum values for each element of `self` and `rhs`.
218    ///
219    /// In other words this computes `[self.x.min(rhs.x), self.y.min(rhs.y), ..]`.
220    #[inline]
221    #[must_use]
222    pub fn min(self, rhs: Self) -> Self {
223        Self {
224            x: self.x.min(rhs.x),
225            y: self.y.min(rhs.y),
226            z: self.z.min(rhs.z),
227        }
228    }
229
230    /// Returns a vector containing the maximum values for each element of `self` and `rhs`.
231    ///
232    /// In other words this computes `[self.x.max(rhs.x), self.y.max(rhs.y), ..]`.
233    #[inline]
234    #[must_use]
235    pub fn max(self, rhs: Self) -> Self {
236        Self {
237            x: self.x.max(rhs.x),
238            y: self.y.max(rhs.y),
239            z: self.z.max(rhs.z),
240        }
241    }
242
243    /// Component-wise clamping of values, similar to [`f32::clamp`].
244    ///
245    /// Each element in `min` must be less-or-equal to the corresponding element in `max`.
246    ///
247    /// # Panics
248    ///
249    /// Will panic if `min` is greater than `max` when `glam_assert` is enabled.
250    #[inline]
251    #[must_use]
252    pub fn clamp(self, min: Self, max: Self) -> Self {
253        glam_assert!(min.cmple(max).all(), "clamp: expected min <= max");
254        self.max(min).min(max)
255    }
256
257    /// Returns the horizontal minimum of `self`.
258    ///
259    /// In other words this computes `min(x, y, ..)`.
260    #[inline]
261    #[must_use]
262    pub fn min_element(self) -> f32 {
263        self.x.min(self.y.min(self.z))
264    }
265
266    /// Returns the horizontal maximum of `self`.
267    ///
268    /// In other words this computes `max(x, y, ..)`.
269    #[inline]
270    #[must_use]
271    pub fn max_element(self) -> f32 {
272        self.x.max(self.y.max(self.z))
273    }
274
275    /// Returns the sum of all elements of `self`.
276    ///
277    /// In other words, this computes `self.x + self.y + ..`.
278    #[inline]
279    #[must_use]
280    pub fn element_sum(self) -> f32 {
281        self.x + self.y + self.z
282    }
283
284    /// Returns the product of all elements of `self`.
285    ///
286    /// In other words, this computes `self.x * self.y * ..`.
287    #[inline]
288    #[must_use]
289    pub fn element_product(self) -> f32 {
290        self.x * self.y * self.z
291    }
292
293    /// Returns a vector mask containing the result of a `==` comparison for each element of
294    /// `self` and `rhs`.
295    ///
296    /// In other words, this computes `[self.x == rhs.x, self.y == rhs.y, ..]` for all
297    /// elements.
298    #[inline]
299    #[must_use]
300    pub fn cmpeq(self, rhs: Self) -> BVec3 {
301        BVec3::new(self.x.eq(&rhs.x), self.y.eq(&rhs.y), self.z.eq(&rhs.z))
302    }
303
304    /// Returns a vector mask containing the result of a `!=` comparison for each element of
305    /// `self` and `rhs`.
306    ///
307    /// In other words this computes `[self.x != rhs.x, self.y != rhs.y, ..]` for all
308    /// elements.
309    #[inline]
310    #[must_use]
311    pub fn cmpne(self, rhs: Self) -> BVec3 {
312        BVec3::new(self.x.ne(&rhs.x), self.y.ne(&rhs.y), self.z.ne(&rhs.z))
313    }
314
315    /// Returns a vector mask containing the result of a `>=` comparison for each element of
316    /// `self` and `rhs`.
317    ///
318    /// In other words this computes `[self.x >= rhs.x, self.y >= rhs.y, ..]` for all
319    /// elements.
320    #[inline]
321    #[must_use]
322    pub fn cmpge(self, rhs: Self) -> BVec3 {
323        BVec3::new(self.x.ge(&rhs.x), self.y.ge(&rhs.y), self.z.ge(&rhs.z))
324    }
325
326    /// Returns a vector mask containing the result of a `>` comparison for each element of
327    /// `self` and `rhs`.
328    ///
329    /// In other words this computes `[self.x > rhs.x, self.y > rhs.y, ..]` for all
330    /// elements.
331    #[inline]
332    #[must_use]
333    pub fn cmpgt(self, rhs: Self) -> BVec3 {
334        BVec3::new(self.x.gt(&rhs.x), self.y.gt(&rhs.y), self.z.gt(&rhs.z))
335    }
336
337    /// Returns a vector mask containing the result of a `<=` comparison for each element of
338    /// `self` and `rhs`.
339    ///
340    /// In other words this computes `[self.x <= rhs.x, self.y <= rhs.y, ..]` for all
341    /// elements.
342    #[inline]
343    #[must_use]
344    pub fn cmple(self, rhs: Self) -> BVec3 {
345        BVec3::new(self.x.le(&rhs.x), self.y.le(&rhs.y), self.z.le(&rhs.z))
346    }
347
348    /// Returns a vector mask containing the result of a `<` comparison for each element of
349    /// `self` and `rhs`.
350    ///
351    /// In other words this computes `[self.x < rhs.x, self.y < rhs.y, ..]` for all
352    /// elements.
353    #[inline]
354    #[must_use]
355    pub fn cmplt(self, rhs: Self) -> BVec3 {
356        BVec3::new(self.x.lt(&rhs.x), self.y.lt(&rhs.y), self.z.lt(&rhs.z))
357    }
358
359    /// Returns a vector containing the absolute value of each element of `self`.
360    #[inline]
361    #[must_use]
362    pub fn abs(self) -> Self {
363        Self {
364            x: math::abs(self.x),
365            y: math::abs(self.y),
366            z: math::abs(self.z),
367        }
368    }
369
370    /// Returns a vector with elements representing the sign of `self`.
371    ///
372    /// - `1.0` if the number is positive, `+0.0` or `INFINITY`
373    /// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
374    /// - `NAN` if the number is `NAN`
375    #[inline]
376    #[must_use]
377    pub fn signum(self) -> Self {
378        Self {
379            x: math::signum(self.x),
380            y: math::signum(self.y),
381            z: math::signum(self.z),
382        }
383    }
384
385    /// Returns a vector with signs of `rhs` and the magnitudes of `self`.
386    #[inline]
387    #[must_use]
388    pub fn copysign(self, rhs: Self) -> Self {
389        Self {
390            x: math::copysign(self.x, rhs.x),
391            y: math::copysign(self.y, rhs.y),
392            z: math::copysign(self.z, rhs.z),
393        }
394    }
395
396    /// Returns a bitmask with the lowest 3 bits set to the sign bits from the elements of `self`.
397    ///
398    /// A negative element results in a `1` bit and a positive element in a `0` bit.  Element `x` goes
399    /// into the first lowest bit, element `y` into the second, etc.
400    #[inline]
401    #[must_use]
402    pub fn is_negative_bitmask(self) -> u32 {
403        (self.x.is_sign_negative() as u32)
404            | (self.y.is_sign_negative() as u32) << 1
405            | (self.z.is_sign_negative() as u32) << 2
406    }
407
408    /// Returns `true` if, and only if, all elements are finite.  If any element is either
409    /// `NaN`, positive or negative infinity, this will return `false`.
410    #[inline]
411    #[must_use]
412    pub fn is_finite(self) -> bool {
413        self.x.is_finite() && self.y.is_finite() && self.z.is_finite()
414    }
415
416    /// Returns `true` if any elements are `NaN`.
417    #[inline]
418    #[must_use]
419    pub fn is_nan(self) -> bool {
420        self.x.is_nan() || self.y.is_nan() || self.z.is_nan()
421    }
422
423    /// Performs `is_nan` on each element of self, returning a vector mask of the results.
424    ///
425    /// In other words, this computes `[x.is_nan(), y.is_nan(), z.is_nan(), w.is_nan()]`.
426    #[inline]
427    #[must_use]
428    pub fn is_nan_mask(self) -> BVec3 {
429        BVec3::new(self.x.is_nan(), self.y.is_nan(), self.z.is_nan())
430    }
431
432    /// Computes the length of `self`.
433    #[doc(alias = "magnitude")]
434    #[inline]
435    #[must_use]
436    pub fn length(self) -> f32 {
437        math::sqrt(self.dot(self))
438    }
439
440    /// Computes the squared length of `self`.
441    ///
442    /// This is faster than `length()` as it avoids a square root operation.
443    #[doc(alias = "magnitude2")]
444    #[inline]
445    #[must_use]
446    pub fn length_squared(self) -> f32 {
447        self.dot(self)
448    }
449
450    /// Computes `1.0 / length()`.
451    ///
452    /// For valid results, `self` must _not_ be of length zero.
453    #[inline]
454    #[must_use]
455    pub fn length_recip(self) -> f32 {
456        self.length().recip()
457    }
458
459    /// Computes the Euclidean distance between two points in space.
460    #[inline]
461    #[must_use]
462    pub fn distance(self, rhs: Self) -> f32 {
463        (self - rhs).length()
464    }
465
466    /// Compute the squared euclidean distance between two points in space.
467    #[inline]
468    #[must_use]
469    pub fn distance_squared(self, rhs: Self) -> f32 {
470        (self - rhs).length_squared()
471    }
472
473    /// Returns the element-wise quotient of [Euclidean division] of `self` by `rhs`.
474    #[inline]
475    #[must_use]
476    pub fn div_euclid(self, rhs: Self) -> Self {
477        Self::new(
478            math::div_euclid(self.x, rhs.x),
479            math::div_euclid(self.y, rhs.y),
480            math::div_euclid(self.z, rhs.z),
481        )
482    }
483
484    /// Returns the element-wise remainder of [Euclidean division] of `self` by `rhs`.
485    ///
486    /// [Euclidean division]: f32::rem_euclid
487    #[inline]
488    #[must_use]
489    pub fn rem_euclid(self, rhs: Self) -> Self {
490        Self::new(
491            math::rem_euclid(self.x, rhs.x),
492            math::rem_euclid(self.y, rhs.y),
493            math::rem_euclid(self.z, rhs.z),
494        )
495    }
496
497    /// Returns `self` normalized to length 1.0.
498    ///
499    /// For valid results, `self` must _not_ be of length zero, nor very close to zero.
500    ///
501    /// See also [`Self::try_normalize()`] and [`Self::normalize_or_zero()`].
502    ///
503    /// Panics
504    ///
505    /// Will panic if `self` is zero length when `glam_assert` is enabled.
506    #[inline]
507    #[must_use]
508    pub fn normalize(self) -> Self {
509        #[allow(clippy::let_and_return)]
510        let normalized = self.mul(self.length_recip());
511        glam_assert!(normalized.is_finite());
512        normalized
513    }
514
515    /// Returns `self` normalized to length 1.0 if possible, else returns `None`.
516    ///
517    /// In particular, if the input is zero (or very close to zero), or non-finite,
518    /// the result of this operation will be `None`.
519    ///
520    /// See also [`Self::normalize_or_zero()`].
521    #[inline]
522    #[must_use]
523    pub fn try_normalize(self) -> Option<Self> {
524        let rcp = self.length_recip();
525        if rcp.is_finite() && rcp > 0.0 {
526            Some(self * rcp)
527        } else {
528            None
529        }
530    }
531
532    /// Returns `self` normalized to length 1.0 if possible, else returns a
533    /// fallback value.
534    ///
535    /// In particular, if the input is zero (or very close to zero), or non-finite,
536    /// the result of this operation will be the fallback value.
537    ///
538    /// See also [`Self::try_normalize()`].
539    #[inline]
540    #[must_use]
541    pub fn normalize_or(self, fallback: Self) -> Self {
542        let rcp = self.length_recip();
543        if rcp.is_finite() && rcp > 0.0 {
544            self * rcp
545        } else {
546            fallback
547        }
548    }
549
550    /// Returns `self` normalized to length 1.0 if possible, else returns zero.
551    ///
552    /// In particular, if the input is zero (or very close to zero), or non-finite,
553    /// the result of this operation will be zero.
554    ///
555    /// See also [`Self::try_normalize()`].
556    #[inline]
557    #[must_use]
558    pub fn normalize_or_zero(self) -> Self {
559        self.normalize_or(Self::ZERO)
560    }
561
562    /// Returns whether `self` is length `1.0` or not.
563    ///
564    /// Uses a precision threshold of approximately `1e-4`.
565    #[inline]
566    #[must_use]
567    pub fn is_normalized(self) -> bool {
568        math::abs(self.length_squared() - 1.0) <= 2e-4
569    }
570
571    /// Returns the vector projection of `self` onto `rhs`.
572    ///
573    /// `rhs` must be of non-zero length.
574    ///
575    /// # Panics
576    ///
577    /// Will panic if `rhs` is zero length when `glam_assert` is enabled.
578    #[inline]
579    #[must_use]
580    pub fn project_onto(self, rhs: Self) -> Self {
581        let other_len_sq_rcp = rhs.dot(rhs).recip();
582        glam_assert!(other_len_sq_rcp.is_finite());
583        rhs * self.dot(rhs) * other_len_sq_rcp
584    }
585
586    /// Returns the vector rejection of `self` from `rhs`.
587    ///
588    /// The vector rejection is the vector perpendicular to the projection of `self` onto
589    /// `rhs`, in rhs words the result of `self - self.project_onto(rhs)`.
590    ///
591    /// `rhs` must be of non-zero length.
592    ///
593    /// # Panics
594    ///
595    /// Will panic if `rhs` has a length of zero when `glam_assert` is enabled.
596    #[inline]
597    #[must_use]
598    pub fn reject_from(self, rhs: Self) -> Self {
599        self - self.project_onto(rhs)
600    }
601
602    /// Returns the vector projection of `self` onto `rhs`.
603    ///
604    /// `rhs` must be normalized.
605    ///
606    /// # Panics
607    ///
608    /// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
609    #[inline]
610    #[must_use]
611    pub fn project_onto_normalized(self, rhs: Self) -> Self {
612        glam_assert!(rhs.is_normalized());
613        rhs * self.dot(rhs)
614    }
615
616    /// Returns the vector rejection of `self` from `rhs`.
617    ///
618    /// The vector rejection is the vector perpendicular to the projection of `self` onto
619    /// `rhs`, in rhs words the result of `self - self.project_onto(rhs)`.
620    ///
621    /// `rhs` must be normalized.
622    ///
623    /// # Panics
624    ///
625    /// Will panic if `rhs` is not normalized when `glam_assert` is enabled.
626    #[inline]
627    #[must_use]
628    pub fn reject_from_normalized(self, rhs: Self) -> Self {
629        self - self.project_onto_normalized(rhs)
630    }
631
632    /// Returns a vector containing the nearest integer to a number for each element of `self`.
633    /// Round half-way cases away from 0.0.
634    #[inline]
635    #[must_use]
636    pub fn round(self) -> Self {
637        Self {
638            x: math::round(self.x),
639            y: math::round(self.y),
640            z: math::round(self.z),
641        }
642    }
643
644    /// Returns a vector containing the largest integer less than or equal to a number for each
645    /// element of `self`.
646    #[inline]
647    #[must_use]
648    pub fn floor(self) -> Self {
649        Self {
650            x: math::floor(self.x),
651            y: math::floor(self.y),
652            z: math::floor(self.z),
653        }
654    }
655
656    /// Returns a vector containing the smallest integer greater than or equal to a number for
657    /// each element of `self`.
658    #[inline]
659    #[must_use]
660    pub fn ceil(self) -> Self {
661        Self {
662            x: math::ceil(self.x),
663            y: math::ceil(self.y),
664            z: math::ceil(self.z),
665        }
666    }
667
668    /// Returns a vector containing the integer part each element of `self`. This means numbers are
669    /// always truncated towards zero.
670    #[inline]
671    #[must_use]
672    pub fn trunc(self) -> Self {
673        Self {
674            x: math::trunc(self.x),
675            y: math::trunc(self.y),
676            z: math::trunc(self.z),
677        }
678    }
679
680    /// Returns a vector containing the fractional part of the vector as `self - self.trunc()`.
681    ///
682    /// Note that this differs from the GLSL implementation of `fract` which returns
683    /// `self - self.floor()`.
684    ///
685    /// Note that this is fast but not precise for large numbers.
686    #[inline]
687    #[must_use]
688    pub fn fract(self) -> Self {
689        self - self.trunc()
690    }
691
692    /// Returns a vector containing the fractional part of the vector as `self - self.floor()`.
693    ///
694    /// Note that this differs from the Rust implementation of `fract` which returns
695    /// `self - self.trunc()`.
696    ///
697    /// Note that this is fast but not precise for large numbers.
698    #[inline]
699    #[must_use]
700    pub fn fract_gl(self) -> Self {
701        self - self.floor()
702    }
703
704    /// Returns a vector containing `e^self` (the exponential function) for each element of
705    /// `self`.
706    #[inline]
707    #[must_use]
708    pub fn exp(self) -> Self {
709        Self::new(math::exp(self.x), math::exp(self.y), math::exp(self.z))
710    }
711
712    /// Returns a vector containing each element of `self` raised to the power of `n`.
713    #[inline]
714    #[must_use]
715    pub fn powf(self, n: f32) -> Self {
716        Self::new(
717            math::powf(self.x, n),
718            math::powf(self.y, n),
719            math::powf(self.z, n),
720        )
721    }
722
723    /// Returns a vector containing the reciprocal `1.0/n` of each element of `self`.
724    #[inline]
725    #[must_use]
726    pub fn recip(self) -> Self {
727        Self {
728            x: 1.0 / self.x,
729            y: 1.0 / self.y,
730            z: 1.0 / self.z,
731        }
732    }
733
734    /// Performs a linear interpolation between `self` and `rhs` based on the value `s`.
735    ///
736    /// When `s` is `0.0`, the result will be equal to `self`.  When `s` is `1.0`, the result
737    /// will be equal to `rhs`. When `s` is outside of range `[0, 1]`, the result is linearly
738    /// extrapolated.
739    #[doc(alias = "mix")]
740    #[inline]
741    #[must_use]
742    pub fn lerp(self, rhs: Self, s: f32) -> Self {
743        self + ((rhs - self) * s)
744    }
745
746    /// Moves towards `rhs` based on the value `d`.
747    ///
748    /// When `d` is `0.0`, the result will be equal to `self`. When `d` is equal to
749    /// `self.distance(rhs)`, the result will be equal to `rhs`. Will not go past `rhs`.
750    #[inline]
751    #[must_use]
752    pub fn move_towards(&self, rhs: Self, d: f32) -> Self {
753        let a = rhs - *self;
754        let len = a.length();
755        if len <= d || len <= 1e-4 {
756            return rhs;
757        }
758        *self + a / len * d
759    }
760
761    /// Calculates the midpoint between `self` and `rhs`.
762    ///
763    /// The midpoint is the average of, or halfway point between, two vectors.
764    /// `a.midpoint(b)` should yield the same result as `a.lerp(b, 0.5)`
765    /// while being slightly cheaper to compute.
766    #[inline]
767    pub fn midpoint(self, rhs: Self) -> Self {
768        (self + rhs) * 0.5
769    }
770
771    /// Returns true if the absolute difference of all elements between `self` and `rhs` is
772    /// less than or equal to `max_abs_diff`.
773    ///
774    /// This can be used to compare if two vectors contain similar elements. It works best when
775    /// comparing with a known value. The `max_abs_diff` that should be used used depends on
776    /// the values being compared against.
777    ///
778    /// For more see
779    /// [comparing floating point numbers](https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/).
780    #[inline]
781    #[must_use]
782    pub fn abs_diff_eq(self, rhs: Self, max_abs_diff: f32) -> bool {
783        self.sub(rhs).abs().cmple(Self::splat(max_abs_diff)).all()
784    }
785
786    /// Returns a vector with a length no less than `min` and no more than `max`
787    ///
788    /// # Panics
789    ///
790    /// Will panic if `min` is greater than `max` when `glam_assert` is enabled.
791    #[inline]
792    #[must_use]
793    pub fn clamp_length(self, min: f32, max: f32) -> Self {
794        glam_assert!(min <= max);
795        let length_sq = self.length_squared();
796        if length_sq < min * min {
797            min * (self / math::sqrt(length_sq))
798        } else if length_sq > max * max {
799            max * (self / math::sqrt(length_sq))
800        } else {
801            self
802        }
803    }
804
805    /// Returns a vector with a length no more than `max`
806    #[inline]
807    #[must_use]
808    pub fn clamp_length_max(self, max: f32) -> Self {
809        let length_sq = self.length_squared();
810        if length_sq > max * max {
811            max * (self / math::sqrt(length_sq))
812        } else {
813            self
814        }
815    }
816
817    /// Returns a vector with a length no less than `min`
818    #[inline]
819    #[must_use]
820    pub fn clamp_length_min(self, min: f32) -> Self {
821        let length_sq = self.length_squared();
822        if length_sq < min * min {
823            min * (self / math::sqrt(length_sq))
824        } else {
825            self
826        }
827    }
828
829    /// Fused multiply-add. Computes `(self * a) + b` element-wise with only one rounding
830    /// error, yielding a more accurate result than an unfused multiply-add.
831    ///
832    /// Using `mul_add` *may* be more performant than an unfused multiply-add if the target
833    /// architecture has a dedicated fma CPU instruction. However, this is not always true,
834    /// and will be heavily dependant on designing algorithms with specific target hardware in
835    /// mind.
836    #[inline]
837    #[must_use]
838    pub fn mul_add(self, a: Self, b: Self) -> Self {
839        Self::new(
840            math::mul_add(self.x, a.x, b.x),
841            math::mul_add(self.y, a.y, b.y),
842            math::mul_add(self.z, a.z, b.z),
843        )
844    }
845
846    /// Returns the angle (in radians) between two vectors.
847    ///
848    /// The inputs do not need to be unit vectors however they must be non-zero.
849    #[inline]
850    #[must_use]
851    pub fn angle_between(self, rhs: Self) -> f32 {
852        math::acos_approx(
853            self.dot(rhs)
854                .div(math::sqrt(self.length_squared().mul(rhs.length_squared()))),
855        )
856    }
857
858    /// Returns some vector that is orthogonal to the given one.
859    ///
860    /// The input vector must be finite and non-zero.
861    ///
862    /// The output vector is not necessarily unit length. For that use
863    /// [`Self::any_orthonormal_vector()`] instead.
864    #[inline]
865    #[must_use]
866    pub fn any_orthogonal_vector(&self) -> Self {
867        // This can probably be optimized
868        if math::abs(self.x) > math::abs(self.y) {
869            Self::new(-self.z, 0.0, self.x) // self.cross(Self::Y)
870        } else {
871            Self::new(0.0, self.z, -self.y) // self.cross(Self::X)
872        }
873    }
874
875    /// Returns any unit vector that is orthogonal to the given one.
876    ///
877    /// The input vector must be unit length.
878    ///
879    /// # Panics
880    ///
881    /// Will panic if `self` is not normalized when `glam_assert` is enabled.
882    #[inline]
883    #[must_use]
884    pub fn any_orthonormal_vector(&self) -> Self {
885        glam_assert!(self.is_normalized());
886        // From https://graphics.pixar.com/library/OrthonormalB/paper.pdf
887        let sign = math::signum(self.z);
888        let a = -1.0 / (sign + self.z);
889        let b = self.x * self.y * a;
890        Self::new(b, sign + self.y * self.y * a, -self.y)
891    }
892
893    /// Given a unit vector return two other vectors that together form an orthonormal
894    /// basis. That is, all three vectors are orthogonal to each other and are normalized.
895    ///
896    /// # Panics
897    ///
898    /// Will panic if `self` is not normalized when `glam_assert` is enabled.
899    #[inline]
900    #[must_use]
901    pub fn any_orthonormal_pair(&self) -> (Self, Self) {
902        glam_assert!(self.is_normalized());
903        // From https://graphics.pixar.com/library/OrthonormalB/paper.pdf
904        let sign = math::signum(self.z);
905        let a = -1.0 / (sign + self.z);
906        let b = self.x * self.y * a;
907        (
908            Self::new(1.0 + sign * self.x * self.x * a, sign * b, -sign * self.x),
909            Self::new(b, sign + self.y * self.y * a, -self.y),
910        )
911    }
912
913    /// Casts all elements of `self` to `f64`.
914    #[inline]
915    #[must_use]
916    pub fn as_dvec3(&self) -> crate::DVec3 {
917        crate::DVec3::new(self.x as f64, self.y as f64, self.z as f64)
918    }
919
920    /// Casts all elements of `self` to `i16`.
921    #[inline]
922    #[must_use]
923    pub fn as_i16vec3(&self) -> crate::I16Vec3 {
924        crate::I16Vec3::new(self.x as i16, self.y as i16, self.z as i16)
925    }
926
927    /// Casts all elements of `self` to `u16`.
928    #[inline]
929    #[must_use]
930    pub fn as_u16vec3(&self) -> crate::U16Vec3 {
931        crate::U16Vec3::new(self.x as u16, self.y as u16, self.z as u16)
932    }
933
934    /// Casts all elements of `self` to `i32`.
935    #[inline]
936    #[must_use]
937    pub fn as_ivec3(&self) -> crate::IVec3 {
938        crate::IVec3::new(self.x as i32, self.y as i32, self.z as i32)
939    }
940
941    /// Casts all elements of `self` to `u32`.
942    #[inline]
943    #[must_use]
944    pub fn as_uvec3(&self) -> crate::UVec3 {
945        crate::UVec3::new(self.x as u32, self.y as u32, self.z as u32)
946    }
947
948    /// Casts all elements of `self` to `i64`.
949    #[inline]
950    #[must_use]
951    pub fn as_i64vec3(&self) -> crate::I64Vec3 {
952        crate::I64Vec3::new(self.x as i64, self.y as i64, self.z as i64)
953    }
954
955    /// Casts all elements of `self` to `u64`.
956    #[inline]
957    #[must_use]
958    pub fn as_u64vec3(&self) -> crate::U64Vec3 {
959        crate::U64Vec3::new(self.x as u64, self.y as u64, self.z as u64)
960    }
961}
962
963impl Default for Vec3 {
964    #[inline(always)]
965    fn default() -> Self {
966        Self::ZERO
967    }
968}
969
970impl Div<Vec3> for Vec3 {
971    type Output = Self;
972    #[inline]
973    fn div(self, rhs: Self) -> Self {
974        Self {
975            x: self.x.div(rhs.x),
976            y: self.y.div(rhs.y),
977            z: self.z.div(rhs.z),
978        }
979    }
980}
981
982impl DivAssign<Vec3> for Vec3 {
983    #[inline]
984    fn div_assign(&mut self, rhs: Self) {
985        self.x.div_assign(rhs.x);
986        self.y.div_assign(rhs.y);
987        self.z.div_assign(rhs.z);
988    }
989}
990
991impl Div<f32> for Vec3 {
992    type Output = Self;
993    #[inline]
994    fn div(self, rhs: f32) -> Self {
995        Self {
996            x: self.x.div(rhs),
997            y: self.y.div(rhs),
998            z: self.z.div(rhs),
999        }
1000    }
1001}
1002
1003impl DivAssign<f32> for Vec3 {
1004    #[inline]
1005    fn div_assign(&mut self, rhs: f32) {
1006        self.x.div_assign(rhs);
1007        self.y.div_assign(rhs);
1008        self.z.div_assign(rhs);
1009    }
1010}
1011
1012impl Div<Vec3> for f32 {
1013    type Output = Vec3;
1014    #[inline]
1015    fn div(self, rhs: Vec3) -> Vec3 {
1016        Vec3 {
1017            x: self.div(rhs.x),
1018            y: self.div(rhs.y),
1019            z: self.div(rhs.z),
1020        }
1021    }
1022}
1023
1024impl Mul<Vec3> for Vec3 {
1025    type Output = Self;
1026    #[inline]
1027    fn mul(self, rhs: Self) -> Self {
1028        Self {
1029            x: self.x.mul(rhs.x),
1030            y: self.y.mul(rhs.y),
1031            z: self.z.mul(rhs.z),
1032        }
1033    }
1034}
1035
1036impl MulAssign<Vec3> for Vec3 {
1037    #[inline]
1038    fn mul_assign(&mut self, rhs: Self) {
1039        self.x.mul_assign(rhs.x);
1040        self.y.mul_assign(rhs.y);
1041        self.z.mul_assign(rhs.z);
1042    }
1043}
1044
1045impl Mul<f32> for Vec3 {
1046    type Output = Self;
1047    #[inline]
1048    fn mul(self, rhs: f32) -> Self {
1049        Self {
1050            x: self.x.mul(rhs),
1051            y: self.y.mul(rhs),
1052            z: self.z.mul(rhs),
1053        }
1054    }
1055}
1056
1057impl MulAssign<f32> for Vec3 {
1058    #[inline]
1059    fn mul_assign(&mut self, rhs: f32) {
1060        self.x.mul_assign(rhs);
1061        self.y.mul_assign(rhs);
1062        self.z.mul_assign(rhs);
1063    }
1064}
1065
1066impl Mul<Vec3> for f32 {
1067    type Output = Vec3;
1068    #[inline]
1069    fn mul(self, rhs: Vec3) -> Vec3 {
1070        Vec3 {
1071            x: self.mul(rhs.x),
1072            y: self.mul(rhs.y),
1073            z: self.mul(rhs.z),
1074        }
1075    }
1076}
1077
1078impl Add<Vec3> for Vec3 {
1079    type Output = Self;
1080    #[inline]
1081    fn add(self, rhs: Self) -> Self {
1082        Self {
1083            x: self.x.add(rhs.x),
1084            y: self.y.add(rhs.y),
1085            z: self.z.add(rhs.z),
1086        }
1087    }
1088}
1089
1090impl AddAssign<Vec3> for Vec3 {
1091    #[inline]
1092    fn add_assign(&mut self, rhs: Self) {
1093        self.x.add_assign(rhs.x);
1094        self.y.add_assign(rhs.y);
1095        self.z.add_assign(rhs.z);
1096    }
1097}
1098
1099impl Add<f32> for Vec3 {
1100    type Output = Self;
1101    #[inline]
1102    fn add(self, rhs: f32) -> Self {
1103        Self {
1104            x: self.x.add(rhs),
1105            y: self.y.add(rhs),
1106            z: self.z.add(rhs),
1107        }
1108    }
1109}
1110
1111impl AddAssign<f32> for Vec3 {
1112    #[inline]
1113    fn add_assign(&mut self, rhs: f32) {
1114        self.x.add_assign(rhs);
1115        self.y.add_assign(rhs);
1116        self.z.add_assign(rhs);
1117    }
1118}
1119
1120impl Add<Vec3> for f32 {
1121    type Output = Vec3;
1122    #[inline]
1123    fn add(self, rhs: Vec3) -> Vec3 {
1124        Vec3 {
1125            x: self.add(rhs.x),
1126            y: self.add(rhs.y),
1127            z: self.add(rhs.z),
1128        }
1129    }
1130}
1131
1132impl Sub<Vec3> for Vec3 {
1133    type Output = Self;
1134    #[inline]
1135    fn sub(self, rhs: Self) -> Self {
1136        Self {
1137            x: self.x.sub(rhs.x),
1138            y: self.y.sub(rhs.y),
1139            z: self.z.sub(rhs.z),
1140        }
1141    }
1142}
1143
1144impl SubAssign<Vec3> for Vec3 {
1145    #[inline]
1146    fn sub_assign(&mut self, rhs: Vec3) {
1147        self.x.sub_assign(rhs.x);
1148        self.y.sub_assign(rhs.y);
1149        self.z.sub_assign(rhs.z);
1150    }
1151}
1152
1153impl Sub<f32> for Vec3 {
1154    type Output = Self;
1155    #[inline]
1156    fn sub(self, rhs: f32) -> Self {
1157        Self {
1158            x: self.x.sub(rhs),
1159            y: self.y.sub(rhs),
1160            z: self.z.sub(rhs),
1161        }
1162    }
1163}
1164
1165impl SubAssign<f32> for Vec3 {
1166    #[inline]
1167    fn sub_assign(&mut self, rhs: f32) {
1168        self.x.sub_assign(rhs);
1169        self.y.sub_assign(rhs);
1170        self.z.sub_assign(rhs);
1171    }
1172}
1173
1174impl Sub<Vec3> for f32 {
1175    type Output = Vec3;
1176    #[inline]
1177    fn sub(self, rhs: Vec3) -> Vec3 {
1178        Vec3 {
1179            x: self.sub(rhs.x),
1180            y: self.sub(rhs.y),
1181            z: self.sub(rhs.z),
1182        }
1183    }
1184}
1185
1186impl Rem<Vec3> for Vec3 {
1187    type Output = Self;
1188    #[inline]
1189    fn rem(self, rhs: Self) -> Self {
1190        Self {
1191            x: self.x.rem(rhs.x),
1192            y: self.y.rem(rhs.y),
1193            z: self.z.rem(rhs.z),
1194        }
1195    }
1196}
1197
1198impl RemAssign<Vec3> for Vec3 {
1199    #[inline]
1200    fn rem_assign(&mut self, rhs: Self) {
1201        self.x.rem_assign(rhs.x);
1202        self.y.rem_assign(rhs.y);
1203        self.z.rem_assign(rhs.z);
1204    }
1205}
1206
1207impl Rem<f32> for Vec3 {
1208    type Output = Self;
1209    #[inline]
1210    fn rem(self, rhs: f32) -> Self {
1211        Self {
1212            x: self.x.rem(rhs),
1213            y: self.y.rem(rhs),
1214            z: self.z.rem(rhs),
1215        }
1216    }
1217}
1218
1219impl RemAssign<f32> for Vec3 {
1220    #[inline]
1221    fn rem_assign(&mut self, rhs: f32) {
1222        self.x.rem_assign(rhs);
1223        self.y.rem_assign(rhs);
1224        self.z.rem_assign(rhs);
1225    }
1226}
1227
1228impl Rem<Vec3> for f32 {
1229    type Output = Vec3;
1230    #[inline]
1231    fn rem(self, rhs: Vec3) -> Vec3 {
1232        Vec3 {
1233            x: self.rem(rhs.x),
1234            y: self.rem(rhs.y),
1235            z: self.rem(rhs.z),
1236        }
1237    }
1238}
1239
1240#[cfg(not(target_arch = "spirv"))]
1241impl AsRef<[f32; 3]> for Vec3 {
1242    #[inline]
1243    fn as_ref(&self) -> &[f32; 3] {
1244        unsafe { &*(self as *const Vec3 as *const [f32; 3]) }
1245    }
1246}
1247
1248#[cfg(not(target_arch = "spirv"))]
1249impl AsMut<[f32; 3]> for Vec3 {
1250    #[inline]
1251    fn as_mut(&mut self) -> &mut [f32; 3] {
1252        unsafe { &mut *(self as *mut Vec3 as *mut [f32; 3]) }
1253    }
1254}
1255
1256impl Sum for Vec3 {
1257    #[inline]
1258    fn sum<I>(iter: I) -> Self
1259    where
1260        I: Iterator<Item = Self>,
1261    {
1262        iter.fold(Self::ZERO, Self::add)
1263    }
1264}
1265
1266impl<'a> Sum<&'a Self> for Vec3 {
1267    #[inline]
1268    fn sum<I>(iter: I) -> Self
1269    where
1270        I: Iterator<Item = &'a Self>,
1271    {
1272        iter.fold(Self::ZERO, |a, &b| Self::add(a, b))
1273    }
1274}
1275
1276impl Product for Vec3 {
1277    #[inline]
1278    fn product<I>(iter: I) -> Self
1279    where
1280        I: Iterator<Item = Self>,
1281    {
1282        iter.fold(Self::ONE, Self::mul)
1283    }
1284}
1285
1286impl<'a> Product<&'a Self> for Vec3 {
1287    #[inline]
1288    fn product<I>(iter: I) -> Self
1289    where
1290        I: Iterator<Item = &'a Self>,
1291    {
1292        iter.fold(Self::ONE, |a, &b| Self::mul(a, b))
1293    }
1294}
1295
1296impl Neg for Vec3 {
1297    type Output = Self;
1298    #[inline]
1299    fn neg(self) -> Self {
1300        Self {
1301            x: self.x.neg(),
1302            y: self.y.neg(),
1303            z: self.z.neg(),
1304        }
1305    }
1306}
1307
1308impl Index<usize> for Vec3 {
1309    type Output = f32;
1310    #[inline]
1311    fn index(&self, index: usize) -> &Self::Output {
1312        match index {
1313            0 => &self.x,
1314            1 => &self.y,
1315            2 => &self.z,
1316            _ => panic!("index out of bounds"),
1317        }
1318    }
1319}
1320
1321impl IndexMut<usize> for Vec3 {
1322    #[inline]
1323    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
1324        match index {
1325            0 => &mut self.x,
1326            1 => &mut self.y,
1327            2 => &mut self.z,
1328            _ => panic!("index out of bounds"),
1329        }
1330    }
1331}
1332
1333#[cfg(not(target_arch = "spirv"))]
1334impl fmt::Display for Vec3 {
1335    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1336        if let Some(p) = f.precision() {
1337            write!(f, "[{:.*}, {:.*}, {:.*}]", p, self.x, p, self.y, p, self.z)
1338        } else {
1339            write!(f, "[{}, {}, {}]", self.x, self.y, self.z)
1340        }
1341    }
1342}
1343
1344#[cfg(not(target_arch = "spirv"))]
1345impl fmt::Debug for Vec3 {
1346    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1347        fmt.debug_tuple(stringify!(Vec3))
1348            .field(&self.x)
1349            .field(&self.y)
1350            .field(&self.z)
1351            .finish()
1352    }
1353}
1354
1355impl From<[f32; 3]> for Vec3 {
1356    #[inline]
1357    fn from(a: [f32; 3]) -> Self {
1358        Self::new(a[0], a[1], a[2])
1359    }
1360}
1361
1362impl From<Vec3> for [f32; 3] {
1363    #[inline]
1364    fn from(v: Vec3) -> Self {
1365        [v.x, v.y, v.z]
1366    }
1367}
1368
1369impl From<(f32, f32, f32)> for Vec3 {
1370    #[inline]
1371    fn from(t: (f32, f32, f32)) -> Self {
1372        Self::new(t.0, t.1, t.2)
1373    }
1374}
1375
1376impl From<Vec3> for (f32, f32, f32) {
1377    #[inline]
1378    fn from(v: Vec3) -> Self {
1379        (v.x, v.y, v.z)
1380    }
1381}
1382
1383impl From<(Vec2, f32)> for Vec3 {
1384    #[inline]
1385    fn from((v, z): (Vec2, f32)) -> Self {
1386        Self::new(v.x, v.y, z)
1387    }
1388}
1389
1390impl From<BVec3> for Vec3 {
1391    #[inline]
1392    fn from(v: BVec3) -> Self {
1393        Self::new(f32::from(v.x), f32::from(v.y), f32::from(v.z))
1394    }
1395}
1396
1397impl From<BVec3A> for Vec3 {
1398    #[inline]
1399    fn from(v: BVec3A) -> Self {
1400        let bool_array: [bool; 3] = v.into();
1401        Self::new(
1402            f32::from(bool_array[0]),
1403            f32::from(bool_array[1]),
1404            f32::from(bool_array[2]),
1405        )
1406    }
1407}
glam/f32/vec3.rs

glam/f32/
vec3.rs
