offapi/com/sun/star/rendering/AnimationAttributes.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: AnimationAttributes.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_AnimationAttributes_idl__
  31 #define __com_sun_star_rendering_AnimationAttributes_idl__
  32
  33 #ifndef __com_sun_star_geometry_RealSize2D_idl__
  34 #include <com/sun/star/geometry/RealSize2D.idl>
  35 #endif
  36
  37 module com { module sun { module star { module rendering {
  38
  39 /** This structure contains attributes needed to run an animation.
  40
  41     @since OOo 2.0.0
  42  */
  43 struct AnimationAttributes
  44 {
  45     /// Preferred duration of the animation sequence in seconds.
  46     double                                                                              Duration;
  47
  48     //-------------------------------------------------------------------------
  49
  50     /** Repeat mode of the animation sequence.<p>
  51
  52         This value determines how the [0,1] parameter space of the animation
  53         should be sweeped through. Permissible values are given in
  54         <type>AnimationRepeat</type>.<p>
  55
  56         @see AnimationRepeat.
  57      */
  58     byte                                                                                RepeatMode;
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** Size of the untrasnformed animation sequence.<p>
  63
  64         This value specifies the size of the animation when rendered
  65         with the identity view transform. This permits
  66         e.g. <type>XSprite</type> implementations to cache rendered
  67         animation content in finite-sized bitmaps.<p>
  68      */
  69     ::com::sun::star::geometry::RealSize2D      UntransformedSize;
  70 };
  71
  72 }; }; }; };
  73
  74 #endif