Merge pull request dimforge#845 from dimforge/glam

Add conversions from/to glam types.

Author: sebcrozet

CHANGELOG.md

@@ -6,6 +6,12 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [0.25.2] - WIP
 ### Added
+- A `convert-glam` cargo feature to enable implementations of `From` traits to convert
+  between `glam` types and `nalgebra` types.
+- A `convert-glam-unchecked` cargo feature to enable some extra `glam`/`nalgebra` conversions that may
+  lead to unexpected results if used improperly. For example, this enables the conversion from a
+  `glam::Mat4` to a `na::Isometry3`. This conversion will be cheap (without any check) but willlead to
+  unexpected results if the glam matrix contains non-isometric components (like scaling for example).
 - A `cast` method has been added to most types. This can be used to change the
   type of the components of a given entity. Example: `vector.cast::<f32>()`.
 

Cargo.toml

@@ -24,23 +24,33 @@ path = "src/lib.rs"
 [features]
 default         = [ "std" ]
 std             = [ "matrixmultiply", "simba/std" ]
-rand-no-std     = [ "rand-package" ]
-rand            = [ "rand-no-std", "rand-package/std", "rand-package/std_rng", "rand_distr" ]
-arbitrary       = [ "quickcheck" ]
-serde-serialize = [ "serde", "num-complex/serde" ]
-abomonation-serialize = [ "abomonation" ]
 sparse = [ ]
 debug = [ "approx/num-complex", "rand" ]
 alloc = [ ]
 io = [ "pest", "pest_derive" ]
 compare = [ "matrixcompare-core" ]
 libm = [ "simba/libm" ]
 libm-force = [ "simba/libm_force" ]
-proptest-support = [ "proptest" ]
 no_unsound_assume_init = [ ]
 
-# This feature is only used for tests, and enables tests that require more time to run
-slow-tests = []
+# Conversion
+convert-mint = [ "mint" ]
+convert-glam = [ "glam" ]
+convert-glam-unchecked = [ "convert-glam" ] # Unable edgy conversions like Mat4 -> Isometry3
+convert-bytemuck = [ "bytemuck" ]
+
+# Serialization
+serde-serialize = [ "serde", "num-complex/serde" ]
+abomonation-serialize = [ "abomonation" ]
+
+# Randomness
+rand-no-std = [ "rand-package" ]
+rand        = [ "rand-no-std", "rand-package/std", "rand-package/std_rng", "rand_distr" ]
+
+# Tests
+arbitrary        = [ "quickcheck" ]
+proptest-support = [ "proptest" ]
+slow-tests       = []
 
 [dependencies]
 typenum        = "1.12"
@@ -57,6 +67,7 @@ matrixmultiply = { version = "0.3", optional = true }
 serde          = { version = "1.0", default-features = false, features = [ "derive" ], optional = true }
 abomonation    = { version = "0.7", optional = true }
 mint           = { version = "0.5", optional = true }
+glam           = { version = "0.13", optional = true }
 quickcheck     = { version = "1", optional = true }
 pest           = { version = "2", optional = true }
 pest_derive    = { version = "2", optional = true }

src/base/conversion.rs

@@ -1,7 +1,5 @@
 #[cfg(all(feature = "alloc", not(feature = "std")))]
 use alloc::vec::Vec;
-#[cfg(feature = "mint")]
-use mint;
 use simba::scalar::{SubsetOf, SupersetOf};
 use std::convert::{AsMut, AsRef, From, Into};
 use std::mem;
@@ -235,119 +233,6 @@ impl_from_into_asref_2D!(
     (U6, U2) => (6, 2); (U6, U3) => (6, 3); (U6, U4) => (6, 4); (U6, U5) => (6, 5); (U6, U6) => (6, 6);
 );
 
