sd/source/ui/slidesorter/controller/SlsAnimator.cxx

   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.cxx,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 #include "precompiled_sd.hxx"
  33 #include "controller/SlsAnimator.hxx"
  34 #include "view/SlideSorterView.hxx"
  35 #include "View.hxx"
  36
  37 namespace sd { namespace slidesorter { namespace controller {
  38
  39 namespace {
  40     static const sal_Int32 gnResolution = 25;
  41 }
  42 /** Handle one animation function by using a timer for frequent calls to
  43     the animations operator().
  44 */
  45 class Animator::Animation
  46 {
  47 public:
  48     Animation (
  49         const Animator::AnimationFunction& rAnimation,
  50         const double nDelta);
  51     ~Animation (void);
  52     bool Run (void);
  53     bool IsExpired (void);
  54     Animator::AnimationFunction maAnimation;
  55     double mnValue;
  56     double mnDelta;
  57 };
  58
  59
  60
  61
  62 class Animator::DrawLock
  63 {
  64 public:
  65     DrawLock (View& rView);
  66     ~DrawLock (void);
  67
  68 private:
  69     View& mrView;
  70 };
  71
  72
  73
  74
  75 Animator::Animator (SlideSorter& rSlideSorter)
  76     : mrSlideSorter(rSlideSorter),
  77       maTimer(),
  78       maAnimations(),
  79       mpDrawLock()
  80 {
  81     maTimer.SetTimeout(gnResolution);
  82     maTimer.SetTimeoutHdl(LINK(this,Animator,TimeoutHandler));
  83 }
  84
  85
  86
  87
  88 Animator::~Animator (void)
  89 {
  90     maTimer.Stop();
  91     mpDrawLock.reset();
  92 }
  93
  94
  95
  96
  97 void Animator::AddAnimation (
  98     const AnimationFunction& rAnimation,
  99     const sal_Int32 nDuration)
 100 {
 101     const double nDelta = double(gnResolution) / double(nDuration);
 102     maAnimations.push_back(boost::shared_ptr<Animation>(new Animation(rAnimation, nDelta)));
 103
 104     // Prevent redraws except for the ones in TimeoutHandler.
 105     // While the Animator is active it will schedule repaints regularly.
 106     // Repaints in between would only lead to visual artifacts.
 107     mpDrawLock.reset(new DrawLock(mrSlideSorter.GetView()));
 108     maTimer.Start();
 109 }
 110
 111
 112
 113
 114 bool Animator::ServeAnimations (void)
 115 {
 116     bool bExpired (false);
 117
 118     AnimationList aCopy (maAnimations);
 119     AnimationList::const_iterator iAnimation;
 120     for (iAnimation=aCopy.begin(); iAnimation!=aCopy.end(); ++iAnimation)
 121     {
 122         bExpired |= (*iAnimation)->Run();
 123     }
 124
 125     return bExpired;
 126 }
 127
 128
 129
 130
 131 void Animator::CleanUpAnimationList (void)
 132 {
 133     AnimationList aActiveAnimations;
 134
 135     AnimationList::const_iterator iAnimation;
 136     for (iAnimation=maAnimations.begin(); iAnimation!=maAnimations.end(); ++iAnimation)
 137     {
 138         if ( ! (*iAnimation)->IsExpired())
 139             aActiveAnimations.push_back(*iAnimation);
 140     }
 141
 142     maAnimations.swap(aActiveAnimations);
 143 }
 144
 145
 146
 147
 148 IMPL_LINK(Animator, TimeoutHandler, Timer*, EMPTYARG)
 149 {
 150     if (ServeAnimations())
 151         CleanUpAnimationList();
 152
 153     // Unlock the draw lock.  This should lead to a repaint.
 154     mpDrawLock.reset();
 155
 156     if (maAnimations.size() > 0)
 157     {
 158         mpDrawLock.reset(new DrawLock(mrSlideSorter.GetView()));
 159         maTimer.Start();
 160     }
 161
 162     return 0;
 163 }
 164
 165
 166
 167
 168 //===== Animator::Animation ===================================================
 169
 170 Animator::Animation::Animation (
 171     const Animator::AnimationFunction& rAnimation,
 172     const double nDelta)
 173     : maAnimation(rAnimation),
 174       mnValue(0),
 175       mnDelta(nDelta)
 176 {
 177
 178     maAnimation(mnValue);
 179     mnValue = mnDelta;
 180
 181 }
 182
 183
 184
 185
 186 Animator::Animation::~Animation (void)
 187 {
 188 }
 189
 190
 191
 192
 193 bool Animator::Animation::Run (void)
 194 {
 195     if (mnValue < 1.0)
 196     {
 197         maAnimation(mnValue);
 198         mnValue += mnDelta;
 199         return false;
 200     }
 201     else
 202     {
 203         maAnimation(1.0);
 204         return true;
 205     }
 206 }
 207
 208
 209
 210
 211 bool Animator::Animation::IsExpired (void)
 212 {
 213     return mnValue >= 1.0;
 214 }
 215
 216
 217
 218
 219 //===== Animator::DrawLock ====================================================
 220
 221 Animator::DrawLock::DrawLock (View& rView)
 222     : mrView(rView)
 223 {
 224     mrView.LockRedraw(TRUE);
 225 }
 226
 227
 228
 229
 230 Animator::DrawLock::~DrawLock (void)
 231 {
 232     mrView.LockRedraw(FALSE);
 233 }
 234
 235
 236 } } } // end of namespace ::sd::slidesorter::controller