annotate scripts/plot/shading.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents 22c50cbad2ce
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: 14092
diff changeset
1 ## Copyright (C) 2006-2012 Kai Habel
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
2 ##
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7151
diff changeset
3 ## This file is part of Octave.
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7151
diff changeset
4 ##
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7151
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7151
diff changeset
8 ## your option) any later version.
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
9 ##
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
14 ##
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7151
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7151
diff changeset
17 ## <http://www.gnu.org/licenses/>.
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
18
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10635
diff changeset
20 ## @deftypefn {Function File} {} shading (@var{type})
7122
542379d37bf9 [project @ 2007-11-07 21:50:41 by jwe]
jwe
parents: 7110
diff changeset
21 ## @deftypefnx {Function File} {} shading (@var{ax}, @dots{})
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
22 ## Set the shading of surface or patch graphic objects. Valid arguments
7978
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
23 ## for @var{type} are
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
24 ##
11595
5ec6aa05638d Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
25 ## @table @asis
7978
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
26 ## @item "flat"
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
27 ## Single colored patches with invisible edges.
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
28 ##
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
29 ## @item "faceted"
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
30 ## Single colored patches with visible edges.
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
31 ##
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
32 ## @item "interp"
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
33 ## Color between patch vertices are interpolated and the patch edges are
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
34 ## invisible.
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
35 ## @end table
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
36 ##
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
37 ## If @var{ax} is given the shading is applied to axis @var{ax} instead
f8514786c490 Clarify help of the shading function
David Bateman <dbateman@free.fr>
parents: 7249
diff changeset
38 ## of the current axis.
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
39 ## @end deftypefn
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
40
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
41 ## Author: Kai Habel <kai.habel@gmx.de>
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
42
7249
87b5a3fb5286 [project @ 2007-12-04 18:04:23 by jwe]
jwe
parents: 7164
diff changeset
43 function shading (varargin)
87b5a3fb5286 [project @ 2007-12-04 18:04:23 by jwe]
jwe
parents: 7164
diff changeset
44
87b5a3fb5286 [project @ 2007-12-04 18:04:23 by jwe]
jwe
parents: 7164
diff changeset
45 [ax, varargin] = __plt_get_axis_arg__ ("shading", varargin{:});
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
46
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
47 if (nargin != 1 && nargin != 2)
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
48 print_usage ();
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
49 endif
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
50
7249
87b5a3fb5286 [project @ 2007-12-04 18:04:23 by jwe]
jwe
parents: 7164
diff changeset
51 mode = varargin{1};
87b5a3fb5286 [project @ 2007-12-04 18:04:23 by jwe]
jwe
parents: 7164
diff changeset
52
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
53 h1 = findobj (ax, "type", "patch");
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
54 h2 = findobj (ax, "type", "surface");
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
55
7249
87b5a3fb5286 [project @ 2007-12-04 18:04:23 by jwe]
jwe
parents: 7164
diff changeset
56 obj = [h1(:); h2(:)];
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
57
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
58 for n = 1:numel(obj)
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
59 h = obj(n);
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 8166
diff changeset
60 if (strcmpi (mode, "flat"))
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
61 set (h, "facecolor", "flat");
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
62 set (h, "edgecolor", "none");
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 8166
diff changeset
63 elseif (strcmpi (mode, "interp"))
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
64 set (h, "facecolor", "interp");
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
65 set (h, "edgecolor", "none");
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 8166
diff changeset
66 elseif (strcmpi (mode, "faceted"))
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
67 set (h, "facecolor", "flat");
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
68 set (h, "edgecolor", [0 0 0]);
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
69 else
10635
d1978e7364ad Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents: 9040
diff changeset
70 error ("shading: unknown argument");
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
71 endif
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
72 endfor
7110
0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe]
jwe
parents: 7109
diff changeset
73
7109
5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe]
jwe
parents:
diff changeset
74 endfunction
8166
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
75
13967
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
76
8166
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
77 %!demo
8765
cf2163418140 Trivial change to shading.m and surfl.m demos.
Ben Abbott <bpabbott@mac.com>
parents: 8746
diff changeset
78 %! clf
cf2163418140 Trivial change to shading.m and surfl.m demos.
Ben Abbott <bpabbott@mac.com>
parents: 8746
diff changeset
79 %! colormap (jet)
8166
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
80 %! sombrero
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
81 %! shading faceted
13967
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
82 %! title ('shading "faceted"')
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
83
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
84 %!demo
14092
22c50cbad2ce Add clf() to all plot demos.
Ben Abbott <bpabbott@mac.com>
parents: 13967
diff changeset
85 %! clf
13967
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
86 %! sombrero
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
87 %! shading flat
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
88 %! title ('shading "flat"')
8765
cf2163418140 Trivial change to shading.m and surfl.m demos.
Ben Abbott <bpabbott@mac.com>
parents: 8746
diff changeset
89
cf2163418140 Trivial change to shading.m and surfl.m demos.
Ben Abbott <bpabbott@mac.com>
parents: 8746
diff changeset
90 %!demo
14092
22c50cbad2ce Add clf() to all plot demos.
Ben Abbott <bpabbott@mac.com>
parents: 13967
diff changeset
91 %! clf
8166
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
92 %! sombrero
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
93 %! shading interp
13967
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
94 %! title ('shading "interp"')
8765
cf2163418140 Trivial change to shading.m and surfl.m demos.
Ben Abbott <bpabbott@mac.com>
parents: 8746
diff changeset
95
cf2163418140 Trivial change to shading.m and surfl.m demos.
Ben Abbott <bpabbott@mac.com>
parents: 8746
diff changeset
96 %!demo
14092
22c50cbad2ce Add clf() to all plot demos.
Ben Abbott <bpabbott@mac.com>
parents: 13967
diff changeset
97 %! clf
8166
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
98 %! pcolor (peaks ())
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
99 %! shading faceted
13967
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
100 %! title ('shading "faceted"')
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
101
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
102 %!demo
14092
22c50cbad2ce Add clf() to all plot demos.
Ben Abbott <bpabbott@mac.com>
parents: 13967
diff changeset
103 %! clf
13967
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
104 %! pcolor (peaks ())
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
105 %! shading flat
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
106 %! title ('shading "flat"')
8765
cf2163418140 Trivial change to shading.m and surfl.m demos.
Ben Abbott <bpabbott@mac.com>
parents: 8746
diff changeset
107
cf2163418140 Trivial change to shading.m and surfl.m demos.
Ben Abbott <bpabbott@mac.com>
parents: 8746
diff changeset
108 %!demo
14092
22c50cbad2ce Add clf() to all plot demos.
Ben Abbott <bpabbott@mac.com>
parents: 13967
diff changeset
109 %! clf
8166
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
110 %! pcolor (peaks ())
4024fc815f8d __go_draw_axes__.m: Fix interpolation of facecolors.
Ben Abbott <bpabbott@mac.com>
parents: 7978
diff changeset
111 %! shading interp
13967
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
112 %! title ('shading "interp"')
9ff0273cd054 shading.m: Add demos for 'flat' option
Rik <octave@nomad.inbox5.com>
parents: 12437
diff changeset
113