Mercurial > hg > octave-lyh

annotate scripts/plot/hidden.m @ 16990:cd0c56969d59

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
hidden.m: Overhaul function and documentation. * scripts/plot/hidden.m: Redo docstring. Match function variables to documentation. Do input validation first. Fix bug in for loop when multiple surface objects exist.
author Rik <rik@octave.org>
date Tue, 16 Jul 2013 18:13:52 -0700
parents 7277fe922e99
children b59919bd2b0b
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: 11523
diff changeset
1 ## Copyright (C) 2007-2012 Michael Goffioul
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
2 ##
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
4 ##
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
8 ## your option) any later version.
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
9 ##
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
14 ##
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
18
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
16990
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
20 ## @deftypefn {Function File} {} hidden ()
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
21 ## @deftypefnx {Function File} {} hidden ("on")
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
22 ## @deftypefnx {Function File} {} hidden ("off")
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
23 ## @deftypefnx {Function File} {@var{state} =} hidden (@var{dots{})
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
24 ## Control mesh hidden line removal.
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
25 ##
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
26 ## When called with no argument the hidden line removal state is toggled.
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
27 ## When called with one of the modes "on" or "off" the state is set accordingly.
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
28 ##
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
29 ## The optional output argument @var{mode} is the current state.
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
30 ##
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
31 ## Hidden Line Removal determines what graphic objects behind a mesh plot
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
32 ## are visible. The default is for the mesh to be opaque and lines behind
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
33 ## the mesh are not visible. If hidden line removal is turned off then
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
34 ## objects behind the mesh can be seen through the faces (openings) of the
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
35 ## mesh, although the mesh grid lines are still opaque.
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
36 ##
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
37 ## @seealso{mesh, meshc, meshz, ezmesh, ezmeshc}
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
38 ## @end deftypefn
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
39
16990
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
40 function state = hidden (mode = "toggle")
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
41
16990
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
42 if (nargin > 2)
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
43 print_usage ();
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
44 elseif (nargin == 1)
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
45 if (! ischar (mode))
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
46 error ("hidden: expecting MODE to be a string");
16990
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
47 elseif (! any (strcmpi (mode, {"on", "off"})))
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
48 error ('hidden: MODE must be "on" or "off"');
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
49 endif
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
50 endif
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
51
16990
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
52 for h = (get (gca (), "children")).';
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
53 htype = get (h, "type");
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
54 if (strcmp (htype, "surface"))
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
55 fc = get (h, "facecolor");
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
56 if ((! ischar (fc) && is_white (fc))
16990
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
57 || (ischar (fc) && strcmp (fc, "none")))
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
58 switch (mode)
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
59 case "on"
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
60 set (h, "facecolor", "w");
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
61 case "off"
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
62 set (h, "facecolor", "none");
16990
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
63 case "toggle"
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
64 if (ischar (fc))
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
65 set (h, "facecolor", "w");
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9040
diff changeset
66 mode = "on";
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
67 else
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
68 set (h, "facecolor", "none");
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9040
diff changeset
69 mode = "off";
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
70 endif
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
71 endswitch
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
72 endif
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
73 endif
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
74 endfor
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
75
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
76 if (nargout > 0)
16990
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
77 state = mode;
7149
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
78 endif
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
79
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
80 endfunction
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
81
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
82 function retval = is_white (color)
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
83 retval = all (color == 1);
5c121a8b40b5 [project @ 2007-11-09 18:15:39 by jwe]
jwe
parents:
diff changeset
84 endfunction
16990
cd0c56969d59 hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents: 14359
diff changeset
85