apply march 2024 deprecation and update mesh.split docstring

Author: mikedh

trimesh/base.py

@@ -7,7 +7,6 @@
 Library for importing, exporting and doing simple operations on triangular meshes.
 """
 
-import warnings
 from copy import deepcopy
 
 import numpy as np
@@ -1343,44 +1342,45 @@ def unique_faces(self) -> NDArray[np.bool_]:
         mask[grouping.unique_rows(np.sort(self.faces, axis=1))[0]] = True
         return mask
 
-    def remove_duplicate_faces(self) -> None:
-        """
-        DERECATED MARCH 2024 REPLACE WITH:
-        `mesh.update_faces(mesh.unique_faces())`
-        """
-        warnings.warn(
-            "`remove_duplicate_faces` is deprecated "
-            + "and will be removed in March 2024: "
-            + "replace with `mesh.update_faces(mesh.unique_faces())`",
-            category=DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_faces(self.unique_faces())
-
     def rezero(self) -> None:
         """
-        Translate the mesh so that all vertex vertices are positive.
+        Translate the mesh so that all vertex vertices are positive
+        and the lower bound of `self.bounds` will be exactly zero.
 
         Alters `self.vertices`.
         """
         self.apply_translation(self.bounds[0] * -1.0)
 
     def split(self, **kwargs) -> List["Trimesh"]:
         """
-        Returns a list of Trimesh objects, based on face connectivity.
-        Splits into individual components, sometimes referred to as 'bodies'
+        Split a mesh into multiple meshes from face
+        connectivity.
+
+        If only_watertight is true it will only return
+        watertight meshes and will attempt to repair
+        single triangle or quad holes.
 
         Parameters
-        ------------
-        only_watertight : bool
-          Only return watertight meshes and discard remainder
-        adjacency : None or (n, 2) int
-          Override face adjacency with custom values
+        ----------
+        mesh : trimesh.Trimesh
+          The source multibody mesh to split
+        only_watertight
+          Only return watertight components and discard
+          any connected component that isn't fully watertight.
+        repair
+          If set try to fill small holes in a mesh, before the
+          discard step in `only_watertight.
+        adjacency : (n, 2) int
+          If passed will be used instead of `mesh.face_adjacency`
+        engine
+          Which graph engine to use for the connected components.
+        kwargs
+          Will be passed to `mesh.submesh`
 
         Returns
-        ---------
-        meshes : (n, ) trimesh.Trimesh
-          Separate bodies from original mesh
+        ----------
+        meshes : (m,) trimesh.Trimesh
+          Results of splitting based on parameters.
         """
         return graph.split(self, **kwargs)
 
@@ -1731,20 +1731,6 @@ def kdtree(self) -> cKDTree:
         """
         return cKDTree(self.vertices.view(np.ndarray))
 
-    def remove_degenerate_faces(self, height: Floating = tol.merge) -> None:
-        """
-        DERECATED MARCH 2024 REPLACE WITH:
-        `self.update_faces(self.nondegenerate_faces(height=height))`
-        """
-        warnings.warn(
-            "`remove_degenerate_faces` is deprecated "
-            + "and will be removed in March 2024 replace with "
-            + "`self.update_faces(self.nondegenerate_faces(height=height))`",
-            category=DeprecationWarning,
-            stacklevel=2,
-        )
-        self.update_faces(self.nondegenerate_faces(height=height))
-
     def nondegenerate_faces(self, height: Floating = tol.merge) -> NDArray[np.bool_]:
         """
         Identify degenerate faces (faces without 3 unique vertex indices)
@@ -1894,7 +1880,7 @@ def facets_on_hull(self) -> NDArray[np.bool_]:
 
         return on_hull
 
-    def fix_normals(self, multibody: Optional[bool] = None) -> None:
+    def fix_normals(self, multibody: Optional[bool] = None) -> Self:
         """
         Find and fix problems with self.face_normals and self.faces
         winding direction.
@@ -1906,12 +1892,13 @@ def fix_normals(self, multibody: Optional[bool] = None) -> None:
         Parameters
         -------------
         multibody : None or bool
-          Fix normals across multiple bodies
-          if None automatically pick from body_count
+          Fix normals across multiple bodies or if unspecified
+          check the current `Trimesh.body_count`.
         """
         if multibody is None:
             multibody = self.body_count > 1
         repair.fix_normals(self, multibody=multibody)
+        return self
 
     def fill_holes(self) -> bool:
         """

trimesh/graph.py

@@ -364,17 +364,22 @@ def split(
     Parameters
     ----------
     mesh : trimesh.Trimesh
-    only_watertight: bool
-      Only return watertight components
+      The source multibody mesh to split
+    only_watertight
+      Only return watertight components and discard
+      any connected component that isn't fully watertight.
+    repair
+      If set try to fill small holes in a mesh, before the
+      discard step in `only_watertight.
     adjacency : (n, 2) int
-      Face adjacency to override full mesh
+      If passed will be used instead of `mesh.face_adjacency`
     engine
-      Which graph engine to use
+      Which graph engine to use for the connected components.
 
     Returns
     ----------
     meshes : (m,) trimesh.Trimesh
-      Results of splitting
+      Results of splitting based on parameters.
     """
     if adjacency is None:
         adjacency = mesh.face_adjacency