Mercurial > hg > octave-nkf

annotate scripts/plot/view.m @ 17157:5fd07aa232cf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
view.m: Overhaul function. Implement return value for 1 argument. * scripts/plot/view.m: Overhaul function. Implement return value for 1 argument.
author Rik <rik@octave.org>
date Fri, 02 Aug 2013 16:12:53 -0700
parents b5d6314314fc
children bb60b1bb47cf
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: 13141
diff changeset
1 ## Copyright (C) 2007-2012 John W. Eaton
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
2 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
4 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6257
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6257
diff changeset
8 ## your option) any later version.
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
9 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
14 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6257
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6257
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
18
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
20 ## @deftypefn {Function File} {} view (@var{azimuth}, @var{elevation})
12642
f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
21 ## @deftypefnx {Function File} {} view ([@var{azimuth} @var{elevation}])
f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
22 ## @deftypefnx {Function File} {} view ([@var{x} @var{y} @var{z}])
16356
df643a532b61 doc: Update docstring for view.m
Rik <rik@octave.org>
parents: 14363
diff changeset
23 ## @deftypefnx {Function File} {} view (2)
df643a532b61 doc: Update docstring for view.m
Rik <rik@octave.org>
parents: 14363
diff changeset
24 ## @deftypefnx {Function File} {} view (3)
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
25 ## @deftypefnx {Function File} {} view (@var{hax}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
26 ## @deftypefnx {Function File} {[@var{azimuth}, @var{elevation}] =} view ()
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
27 ## Query or set the viewpoint for the current axes.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
28 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
29 ## The parameters @var{azimuth} and @var{elevation} can be given as two
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
30 ## arguments or as 2-element vector. The viewpoint can also be specified with
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
31 ## Cartesian coordinates @var{x}, @var{y}, and @var{z}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
32 ##
17157
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
33 ## The call @code{view (2)} sets the viewpoint to @w{@var{azimuth} = 0}
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
34 ## and @w{@var{elevation} = 90}, which is the default for 2-D graphs.
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
35 ##
17157
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
36 ## The call @code{view (3)} sets the viewpoint to @w{@var{azimuth} = -37.5}
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
37 ## and @w{@var{elevation} = 30}, which is the default for 3-D graphs.
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
38 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
39 ## If the first argument @var{hax} is an axes handle, then operate on
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
40 ## this axis rather than the current axes returned by @code{gca}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
41 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16356
diff changeset
42 ## If no inputs are given, return the current @var{azimuth} and @var{elevation}.
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
43 ## @end deftypefn
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
44
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
45 ## Author: jwe
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
46
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
47 function [azimuth, elevation] = view (varargin)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
48
17157
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
49 [hax, varargin, nargin] = __plt_get_axis_arg__ ("view", varargin{:});
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
50 if (isempty (hax))
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
51 hax = gca ();
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
52 endif
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
53
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
54 if (nargin > 3)
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
55 print_usage ();
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
56 endif
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
57
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
58 if (nargin == 0)
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
59 x = get (hax, "view");
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
60 az = x(1);
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
61 el = x(2);
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
62 elseif (length (varargin) == 1)
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
63 x = varargin{1};
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
64 if (length (x) == 2)
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
65 az = x(1);
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
66 el = x(2);
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
67 elseif (length (x) == 3)
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
68 [az, el] = cart2sph (x(1), x(2), x(3));
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
69 az *= 180/pi;
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
70 az += 90;
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
71 el *= 180/pi;
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
72 elseif (x == 2)
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
73 az = 0;
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
74 el = 90;
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
75 elseif (x == 3)
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
76 az = -37.5;
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
77 el = 30;
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
78 else
17157
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
79 print_usage ();
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
80 endif
17157
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
81 elseif (length (varargin) == 2)
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
82 az = args{1};
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
83 el = args{2};
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
84 endif
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
85
17157
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
86 if (nargin > 0)
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
87 set (hax, "view", [az, el]);
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
88 else
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
89 if (nargout == 1)
17157
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
90 azimuth = [az, el];
5fd07aa232cf view.m: Overhaul function. Implement return value for 1 argument.
Rik <rik@octave.org>
parents: 17125
diff changeset
91 elseif (nargout == 2)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
92 azimuth = az;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
93 elevation = el;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
94 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
95 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
96
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
97 endfunction
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
98
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
99
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
100 %!test
13124
2ea1658ad049 Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
101 %! hf = figure ("visible", "off");
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13124
diff changeset
102 %! unwind_protect
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
103 %! plot3 ([0,1], [0,1], [0,1]);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
104 %! [az, el] = view;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
105 %! assert ([az, el], [-37.5, 30], eps);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
106 %! view (2);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
107 %! [az, el] = view;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
108 %! assert ([az, el], [0, 90], eps);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
109 %! view ([1 1 0]);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
110 %! [az, el] = view;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
111 %! assert ([az, el], [135, 0], eps);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
112 %! unwind_protect_cleanup
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
113 %! close (hf);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
114 %! end_unwind_protect
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
115
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
116 %!test
13124
2ea1658ad049 Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
117 %! hf = figure ("visible", "off");
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13124
diff changeset
118 %! unwind_protect
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
119 %! line;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
120 %! [az, el] = view;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
121 %! assert ([az, el], [0, 90], eps);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
122 %! view (3);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
123 %! [az, el] = view;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
124 %! assert ([az, el], [-37.5, 30], eps);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
125 %! unwind_protect_cleanup
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
126 %! close (hf);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12642
diff changeset
127 %! end_unwind_protect
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
128