1 files changed, 122 insertions, 0 deletions
diff --git a/sd/source/ui/slidesorter/inc/controller/SlsAnimator.hxx b/sd/source/ui/slidesorter/inc/controller/SlsAnimator.hxx
new file mode 100644
index 0000000000..8c9ec9e81e
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/controller/SlsAnimator.hxx
@@ -0,0 +1,122 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#pragma once
+
+#include <view/SlideSorterView.hxx>
+#include <canvas/elapsedtime.hxx>
+#include <vcl/idle.hxx>
+#include <sal/types.h>
+#include <o3tl/deleter.hxx>
+
+#include <functional>
+#include <memory>
+#include <vector>
+
+namespace sd::slidesorter { class SlideSorter; }
+
+namespace sd::slidesorter::controller {
+
+/** Experimental class for simple eye candy animations.
+*/
+class Animator
+{
+public:
+    /** In some circumstances we have to avoid animation and jump to the
+        final animation state immediately.  Use this enum instead of a bool
+        to be more expressive.
+    */
+    enum AnimationMode { AM_Animated, AM_Immediate };
+
+    explicit Animator (SlideSorter& rSlideSorter);
+    ~Animator();
+    Animator(const Animator&) = delete;
+    Animator& operator=(const Animator&) = delete;
+
+    /** When disposed the animator will stop its work immediately and not
+        process any timer events anymore.
+    */
+    void Dispose();
+
+    /** An animation object is called with values between 0 and 1 as single
+        argument to its operator() method.
+    */
+    typedef ::std::function<void (double)> AnimationFunctor;
+    typedef ::std::function<void ()> FinishFunctor;
+
+    typedef sal_Int32 AnimationId;
+    static const AnimationId NotAnAnimationId = -1;
+
+    /** Schedule a new animation for execution.  The () operator of that
+        animation will be called with increasing values between 0 and 1 for
+        the specified duration.
+        @param rAnimation
+            The animation operation.
+    */
+    AnimationId AddAnimation (
+        const AnimationFunctor& rAnimation,
+        const FinishFunctor& rFinishFunctor);
+
+    /** Abort and remove an animation.  In order to reduce the bookkeeping
+        on the caller side, it is OK to call this method with an animation
+        function that is not currently being animated.  Such a call is
+        silently ignored.
+    */
+    void RemoveAnimation (const AnimationId nAnimationId);
+
+    /** A typical use case for this method is the temporary shutdown of the
+        slidesorter when the slide sorter bar is put into a cache due to a
+        change of the edit mode.
+    */
+    void RemoveAllAnimations();
+
+private:
+    SlideSorter& mrSlideSorter;
+    Idle maIdle;
+    bool mbIsDisposed;
+    class Animation;
+    typedef ::std::vector<std::shared_ptr<Animation> > AnimationList;
+    AnimationList maAnimations;
+    ::canvas::tools::ElapsedTime maElapsedTime;
+
+    std::unique_ptr<view::SlideSorterView::DrawLock, o3tl::default_delete<view::SlideSorterView::DrawLock>> mpDrawLock;
+
+    AnimationId mnNextAnimationId;
+
+    DECL_LINK(TimeoutHandler, Timer *, void);
+
+    /** Execute one step of every active animation.
+        @param nTime
+            Time measured in milliseconds with some arbitrary reference point.
+        @return
+            When one or more animation has finished then <TRUE/> is
+            returned.  Call CleanUpAnimationList() in this case.
+    */
+    bool ProcessAnimations (const double nTime);
+
+    /** Remove animations that have expired.
+    */
+    void CleanUpAnimationList();
+
+    void RequestNextFrame();
+};
+
+} // end of namespace ::sd::slidesorter::controller
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */