Mercurial > hg > octave-nkf
annotate scripts/plot/view.m @ 12344:68ac95d2460c
Periodic grammarcheck of documentation.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sat, 05 Feb 2011 12:58:34 -0800 |
| parents | c792872f8942 |
| children | d0b799dafede |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 2007-2011 John W. Eaton |
| 6257 | 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 | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 6257 | 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 | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 6257 | 18 |
| 19 ## -*- texinfo -*- | |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
20 ## @deftypefn {Function File} {[@var{azimuth}, @var{elevation}] =} view () |
| 11567 | 21 ## @deftypefnx {Function File} {} view (@var{azimuth}, @var{elevation}) |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
22 ## @deftypefnx {Function File} {} view ([@var{azimuth}, @var{elevation}]) |
|
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
23 ## @deftypefnx {Function File} {} view ([@var{x}, @var{y}, @var{z}]) |
| 6257 | 24 ## @deftypefnx {Function File} {} view (@var{dims}) |
| 11344 | 25 ## @deftypefnx {Function File} {} view (@var{ax}, @dots{}) |
|
12344
68ac95d2460c
Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
26 ## Query or set the viewpoint for the current axes. The parameters |
| 11344 | 27 ## @var{azimuth} and @var{elevation} can be given as two arguments or as |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11567
diff
changeset
|
28 ## 2-element vector. |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11567
diff
changeset
|
29 ## The viewpoint can also be given with Cartesian coordinates @var{x}, |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11567
diff
changeset
|
30 ## @var{y}, and @var{z}. |
| 11344 | 31 ## The call @code{view (2)} sets the viewpoint to @var{azimuth} = 0 |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
32 ## and @var{elevation} = 90, which is the default for 2-D graphs. |
| 11344 | 33 ## The call @code{view (3)} sets the viewpoint to @var{azimuth} = -37.5 |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
34 ## and @var{elevation} = 30, which is the default for 3-D graphs. |
| 11344 | 35 ## If @var{ax} is given, the viewpoint is set for this axes, otherwise |
| 36 ## it is set for the current axes. | |
| 6257 | 37 ## @end deftypefn |
| 38 | |
| 39 ## Author: jwe | |
| 40 | |
| 11344 | 41 function [azimuth, elevation] = view (varargin) |
| 6257 | 42 |
|
11345
488f07b65b1d
Fix bugs of previous changeset
Kai Habel <kai.habel@gmx.de>
parents:
11344
diff
changeset
|
43 if (nargin < 4) |
|
7712
a626db2e8a1c
view: get values from current axes if nargin == 0
John W. Eaton <jwe@octave.org>
parents:
7016
diff
changeset
|
44 if (nargin == 0) |
|
11391
98d523608f70
view.m: Return azimuth and elevation for nargin == 0.
Ben Abbott <bpabbott@mac.com>
parents:
11345
diff
changeset
|
45 args = {get(gca (), "view")}; |
| 11344 | 46 else |
| 47 ax = varargin{1}; | |
| 48 if (ishandle (ax) && strcmp (get (ax, "type"), "axes")) | |
|
11345
488f07b65b1d
Fix bugs of previous changeset
Kai Habel <kai.habel@gmx.de>
parents:
11344
diff
changeset
|
49 args = varargin(2:end); |
| 11344 | 50 else |
| 51 ax = gca; | |
| 52 args = varargin; | |
| 53 endif | |
| 54 endif | |
|
11345
488f07b65b1d
Fix bugs of previous changeset
Kai Habel <kai.habel@gmx.de>
parents:
11344
diff
changeset
|
55 if (length (args) == 1) |
| 11344 | 56 x = args{1}; |
| 57 if (length (x) == 2) | |
| 58 az = x(1); | |
| 59 el = x(2); | |
| 60 elseif (length (x) == 3) | |
| 61 [az, el] = cart2sph (x(1), x(2), x(3)); | |
| 62 az *= 180/pi; | |
| 63 az += 90; | |
| 64 el *= 180/pi; | |
| 65 elseif (x == 2) | |
| 10549 | 66 az = 0; |
| 67 el = 90; | |
| 6257 | 68 elseif (x == 3) |
| 10549 | 69 az = -37.5; |
| 70 el = 30; | |
| 6257 | 71 else |
| 11344 | 72 print_usage (); |
| 6257 | 73 endif |
|
11345
488f07b65b1d
Fix bugs of previous changeset
Kai Habel <kai.habel@gmx.de>
parents:
11344
diff
changeset
|
74 elseif (length (args) == 2) |
| 11344 | 75 az = args{1}; |
| 76 el = args{2}; | |
| 6257 | 77 endif |
| 78 | |
| 79 if (nargin > 0) | |
| 11344 | 80 set (ax, "view", [az, el]); |
| 6257 | 81 endif |
| 82 | |
| 83 if (nargout == 1) | |
| 84 error ("view: T = view () not implemented"); | |
| 85 endif | |
| 86 | |
| 87 if (nargout == 2) | |
| 88 azimuth = az; | |
| 89 elevation = el; | |
| 90 endif | |
| 91 else | |
| 92 print_usage (); | |
| 93 endif | |
| 94 | |
| 95 endfunction |