Mercurial > octave

annotate scripts/plot/draw/comet3.m @ 23219:3ac9f9ecfae5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Update copyright dates.
author John W. Eaton <jwe@octave.org>
date Wed, 22 Feb 2017 12:39:29 -0500
parents e9a0469dedd9
children 092078913d54 0c6cedafc71e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23219
3ac9f9ecfae5 maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents: 23083
diff changeset
1 ## Copyright (C) 2010-2017 Ben Abbott and John W. Eaton
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
2 ##
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
20 ## @deftypefn {} {} comet3 (@var{z})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
21 ## @deftypefnx {} {} comet3 (@var{x}, @var{y}, @var{z})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
22 ## @deftypefnx {} {} comet3 (@var{x}, @var{y}, @var{z}, @var{p})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20173
diff changeset
23 ## @deftypefnx {} {} comet3 (@var{hax}, @dots{})
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
24 ## Produce a simple comet style animation along the trajectory provided by
20173
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
25 ## the input coordinate vectors (@var{x}, @var{y}, @var{z}).
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
26 ##
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
27 ## If only @var{z} is specified then @var{x}, @var{y} default to the indices
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
28 ## of @var{z}.
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 ##
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 ## The speed of the comet may be controlled by @var{p}, which represents the
16826
a4969508008e doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents: 16814
diff changeset
31 ## time each point is displayed before moving to the next one. The default for
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
32 ## @var{p} is 0.1 seconds.
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17060
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: 17060
diff changeset
35 ## rather than the current axes returned by @code{gca}.
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14868
diff changeset
36 ## @seealso{comet}
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 ## @end deftypefn
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 ## Author: jwe
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 ## Created: 2010-12-17
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 function comet3 (varargin)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
44 [hax, varargin, nargin] = __plt_get_axis_arg__ ("comet3", varargin{:});
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 if (nargin == 0 || nargin == 2 || nargin > 4)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 print_usage ();
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 elseif (nargin == 1)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 z = varargin{1};
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
50 x = y = 1:numel (z);
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 p = 0.1;
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 elseif (nargin == 3)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 x = varargin{1};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 y = varargin{2};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 z = varargin{3};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 p = 0.1;
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 elseif (nargin == 4)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 x = varargin{1};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 y = varargin{2};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 z = varargin{3};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 p = varargin{4};
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
63
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
64 oldfig = [];
17301
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17211
diff changeset
65 if (! isempty (hax))
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
66 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
67 endif
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 unwind_protect
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
69 hax = newplot (hax);
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
70 limits = [min(x), max(x), min(y), max(y), min(z), max(z)];
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
71 num = numel (y);
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72 dn = round (num/10);
17187
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
73
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
74 hl = plot3 (x(1), y(1), z(1), "color", "r", "marker", "none",
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
75 x(1), y(1), z(1), "color", "g", "marker", "none",
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
76 x(1), y(1), z(1), "color", "b", "marker", "o");
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
77 axis (limits); # set manual limits to speed up plotting
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
78
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
79 for n = 2:(num+dn);
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
80 m = n - dn;
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
81 m = max ([m, 1]);
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
82 k = min ([n, num]);
17187
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
83 set (hl(1), "xdata", x(1:m), "ydata", y(1:m), "zdata", z(1:m));
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
84 set (hl(2), "xdata", x(m:k), "ydata", y(m:k), "zdata", z(m:k));
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
85 set (hl(3), "xdata", x(k) , "ydata", y(k) , "zdata", z(k));
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
86 drawnow ();
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
87 pause (p);
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
88 endfor
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
89 unwind_protect_cleanup
17060
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
90 if (! isempty (oldfig))
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
91 set (0, "currentfigure", oldfig);
2d17dbdf6b7d comet.m, comet3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16826
diff changeset
92 endif
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
93 end_unwind_protect
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
94
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
95 endfunction
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
96
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
97
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
98 %!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
99 %! clf;
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 20852
diff changeset
100 %! title ("comet3() animation");
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17187
diff changeset
101 %! view (3); hold on;
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
102 %! t = 0:pi/20:5*pi;
17187
1c2f14a7935d comet3.m: Speed up animation by using low-level graphic commands.
Rik <rik@octave.org>
parents: 17126
diff changeset
103 %! comet3 (cos (t), sin (t), t, 0.05);
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17187
diff changeset
104 %! hold off;