offapi/com/sun/star/rendering/AnimationRepeat.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AnimationRepeat.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_rendering_AnimationRepeat_idl__
  31 #define __com_sun_star_rendering_AnimationRepeat_idl__
  32
  33 module com { module sun { module star { module rendering {
  34
  35 /** This are the possible repeat modes for animations.<p>
  36
  37     These constants determine how the [0,1] parameter range of the
  38     animation is driven through, thus defining the possible repeat
  39     modes.<p>
  40
  41     @since OOo 2.0.0
  42  */
  43 constants AnimationRepeat
  44 {
  45     /** The [0,1] parameter range is sweeped through exactly once.<p>
  46
  47         The [0,1] parameter range is sweeped through exactly once,
  48         starting with 0 and ending with 1.<p>
  49     */
  50     const byte ONE_SHOT=0;
  51
  52     //-------------------------------------------------------------------------
  53
  54     /** The [0,1] parameter range is sweeped through exactly twice.<p>
  55
  56         The [0,1] parameter range is sweeped through exactly twice,
  57         starting with 0, going to 1, and going back to 0. When
  58         plotting the value over time, this yields a triangle curve.<p>
  59     */
  60     const byte ONE_SHOT_PINGPONG=1;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** The [0,1] parameter range is sweeped through infinitely.<p>
  65
  66         The [0,1] parameter range is sweeped through infinitely,
  67         starting with 0, going to 1, and going back to 0, and then
  68         starting again. When plotting the value over time, this yields
  69         a repeated triangle curve.<p>
  70     */
  71     const byte PINGPONG=2;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** The [0,1] parameter range is sweeped through infinitely.<p>
  76
  77         The [0,1] parameter range is sweeped through infinitely,
  78         starting with 0, going to 1, and starting with 0 again. When
  79         plotting the value over time, this yields a repeated saw-tooth
  80         curve.<p>
  81     */
  82     const byte REPEAT=3;
  83 };
  84
  85 }; }; }; };
  86
  87 #endif