Mercurial > hg > octave-lyh

annotate scripts/plot/hidden.m @ 17126:eaab03308c0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links. * doc/interpreter/plot.txi: Add @findex entries that were in xlim.m * scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m, scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m, scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m, scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m, scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m, scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m, scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m, scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m, scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m, scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m, scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m, scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m, scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m, scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m, scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m, scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m, scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m, scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m, scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m, scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m, scripts/plot/zlim.m: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links.
author Rik <rik@octave.org>
date Wed, 31 Jul 2013 13:53:30 -0700
parents b59919bd2b0b
children c3c1ebfaa7dc
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 -*-
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16991
diff changeset
20 ## @deftypefn {Command} {} hidden
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16991
diff changeset
21 ## @deftypefnx {Command} {} hidden "on"
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16991
diff changeset
22 ## @deftypefnx {Command} {} hidden "off"
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16991
diff changeset
23 ## @deftypefnx {Function File} {@var{mode} =} hidden (@dots{})
16990
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 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16991
diff changeset
37 ## @seealso{mesh, meshc, meshz, ezmesh, ezmeshc, trimesh, waterfall}
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