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