xref: /AOO41X/main/slideshow/source/inc/animation.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef INCLUDED_SLIDESHOW_ANIMATION_HXX
29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_ANIMATION_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <animatableshape.hxx>
32*cdf0e10cSrcweir #include <shapeattributelayer.hxx>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir /* Definition of Animation interface */
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir namespace slideshow
38*cdf0e10cSrcweir {
39*cdf0e10cSrcweir     namespace internal
40*cdf0e10cSrcweir     {
41*cdf0e10cSrcweir         /** Interface defining a generic animation.
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir         	This interface is used by objects implementing the
44*cdf0e10cSrcweir         	Activity interface to drive the animation effect. Objects
45*cdf0e10cSrcweir         	implementing this interface will receive time-varying
46*cdf0e10cSrcweir         	animation values, which they can forward to the
47*cdf0e10cSrcweir         	appropriate attributes. The type of these animation values
48*cdf0e10cSrcweir             is given in derived interfaces.
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir             @see NumberAnimation
51*cdf0e10cSrcweir             @see ColorAnimation
52*cdf0e10cSrcweir             @see PairAnimation
53*cdf0e10cSrcweir          */
54*cdf0e10cSrcweir         class Animation
55*cdf0e10cSrcweir         {
56*cdf0e10cSrcweir         public:
57*cdf0e10cSrcweir             virtual ~Animation() {}
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir             /** Notify that the animation going active soon.
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir                 Implementers should preload any buffers, and create
62*cdf0e10cSrcweir                 any expensive objects at this time.
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir             	@param rShape
65*cdf0e10cSrcweir                 Shape to apply this animation to.
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir             	@param rAttrLayer
68*cdf0e10cSrcweir                 Attribute layer to play the animation on.
69*cdf0e10cSrcweir              */
70*cdf0e10cSrcweir             virtual void prefetch( const AnimatableShapeSharedPtr&     rShape,
71*cdf0e10cSrcweir                                    const ShapeAttributeLayerSharedPtr& rAttrLayer ) = 0;
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir             /** Notify that the animation is about to begin.
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir                 Implementers are free to start accompanying effects,
76*cdf0e10cSrcweir                 such as sounds, and the animation timer now.
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir             	@param rShape
79*cdf0e10cSrcweir                 Shape to apply this animation to.
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir             	@param rAttrLayer
82*cdf0e10cSrcweir                 Attribute layer to play the animation on.
83*cdf0e10cSrcweir              */
84*cdf0e10cSrcweir             virtual void start( const AnimatableShapeSharedPtr&		rShape,
85*cdf0e10cSrcweir                                 const ShapeAttributeLayerSharedPtr& rAttrLayer ) = 0;
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir             /** Notify that the animation is about to end.
88*cdf0e10cSrcweir              */
89*cdf0e10cSrcweir             virtual void end() = 0;
90*cdf0e10cSrcweir         };
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir         typedef ::boost::shared_ptr< Animation > AnimationSharedPtr;
93*cdf0e10cSrcweir 
94*cdf0e10cSrcweir     }
95*cdf0e10cSrcweir }
96*cdf0e10cSrcweir 
97*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_ANIMATION_HXX */
98