scripts/plot/draw/ezplot3.m

@(
)
@(
)
@(
)
@(
)
@(
)
@(
)
author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e
rev	line source
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	1 ## Copyright (C) 2007-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26552 diff changeset	2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26552 diff changeset	3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26552 diff changeset	4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26552 diff changeset	5 ##
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	6 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	7 ## This file is part of Octave.
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	8 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24432 diff changeset	9 ## Octave is free software: you can redistribute it and/or modify it
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	10 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24432 diff changeset	11 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22332 diff changeset	12 ## (at your option) any later version.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	13 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	14 ## Octave is distributed in the hope that it will be useful, but
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22332 diff changeset	16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22332 diff changeset	17 ## GNU General Public License for more details.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	18 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	19 ## You should have received a copy of the GNU General Public License
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	20 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24432 diff changeset	21 ## <https://www.gnu.org/licenses/>.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	22
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	23 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## @deftypefn {} {} ezplot3 (@var{fx}, @var{fy}, @var{fz})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	25 ## @deftypefnx {} {} ezplot3 (@dots{}, @var{dom})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	26 ## @deftypefnx {} {} ezplot3 (@dots{}, @var{n})
22332 1d85005fc6b7 Fix minor issues revealed from dump_plots. Rik <rik@octave.org> parents: 22323 diff changeset	27 ## @deftypefnx {} {} ezplot3 (@dots{}, "animate")
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	28 ## @deftypefnx {} {} ezplot3 (@var{hax}, @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	29 ## @deftypefnx {} {@var{h} =} ezplot3 (@dots{})
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	30 ##
14038 b0cdd60db5e5 doc: Grammarcheck documentation ahead of 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 14001 diff changeset	31 ## Plot a parametrically defined curve in three dimensions.
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	32 ##
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	33 ## @var{fx}, @var{fy}, and @var{fz} are strings, inline functions,
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	34 ## or function handles with one argument defining the function. By
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	35 ## default the plot is over the domain @code{0 <= @var{t} <= 2*pi}
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	36 ## with 500 points.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	37 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	38 ## If @var{dom} is a two element vector, it represents the minimum and maximum
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	39 ## values of @var{t}.
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	40 ##
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	41 ## @var{n} is a scalar defining the number of points to use in plotting the
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	42 ## function.
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	43 ##
22332 1d85005fc6b7 Fix minor issues revealed from dump_plots. Rik <rik@octave.org> parents: 22323 diff changeset	44 ## If the @qcode{"animate"} option is given then the plotting is animated
1d85005fc6b7 Fix minor issues revealed from dump_plots. Rik <rik@octave.org> parents: 22323 diff changeset	45 ## in the style of @code{comet3}.
1d85005fc6b7 Fix minor issues revealed from dump_plots. Rik <rik@octave.org> parents: 22323 diff changeset	46 ##
24431 0c6cedafc71e doc: Use 'axes' rather than 'axis' appropriately in docstrings. Rik <rik@octave.org> parents: 23219 diff changeset	47 ## If the first argument @var{hax} is an axes handle, then plot into this axes,
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16993 diff changeset	48 ## rather than the current axes returned by @code{gca}.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	49 ##
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	50 ## The optional return value @var{h} is a graphics handle to the created plot.
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	51 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	52 ## @example
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	53 ## @group
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	54 ## fx = @@(t) cos (t);
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	55 ## fy = @@(t) sin (t);
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	56 ## fz = @@(t) t;
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	57 ## ezplot3 (fx, fy, fz, [0, 10*pi], 100);
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	58 ## @end group
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	59 ## @end example
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	60 ##
22332 1d85005fc6b7 Fix minor issues revealed from dump_plots. Rik <rik@octave.org> parents: 22323 diff changeset	61 ## @seealso{plot3, comet3, ezplot, ezmesh, ezsurf}
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	62 ## @end deftypefn
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	63
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	64 function h = ezplot3 (varargin)
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	65
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	66 [htmp, needusage] = __ezplot__ ("plot3", varargin{:});
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	67
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	68 if (needusage)
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	69 print_usage ();
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	70 endif
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	71
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	72 if (nargout > 0)
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	73 h = htmp;
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	74 endif
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	75
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	76 endfunction
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	77
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	78
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	79 %!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	80 %! clf;
7337 e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	81 %! fx = @(t) cos (t);
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	82 %! fy = @(t) sin (t);
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe] jwe parents: diff changeset	83 %! fz = @(t) t;
26552 fce57b70768b ezplot3.m: Change %!demo code to run under Matlab (bug #55841). Rik <rik@octave.org> parents: 26376 diff changeset	84 %! ezplot3 (fx, fy, fz, [0, 10*pi]);
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	85
16993 78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	86 %!demo
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	87 %! clf;
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	88 %! fx = @(t) cos (t);
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	89 %! fy = @(t) sin (t);
78f57b14535c Overhaul ez* family of plot functions. Rik <rik@octave.org> parents: 14237 diff changeset	90 %! fz = @(t) t;
26552 fce57b70768b ezplot3.m: Change %!demo code to run under Matlab (bug #55841). Rik <rik@octave.org> parents: 26376 diff changeset	91 %! ezplot3 (fx, fy, fz, [0, 5*pi], "animate");