xref: /trunk/main/slideshow/source/inc/animationactivity.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef INCLUDED_SLIDESHOW_ANIMATIONACTIVITY_HXX
29 #define INCLUDED_SLIDESHOW_ANIMATIONACTIVITY_HXX
30 
31 #include "activity.hxx"
32 #include "animatableshape.hxx"
33 #include "shapeattributelayer.hxx"
34 
35 
36 /* Definition of AnimationActivity interface */
37 
38 namespace slideshow
39 {
40     namespace internal
41     {
42 
43         /** Extends the Activity interface with animation-specific functions
44          */
45         class AnimationActivity : public Activity
46         {
47         public:
48             /** Sets targets (shape and attributeLayer)
49 
50                 Since attribute layers can only be generated when the
51                 animation starts, the Activity owner must be able to
52                 pass it into the Activity after initial creation. The
53                 same applies to the actual shape the animation must
54                 run for, since e.g. subsetted shapes are generated
55                 close before the animation starts, too (this is not
56                 necessary in and out of itself, but for performance
57                 reasons. Otherwise, character iterations produce tons
58                 of subset shapes).
59 
60                 @param rShape
61                 Shape to play the animation on.
62 
63                 @param rAttrLayer
64                 Attribute layer to change the animated values on.
65              */
66             virtual void setTargets( const AnimatableShapeSharedPtr&        rShape,
67                                      const ShapeAttributeLayerSharedPtr&    rAttrLayer ) = 0;
68         };
69 
70         typedef ::boost::shared_ptr< AnimationActivity > AnimationActivitySharedPtr;
71 
72     }
73 }
74 
75 #endif /* INCLUDED_SLIDESHOW_ANIMATIONACTIVITY_HXX */
76