Mercurial > hg > octave-lyh

annotate scripts/plot/cylinder.m @ 17455:359366a4994f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
waitbar.m: Use Octave coding conventions. * scripts/plot/waitbar.m: Rename 'retval' to 'h' to match documentation. Use 'hf', 'hp' for figure and patch graphics handles.
author Rik <rik@octave.org>
date Thu, 19 Sep 2013 14:26:47 -0700
parents 68bcac3c043a
children 25f6e31bbce9
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: 14092
diff changeset
1 ## Copyright (C) 2007-2012 Michael Goffioul and Kai Habel
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
2 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
4 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
8 ## your option) any later version.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
9 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
14 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
18
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
20 ## @deftypefn {Command} {} cylinder
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefnx {Function File} {} cylinder (@var{r})
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} cylinder (@var{r}, @var{n})
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
23 ## @deftypefnx {Function File} {} cylinder (@var{hax}, @dots{})
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
24 ## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} cylinder (@dots{})
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
25 ## Plot a 3-D unit cylinder.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
26 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
27 ## The optional input @var{r} is a vector specifying the radius along the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
28 ## unit z-axis. The default is [1 1] indicating radius 1 at @code{Z == 0}
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
29 ## and at @code{Z == 1}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
30 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
31 ## 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
32 ## the circumference of the cylinder. The default value is 20.
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
33 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
34 ## 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
35 ## rather than the current axes returned by @code{gca}.
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
36 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
37 ## If outputs are requested @code{cylinder} returns three matrices in
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
38 ## @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
39 ## generates a unit cylinder.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
40 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
41 ## Example:
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
42 ##
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
43 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
44 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
45 ## [x, y, z] = cylinder (10:-1:0, 50);
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
46 ## surf (x, y, z);
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
47 ## title ("a cone");
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
48 ## @end group
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
49 ## @end example
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
50 ## @seealso{ellipsoid, rectangle, sphere}
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
51 ## @end deftypefn
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
52
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
53 function [xx, yy, zz] = cylinder (varargin)
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
54
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: 14868
diff changeset
55 [hax, args, nargs] = __plt_get_axis_arg__ ("cylinder", varargin{:});
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
56
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
57 if (nargs == 0)
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
58 n = 20;
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
59 r = [1, 1];
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
60 elseif (nargs == 1)
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
61 n = 20;
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
62 r = args{1};
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
63 elseif (nargs == 2)
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
64 r = args{1};
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
65 n = args{2};
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
66 else
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
67 print_usage ();
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
68 endif
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
69
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
70 if (length (r) < 2)
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
71 error ("cylinder: length (R) must be larger than 2");
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
72 endif
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
73
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
74 phi = linspace (0, 2*pi, n+1);
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
75 idx = 1:length (r);
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
76 [phi, idx] = meshgrid (phi, idx);
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
77 z = (idx - 1) / (length (r) - 1);
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
78 r = r(idx);
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
79 [x, y] = pol2cart (phi, r);
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
80
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
81 if (nargout > 0)
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
82 xx = x;
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
83 yy = y;
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
84 zz = z;
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
85 else
17219
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17198
diff changeset
86 oldfig = [];
17309
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17219
diff changeset
87 if (! isempty (hax))
17219
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17198
diff changeset
88 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17198
diff changeset
89 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: 14868
diff changeset
90 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: 14868
diff changeset
91 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: 14868
diff changeset
92
17130
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17126
diff changeset
93 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: 14868
diff changeset
94 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: 14868
diff changeset
95 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: 14868
diff changeset
96 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: 14868
diff changeset
97 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: 14868
diff changeset
98 end_unwind_protect
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
99 endif
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
100
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
101 endfunction
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7215
diff changeset
102
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
103
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7215
diff changeset
104 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
105 %! clf;
14247
c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo.
Rik <octave@nomad.inbox5.com>
parents: 14245
diff changeset
106 %! colormap ('default');
17198
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
107 %! [x, y, z] = cylinder (10:-1:0, 50);
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7215
diff changeset
108 %! surf (x, y, z);
17198
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17130
diff changeset
109 %! title ('cylinder() with linearly shrinking radius produces a cone');
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
110