Mercurial > hg > octave-lyh
annotate scripts/plot/fill.m @ 17455:359366a4994f
waitbar.m: Use Octave coding conventions.
* scripts/plot/waitbar.m: Rename 'retval' to 'h' to match documentation.
Use 'hf', 'hp' for figure and patch graphics handles.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 19 Sep 2013 14:26:47 -0700 |
parents | 3f0ed69d21c6 |
children |
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 | 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 -*- | |
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 | 21 ## @deftypefnx {Function File} {} fill (@var{x1}, @var{y1}, @var{c1}, @var{x2}, @var{y2}, @var{c2}) |
22 ## @deftypefnx {Function File} {} fill (@dots{}, @var{prop}, @var{val}) | |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
23 ## @deftypefnx {Function File} {} fill (@var{hax}, @dots{}) |
7650 | 24 ## @deftypefnx {Function File} {@var{h} =} fill (@dots{}) |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
25 ## Create one or more filled 2-D polygons. |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
26 ## |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
27 ## The inputs @var{x} and @var{y} are the coordinates of the polygon vertices. |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
28 ## If the inputs are matrices then the rows represent different vertices and |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17075
diff
changeset
|
29 ## each column produces a different polygon. @code{fill} will close any open |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17075
diff
changeset
|
30 ## polygons before plotting. |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
31 ## |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
32 ## The input @var{c} determines the color of the polygon. The simplest form |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
33 ## is a single color specification such as a @code{plot} format or an |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
34 ## RGB-triple. In this case the polygon(s) will have one unique color. If |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
35 ## @var{c} is a vector or matrix then the color data is first scaled using |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
36 ## @code{caxis} and then indexed into the current colormap. A row vector will |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
37 ## color each polygon (a column from matrices @var{x} and @var{y}) with a |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
38 ## single computed color. A matrix @var{c} of the same size as @var{x} and |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
39 ## @var{y} will compute the color of each vertex and then interpolate the face |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
40 ## color between the vertices. |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
41 ## |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
42 ## Multiple property/value pairs for the underlying patch object may be |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
43 ## specified, but they must appear in pairs. |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
44 ## |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17075
diff
changeset
|
45 ## If the first argument @var{hax} is an axes handle, then plot into this axis, |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17075
diff
changeset
|
46 ## rather than the current axes returned by @code{gca}. |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
47 ## |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17075
diff
changeset
|
48 ## The optional return value @var{h} is a vector of graphics handles to |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
49 ## the created patch objects. |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
50 ## |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
51 ## Example: red square |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
52 ## |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
53 ## @example |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
54 ## @group |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
55 ## vertices = [0 0 |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
56 ## 1 0 |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
57 ## 1 1 |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
58 ## 0 1]; |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
59 ## fill (vertices(:,1), vertices(:,2), "r"); |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
60 ## axis ([-0.5 1.5, -0.5 1.5]) |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
61 ## axis equal |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
62 ## @end group |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
63 ## @end example |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
64 ## |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
65 ## @seealso{patch, caxis, colormap} |
7020 | 66 ## @end deftypefn |
67 | |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
68 function h = fill (varargin) |
7020 | 69 |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
70 [hax, varargin] = __plt_get_axis_arg__ ("fill", varargin{:}); |
7216 | 71 |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
72 hlist = []; |
7215 | 73 iargs = __find_patches__ (varargin{:}); |
7216 | 74 |
17219
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
75 oldfig = []; |
17309
68bcac3c043a
Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
76 if (! isempty (hax)) |
17219
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
77 oldfig = get (0, "currentfigure"); |
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
78 endif |
7215 | 79 unwind_protect |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
80 hax = newplot (hax); |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
81 old_nxtplt = get (hax, "nextplot"); |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
82 set (hax, "nextplot", "add"); |
7020 | 83 |
84 for i = 1 : length (iargs) | |
85 if (i == length (iargs)) | |
14230
fe65588c31b8
fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
86 args = varargin(iargs(i):end); |
7020 | 87 else |
14230
fe65588c31b8
fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
88 args = varargin(iargs(i):iargs(i+1)-1); |
7020 | 89 endif |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
90 [htmp, fail] = __patch__ (hax, args{:}); |
7020 | 91 if (fail) |
14230
fe65588c31b8
fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
92 print_usage (); |
7020 | 93 endif |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
94 hlist(end + 1, 1) = htmp; |
7020 | 95 endfor |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
96 |
17413
3f0ed69d21c6
Replace unnecessary instances of strncmp with strcmp.
Rik <rik@octave.org>
parents:
17309
diff
changeset
|
97 if (strcmp (old_nxtplt, "replace")) |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
98 set (hax, "nextplot", old_nxtplt); |
11306
262c365eb71c
fill.m: Allow multiple filled polygons.
Ben Abbott <bpabbott@mac.com>
parents:
11149
diff
changeset
|
99 endif |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
100 |
7215 | 101 unwind_protect_cleanup |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
102 if (! isempty (oldfig)) |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
103 set (0, "currentfigure", oldfig); |
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
104 endif |
7215 | 105 end_unwind_protect |
106 | |
7020 | 107 if (nargout > 0) |
17075
806f48d8a577
fill.m, shading.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14237
diff
changeset
|
108 h = hlist; |
7020 | 109 endif |
7215 | 110 |
7020 | 111 endfunction |
112 | |
113 function iargs = __find_patches__ (varargin) | |
114 iargs = []; | |
115 i = 1; | |
116 while (i < nargin) | |
14230
fe65588c31b8
fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
117 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
|
118 if (ischar (varargin{i}) |
10549 | 119 && (strcmpi (varargin{i}, "faces") |
120 || strcmpi (varargin{i}, "vertices"))) | |
7020 | 121 i += 4; |
7208 | 122 elseif (isnumeric (varargin{i})) |
7020 | 123 i += 2; |
124 endif | |
125 | |
126 if (i <= nargin) | |
127 while (true); | |
11149
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
128 if (ischar (varargin{i}) |
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
129 && (strcmpi (varargin{i}, "faces") |
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
130 || strcmpi (varargin{i}, "vertices"))) |
10549 | 131 break; |
132 elseif (isnumeric (varargin{i})) | |
133 ## Assume its the colorspec | |
134 i++; | |
135 break; | |
136 elseif (ischar (varargin{i})) | |
137 colspec = tolower (varargin{i}); | |
138 collen = length (colspec); | |
14230
fe65588c31b8
fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
139 if (any (strncmp (colspec, |
fe65588c31b8
fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
140 {"blue", "black", "k", "red", "green", ... |
fe65588c31b8
fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
141 "yellow", "magenta", "cyan", "white"}, |
fe65588c31b8
fill.m: Return column vector of graphics handles
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
142 collen))) |
10549 | 143 i++; |
144 break; | |
145 endif | |
146 else | |
147 i += 2; | |
148 endif | |
7020 | 149 endwhile |
150 endif | |
151 endwhile | |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14230
diff
changeset
|
152 |
7020 | 153 endfunction |
154 | |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
155 |
7020 | 156 %!demo |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14230
diff
changeset
|
157 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14230
diff
changeset
|
158 %! t1 = (1/16:1/8:1) * 2*pi; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14230
diff
changeset
|
159 %! t2 = ((1/16:1/8:1) + 1/32) * 2*pi; |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
160 %! 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
|
161 %! 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
|
162 %! 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
|
163 %! 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
|
164 %! 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
|
165 |