slideshow/source/engine/effectrewinder.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 #ifndef INCLUDED_SLIDESHOW_SOURCE_ENGINE_EFFECTREWINDER_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_ENGINE_EFFECTREWINDER_HXX
  22
  23 #include <animationnode.hxx>
  24 #include <eventhandler.hxx>
  25 #include <animationeventhandler.hxx>
  26 #include <event.hxx>
  27 #include <screenupdater.hxx>
  28
  29 #include <functional>
  30 #include <memory>
  31 #include <vector>
  32
  33 namespace slideshow { namespace internal {
  34
  35 class EventMultiplexer;
  36 class EventQueue;
  37 class UserEventQueue;
  38
  39 /** Rewind single effects of the main effect sequence.  A rewind is
  40     initiated by calling the Rewind() method.  Part of the processing is
  41     done asynchronously.  Multiple EventQueue::update() calls may be
  42     necessary to finish a rewind.
  43
  44     Remember to call SetRootAnimationNode() when switching to a different
  45     slide so that the EffectRewinder can determine the number of main
  46     sequence effects.
  47 */
  48 class EffectRewinder
  49 {
  50 public:
  51     EffectRewinder (
  52         EventMultiplexer& rEventMultiplexer,
  53         EventQueue& rEventQueue,
  54         UserEventQueue& rUserEventQueue);
  55     ~EffectRewinder();
  56
  57     /** Call Dispose() before the owner of an EffectRewinder object dies so
  58         that the EffectRewinder can release all references to the owner.
  59
  60     */
  61     void dispose();
  62
  63     /** Store the root node of the animation tree.  It is used in
  64         CountMainSequenceEffects() to count the number of main sequence
  65         effects (or effect groups.)
  66     */
  67     void setRootAnimationNode (
  68         const css::uno::Reference<css::animations::XAnimationNode>& xRootNode);
  69
  70     /** Rewind one effect of the main effect sequence.  When the current
  71         slide has not effects or no main sequence effect has yet been played
  72         then switch to the previous slide and replay all of its main
  73         sequence effects.
  74         The caller has to pass two functors that redisplay the current slide
  75         or switch to the previous slide so that it does not have to expose
  76         its internals to us.  Only one of the two functors is called.
  77         @param rpPaintLock
  78             This paint lock is released after the whole asynchronous
  79             process of rewinding the current effect is completed.  It
  80             prevents intermediate repaints  that would show partial replay
  81             of effects.
  82         @param rSlideRewindFunctor
  83             This functor is called when the current slide is to be
  84             redisplayed.  When it is called then the other functor is not
  85             called.
  86         @param rPreviousSlideFunctor
  87             This functor is called to switch to the previous slide.  When it
  88             is called then the other functor is not called.
  89     */
  90     bool rewind (
  91         const ::std::shared_ptr<ScreenUpdater::UpdateLock>& rpPaintLock,
  92         const ::std::function<void ()>& rSlideRewindFunctor,
  93         const ::std::function<void ()>& rPreviousSlideFunctor);
  94
  95     /** Call this method after gotoPreviousEffect() triggered a slide change
  96         to the previous slide.
  97     */
  98     void skipAllMainSequenceEffects();
  99
 100 private:
 101     EventMultiplexer& mrEventMultiplexer;
 102     EventQueue& mrEventQueue;
 103     UserEventQueue& mrUserEventQueue;
 104
 105     EventHandlerSharedPtr mpSlideStartHandler;
 106     EventHandlerSharedPtr mpSlideEndHandler;
 107     AnimationEventHandlerSharedPtr mpAnimationStartHandler;
 108
 109     /** The number off main sequence effects so far.
 110     */
 111     sal_Int32 mnMainSequenceEffectCount;
 112
 113     /** This is the currently scheduled event that executes the asynchronous
 114         part of the effect rewinding.  It is also used as flag that prevents
 115         nested rewinds.
 116     */
 117     EventSharedPtr mpAsynchronousRewindEvent;
 118
 119     css::uno::Reference<css::animations::XAnimationNode> mxCurrentAnimationRootNode;
 120     ::std::shared_ptr<ScreenUpdater::UpdateLock> mpPaintLock;
 121
 122     bool mbNonUserTriggeredMainSequenceEffectSeen;
 123
 124     void initialize();
 125
 126     bool resetEffectCount();
 127     /** Called by listeners when an animation (not necessarily of a main
 128         sequence effect) starts.
 129     */
 130     bool notifyAnimationStart (const AnimationNodeSharedPtr& rpNode);
 131
 132     /** Count the number of effects (or effect groups) in the main effect
 133         sequence.
 134     */
 135     sal_Int32 countMainSequenceEffects();
 136
 137     /** Skip the next main sequence effect.
 138     */
 139     void skipSingleMainSequenceEffects();
 140
 141     /** Rewind the last effect of the main effect sequence by replaying all
 142         previous effects.
 143         @param nEffectCount
 144             The number of main sequence effects to replay.
 145         @param bRedisplayCurrentSlide
 146             When <TRUE/> then the current slide is redisplayed before the
 147             effects are replayed.
 148         @param rSlideRewindFunctor
 149             This functor is used to redisplay the current slide.
 150     */
 151     void asynchronousRewind (
 152         sal_Int32 nEffectCount,
 153         const bool bRedisplayCurrentSlide,
 154         const ::std::function<void ()>& rSlideRewindFunctor);
 155
 156     /** Go to the previous slide and replay all of its main sequence effects
 157         (or effect groups).
 158         @param rPreviousSlideFunctor
 159             This functor is used to go to the previous slide.
 160     */
 161     void asynchronousRewindToPreviousSlide (
 162         const ::std::function<void ()>& rPreviousSlideFunctor);
 163 };
 164
 165 } } // end of namespace ::slideshow::internal
 166
 167 #endif
 168
 169 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */