sd/source/ui/slidesorter/inc/controller/SlsAnimator.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SlsAnimator.hxx,v $
  10  *
  11  * $Revision: 1.3 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef SD_SLIDESORTER_CONTROLLER_ANIMATOR_HXX
  33 #define SD_SLIDESORTER_CONTROLLER_ANIMATOR_HXX
  34
  35 #include "SlideSorter.hxx"
  36 #include <vcl/timer.hxx>
  37 #include <sal/types.h>
  38 #include <vector>
  39 #include <boost/function.hpp>
  40 #include <boost/noncopyable.hpp>
  41 #include <boost/scoped_ptr.hpp>
  42 #include <boost/shared_ptr.hpp>
  43
  44
  45 namespace sd { namespace slidesorter { namespace controller {
  46
  47 /** Experimental class for simple eye candy animations.
  48 */
  49 class Animator
  50     : private ::boost::noncopyable
  51 {
  52 public:
  53     Animator (SlideSorter& rSlideSorter);
  54     ~Animator (void);
  55
  56     /** An animation object is called with values between 0 and 1 as single
  57         argument to its operator() method.
  58     */
  59     typedef ::boost::function1<void, double> AnimationFunction;
  60
  61     /** Schedule a new animation for execution.  The () operator of that
  62         animation will be called with increasing values between 0 and 1 for
  63         the specified duration.
  64         @param rAnimation
  65             The animation operation.
  66         @param nDuration
  67             The duration in milli seconds.
  68     */
  69     void AddAnimation (
  70         const AnimationFunction& rAnimation,
  71         const sal_Int32 nDuration);
  72
  73 private:
  74     SlideSorter& mrSlideSorter;
  75     Timer maTimer;
  76
  77     class Animation;
  78     typedef ::std::vector<boost::shared_ptr<Animation> > AnimationList;
  79     AnimationList maAnimations;
  80
  81     class DrawLock;
  82     ::boost::scoped_ptr<DrawLock> mpDrawLock;
  83
  84     DECL_LINK(TimeoutHandler, Timer*);
  85
  86     /** Execute one step of every active animation.
  87         @return
  88             When one or more animation has finished then <TRUE/> is
  89             returned.  Call CleanUpAnimationList() in this case.
  90     */
  91     bool ServeAnimations (void);
  92
  93     /** Remove animations that have expired.
  94     */
  95     void CleanUpAnimationList (void);
  96 };
  97
  98 } } } // end of namespace ::sd::slidesorter::controller
  99
 100 #endif