meshes3d: rename meshComplement.m to reverseMeshFaceOrientation.m

matGeom/meshes3d/meshComplement.m → matGeom/deprecated/meshes3d/meshComplement.m

@@ -1,6 +1,8 @@
 function varargout = meshComplement(varargin)
 %MESHCOMPLEMENT Reverse the normal of each face in the mesh.
 %
+%   Note: deprecated, use reverseMeshFaceOrientation instead.
+%
 %   [V2, F2] = meshComplement(V, F)
 %
 %   Example
@@ -22,6 +24,10 @@
 % Created: 2020-01-22, using Matlab 9.7.0.1247435 (R2019b) Update 2
 % Copyright 2020-2024 INRAE - BIA Research Unit - BIBS Platform (Nantes)
 
+warning('matgeom:meshes3d:deprecated', ...
+    'meshComplement is deprecated, use reverseMeshFaceOrientation instead');
+
+
 % extract mesh data
 mesh = parseMeshData(varargin{:});
 faces = mesh.faces;

matGeom/meshes3d/reverseMeshFaceOrientation.m

@@ -0,0 +1,44 @@
+function varargout = reverseMeshFaceOrientation(varargin)
+%REVERSEMESHFACEORIENTATION Reverse the normal of each face in the mesh.
+%
+%   [V2, F2] = reverseMeshFaceOrientation(V, F)
+%   Computes new face vertex indices such that the volume enclosed by the
+%   mesh becomes the opposite of that of the original mesh. The vertex
+%   position of the two meshes are the same.
+%
+%   Example
+%     [v, f] = createOctahedron;
+%     meshVolume(v, f)
+%     ans =
+%         1.3333
+%     [v2, f2] = reverseMeshFaceOrientation(v, f);
+%     meshVolume(v2, f2)
+%     ans =
+%        -1.3333
+%
+%   See also 
+%     meshes3d, meshVolume
+%
+
+% ------
+% Author: David Legland
+% e-mail: david.legland@inrae.fr
+% INRAE - BIA Research Unit - BIBS Platform (Nantes)
+% Created: 2024-07-15,    using Matlab 24.1.0.2628055 (R2024a) Update 4
+% Copyright 2024 INRAE.
+
+% extract mesh data
+mesh = parseMeshData(varargin{:});
+faces = mesh.faces;
+
+% iterate over faces to invert order of vertex indices
+if isnumeric(faces)
+    faces = faces(:, [1 end:-1:2]);
+else
+    for i = 1:size(faces, 1)
+        faces{i} = faces{i}([1 end:-1:2]);
+    end
+end
+
+% create new mesh data
+varargout = formatMeshOutput(nargout, mesh.vertices, faces);