4.3.0r28
[enigma2.git] / usr / share / enigma2 / animations.xml
1 <!--
2 An animation consists of a <animation> tag and a number of child-tags defining the type of animation.
3
4 required <animation>-tag attributes are
5 - key="unique_key" - Has to be unique
6 - duration="xyz" - Duration of the complete animation in milliseconds (ms)
7
8 optional <animation>-tag attributes are
9 - title="User defined Name" - Display Name for the UI
10
11 - interpolate="linear|accelerate|decelerate|overshoot|bounce" - Defines the Animation Progress interpolator.
12   - accelerate: An interpolator where the rate of change starts out slowly and then accelerates
13     - optional attribute: factor="1.0" - Degree (as float) to which the animation should be eased. Setting factor to 1.0f produces a y=x^2 parabola.
14                                            Increasing factor above 1.0f increases the ease-in effect (i.e., it starts even slower and ends even faster)
15
16   - decelerate: An interpolator where the rate of change starts out quickly and and then decelerates.
17     - optional attribute: factor="1.0" - Degree (as float) to which the animation should be eased. Setting factor to 1.0 produces an upside-down y=x^2 parabola.
18                                            Increasing factor above 1.0 makes increases the ease-out effect (i.e., it starts even faster and ends even slower)
19
20   - overshoot: An interpolator where the change flings forward and overshoots the last value then comes back.
21     - optional attribute: tension="2.0" - Amount of overshoot (as float). When tension equals 0.0f, there is no overshoot and the interpolator becomes a simple deceleration interpolator.
22
23   -bounce:  An interpolator where the change bounces at the end.
24
25 Animating properties:
26 One may currently animate:
27 - alpha -> <alpha> and <alpha_hide>
28 - position -> <position> and <position_hide>
29 - size -> <size> and <size_hide>
30
31 Tags without "_hide"-postfix are "show" animations. Tags with "_hide"-postfix are hide animations.
32 When no explicit <*_hide> definition is present the "show" definition will be automatically reversed for hiding, this is especially useful for things like fade-in/fade-out.
33 On "Auto-Reversed" hide-animations the PROGRESS value will be inverted - mathematically speaking it'll become "1.0 - progress" instead of "progress" where 0.0 = 0%, 1.0 = 100%.
34 Please note that this also reverses the interpolation effects (which may look odd, depending on the interpolator).
35
36 * Common Attributes:
37   - value
38     - for "show" animations it defines the start value
39     - for "hide" animations it defines the target value
40     - 0.0 = 0%
41     - 1.0 = 100%
42   - interpolate - exactly the same as interpolate in <animation>. When present overrides the interpolator defined in the <animation> tag.
43
44 * <alpha>-specific attributes
45   -
46 * <position>-specific optional attributes
47   - animateY="" - only Animate the Y Axis (="" makes the parser happy, value is of no matter)
48   - animateX="" - only Animate the X-Axis (="" makes the parser happy, value is of no matter)
49   -> if neither animateY nor animateX are present, X- and Y-Axis will be animated
50
51 * <size>-specific optional attributes
52   - animateW="" - only Animate the width (="" makes the parser happy, value is of no matter)
53   - animateH="" - only Animate the height (="" makes the parser happy, value is of no matter)
54   - centered="" - center point based size animations
55                   this means the size animations will influence the current top-left position (="" makes the parser happy, value is of no matter)
56   -> if neither animateW nor animateH have been set, width and height will be animated
57
58 You may combine all 3 types of animations, but only one of each kind for one type of animation (show/hide).
59 -->
60
61 <animations>
62         <animation key="simple_fade" title="Simple fade" duration="300" interpolate="linear">
63                 <alpha val="0.0" interpolate="decelerate" factor="1.75"/>
64                 <alpha_hide val="0.0" interpolate="accelerate" factor="1.75"/>
65         </animation>
66         <animation key="quick_fade" title="Quick fade" duration="200" interpolate="linear">
67                 <alpha val="0.0" interpolate="decelerate" factor="1.75"/>
68                 <alpha_hide val="0.0" interpolate="accelerate" factor="1.75"/>
69         </animation>
70         <animation key="slide_left_to_right" title="Slide in left + Slide out right" duration="250">
71                 <position val="-1.0" animateX="" />
72                 <position_hide val="2.0" animateX="" />
73         </animation>
74         <animation key="slide_right_to_left" title="Slide in right + Slide out left" duration="250">
75                 <position val="2.0" animateX="" />
76                 <position_hide val="-1.0" animateX="" />
77         </animation>
78         <animation key="slide_top_to_bottom" title="Slide in top + Slide out bottom" duration="250">
79                 <position val="-1.0" animateY="" />
80                 <position_hide val="2.0" animateY="" />
81         </animation>
82         <animation key="zoom_and_fade" title="Zoom in + Shrink out with crossfading" duration="250">
83                 <alpha val="0.5" />
84                 <size val="0,0" centered=""/>
85                 <size_hide val="0,0" centered=""/>
86         </animation>
87         <animation key="grow_left_shrink_top" title="Grow from left + Shrink to top" duration="250">
88                 <size val="0,0" animateW=""/>
89                 <size_hide val="0,0" animateH=""/>
90         </animation>
91                 <animation key="slide_zoom_left_to_right" title="Left to right slide + zoom" duration="250">
92                 <position val="-1.0" animateX="" />
93                 <position_hide val="2.0" animateX="" />
94                 <size val="0,0" centered=""/>
95                 <size_hide val="0,0" centered=""/>
96         </animation>
97         <animation key="slide_zoom_right_to_left" title="Right to left slide + zoom" duration="250">
98                 <position val="2.0" animateX="" />
99                 <position_hide val="-1.0" animateX="" />
100                 <size val="0,0" centered=""/>
101                 <size_hide val="0,0" centered=""/>
102         </animation>
103         <animation key="wizard_previous" title="Slide in left + Slide out right (Wizard)" duration="300">
104                 <alpha val="0.0" interpolate="accelerate" factor="1.5"/>
105                 <position val="-1.0" animateX="" interpolate="decelerate" factor="1.5"/>
106                 <position_hide val="2.0" animateX="" interpolate="accelerate" factor="1.5"/>
107         </animation>
108         <animation key="wizard_next" title="Slide in right + Slide out left (Wizard)" duration="300">
109                 <alpha val="0.0" interpolate="accelerate" factor="1.5"/>
110                 <position val="2.0" animateX="" interpolate="decelerate" factor="1.5"/>
111                 <position_hide val="-1.0" animateX="" interpolate="accelerate" factor="1.5"/>
112         </animation>
113 </animations>