-#[cfg(feature = "mint")]
-macro_rules! impl_from_into_mint_1D(
-    ($($NRows: ident => $VT:ident [$SZ: expr]);* $(;)*) => {$(
-        impl<N> From<mint::$VT<N>> for MatrixMN<N, $NRows, U1>
-        where N: Scalar,
-              DefaultAllocator: Allocator<N, $NRows, U1> {
-            #[inline]
-            fn from(v: mint::$VT<N>) -> Self {
-                unsafe {
-                    let mut res = Self::new_uninitialized();
-                    ptr::copy_nonoverlapping(&v.x, (*res.as_mut_ptr()).data.ptr_mut(), $SZ);
-
-                    res.assume_init()
-                }
-            }
-        }
-
-        impl<N, S> Into<mint::$VT<N>> for Matrix<N, $NRows, U1, S>
-        where N: Scalar,
-              S: ContiguousStorage<N, $NRows, U1> {
-            #[inline]
-            fn into(self) -> mint::$VT<N> {
-                unsafe {
-                    let mut res: mint::$VT<N> = mem::MaybeUninit::uninit().assume_init();
-                    ptr::copy_nonoverlapping(self.data.ptr(), &mut res.x, $SZ);
-                    res
-                }
-            }
-        }
-
-        impl<N, S> AsRef<mint::$VT<N>> for Matrix<N, $NRows, U1, S>
-        where N: Scalar,
-              S: ContiguousStorage<N, $NRows, U1> {
-            #[inline]
-            fn as_ref(&self) -> &mint::$VT<N> {
-                unsafe {
-                    mem::transmute(self.data.ptr())
-                }
-            }
-        }
-
-        impl<N, S> AsMut<mint::$VT<N>> for Matrix<N, $NRows, U1, S>
-        where N: Scalar,
-              S: ContiguousStorageMut<N, $NRows, U1> {
-            #[inline]
-            fn as_mut(&mut self) -> &mut mint::$VT<N> {
-                unsafe {
-                    mem::transmute(self.data.ptr_mut())
-                }
-            }
-        }
-    )*}
-);
-
-// Implement for vectors of dimension 2 .. 4.
-#[cfg(feature = "mint")]
-impl_from_into_mint_1D!(
-    U2 => Vector2[2];
-    U3 => Vector3[3];
-    U4 => Vector4[4];
-);
-
-#[cfg(feature = "mint")]
-macro_rules! impl_from_into_mint_2D(
-    ($(($NRows: ty, $NCols: ty) => $MV:ident{ $($component:ident),* }[$SZRows: expr]);* $(;)*) => {$(
-        impl<N> From<mint::$MV<N>> for MatrixMN<N, $NRows, $NCols>
-        where N: Scalar,
-              DefaultAllocator: Allocator<N, $NRows, $NCols> {
-            #[inline]
-            fn from(m: mint::$MV<N>) -> Self {
-                unsafe {
-                    let mut res = Self::new_uninitialized();
-                    let mut ptr = (*res.as_mut_ptr()).data.ptr_mut();
-                    $(
-                        ptr::copy_nonoverlapping(&m.$component.x, ptr, $SZRows);
-                        ptr = ptr.offset($SZRows);
-                    )*
-                    let _ = ptr;
-                    res.assume_init()
-                }
-            }
-        }
-
-        impl<N> Into<mint::$MV<N>> for MatrixMN<N, $NRows, $NCols>
-        where N: Scalar,
-              DefaultAllocator: Allocator<N, $NRows, $NCols> {
-            #[inline]
-            fn into(self) -> mint::$MV<N> {
-                unsafe {
-                    let mut res: mint::$MV<N> = mem::MaybeUninit::uninit().assume_init();
-                    let mut ptr = self.data.ptr();
-                    $(
-                        ptr::copy_nonoverlapping(ptr, &mut res.$component.x, $SZRows);
-                        ptr = ptr.offset($SZRows);
-                    )*
-                    let _ = ptr;
-                    res
-                }
-            }
-        }
-    )*}
-);
-
-// Implement for matrices with shape 2x2 .. 4x4.
-#[cfg(feature = "mint")]
-impl_from_into_mint_2D!(
-    (U2, U2) => ColumnMatrix2{x, y}[2];
-    (U2, U3) => ColumnMatrix2x3{x, y, z}[2];
-    (U3, U3) => ColumnMatrix3{x, y, z}[3];
-    (U3, U4) => ColumnMatrix3x4{x, y, z, w}[3];
-    (U4, U4) => ColumnMatrix4{x, y, z, w}[4];
-);
-
 impl<'a, N, R, C, RStride, CStride> From<MatrixSlice<'a, N, R, C, RStride, CStride>>
     for Matrix<N, R, C, ArrayStorage<N, R, C>>
 where

src/base/mod.rs

@@ -22,8 +22,6 @@ mod conversion;
 mod edition;
 pub mod indexing;
 mod matrix;
-#[cfg(feature = "alga")]
-mod matrix_alga;
 mod matrix_simba;
 mod matrix_slice;
 mod norm;

src/geometry/mod.rs

@@ -6,8 +6,6 @@ mod op_macros;
 mod abstract_rotation;
 
 mod point;
-#[cfg(feature = "alga")]
-mod point_alga;
 mod point_alias;
 mod point_construction;
 mod point_conversion;
@@ -16,8 +14,6 @@ mod point_ops;
 mod point_simba;
 
 mod rotation;
-#[cfg(feature = "alga")]
-mod rotation_alga;
 mod rotation_alias;
 mod rotation_construction;
 mod rotation_conversion;
