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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <view/SlideSorterView.hxx>
  23 #include <canvas/elapsedtime.hxx>
  24 #include <vcl/idle.hxx>
  25 #include <sal/types.h>
  26 #include <o3tl/deleter.hxx>
  27
  28 #include <functional>
  29 #include <memory>
  30 #include <vector>
  31
  32 namespace sd::slidesorter { class SlideSorter; }
  33
  34 namespace sd::slidesorter::controller {
  35
  36 /** Experimental class for simple eye candy animations.
  37 */
  38 class Animator
  39 {
  40 public:
  41     /** In some circumstances we have to avoid animation and jump to the
  42         final animation state immediately.  Use this enum instead of a bool
  43         to be more expressive.
  44     */
  45     enum AnimationMode { AM_Animated, AM_Immediate };
  46
  47     explicit Animator (SlideSorter& rSlideSorter);
  48     ~Animator();
  49     Animator(const Animator&) = delete;
  50     Animator& operator=(const Animator&) = delete;
  51
  52     /** When disposed the animator will stop its work immediately and not
  53         process any timer events anymore.
  54     */
  55     void Dispose();
  56
  57     /** An animation object is called with values between 0 and 1 as single
  58         argument to its operator() method.
  59     */
  60     typedef ::std::function<void (double)> AnimationFunctor;
  61     typedef ::std::function<void ()> FinishFunctor;
  62
  63     typedef sal_Int32 AnimationId;
  64     static const AnimationId NotAnAnimationId = -1;
  65
  66     /** Schedule a new animation for execution.  The () operator of that
  67         animation will be called with increasing values between 0 and 1 for
  68         the specified duration.
  69         @param rAnimation
  70             The animation operation.
  71     */
  72     AnimationId AddAnimation (
  73         const AnimationFunctor& rAnimation,
  74         const FinishFunctor& rFinishFunctor);
  75
  76     /** Abort and remove an animation.  In order to reduce the bookkeeping
  77         on the caller side, it is OK to call this method with an animation
  78         function that is not currently being animated.  Such a call is
  79         silently ignored.
  80     */
  81     void RemoveAnimation (const AnimationId nAnimationId);
  82
  83     /** A typical use case for this method is the temporary shutdown of the
  84         slidesorter when the slide sorter bar is put into a cache due to a
  85         change of the edit mode.
  86     */
  87     void RemoveAllAnimations();
  88
  89 private:
  90     SlideSorter& mrSlideSorter;
  91     Idle maIdle;
  92     bool mbIsDisposed;
  93     class Animation;
  94     typedef ::std::vector<std::shared_ptr<Animation> > AnimationList;
  95     AnimationList maAnimations;
  96     ::canvas::tools::ElapsedTime maElapsedTime;
  97
  98     std::unique_ptr<view::SlideSorterView::DrawLock, o3tl::default_delete<view::SlideSorterView::DrawLock>> mpDrawLock;
  99
 100     AnimationId mnNextAnimationId;
 101
 102     DECL_LINK(TimeoutHandler, Timer *, void);
 103
 104     /** Execute one step of every active animation.
 105         @param nTime
 106             Time measured in milliseconds with some arbitrary reference point.
 107         @return
 108             When one or more animation has finished then <TRUE/> is
 109             returned.  Call CleanUpAnimationList() in this case.
 110     */
 111     bool ProcessAnimations (const double nTime);
 112
 113     /** Remove animations that have expired.
 114     */
 115     void CleanUpAnimationList();
 116
 117     void RequestNextFrame();
 118 };
 119
 120 } // end of namespace ::sd::slidesorter::controller
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */