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_ANIMATIONFUNCTION_HXX
29 #define INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX
30 
31 #include <sal/config.h>
32 #include <boost/shared_ptr.hpp>
33 
34 
35 /* Definition of AnimationFunction interface */
36 
37 namespace slideshow
38 {
39     namespace internal
40     {
41         /** Interface describing an abstract animation function.
42 
43         	Use this interface to model time-dependent animation
44         	functions of one variable.
45          */
46         class AnimationFunction
47         {
48         public:
49             virtual ~AnimationFunction() {}
50 
51             /** Operator to calculate function value.
52 
53             	This method calculates the function value for the
54             	given time instant t.
55 
56                 @param t
57                 Current time instant, must be in the range [0,1]
58 
59                 @return the function value, typically in relative
60                 user coordinate space ([0,1] range).
61              */
62             virtual double operator()( double t ) const = 0;
63 
64         };
65 
66         typedef ::boost::shared_ptr< AnimationFunction > AnimationFunctionSharedPtr;
67 
68     }
69 }
70 
71 #endif /* INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX */
72