@@ -27,32 +23,24 @@ mod rotation_simba; // TODO: implement Rotation methods.
 mod rotation_specialization;
 
 mod quaternion;
-#[cfg(feature = "alga")]
-mod quaternion_alga;
 mod quaternion_construction;
 mod quaternion_conversion;
 mod quaternion_coordinates;
 mod quaternion_ops;
 mod quaternion_simba;
 
 mod dual_quaternion;
-#[cfg(feature = "alga")]
-mod dual_quaternion_alga;
 mod dual_quaternion_construction;
 mod dual_quaternion_conversion;
 mod dual_quaternion_ops;
 
 mod unit_complex;
-#[cfg(feature = "alga")]
-mod unit_complex_alga;
 mod unit_complex_construction;
 mod unit_complex_conversion;
 mod unit_complex_ops;
 mod unit_complex_simba;
 
 mod translation;
-#[cfg(feature = "alga")]
-mod translation_alga;
 mod translation_alias;
 mod translation_construction;
 mod translation_conversion;
@@ -61,8 +49,6 @@ mod translation_ops;
 mod translation_simba;
 
 mod isometry;
-#[cfg(feature = "alga")]
-mod isometry_alga;
 mod isometry_alias;
 mod isometry_construction;
 mod isometry_conversion;
@@ -71,8 +57,6 @@ mod isometry_ops;
 mod isometry_simba;
 
 mod similarity;
-#[cfg(feature = "alga")]
-mod similarity_alga;
 mod similarity_alias;
 mod similarity_construction;
 mod similarity_conversion;
@@ -82,8 +66,6 @@ mod similarity_simba;
 mod swizzle;
 
 mod transform;
-#[cfg(feature = "alga")]
-mod transform_alga;
 mod transform_alias;
 mod transform_construction;
 mod transform_conversion;

src/geometry/point_conversion.rs

@@ -6,23 +6,14 @@ use crate::base::allocator::Allocator;
 use crate::base::dimension::{DimName, DimNameAdd, DimNameSum, U1};
 use crate::base::{DefaultAllocator, Matrix, Scalar, VectorN};
 
-#[cfg(feature = "mint")]
-use crate::base::dimension::{U2, U3};
-#[cfg(feature = "mint")]
-use crate::base::storage::{Storage, StorageMut};
 use crate::geometry::Point;
-#[cfg(feature = "mint")]
-use mint;
-#[cfg(feature = "mint")]
-use std::convert::{AsMut, AsRef, From, Into};
+
 /*
  * This file provides the following conversions:
  * =============================================
  *
  * Point -> Point
  * Point -> Vector (homogeneous)
- *
- * mint::Point <-> Point
  */
 
 impl<N1, N2, D> SubsetOf<Point<N2, D>> for Point<N1, D>
@@ -80,57 +71,6 @@ where
     }
 }
 
-#[cfg(feature = "mint")]
-macro_rules! impl_from_into_mint_1D(
-    ($($NRows: ident => $PT:ident, $VT:ident [$SZ: expr]);* $(;)*) => {$(
-        impl<N> From<mint::$PT<N>> for Point<N, $NRows>
-        where N: Scalar {
-            #[inline]
-            fn from(p: mint::$PT<N>) -> Self {
-                Self {
-                    coords: VectorN::from(mint::$VT::from(p)),
-                }
-            }
-        }
-
-        impl<N> Into<mint::$PT<N>> for Point<N, $NRows>
-        where N: Scalar {
-            #[inline]
-            fn into(self) -> mint::$PT<N> {
-                let mint_vec: mint::$VT<N> = self.coords.into();
-                mint::$PT::from(mint_vec)
-            }
-        }
-
-        impl<N> AsRef<mint::$PT<N>> for Point<N, $NRows>
-        where N: Scalar {
-            #[inline]
-            fn as_ref(&self) -> &mint::$PT<N> {
-                unsafe {
-                    &*(self.coords.data.ptr() as *const mint::$PT<N>)
-                }
-            }
-        }
-
-        impl<N> AsMut<mint::$PT<N>> for Point<N, $NRows>
-        where N: Scalar {
-            #[inline]
-            fn as_mut(&mut self) -> &mut mint::$PT<N> {
-                unsafe {
-                    &mut *(self.coords.data.ptr_mut() as *mut mint::$PT<N>)
-                }
-            }
-        }
-    )*}
-);
-
-// Implement for points of dimension 2, 3.
-#[cfg(feature = "mint")]
-impl_from_into_mint_1D!(
-    U2 => Point2, Vector2[2];
-    U3 => Point3, Vector3[3];
-);
-
 impl<N: Scalar + Zero + One, D: DimName> From<Point<N, D>> for VectorN<N, DimNameSum<D, U1>>
 where
     D: DimNameAdd<U1>,