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_NUMBERANIMATION_HXX
29 #define INCLUDED_SLIDESHOW_NUMBERANIMATION_HXX
30 
31 #include <animation.hxx>
32 
33 
34 /* Definition of NumberAnimation interface */
35 
36 namespace slideshow
37 {
38     namespace internal
39     {
40         /** Interface defining a number animation.
41 
42         	This interface is a specialization of the Animation
43         	interface, and is used to animate attributes representable
44         	by a single floating point value.
45          */
46         class NumberAnimation : public Animation
47         {
48         public:
49             typedef double ValueType;
50 
51             /** Set the animation to value x
52 
53                 @param x
54                 Current animation value (must be in an
55                 attribute-specific permissible range). Overflowing
56                 values will be clipped to the permissible range
57                 internally.
58              */
59             virtual bool operator()( ValueType x ) = 0;
60 
61             /** Request the underlying value for this animation.
62 
63             	This is necessary for pure To or By animations, as the
64             	Activity cannot determine a sensible start value
65             	otherwise.
66 
67                 @attention Note that you are only permitted to query
68                 for the underlying value, if the animation has actually
69                 been started (via start() call).
70              */
71             virtual ValueType getUnderlyingValue() const = 0;
72         };
73 
74         typedef ::boost::shared_ptr< NumberAnimation > NumberAnimationSharedPtr;
75 
76     }
77 }
78 
79 #endif /* INCLUDED_SLIDESHOW_NUMBERANIMATION_HXX */
80