diff scripts/plot/spinmap.m @ 7164:2b5e6c0a9df9

[project @ 2007-11-12 22:04:42 by jwe]
author jwe
date Mon, 12 Nov 2007 22:06:35 +0000
parents d4d8c7b33e16
children dbd0c77e575e
line wrap: on
line diff
--- a/scripts/plot/spinmap.m	Mon Nov 12 21:54:08 2007 +0000
+++ b/scripts/plot/spinmap.m	Mon Nov 12 22:06:35 2007 +0000
@@ -1,53 +1,57 @@
 ## Copyright (C) 2007 Kai Habel
 ##
-## This program is free software; you can redistribute it and/or modify it
+## 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 2, or (at your option)
-## any later version.
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
 ##
-## OctPlot is distributed in the hope that it will be useful, but
+## 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 OctPlot; see the file COPYING.  If not, write to the Free
-## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-## 02111-1307, USA.
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File}  spinmap (@var{T}, @var{inc})
-## @deftypefnx {Function File}  spinmap (@var{T})
-## @deftypefnx {Function File}  spinmap ()
-## Cycles the colormap for @var{T} seconds with an increment
-## of @var{inc}. Both parameter are optional. In that case 5s and an increment 
-## of 2 is taken.
-## A higher @var{inc} causes a faster cycle through the colormap.
+## @deftypefn {Function File}  spinmap (@var{t}, @var{inc})
+## Cycle the colormap for @var{t} seconds with an increment
+## of @var{inc}.  Both parameters are optional.   The default cycle time
+## is 5 seconds and the default increment is 2.
+##
+## A higher value of @var{inc} causes a faster cycle through the
+## colormap.
+## @seealso{gca, colorbar}
 ## @end deftypefn
-## @seealso{gca, colorbar}
 
 ## Author: Kai Habel <kai.habel at gmx.de>
 
-function spinmap(T, inc)
+function spinmap (t, inc)
 
   if (nargin == 0)
     inc = 2;
-    T = 5;
+    t = 5;
   elseif (nargin == 1)
     inc = 2;
   endif
 
-  cmap = get(gcf,"Colormap");
-  clen = rows(cmap);
+  cmap = get (gcf (), "colormap");
+  clen = rows (cmap);
 
   t0 = clock;
 
-  while (etime(clock, t0) < T)
-    for n = 1 : inc : clen
-      newmap = shift(cmap, n, 1);
-      set(gcf,"Colormap",newmap)
-      drawnow
+  while (etime (clock, t0) < t)
+    for n = 1:inc:clen
+      newmap = shift (cmap, n, 1);
+      set (gcf (), "colormap", newmap)
+      drawnow ();
     endfor
-  end
-  set(gcf,"Colormap",cmap)
-end
+  endwhile
+
+  set (gcf (), "colormap", cmap)
+
+endfunction
+