doc/commands/SetAnimation.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: SetAnimation.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
   3 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   4   "../docbook-xml/docbookx.dtd"
   5 [
   6 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   7 %myents;
   8 ]>
   9
  10
  11 <section id='SetAnimation'>
  12 <title>SetAnimation</title>
  13
  14 <cmdsynopsis>
  15         <command>SetAnimation</command
  16         ><arg choice='plain'
  17                 ><replaceable>milliseconds-delay</replaceable
  18         ></arg
  19         ><arg choice='opt'
  20                 ><replaceable>fractions-to-move-list</replaceable
  21         ></arg>
  22 </cmdsynopsis>
  23
  24 <para>Sets the time between frames and the list of fractional offsets to
  25 customize the animated moves of the
  26 <fvwmref cmd="AnimatedMove"/>
  27 command and the animation of menus (if the menu style is set to
  28 animated; see
  29 <fvwmref cmd="MenuStyle"/>
  30 command).  If the
  31 <replaceable>fractions-to-move-list</replaceable>
  32 is omitted, only the time between frames is altered.  The
  33 <replaceable>fractions-to-move-list</replaceable>
  34 specifies how far the window should be offset at each successive
  35 frame as a fraction of the difference between the starting
  36 location and the ending location.  e.g.:</para>
  37
  38 <programlisting>
  39 SetAnimation 10 -.01 0 .01 .03 .08 .18 .3 \
  40   .45 .6 .75 .85 .90 .94 .97 .99 1.0
  41 </programlisting>
  42
  43 <para>Sets the delay between frames to 10 milliseconds, and sets the
  44 positions of the 16 frames of the animation motion.  Negative
  45 values are allowed, and in particular can be used to make the
  46 motion appear more cartoonish, by briefly moving slightly in the
  47 opposite direction of the main motion.  The above settings are the
  48 default.</para>
  49
  50 </section>