annotate scripts/plot/fill.m @ 14230:fe65588c31b8

fill.m: Return column vector of graphics handles * fill.m: Return column vector of graphics handles
author Rik <octave@nomad.inbox5.com>
date Wed, 18 Jan 2012 21:17:14 -0800
parents 72c96de7a403
children 11949c9795a0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14001
diff changeset
1 ## Copyright (C) 2007-2012 David Bateman
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
2 ##
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
4 ##
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
8 ## your option) any later version.
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
9 ##
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
14 ##
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
18
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
20 ## @deftypefn {Function File} {} fill (@var{x}, @var{y}, @var{c})
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
21 ## @deftypefnx {Function File} {} fill (@var{x1}, @var{y1}, @var{c1}, @var{x2}, @var{y2}, @var{c2})
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
22 ## @deftypefnx {Function File} {} fill (@dots{}, @var{prop}, @var{val})
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
23 ## @deftypefnx {Function File} {} fill (@var{h}, @dots{})
7650
eb7bdde776f2 Texinfo fixes
John W. Eaton <jwe@octave.org>
parents: 7216
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} fill (@dots{})
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
25 ## Create one or more filled patch objects.
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
26 ##
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
27 ## The optional return value @var{h} is an array of graphics handles to
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
28 ## the created patch objects.
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
29 ## @seealso{patch}
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
30 ## @end deftypefn
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
31
7216
5389a52df87b [project @ 2007-11-29 19:07:29 by jwe]
jwe
parents: 7215
diff changeset
32 function retval = fill (varargin)
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
33
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
34 [h, varargin] = __plt_get_axis_arg__ ("fill", varargin{:});
7216
5389a52df87b [project @ 2007-11-29 19:07:29 by jwe]
jwe
parents: 7215
diff changeset
35
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
36 htmp = [];
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
37 iargs = __find_patches__ (varargin{:});
7216
5389a52df87b [project @ 2007-11-29 19:07:29 by jwe]
jwe
parents: 7215
diff changeset
38
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
39 oldh = gca ();
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
40 unwind_protect
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
41 axes (h);
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
42
11306
262c365eb71c fill.m: Allow multiple filled polygons.
Ben Abbott <bpabbott@mac.com>
parents: 11149
diff changeset
43 nextplot = get (h, "nextplot");
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
44 for i = 1 : length (iargs)
11325
56c8a00a269f fill.m: Allow multiple filled polygons.
Ben Abbott <bpabbott@mac.com>
parents: 11306
diff changeset
45 if (i > 1 && strncmp (nextplot, "replace", 7))
56c8a00a269f fill.m: Allow multiple filled polygons.
Ben Abbott <bpabbott@mac.com>
parents: 11306
diff changeset
46 set (h, "nextplot", "add");
56c8a00a269f fill.m: Allow multiple filled polygons.
Ben Abbott <bpabbott@mac.com>
parents: 11306
diff changeset
47 endif
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
48 if (i == length (iargs))
14230
fe65588c31b8 fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
49 args = varargin(iargs(i):end);
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
50 else
14230
fe65588c31b8 fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
51 args = varargin(iargs(i):iargs(i+1)-1);
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
52 endif
7041
32da63705bf9 [project @ 2007-10-19 19:05:21 by dbateman]
dbateman
parents: 7020
diff changeset
53 newplot ();
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
54 [tmp, fail] = __patch__ (h, args{:});
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
55 if (fail)
14230
fe65588c31b8 fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
56 print_usage ();
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
57 endif
14230
fe65588c31b8 fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
58 htmp(end + 1, 1) = tmp;
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
59 endfor
11306
262c365eb71c fill.m: Allow multiple filled polygons.
Ben Abbott <bpabbott@mac.com>
parents: 11149
diff changeset
60 if (strncmp (nextplot, "replace", 7))
262c365eb71c fill.m: Allow multiple filled polygons.
Ben Abbott <bpabbott@mac.com>
parents: 11149
diff changeset
61 set (h, "nextplot", nextplot);
262c365eb71c fill.m: Allow multiple filled polygons.
Ben Abbott <bpabbott@mac.com>
parents: 11149
diff changeset
62 endif
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
63 unwind_protect_cleanup
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
64 axes (oldh);
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
65 end_unwind_protect
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
66
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
67 if (nargout > 0)
7216
5389a52df87b [project @ 2007-11-29 19:07:29 by jwe]
jwe
parents: 7215
diff changeset
68 retval = htmp;
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
69 endif
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
70
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
71 endfunction
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
72
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
73 function iargs = __find_patches__ (varargin)
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
74 iargs = [];
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
75 i = 1;
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
76 while (i < nargin)
14230
fe65588c31b8 fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
77 iargs(end + 1) = i;
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7650
diff changeset
78 if (ischar (varargin{i})
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
79 && (strcmpi (varargin{i}, "faces")
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
80 || strcmpi (varargin{i}, "vertices")))
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
81 i += 4;
7208
a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe]
jwe
parents: 7041
diff changeset
82 elseif (isnumeric (varargin{i}))
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
83 i += 2;
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
84 endif
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
85
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
86 if (i <= nargin)
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
87 while (true);
11149
fe3c3dfc07eb style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
88 if (ischar (varargin{i})
fe3c3dfc07eb style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
89 && (strcmpi (varargin{i}, "faces")
fe3c3dfc07eb style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
90 || strcmpi (varargin{i}, "vertices")))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
91 break;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
92 elseif (isnumeric (varargin{i}))
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
93 ## Assume its the colorspec
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
94 i++;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
95 break;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
96 elseif (ischar (varargin{i}))
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
97 colspec = tolower (varargin{i});
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
98 collen = length (colspec);
14230
fe65588c31b8 fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
99 if (any (strncmp (colspec,
fe65588c31b8 fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
100 {"blue", "black", "k", "red", "green", ...
fe65588c31b8 fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
101 "yellow", "magenta", "cyan", "white"},
fe65588c31b8 fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
102 collen)))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
103 i++;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
104 break;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
105 endif
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
106 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
107 i += 2;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
108 endif
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
109 endwhile
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
110 endif
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
111 endwhile
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
112 endfunction
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
113
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
114
7020
e31f12bb9194 [project @ 2007-10-13 05:13:28 by dbateman]
dbateman
parents:
diff changeset
115 %!demo
8790
a013ff655ca4 Trivial changes to demos to produce a more pleasant output for octave+gnuplot+aquaterm.
Ben Abbott <bpabbott@mac.com>
parents: 8243
diff changeset
116 %! clf
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
117 %! t1 = (1/16:1/8:1)*2*pi;
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
118 %! t2 = ((1/16:1/8:1) + 1/32)*2*pi;
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
119 %! x1 = sin (t1) - 0.8;
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
120 %! y1 = cos (t1);
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
121 %! x2 = sin (t2) + 0.8;
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
122 %! y2 = cos (t2);
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
123 %! h = fill (x1,y1,'r', x2,y2,'g');
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
124