octave_packages/m/plot/spinmap.m

   1 ## Copyright (C) 2007-2012 Kai Habel
   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} {} spinmap (@var{t}, @var{inc})
  21 ## Cycle the colormap for @var{t} seconds with an increment
  22 ## of @var{inc}.  Both parameters are optional.  The default cycle time
  23 ## is 5 seconds and the default increment is 2.
  24 ##
  25 ## A higher value of @var{inc} causes a faster cycle through the
  26 ## colormap.
  27 ## @seealso{gca, colorbar}
  28 ## @end deftypefn
  29
  30 ## Author: Kai Habel <kai.habel at gmx.de>
  31
  32 function spinmap (t, inc)
  33
  34   if (nargin == 0)
  35     inc = 2;
  36     t = 5;
  37   elseif (nargin == 1)
  38     inc = 2;
  39   endif
  40
  41   cmap = get (gcf (), "colormap");
  42   clen = rows (cmap);
  43
  44   t0 = clock;
  45
  46   while (etime (clock, t0) < t)
  47     for n = 1:inc:clen
  48       newmap = shift (cmap, n, 1);
  49       set (gcf (), "colormap", newmap);
  50       drawnow ();
  51     endfor
  52   endwhile
  53
  54   set (gcf (), "colormap", cmap);
  55
  56 endfunction
  57