octave_packages/m/plot/ezplot3.m

   1 ## Copyright (C) 2007-2012 David Bateman
   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
   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.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {} ezplot3 (@var{fx}, @var{fy}, @var{fz})
  21 ## @deftypefnx {Function File} {} ezplot3 (@dots{}, @var{dom})
  22 ## @deftypefnx {Function File} {} ezplot3 (@dots{}, @var{n})
  23 ## @deftypefnx {Function File} {} ezplot3 (@var{h}, @dots{})
  24 ## @deftypefnx {Function File} {@var{h} =} ezplot3 (@dots{})
  25 ##
  26 ## Plot a parametrically defined curve in three dimensions.
  27 ## @var{fx}, @var{fy}, and @var{fz} are strings, inline functions
  28 ## or function handles with one arguments defining the function.  By
  29 ## default the plot is over the domain @code{-2*pi < @var{x} < 2*pi}
  30 ## with 60 points.
  31 ##
  32 ## If @var{dom} is a two element vector, it represents the minimum and maximum
  33 ## value of @var{t}.  @var{n} is a scalar defining the number of points to use.
  34 ##
  35 ## The optional return value @var{h} is a graphics handle to the created plot.
  36 ##
  37 ## @example
  38 ## @group
  39 ## fx = @@(t) cos (t);
  40 ## fy = @@(t) sin (t);
  41 ## fz = @@(t) t;
  42 ## ezplot3 (fx, fy, fz, [0, 10*pi], 100);
  43 ## @end group
  44 ## @end example
  45 ##
  46 ## @seealso{plot3, ezplot, ezsurf, ezmesh}
  47 ## @end deftypefn
  48
  49 function retval = ezplot3 (varargin)
  50
  51   [h, needusage] = __ezplot__ ("plot3", varargin{:});
  52
  53   if (needusage)
  54     print_usage ();
  55   endif
  56
  57   if (nargout > 0)
  58     retval = h;
  59   endif
  60 endfunction
  61
  62
  63 %!demo
  64 %! clf
  65 %! fx = @(t) cos (t);
  66 %! fy = @(t) sin (t);
  67 %! fz = @(t) t;
  68 %! ezplot3 (fx, fy, fz, [0, 10*pi], 100);
  69