glamour 0.18.0

Strongly typed linear algebra with glam
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
//! Size vectors

use crate::{
    Scalar, Transparent, Unit, Vector2, Vector3, bindings::prelude::*, rewrap, scalar::FloatScalar,
    unit::FloatUnit,
};

use bytemuck::{Pod, Zeroable};
use num_traits::{ConstOne, ConstZero};

/// 2D size.
#[cfg_attr(
    all(not(target_arch = "wasm32"), feature = "wasmtime"),
    derive(
        wasmtime::component::ComponentType,
        wasmtime::component::Lower,
        wasmtime::component::Lift
    )
)]
#[cfg_attr(
    all(not(target_arch = "wasm32"), feature = "wasmtime"),
    component(record)
)]
#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
#[repr(C)]
pub struct Size2<U: Unit = f32> {
    /// Width
    pub width: U::Scalar,
    /// Height
    pub height: U::Scalar,
}

/// SAFETY: All members are `Pod`, and we are `#[repr(C)]`.
unsafe impl<T: Unit> Pod for Size2<T> {}
/// SAFETY: All members are `Pod`, and we are `#[repr(C)]`.
unsafe impl<T: Unit> Zeroable for Size2<T> {}
impl<T: Unit> Transparent for Size2<T> {
    type Wrapped = <T::Scalar as Scalar>::Vec2;
}

/// 3D size.
#[cfg_attr(
    all(not(target_arch = "wasm32"), feature = "wasmtime"),
    derive(
        wasmtime::component::ComponentType,
        wasmtime::component::Lower,
        wasmtime::component::Lift
    )
)]
#[cfg_attr(
    all(not(target_arch = "wasm32"), feature = "wasmtime"),
    component(record)
)]
#[repr(C)]
#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
pub struct Size3<U: Unit = f32> {
    /// Width
    pub width: U::Scalar,
    /// Height
    pub height: U::Scalar,
    /// Depth
    pub depth: U::Scalar,
}

/// SAFETY: All members are `Pod`, and we are `#[repr(C)]`.
unsafe impl<T: Unit> Pod for Size3<T> {}
/// SAFETY: All members are `Pod`, and we are `#[repr(C)]`.
unsafe impl<T: Unit> Zeroable for Size3<T> {}
// SAFETY: This is the guarantee of this crate.
impl<T: Unit> Transparent for Size3<T> {
    type Wrapped = <T::Scalar as Scalar>::Vec3;
}

macro_rules! impl_size {
    ($base_type_name:ident [ $dimensions:tt ] => $vec_ty:ident, $vector_type:ident) => {
        impl<T: Unit> From<$vector_type<T>> for $base_type_name<T> {
            #[inline]
            fn from(vec: $vector_type<T>) -> Self {
                rewrap(vec)
            }
        }

        impl<T: Unit> From<$base_type_name<T>> for $vector_type<T> {
            #[inline]
            fn from(point: $base_type_name<T>) -> Self {
                rewrap(point)
            }
        }

        impl<T: Unit> $base_type_name<T> {
            #[doc = "Interpret `vec` as size."]
            #[inline]
            pub fn from_vector(vec: $vector_type<T>) -> Self {
                vec.into()
            }

            #[doc = "Convert to vector."]
            #[inline]
            pub fn to_vector(self) -> $vector_type<T> {
                self.into()
            }

            #[doc = "Reinterpret as vector."]
            #[inline]
            pub fn as_vector(&self) -> &$vector_type<T> {
                bytemuck::cast_ref(self)
            }

            #[doc = "Reinterpret as vector."]
            #[inline]
            pub fn as_vector_mut(&mut self) -> &mut $vector_type<T> {
                bytemuck::cast_mut(self)
            }

            #[doc = "True if any component is zero, or negative, or NaN."]
            pub fn is_empty(self) -> bool {
                let dim: [T::Scalar; $dimensions] = self.into();
                !dim.into_iter().all(|d| d > T::Scalar::ZERO)
            }

            #[doc = "Replace the width component with a new value."]
            #[inline]
            #[must_use]
            pub fn with_width(self, width: T::Scalar) -> Self {
                Self { width, ..self }
            }

            #[doc = "Replace the width component with a new value."]
            #[inline]
            #[must_use]
            pub fn with_height(self, height: T::Scalar) -> Self {
                Self { height, ..self }
            }
        }
    };
}

