Mercurial > octave
annotate scripts/plot/appearance/hidden.m @ 23219:3ac9f9ecfae5 stable
maint: Update copyright dates.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 22 Feb 2017 12:39:29 -0500 |
parents | e9a0469dedd9 |
children | 092078913d54 |
rev | line source |
---|---|
23219
3ac9f9ecfae5
maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents:
23083
diff
changeset
|
1 ## Copyright (C) 2007-2017 Michael Goffioul |
7149 | 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 -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20711
diff
changeset
|
20 ## @deftypefn {} {} hidden |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20711
diff
changeset
|
21 ## @deftypefnx {} {} hidden on |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20711
diff
changeset
|
22 ## @deftypefnx {} {} hidden off |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20711
diff
changeset
|
23 ## @deftypefnx {} {@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. |
20173
777f26aa8e3e
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
27 ## |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17174
diff
changeset
|
28 ## When called with one of the modes @qcode{"on"} or @qcode{"off"} the state |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17174
diff
changeset
|
29 ## is set accordingly. |
16990
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 ## 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
|
32 ## |
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
33 ## 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
|
34 ## 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
|
35 ## 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
|
36 ## 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
|
37 ## mesh, although the mesh grid lines are still opaque. |
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
38 ## |
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16991
diff
changeset
|
39 ## @seealso{mesh, meshc, meshz, ezmesh, ezmeshc, trimesh, waterfall} |
7149 | 40 ## @end deftypefn |
41 | |
16990
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
42 function state = hidden (mode = "toggle") |
7149 | 43 |
16990
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
44 if (nargin > 2) |
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
45 print_usage (); |
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
46 elseif (nargin == 1) |
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
47 if (! ischar (mode)) |
20711
7b608fadc663
Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents:
20178
diff
changeset
|
48 error ("hidden: MODE must be a string"); |
16990
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
49 elseif (! any (strcmpi (mode, {"on", "off"}))) |
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
50 error ('hidden: MODE must be "on" or "off"'); |
7149 | 51 endif |
52 endif | |
53 | |
16990
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
54 for h = (get (gca (), "children")).'; |
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
55 htype = get (h, "type"); |
17494
cd98a50bfa63
hidden.m: Fix hidden so that it also works for trimesh objects.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
56 htag = get (h, "tag"); |
cd98a50bfa63
hidden.m: Fix hidden so that it also works for trimesh objects.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
57 if (strcmp (htype, "surface") || strcmp (htag, "trimesh")) |
7149 | 58 fc = get (h, "facecolor"); |
59 if ((! ischar (fc) && is_white (fc)) | |
16990
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
60 || (ischar (fc) && strcmp (fc, "none"))) |
7149 | 61 switch (mode) |
17174
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
62 case "on" |
7149 | 63 set (h, "facecolor", "w"); |
17174
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
64 case "off" |
7149 | 65 set (h, "facecolor", "none"); |
17174
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
66 case "toggle" |
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
67 if (ischar (fc)) |
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
68 set (h, "facecolor", "w"); |
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
69 mode = "on"; |
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
70 else |
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
71 set (h, "facecolor", "none"); |
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
72 mode = "off"; |
c3c1ebfaa7dc
maint: Use common indentation for switch statement.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
73 endif |
7149 | 74 endswitch |
75 endif | |
76 endif | |
77 endfor | |
78 | |
79 if (nargout > 0) | |
16990
cd0c56969d59
hidden.m: Overhaul function and documentation.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
80 state = mode; |
7149 | 81 endif |
82 | |
83 endfunction | |
84 | |
85 function retval = is_white (color) | |
86 retval = all (color == 1); | |
87 endfunction |