Use M for metadata docs and helpers

Author: timschmidt

readme.md

@@ -28,7 +28,7 @@ pub struct BMesh<M: Clone + Send + Sync + Debug> {
     pub manifold: Option<Manifold>,
     /// Lazily computed Parry AABB for the solid.
     pub bounding_box: OnceLock<Aabb>,
-    /// Whole-shape metadata. Use `M = ()` for no metadata and `M = Option<T>`
+    /// Whole-shape metadata. Use `M = ()` for no metadata and `M = Option<YourMetadata>`
     /// for optional metadata.
     pub metadata: M,
 }
@@ -61,7 +61,10 @@ impl<M: Clone + Send + Sync + Debug> BMesh<M> {
     }
 
     /// Return this boolmesh wrapper with replacement metadata.
-    pub fn with_metadata<T: Clone + Send + Sync + Debug>(self, metadata: T) -> BMesh<T> {
+    pub fn with_metadata<NewM: Clone + Send + Sync + Debug>(
+        self,
+        metadata: NewM,
+    ) -> BMesh<NewM> {
         BMesh {
             manifold: self.manifold,
             bounding_box: OnceLock::new(),
@@ -70,9 +73,9 @@ impl<M: Clone + Send + Sync + Debug> BMesh<M> {
     }
 
     /// Map this boolmesh wrapper's metadata while preserving geometry.
-    pub fn map_metadata<T: Clone + Send + Sync + Debug, F>(self, f: F) -> BMesh<T>
+    pub fn map_metadata<NewM: Clone + Send + Sync + Debug, F>(self, f: F) -> BMesh<NewM>
     where
-        F: FnOnce(M) -> T,
+        F: FnOnce(M) -> NewM,
     {
         BMesh {
             manifold: self.manifold,

src/bmesh/mod.rs

@@ -83,7 +83,7 @@ pub struct Mesh<M: Clone + Send + Sync + Debug> {
     /// Lazily built Parry TriMesh reused by query operations.
     pub query_trimesh: OnceLock<Option<TriMesh>>,
 
-    /// Whole-mesh metadata. Use `M = ()` for no metadata and `M = Option<T>`
+    /// Whole-mesh metadata. Use `M = ()` for no metadata and `M = Option<YourMetadata>`
     /// for optional metadata.
     pub metadata: M,
 }
@@ -136,7 +136,10 @@ impl<M: Clone + Send + Sync + Debug> Mesh<M> {
     }
 
     /// Return this mesh with replacement metadata on the mesh and every polygon.
-    pub fn with_metadata<T: Clone + Send + Sync + Debug>(self, metadata: T) -> Mesh<T> {
+    pub fn with_metadata<NewM: Clone + Send + Sync + Debug>(
+        self,
+        metadata: NewM,
+    ) -> Mesh<NewM> {
         let polygons = self
             .polygons
             .into_iter()
@@ -152,9 +155,9 @@ impl<M: Clone + Send + Sync + Debug> Mesh<M> {
     }
 
     /// Map metadata on the mesh and every polygon while preserving geometry.
-    pub fn map_metadata<T: Clone + Send + Sync + Debug, F>(self, mut f: F) -> Mesh<T>
+    pub fn map_metadata<NewM: Clone + Send + Sync + Debug, F>(self, mut f: F) -> Mesh<NewM>
     where
-        F: FnMut(M) -> T,
+        F: FnMut(M) -> NewM,
     {
         let polygons = self
             .polygons

src/mesh/mod.rs

@@ -56,7 +56,10 @@ impl<M: Clone + Send + Sync + Debug> Nurbs<M> {
     }
 
     /// Return this NURBS geometry with replacement metadata.
-    pub fn with_metadata<T: Clone + Send + Sync + Debug>(self, metadata: T) -> Nurbs<T> {
+    pub fn with_metadata<NewM: Clone + Send + Sync + Debug>(
+        self,
+        metadata: NewM,
+    ) -> Nurbs<NewM> {
         Nurbs {
             regions: self.regions,
             bounding_box: OnceLock::new(),
@@ -65,9 +68,9 @@ impl<M: Clone + Send + Sync + Debug> Nurbs<M> {
     }
 
     /// Map this NURBS geometry's metadata while preserving its regions.
-    pub fn map_metadata<T: Clone + Send + Sync + Debug, F>(self, f: F) -> Nurbs<T>
+    pub fn map_metadata<NewM: Clone + Send + Sync + Debug, F>(self, f: F) -> Nurbs<NewM>
     where
-        F: FnOnce(M) -> T,
+        F: FnOnce(M) -> NewM,
     {
         Nurbs {
             regions: self.regions,

src/nurbs/nurbs.rs

@@ -8,7 +8,7 @@ use std::sync::OnceLock;
 
 /// A polygon, defined by a list of vertices.
 /// - `M` is the generic metadata type stored directly on the polygon. Use
-///   `M = ()` for no metadata, or `M = Option<T>` for optional metadata.
+///   `M = ()` for no metadata, or `M = Option<YourMetadata>` for optional metadata.
 #[derive(Debug, Clone)]
 pub struct Polygon<M: Clone> {
     /// Vertices defining the Polygon's shape
@@ -55,7 +55,7 @@ impl<M: Clone + Send + Sync> Polygon<M> {
     }
 
     /// Return this polygon with replacement metadata.
-    pub fn with_metadata<T: Clone + Send + Sync>(self, metadata: T) -> Polygon<T> {
+    pub fn with_metadata<NewM: Clone + Send + Sync>(self, metadata: NewM) -> Polygon<NewM> {
         Polygon {
             vertices: self.vertices,
             plane: self.plane,
@@ -65,9 +65,9 @@ impl<M: Clone + Send + Sync> Polygon<M> {
     }
 
     /// Map this polygon's metadata while preserving its geometry.
-    pub fn map_metadata<T: Clone + Send + Sync, F>(self, f: F) -> Polygon<T>
+    pub fn map_metadata<NewM: Clone + Send + Sync, F>(self, f: F) -> Polygon<NewM>
     where
-        F: FnOnce(M) -> T,
+        F: FnOnce(M) -> NewM,
     {
         Polygon {
             vertices: self.vertices,

src/polygon.rs

@@ -74,7 +74,7 @@ pub struct Sketch<M> {
     /// Lazily calculated AABB that spans `geometry`.
     pub bounding_box: OnceLock<Aabb>,
 
-    /// Whole-sketch metadata. Use `M = ()` for no metadata and `M = Option<T>`
+    /// Whole-sketch metadata. Use `M = ()` for no metadata and `M = Option<YourMetadata>`
     /// for optional metadata.
     pub metadata: M,
 
@@ -123,7 +123,10 @@ impl<M: Clone + Send + Sync + Debug> Sketch<M> {
     }
 
     /// Return this sketch with replacement metadata.
-    pub fn with_metadata<T: Clone + Send + Sync + Debug>(self, metadata: T) -> Sketch<T> {
+    pub fn with_metadata<NewM: Clone + Send + Sync + Debug>(
+        self,
+        metadata: NewM,
+    ) -> Sketch<NewM> {
         Sketch {
             geometry: self.geometry,
             bounding_box: OnceLock::new(),
@@ -134,9 +137,9 @@ impl<M: Clone + Send + Sync + Debug> Sketch<M> {
     }
 
     /// Map this sketch's metadata while preserving its geometry and origin.
-    pub fn map_metadata<T: Clone + Send + Sync + Debug, F>(self, f: F) -> Sketch<T>
+    pub fn map_metadata<NewM: Clone + Send + Sync + Debug, F>(self, f: F) -> Sketch<NewM>
     where
-        F: FnOnce(M) -> T,
+        F: FnOnce(M) -> NewM,
     {
         Sketch {
             geometry: self.geometry,