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