impl_size!(Size2 [2] => Vec2, Vector2);
impl_size!(Size3 [3] => Vec3, Vector3);

crate::impl_vectorlike::sizelike!(Size2, 2);
crate::impl_vectorlike::sizelike!(Size3, 3);

crate::impl_ops::size_ops!(Size2);
crate::impl_ops::size_ops!(Size3);

impl<T: Unit> Size2<T> {
    /// New size.
    pub const fn new(width: T::Scalar, height: T::Scalar) -> Self {
        Self { width, height }
    }

    /// Calculate the area.
    #[inline]
    #[must_use]
    pub fn area(&self) -> T::Scalar {
        self.to_vector().element_product()
    }
}

impl<T: Unit> Size3<T> {
    /// New size.
    pub const fn new(width: T::Scalar, height: T::Scalar, depth: T::Scalar) -> Self {
        Self {
            width,
            height,
            depth,
        }
    }

    /// Calculate the volume.
    #[inline]
    #[must_use]
    pub fn volume(&self) -> T::Scalar {
        self.to_vector().element_product()
    }

    /// Replace the depth component with a new value.
    #[inline]
    #[must_use]
    pub fn with_depth(self, depth: T::Scalar) -> Self {
        Self { depth, ..self }
    }
}

impl<T: Unit> core::fmt::Debug for Size2<T> {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        f.debug_struct("Size2")
            .field("width", &self.width)
            .field("height", &self.height)
            .finish()
    }
}
impl<T: Unit> core::fmt::Debug for Size3<T> {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        f.debug_struct("Size3")
            .field("width", &self.width)
            .field("height", &self.height)
            .field("depth", &self.depth)
            .finish()
    }
}

#[cfg(test)]
mod tests {
    use crate::{peel, size};

    use super::*;

    #[test]
    fn arithmetic() {
        let mut a: Size2<f32> = size!(100.0, 200.0);
        let b: Size2<f32> = a - size!(50.0, 100.0);
        assert_eq!(b, size!(50.0, 100.0));
        a -= size!(50.0, 100.0);
        assert_eq!(a, size!(50.0, 100.0));
        assert_eq!(a + size!(2.0, 3.0), size!(52.0, 103.0));
        a += size!(100.0, 200.0);
        assert_eq!(a, size!(150.0, 300.0));
    }

    #[test]
    fn as_vector() {
        let mut a: Size2<f32> = size!(100.0, 200.0);
        let _: &Vector2<f32> = a.as_vector();
        let _: &mut Vector2<f32> = a.as_vector_mut();

        let mut b: Size3<f32> = size!(100.0, 200.0, 300.0);
        let _: &Vector3<f32> = b.as_vector();
        let _: &mut Vector3<f32> = b.as_vector_mut();
    }

    #[test]
    fn area() {
        let a: Size2<f32> = Size2 {
            width: 2.0,
            height: 3.0,
        };
        let b: Size2<i32> = Size2 {
            width: 5,
            height: 6,
        };
        let c: Size2<f64> = Size2 {
            width: 100.0,
            height: 300.0,
        };

        assert_eq!(a.area(), 6.0);
        assert_eq!(b.area(), 30);
        assert_eq!(c.area(), 30000.0);
    }

