1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX
25 #define INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX
26 
27 #include <sal/config.h>
28 #include <boost/shared_ptr.hpp>
29 
30 
31 /* Definition of AnimationFunction interface */
32 
33 namespace slideshow
34 {
35     namespace internal
36     {
37         /** Interface describing an abstract animation function.
38 
39         	Use this interface to model time-dependent animation
40         	functions of one variable.
41          */
42         class AnimationFunction
43         {
44         public:
~AnimationFunction()45             virtual ~AnimationFunction() {}
46 
47             /** Operator to calculate function value.
48 
49             	This method calculates the function value for the
50             	given time instant t.
51 
52                 @param t
53                 Current time instant, must be in the range [0,1]
54 
55                 @return the function value, typically in relative
56                 user coordinate space ([0,1] range).
57              */
58             virtual double operator()( double t ) const = 0;
59 
60         };
61 
62         typedef ::boost::shared_ptr< AnimationFunction > AnimationFunctionSharedPtr;
63 
64     }
65 }
66 
67 #endif /* INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX */
68