Mercurial > hg > octave-lyh
annotate scripts/plot/sphere.m @ 17535:c12c688a35ed default tip lyh
Fix warnings
author | LYH <lyh.kernel@gmail.com> |
---|---|
date | Fri, 27 Sep 2013 17:43:27 +0800 |
parents | f0f4b524b6d0 |
children |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
12575
diff
changeset
|
1 ## Copyright (C) 2007-2012 Michael Goffioul |
7189 | 2 ## |
7224 | 3 ## This file is part of Octave. |
7189 | 4 ## |
7224 | 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. | |
7189 | 14 ## |
15 ## You should have received a copy of the GNU General Public License | |
7224 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
7189 | 18 |
19 ## -*- texinfo -*- | |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
20 ## @deftypefn {Function File} {} sphere () |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
21 ## @deftypefnx {Function File} {} sphere (@var{n}) |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
22 ## @deftypefnx {Function File} {} sphere (@var{hax}, @dots{}) |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
23 ## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} sphere (@dots{}) |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
24 ## Plot a 3-D unit sphere. |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
25 ## |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
26 ## The optional input @var{n} determines the number of faces around the |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
27 ## the circumference of the sphere. The default value is 20. |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
28 ## |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
29 ## If the first argument @var{hax} is an axes handle, then plot into this axis, |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
30 ## rather than the current axes returned by @code{gca}. |
7189 | 31 ## |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
32 ## If outputs are requested @code{sphere} returns three matrices in |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
33 ## @code{meshgrid} format such that @code{surf (@var{x}, @var{y}, @var{z})} |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
34 ## generates a unit sphere. |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
35 ## |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
36 ## Example: |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
37 ## |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
38 ## @example |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
39 ## @group |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
40 ## [x, y, z] = sphere (40); |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
41 ## surf (3*x, 3*y, 3*z); |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
42 ## axis equal; |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
43 ## title ("sphere of radius 3"); |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
44 ## @end group |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
45 ## @end example |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17051
diff
changeset
|
46 ## @seealso{cylinder, ellipsoid, rectangle} |
7189 | 47 ## @end deftypefn |
48 | |
7215 | 49 function [xx, yy, zz] = sphere (varargin) |
7189 | 50 |
17051
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
51 [hax, varargin, nargin] = __plt_get_axis_arg__ ("sphere", varargin{:}); |
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
52 |
7215 | 53 if (nargin > 1) |
54 print_usage (); | |
7191 | 55 elseif (nargin == 1) |
7215 | 56 n = varargin{1}; |
7189 | 57 else |
7191 | 58 n = 20; |
7189 | 59 endif |
60 | |
61 theta = linspace (0, 2*pi, n+1); | |
62 phi = linspace (-pi/2, pi/2, n+1); | |
63 [theta,phi] = meshgrid (theta, phi); | |
64 | |
7191 | 65 x = cos (phi) .* cos (theta); |
66 y = cos (phi) .* sin (theta); | |
67 z = sin (phi); | |
7189 | 68 |
69 if (nargout > 0) | |
70 xx = x; | |
71 yy = y; | |
72 zz = z; | |
73 else | |
17487
f0f4b524b6d0
maint: Correct indentation for several plot routines.
Rik <rik@octave.org>
parents:
17346
diff
changeset
|
74 oldfig = []; |
f0f4b524b6d0
maint: Correct indentation for several plot routines.
Rik <rik@octave.org>
parents:
17346
diff
changeset
|
75 if (! isempty (hax)) |
f0f4b524b6d0
maint: Correct indentation for several plot routines.
Rik <rik@octave.org>
parents:
17346
diff
changeset
|
76 oldfig = get (0, "currentfigure"); |
f0f4b524b6d0
maint: Correct indentation for several plot routines.
Rik <rik@octave.org>
parents:
17346
diff
changeset
|
77 endif |
17051
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
78 unwind_protect |
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
79 hax = newplot (hax); |
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
80 |
17130
26589abbc78d
Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
81 surf (x, y, z); |
17051
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
82 unwind_protect_cleanup |
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
83 if (! isempty (oldfig)) |
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
84 set (0, "currentfigure", oldfig); |
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
85 endif |
3e1b24a2454a
cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
14138
diff
changeset
|
86 end_unwind_protect |
7189 | 87 endif |
88 | |
89 endfunction | |
17346
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
17309
diff
changeset
|
90 |