    #[test]
    fn is_empty() {
        assert!(Size2::<f32>::ZERO.is_empty());
        assert!(Size3::<f32>::ZERO.is_empty());
        assert!(!Size2::<f32>::ONE.is_empty());
        assert!(!Size3::<f32>::ONE.is_empty());

        assert!(
            Size2::<f32> {
                width: 0.0,
                height: 1.0
            }
            .is_empty()
        );
        assert!(
            Size3::<f32> {
                width: 0.0,
                height: 1.0,
                depth: 1.0
            }
            .is_empty()
        );
    }

    #[test]
    fn volume() {
        let a: Size3<f32> = Size3 {
            width: 2.0,
            height: 3.0,
            depth: 2.0,
        };
        let b: Size3<i32> = Size3 {
            width: 5,
            height: 6,
            depth: 2,
        };
        let c: Size3<f64> = Size3 {
            width: 100.0,
            height: 300.0,
            depth: 2.0,
        };

        assert_eq!(a.volume(), 12.0);
        assert_eq!(b.volume(), 60);
        assert_eq!(c.volume(), 60000.0);
    }

    #[test]
    fn from_into_vector() {
        let mut p: Size2<f32> = size!(1.0, 2.0);
        let mut v: Vector2<f32> = p.to_vector();
        let q: Size2<f32> = Size2::from_vector(v);
        assert_eq!(p, q);
        assert_eq!(Vector2::from_size(p), v);

        let _: &Vector2<_> = p.as_vector();
        let _: &mut Vector2<_> = p.as_vector_mut();
        let _: &Size2<_> = v.as_size();
        let _: &mut Size2<_> = v.as_size_mut();
    }

    #[test]
    fn to_raw() {
        let s = Size2::<f32> {
            width: 1.0,
            height: 2.0,
        };
        assert_eq!(peel(s), glam::Vec2 { x: 1.0, y: 2.0 });
        let s = Size3::<f32> {
            width: 1.0,
            height: 2.0,
            depth: 3.0,
        };
        assert_eq!(
            peel(s),
            glam::Vec3 {
                x: 1.0,
                y: 2.0,
                z: 3.0
            }
        );
        assert_eq!(
            Size3::<f32>::wrap(glam::Vec3::new(1.0, 2.0, 3.0)),
            Size3 {
                width: 1.0,
                height: 2.0,
                depth: 3.0
            }
        );
    }

    #[test]
    fn with_width_height_depth() {
        let s = Size2::<f32> {
            width: 1.0,
            height: 2.0,
        };
        assert_eq!(
            s.with_width(3.0),
            Size2::<f32> {
                width: 3.0,
                height: 2.0
            }
        );
        assert_eq!(
            s.with_height(3.0),
            Size2::<f32> {
                width: 1.0,
                height: 3.0
            }
        );

        let s = Size3::<f32> {
            width: 1.0,
            height: 2.0,
            depth: 3.0,
        };
        assert_eq!(
            s.with_width(4.0),
            Size3::<f32> {
                width: 4.0,
                height: 2.0,
                depth: 3.0
            }
        );
        assert_eq!(
            s.with_height(4.0),
            Size3::<f32> {
                width: 1.0,
                height: 4.0,
                depth: 3.0
            }
        );
        assert_eq!(
            s.with_depth(4.0),
            Size3::<f32> {
                width: 1.0,
                height: 2.0,
                depth: 4.0
            }
        );
    }

    #[test]
    fn gaslight_coverage() {
        extern crate alloc;
        _ = alloc::format!("{:?}", Size2::<f32>::ZERO);
        _ = alloc::format!("{:?}", Size3::<f32>::ZERO);
        assert_eq!(Size2::<f32>::from_tuple((1.0, 2.0)), Size2::new(1.0, 2.0));
        assert_eq!(
            Size3::<f32>::from_tuple((1.0, 2.0, 3.0)),
            Size3::new(1.0, 2.0, 3.0)
        );
        assert_eq!(Size2::<f32>::ZERO.to_tuple(), (0.0, 0.0));
        assert_eq!(Size3::<f32>::ZERO.to_tuple(), (0.0, 0.0, 0.0));
    }
}