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_ANIMATABLESHAPE_HXX 25cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_ANIMATABLESHAPE_HXX 26cdf0e10cSrcweir 27cdf0e10cSrcweir #include <boost/shared_ptr.hpp> 28cdf0e10cSrcweir 29cdf0e10cSrcweir #include "shape.hxx" 30cdf0e10cSrcweir 31cdf0e10cSrcweir 32cdf0e10cSrcweir namespace slideshow 33cdf0e10cSrcweir { 34cdf0e10cSrcweir namespace internal 35cdf0e10cSrcweir { 36cdf0e10cSrcweir /** Represents an animatable shape. 37cdf0e10cSrcweir 38cdf0e10cSrcweir This interface adds animation handling methods to a 39cdf0e10cSrcweir shape. It allows transparent switching between 40cdf0e10cSrcweir sprite-based viewing and static painting, depending on 41cdf0e10cSrcweir whether animations are currently running. 42cdf0e10cSrcweir */ 43cdf0e10cSrcweir class AnimatableShape : public Shape 44cdf0e10cSrcweir { 45cdf0e10cSrcweir public: 46cdf0e10cSrcweir // Animation methods 47cdf0e10cSrcweir //------------------------------------------------------------------ 48cdf0e10cSrcweir 49cdf0e10cSrcweir /** Notify the Shape that an animation starts now 50cdf0e10cSrcweir 51cdf0e10cSrcweir This method enters animation mode on all registered 52cdf0e10cSrcweir views. 53cdf0e10cSrcweir 54cdf0e10cSrcweir @attention This method is supposed to be called only 55cdf0e10cSrcweir from the LayerManager, since it might involve shifting 56cdf0e10cSrcweir shapes between different layers (and removing this 57cdf0e10cSrcweir shape from the background layer in the first place) 58cdf0e10cSrcweir */ 59cdf0e10cSrcweir virtual void enterAnimationMode() = 0; 60cdf0e10cSrcweir 61cdf0e10cSrcweir /** Notify the Shape that it is no longer animated 62cdf0e10cSrcweir 63cdf0e10cSrcweir This methods requests the Shape to end animation mode 64cdf0e10cSrcweir on all registered views, if called more or equal the 65cdf0e10cSrcweir times enterAnimationMode() was called. That is, the 66cdf0e10cSrcweir Shape only leaves animation mode, if all requested 67cdf0e10cSrcweir enterAnimationMode() call sites have issued their 68cdf0e10cSrcweir matching leaveAnimationMode(). 69cdf0e10cSrcweir 70cdf0e10cSrcweir @attention This method is supposed to be called only 71cdf0e10cSrcweir from the LayerManager, since it might involve shifting 72cdf0e10cSrcweir shapes between different layers (and adding this 73cdf0e10cSrcweir shape to the background layer again) 74cdf0e10cSrcweir */ 75cdf0e10cSrcweir virtual void leaveAnimationMode() = 0; 76cdf0e10cSrcweir 77cdf0e10cSrcweir }; 78cdf0e10cSrcweir 79cdf0e10cSrcweir typedef ::boost::shared_ptr< AnimatableShape > AnimatableShapeSharedPtr; 80cdf0e10cSrcweir 81cdf0e10cSrcweir } 82cdf0e10cSrcweir } 83cdf0e10cSrcweir 84cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_ANIMATABLESHAPE_HXX */ 85