annotate scripts/plot/view.m @ 11344:cac58372d547

Make view more compatible
author Kai Habel <kai.habel@gmx.de>
date Sun, 12 Dec 2010 16:44:29 +0100
parents be55736a0783
children 488f07b65b1d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 7712
diff changeset
1 ## Copyright (C) 2007, 2008 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 -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
20 ## @deftypefn {Function File} {} view (@var{azimuth}, @var{elevation})
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
21 ## @deftypefnx {Function File} {} view ([@var{azimuth}, @var{elevation}])
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
22 ## @deftypefnx {Function File} {} view ([@var{x}, @var{y}, @var{z}])
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
23 ## @deftypefnx {Function File} {} view (@var{dims})
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
24 ## @deftypefnx {Function File} {} view (@var{ax}, @dots{})
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
25 ## @deftypefnx {Function File} {[@var{azimuth}, @var{elevation}] =} view ()
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
26 ## Set or get the viewpoint for the current axes. The parameters
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
27 ## @var{azimuth} and @var{elevation} can be given as two arguments or as
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
28 ## 2-element vector.
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
29 ## The viewpoint can also be given with cartesian coordinates @var{x},
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
30 ## @var{y}, and @var{z}.
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
31 ## The call @code{view (2)} sets the viewpoint to @var{azimuth} = 0
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
32 ## and @var{elevation} = 90, which is default for 2d graphs.
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
33 ## The call @code{view (3)} sets the viewpoint to @var{azimuth} = -37.5
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
34 ## and @var{elevation} = 30, which is default for 3d graphs.
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
35 ## If @var{ax} is given, the viewpoint is set for this axes, otherwise
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
36 ## it is set for the current axes.
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
37 ## @end deftypefn
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
38
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
39 ## Author: jwe
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
40
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
41 function [azimuth, elevation] = view (varargin)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
42
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
43 if (nargin < 3)
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
44
7712
a626db2e8a1c view: get values from current axes if nargin == 0
John W. Eaton <jwe@octave.org>
parents: 7016
diff changeset
45 if (nargin == 0)
a626db2e8a1c view: get values from current axes if nargin == 0
John W. Eaton <jwe@octave.org>
parents: 7016
diff changeset
46 tmp = get (gca (), "view");
a626db2e8a1c view: get values from current axes if nargin == 0
John W. Eaton <jwe@octave.org>
parents: 7016
diff changeset
47 az = tmp(1);
a626db2e8a1c view: get values from current axes if nargin == 0
John W. Eaton <jwe@octave.org>
parents: 7016
diff changeset
48 el = tmp(2);
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
49 else
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
50 ax = varargin{1};
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
51 if (ishandle (ax) && strcmp (get (ax, "type"), "axes"))
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
52 args = varargin{2:end};
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
53 else
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
54 ax = gca;
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
55 args = varargin;
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
56 endif
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
57 endif
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
58
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
59 if (nargin == 1)
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
60 x = args{1};
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
61 if (length (x) == 2)
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
62 az = x(1);
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
63 el = x(2);
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
64 elseif (length (x) == 3)
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
65 [az, el] = cart2sph (x(1), x(2), x(3));
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
66 az *= 180/pi;
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
67 az += 90;
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
68 el *= 180/pi;
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
69 elseif (x == 2)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
70 az = 0;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
71 el = 90;
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
72 elseif (x == 3)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
73 az = -37.5;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
74 el = 30;
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
75 else
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
76 print_usage ();
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
77 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
78 elseif (nargin == 2)
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
79 az = args{1};
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
80 el = args{2};
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
81 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
82
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
83 if (nargin > 0)
11344
cac58372d547 Make view more compatible
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
84 set (ax, "view", [az, el]);
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
85 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
86
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
87 if (nargout == 1)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
88 error ("view: T = view () not implemented");
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
89 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
90
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
91 if (nargout == 2)
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 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
96 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
97 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
98
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
99 endfunction