Mercurial > hg > octave-lyh
annotate scripts/plot/shrinkfaces.m @ 16923:5d08a2ec7edb
doc: Move graphics object functions into the right section
* plot.txi: Merge node "Use of axis, line, and patch Functions" into
node "Graphics Objects".
* octave.texi: Remove node "Use of axis, line, and patch Functions"
| author | Mike Miller <mtmiller@ieee.org> |
|---|---|
| date | Mon, 08 Jul 2013 09:13:30 -0400 |
| parents | ddac88d32d6a |
| children | eaab03308c0b |
| rev | line source |
|---|---|
| 14574 | 1 ## Copyright (C) 2012 Martin Helm |
| 2 ## | |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 ## -*- texinfo -*- | |
|
14620
cd375519eab0
doc: Periodic grammar check of documentation
Rik <octave@nomad.inbox5.com>
parents:
14574
diff
changeset
|
20 ## @deftypefn {Function File} {} shrinkfaces (@var{p}, @var{sf}) |
| 14574 | 21 ## @deftypefnx {Function File} {@var{nfv} =} shrinkfaces (@var{p}, @var{sf}) |
| 22 ## @deftypefnx {Function File} {@var{nfv} =} shrinkfaces (@var{fv}, @var{sf}) | |
| 23 ## @deftypefnx {Function File} {@var{nfv} =} shrinkfaces (@var{f}, @var{v}, @var{sf}) | |
| 24 ## @deftypefnx {Function File} {[@var{nf}, @var{nv}] =} shrinkfaces (@dots{}) | |
| 25 ## | |
| 26 ## Reduce the faces area for a given patch, structure or explicit faces | |
| 27 ## and points matrices by a scale factor @var{sf}. The structure | |
| 28 ## @var{fv} must contain the fields 'faces' and 'vertices'. If the | |
| 29 ## factor @var{sf} is omitted then a default of 0.3 is used. | |
| 30 ## | |
| 31 ## Given a patch handle as the first input argument and no output | |
| 32 ## parameters, perform the shrinking of the patch faces in place and | |
| 33 ## redraw the patch. | |
| 34 ## | |
| 35 ## If called with one output argument, return a structure with fields | |
| 36 ## 'faces', 'vertices', and 'facevertexcdata' containing the data after | |
| 37 ## shrinking which can then directly be used as an input argument for the | |
| 38 ## @command{patch} function. | |
| 39 ## | |
| 40 ## Performing the shrinking on faces which are not convex can lead to | |
| 41 ## undesired results. | |
| 42 ## | |
|
14620
cd375519eab0
doc: Periodic grammar check of documentation
Rik <octave@nomad.inbox5.com>
parents:
14574
diff
changeset
|
43 ## For example, |
| 14574 | 44 ## |
| 45 ## @example | |
| 46 ## @group | |
| 47 ## [phi r] = meshgrid (linspace (0, 1.5*pi, 16), linspace (1, 2, 4)); | |
| 48 ## tri = delaunay (phi(:), r(:)); | |
| 49 ## v = [r(:).*sin(phi(:)) r(:).*cos(phi(:))]; | |
| 50 ## clf () | |
| 51 ## p = patch ("Faces", tri, "Vertices", v, "FaceColor", "none"); | |
| 52 ## fv = shrinkfaces (p); | |
| 53 ## patch (fv) | |
| 54 ## axis equal | |
| 55 ## grid on | |
| 56 ## @end group | |
| 57 ## @end example | |
| 58 ## | |
| 59 ## @noindent | |
|
14621
1804d5422f61
doc: Periodic spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14620
diff
changeset
|
60 ## draws a triangulated 3/4 circle and the corresponding shrunken |
| 14574 | 61 ## version. |
| 62 ## @seealso{patch} | |
| 63 ## @end deftypefn | |
| 64 | |
| 65 ## Author: Martin Helm <martin@mhelm.de> | |
| 66 | |
| 67 function [nf, nv] = shrinkfaces (varargin) | |
| 68 | |
| 69 if (nargin < 1 || nargin > 3 || nargout > 2) | |
| 70 print_usage (); | |
| 71 endif | |
| 72 | |
| 73 sf = 0.3; | |
| 74 p = varargin{1}; | |
| 75 colors = []; | |
| 76 | |
| 77 if (ishandle (p) && nargin < 3) | |
| 78 faces = get (p, "Faces"); | |
| 79 vertices = get (p, "Vertices"); | |
| 80 colors = get (p, "FaceVertexCData"); | |
| 81 if (nargin == 2) | |
| 82 sf = varargin{2}; | |
| 83 endif | |
| 84 elseif (isstruct (p) && nargin < 3) | |
| 85 faces = p.faces; | |
| 86 vertices = p.vertices; | |
| 87 if (isfield (p, "facevertexcdata")) | |
| 88 colors = p.facevertexcdata; | |
| 89 endif | |
| 90 if (nargin == 2) | |
| 91 sf = varargin{2}; | |
| 92 endif | |
| 93 elseif (ismatrix (p) && nargin >= 2 && ismatrix (varargin{2})) | |
| 94 faces = p; | |
| 95 vertices = varargin{2}; | |
| 96 if (nargin == 3) | |
| 97 sf = varargin{3}; | |
| 98 endif | |
| 99 else | |
| 100 print_usage (); | |
| 101 endif | |
| 102 | |
| 103 if (! isscalar (sf) || sf <= 0) | |
|
15202
f3b5cadfd6d5
fix missing semicolons in various .m files
John W. Eaton <jwe@octave.org>
parents:
14872
diff
changeset
|
104 error ("shrinkfaces: scale factor must be a positive scalar"); |
| 14574 | 105 endif |
| 106 | |
|
14872
c2dbdeaa25df
maint: use rows() and columns() to clarify m-files.
Rik <octave@nomad.inbox5.com>
parents:
14621
diff
changeset
|
107 n = columns (vertices); |
| 14574 | 108 if (n < 2 || n > 3) |
|
15202
f3b5cadfd6d5
fix missing semicolons in various .m files
John W. Eaton <jwe@octave.org>
parents:
14872
diff
changeset
|
109 error ("shrinkfaces: only 2D and 3D patches are supported"); |
| 14574 | 110 endif |
| 111 | |
|
14872
c2dbdeaa25df
maint: use rows() and columns() to clarify m-files.
Rik <octave@nomad.inbox5.com>
parents:
14621
diff
changeset
|
112 m = columns (faces); |
| 14574 | 113 if (m < 3) |
|
15202
f3b5cadfd6d5
fix missing semicolons in various .m files
John W. Eaton <jwe@octave.org>
parents:
14872
diff
changeset
|
114 error ("shrinkfaces: faces must consist of at least 3 vertices"); |
| 14574 | 115 endif |
| 116 | |
| 117 v = vertices(faces'(:), :); | |
|
14872
c2dbdeaa25df
maint: use rows() and columns() to clarify m-files.
Rik <octave@nomad.inbox5.com>
parents:
14621
diff
changeset
|
118 if (isempty (colors) || rows (colors) == rows (faces)) |
| 14574 | 119 c = colors; |
|
14872
c2dbdeaa25df
maint: use rows() and columns() to clarify m-files.
Rik <octave@nomad.inbox5.com>
parents:
14621
diff
changeset
|
120 elseif (rows (colors) == rows (vertices)) |
| 14574 | 121 c = colors(faces'(:), :); |
| 122 else | |
| 123 ## Discard inconsistent color data. | |
| 124 c = []; | |
| 125 endif | |
|
14872
c2dbdeaa25df
maint: use rows() and columns() to clarify m-files.
Rik <octave@nomad.inbox5.com>
parents:
14621
diff
changeset
|
126 sv = rows (v); |
| 14574 | 127 ## we have to deal with a probably very large number of vertices, so |
| 128 ## use sparse we use as midpoint (1/m, ..., 1/m) in generalized | |
| 129 ## barycentric coordinates. | |
| 130 midpoints = full (kron ( speye (sv / m), ones (m, m) / m) * sparse (v)); | |
| 131 v = sqrt (sf) * (v - midpoints) + midpoints; | |
| 132 f = reshape (1:sv, m, sv / m)'; | |
| 133 | |
| 134 switch (nargout) | |
| 135 case 0 | |
| 136 if (ishandle (p)) | |
|
15202
f3b5cadfd6d5
fix missing semicolons in various .m files
John W. Eaton <jwe@octave.org>
parents:
14872
diff
changeset
|
137 ## avoid exceptions |
|
f3b5cadfd6d5
fix missing semicolons in various .m files
John W. Eaton <jwe@octave.org>
parents:
14872
diff
changeset
|
138 set (p, "FaceVertexCData", [], "CData", []); |
|
15332
b613757ff5be
Fix typo in shrinkfaces.m (thanks Marco Atzeri)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
15202
diff
changeset
|
139 set (p, "Vertices", v, "Faces", f, "FaceVertexCData", c); |
| 14574 | 140 else |
| 141 nf = struct ("faces", f, "vertices", v, "facevertexcdata", c); | |
| 142 endif | |
| 143 case 1 | |
| 144 nf = struct ("faces", f, "vertices", v, "facevertexcdata", c); | |
| 145 case 2 | |
| 146 nf = f; | |
| 147 nv = v; | |
| 148 endswitch | |
| 149 | |
| 150 endfunction | |
| 151 | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
152 |
| 14574 | 153 %!demo |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
154 %! clf; |
| 14574 | 155 %! faces = [1 2 3; 1 3 4]; |
| 156 %! vertices = [0 0; 1 0; 1 1; 0 1]; | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
157 %! patch ('Faces', faces, 'Vertices', vertices, 'FaceColor', 'none'); |
| 14574 | 158 %! fv = shrinkfaces (faces, vertices, 0.25); |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
159 %! patch (fv); |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
160 %! axis equal; |
| 14574 | 161 |
| 162 %!demo | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
163 %! clf; |
| 14574 | 164 %! faces = [1 2 3 4; 5 6 7 8]; |
| 165 %! vertices = [0 0; 1 0; 2 1; 1 1; 2 0; 3 0; 4 1; 3.5 1]; | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
166 %! patch ('Faces', faces, 'Vertices', vertices, 'FaceColor', 'none'); |
| 14574 | 167 %! fv = shrinkfaces (faces, vertices, 0.25); |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
168 %! patch (fv); |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
169 %! axis equal; |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
170 %! grid on; |
| 14574 | 171 |
| 172 %!demo | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
173 %! clf; |
| 14574 | 174 %! faces = [1 2 3 4]; |
| 175 %! vertices = [-1 2; 0 0; 1 2; 0 1]; | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
176 %! patch ('Faces', faces, 'Vertices', vertices, 'FaceColor', 'none'); |
| 14574 | 177 %! fv = shrinkfaces (faces, vertices, 0.25); |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
178 %! patch (fv); |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
179 %! axis equal; |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
180 %! grid on; |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
181 %! title 'faces which are not convex are clearly not allowed' |
| 14574 | 182 |
| 183 %!demo | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
184 %! clf; |
| 14574 | 185 %! [phi r] = meshgrid (linspace (0, 1.5*pi, 16), linspace (1, 2, 4)); |
| 186 %! tri = delaunay (phi(:), r(:)); | |
| 187 %! v = [r(:).*sin(phi(:)) r(:).*cos(phi(:))]; | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
188 %! p = patch ('Faces', tri, 'Vertices', v, 'FaceColor', 'none'); |
| 14574 | 189 %! fv = shrinkfaces (p); |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
190 %! patch (fv); |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
191 %! axis equal; |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
192 %! grid on; |
| 14574 | 193 |
| 194 %!demo | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
195 %! clf; |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
196 %! N = 10; % N intervals per axis |
| 14574 | 197 %! [x, y, z] = meshgrid (linspace (-4,4,N+1)); |
| 198 %! val = x.^3 + y.^3 + z.^3; | |
| 199 %! fv = isosurface (x, y, z, val, 3, z); | |
| 200 %! | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
201 %! p = patch ('Faces', fv.faces, 'Vertices', fv.vertices, 'FaceVertexCData', ... |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
202 %! fv.facevertexcdata, 'FaceColor', 'interp', 'EdgeColor', 'black'); |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
203 %! axis equal; |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
204 %! view (115, 30); |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
205 %! drawnow; |
| 14574 | 206 %! shrinkfaces (p, 0.6); |
| 207 | |
| 208 %!shared faces, vertices, nfv, nfv2 | |
| 209 %! faces = [1 2 3]; | |
| 210 %! vertices = [0 0 0; 1 0 0; 1 1 0]; | |
| 211 %! nfv = shrinkfaces (faces, vertices, 0.7); | |
| 212 %! nfv2 = shrinkfaces (nfv, 1/0.7); | |
|
16828
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
213 %!assert (isfield (nfv, "faces")) |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
214 %!assert (isfield (nfv, "vertices")) |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
215 %!assert (size (nfv.faces), [1 3]) |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
216 %!assert (size (nfv.vertices), [3 3]) |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
217 %!assert (norm (nfv2.vertices - vertices), 0, 2*eps) |
|
ddac88d32d6a
Make demos in plot m-files compatible with Matlab for running comparison script.
Rik <rik@octave.org>
parents:
15332
diff
changeset
|
218 |