File: drawMesh.m

package info (click to toggle)
octave-matgeom 1.2.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,584 kB
  • sloc: objc: 469; makefile: 10
file content (200 lines) | stat: -rw-r--r-- 6,798 bytes parent folder | download
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
## Copyright (C) 2024 David Legland
## All rights reserved.
## 
## Redistribution and use in source and binary forms, with or without
## modification, are permitted provided that the following conditions are met:
## 
##     1 Redistributions of source code must retain the above copyright notice,
##       this list of conditions and the following disclaimer.
##     2 Redistributions in binary form must reproduce the above copyright
##       notice, this list of conditions and the following disclaimer in the
##       documentation and/or other materials provided with the distribution.
## 
## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ''AS IS''
## AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
## IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
## ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
## ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
## DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
## SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
## CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
## OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
## 
## The views and conclusions contained in the software and documentation are
## those of the authors and should not be interpreted as representing official
## policies, either expressed or implied, of the copyright holders.

function varargout = drawMesh(varargin)
%DRAWMESH Draw a 3D mesh defined by vertex and face arrays.
%
%   drawMesh(VERTICES, FACES)
%   Draws the 3D mesh defined by vertices VERTICES and the faces FACES. 
%   vertices is a NV-by-3 array containing coordinates of vertices, and
%   FACES is either a NF-by-3 or NF-by-4 array containing face vertex
%   indices of the triangular or rectangular faces.
%   FACES can also be a cell array, each cell containing an array of vertex
%   indices for the corresponding face. In this case the faces may have
%   variable number of vertices. 
%   
%   drawMesh(MESH)
%   Specifies the mesh as a structure containing at least the fields
%   'vertices' and 'faces', using the same conventions as above.
%
%   drawMesh(..., COLOR)
%   Use the specified color to render the mesh faces.
%
%   drawMesh(..., NAME, VALUE)
%   Use one or several pairs of parameter name/value to specify drawing
%   options. Options are the same as the 'patch' function.
%
%   drawMesh(AX,...) 
%   Draw into the axis specified by AX instead of the current axis.
%
%
%   H = drawMesh(...);
%   Also returns a handle to the created patch.
%
%   Example:
%     % display a polyhedra with polygonal faces
%     [v, f] = createSoccerBall;
%     drawMesh(v, f);
%
%     % Display a mesh representing a  torus, using uniform face color
%     [v, f] = torusMesh;
%     figure; hold on; axis equal; view(3);
%     drawMesh(v, f, 'FaceColor', 'g')
%     % paint the mesh according to vertex x-coordinate
%     figure; hold on; axis equal; view(3);
%     drawMesh(v, f, 'VertexColor', v(:,1), 'LineStyle', 'none');
%
%   See also 
%     meshes3d, polyhedra, patch
%

% ------
% Author: David Legland 
% E-mail: david.legland@inrae.fr
% Created: 2005-02-10
% Copyright 2005-2023 INRA - TPV URPOI - BIA IMASTE

%% Parse input arguments

% extract first argument
var1 = varargin{1};
varargin(1) = [];

% Check if first input argument is an axes handle
if isAxisHandle(var1)
    ax = var1;
    var1 = varargin{1};
    varargin(1) = [];
else
    ax = gca;
end

% Check if the input is a mesh structure
if isstruct(var1)
    % extract data to display
    vertices = var1.vertices;
    faces = var1.faces;
else
    % assumes input is given with vertices+faces arrays
    vertices = var1;
    faces = varargin{1};
    varargin(1) = [];
end

% if vertices are 2D points, add a z=0 coordinate
if size(vertices, 2) == 2
    vertices(1, 3) = 0;
end


%% Pre-processing for formatting display options

% default color for drawing mesh
faceColor = [1 0 0];

% combine defualt face color with varargin
if isempty(varargin)
    varargin = [{'FaceColor'}, faceColor];
elseif length(varargin) == 1
    % if only one optional argument is provided, it is assumed to be color
    faceColor = varargin{1};
    varargin = [{'FaceColor'}, varargin];
elseif length(varargin) > 1
    % check if FaceColor option is specified, 
    % and if not use default face color
    indFC = strcmpi(varargin(1:2:end), 'FaceColor');
    if ~any(indFC)
        varargin = [{'FaceColor'}, {faceColor}, varargin];
    end
end

% check if simplified options are present
indVC = find(strcmpi(varargin(1:2:end), 'VertexColor'));
if ~isempty(indVC)
    vertexColor = varargin{indVC * 2};
    varargin([indVC*2-1 indVC*2]) = [];
    indFC = find(strcmpi(varargin(1:2:end), 'FaceColor'));
    if ~isempty(indFC)
        varargin([indFC*2-1 indFC*2]) = [];
    end
    varargin = [{'FaceVertexCData'}, {vertexColor}, {'FaceColor'}, {'interp'}, varargin];
end


%% Draw the mesh

% overwrite on current figure
hold(ax, 'on');

% Use different processing depending on the type of faces
if isnumeric(faces)
    % array FACES is a NF-by-NV indices array, with NF: number of faces,
    % and NV: number of vertices per face 
    h = patch('Parent', ax, ...
        'vertices', vertices, 'faces', faces, ...
        varargin{:});

elseif iscell(faces)
    % array FACES is a cell array. Need to draw each face as a single
    % patch.
    h = zeros(length(faces(:)), 1);

    for iFace = 1:length(faces(:))
        % get vertices of the cell
        face = faces{iFace};

        % Special processing in case of multiple polygonal face:
        % each polygonal loop is separated by a NaN.
        if sum(isnan(face)) ~= 0
            
            % find indices of loops breaks
            inds = find(isnan(face));
            
            % replace NaNs by index of first vertex of each polygon
            face(inds(2:end))   = face(inds(1:end-1)+1);
            face(inds(1))       = face(1);
            face(length(face)+1)= face(inds(end)+1);            
        end
        
        % draw current face
        cnodes = vertices(face, :);
        h(iFace) = patch(ax, cnodes(:, 1), cnodes(:, 2), cnodes(:, 3), faceColor);
    end
    
    % set up drawing options
    set(h, varargin{:});
else
    error('MatGeom:drawMesh', 'Second argument must be a face array');
end


%% Process output arguments

% format output parameters
if nargout > 0
    varargout = {h};
end