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_HSLCOLORANIMATION_HXX
25 #define INCLUDED_SLIDESHOW_HSLCOLORANIMATION_HXX
26 
27 #include "animation.hxx"
28 #include "hslcolor.hxx"
29 
30 
31 /* Definition of HSLColorAnimation interface */
32 
33 namespace slideshow
34 {
35     namespace internal
36     {
37         /** Interface defining a HSL color animation.
38 
39         	This interface is a specialization of the Animation
40         	interface, and is used to animate attributes representable
41         	by a HSL color value.
42          */
43         class HSLColorAnimation : public Animation
44         {
45         public:
46             typedef HSLColor ValueType;
47 
48             /** Set the animation to the given color value
49 
50                 @param rColor
51                 Current animation value.
52              */
53             virtual bool operator()( const ValueType& rColor ) = 0;
54 
55             /** Request the underlying value for this animation.
56 
57             	This is necessary for pure To or By animations, as the
58             	Activity cannot determine a sensible start value
59             	otherwise.
60 
61                 @attention Note that you are only permitted to query
62                 for the underlying value, if the animation has actually
63                 been started (via start() call).
64              */
65             virtual ValueType getUnderlyingValue() const = 0;
66         };
67 
68         typedef ::boost::shared_ptr< HSLColorAnimation > HSLColorAnimationSharedPtr;
69 
70     }
71 }
72 
73 #endif /* INCLUDED_SLIDESHOW_HSLCOLORANIMATION_HXX */
74