Mercurial > octave
view scripts/plot/draw/cylinder.m @ 24431:0c6cedafc71e stable
doc: Use 'axes' rather than 'axis' appropriately in docstrings.
* voronoi.m, axis.m, box.m, caxis.m, datetick.m, grid.m, legend.m,
lighting.m, shading.m, title.m, view.m, xlabel.m, xlim.m, ylabel.m, ylim.m,
zlabel.m, zlim.m, area.m, bar.m, barh.m, colorbar.m, comet.m, comet3.m,
compass.m, contour.m, contour3.m, contourf.m, cylinder.m, ellipsoid.m,
errorbar.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m,
ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, fplot.m, hist.m,
line.m, loglog.m, loglogerr.m, mesh.m, meshc.m, meshz.m, pareto.m, patch.m,
pcolor.m, pie.m, pie3.m, plot.m, plot3.m, plotmatrix.m, plotyy.m, polar.m,
quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m,
semilogx.m, semilogxerr.m, semilogy.m, semilogyerr.m, slice.m, sphere.m,
stairs.m, stem.m, stem3.m, surf.m, surface.m, surfc.m, surfl.m, surfnorm.m,
waterfall.m, axes.m, cla.m, gca.m, hold.m, newplot.m, subplot.m:
Use 'axes' rather than 'axis' appropriately in docstrings.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 19 Dec 2017 12:39:25 -0800 |
parents | 3ac9f9ecfae5 |
children | 6cf385e26616 |
line wrap: on
line source
## Copyright (C) 2007-2017 Michael Goffioul and Kai Habel ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {} {} cylinder ## @deftypefnx {} {} cylinder (@var{r}) ## @deftypefnx {} {} cylinder (@var{r}, @var{n}) ## @deftypefnx {} {} cylinder (@var{hax}, @dots{}) ## @deftypefnx {} {[@var{x}, @var{y}, @var{z}] =} cylinder (@dots{}) ## Plot a 3-D unit cylinder. ## ## The optional input @var{r} is a vector specifying the radius along the ## unit z-axis. The default is [1 1] indicating radius 1 at @code{Z == 0} ## and at @code{Z == 1}. ## ## The optional input @var{n} determines the number of faces around the ## circumference of the cylinder. The default value is 20. ## ## If the first argument @var{hax} is an axes handle, then plot into this axes, ## rather than the current axes returned by @code{gca}. ## ## If outputs are requested @code{cylinder} returns three matrices in ## @code{meshgrid} format, such that @code{surf (@var{x}, @var{y}, @var{z})} ## generates a unit cylinder. ## ## Example: ## ## @example ## @group ## [x, y, z] = cylinder (10:-1:0, 50); ## surf (x, y, z); ## title ("a cone"); ## @end group ## @end example ## @seealso{ellipsoid, rectangle, sphere} ## @end deftypefn function [xx, yy, zz] = cylinder (varargin) [hax, args, nargs] = __plt_get_axis_arg__ ("cylinder", varargin{:}); if (nargs == 0) r = [1, 1]; n = 20; elseif (nargs == 1) r = args{1}; n = 20; elseif (nargs == 2) r = args{1}; n = args{2}; else print_usage (); endif if (length (r) < 2) error ("cylinder: length (R) must be larger than 2"); endif phi = linspace (0, 2*pi, n+1); idx = 1:length (r); [phi, idx] = meshgrid (phi, idx); z = (idx - 1) / (length (r) - 1); r = r(idx); [x, y] = pol2cart (phi, r); if (nargout > 0) xx = x; yy = y; zz = z; else oldfig = []; if (! isempty (hax)) oldfig = get (0, "currentfigure"); endif unwind_protect hax = newplot (hax); surf (x, y, z); unwind_protect_cleanup if (! isempty (oldfig)) set (0, "currentfigure", oldfig); endif end_unwind_protect endif endfunction %!demo %! clf; %! colormap ("default"); %! [x, y, z] = cylinder (10:-1:0, 50); %! surf (x, y, z); %! title ("cylinder() with linearly shrinking radius produces a cone");