slideshow/source/engine/activities/simplecontinuousactivitybase.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_ACTIVITIES_SIMPLECONTINUOUSACTIVITYBASE_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_ENGINE_ACTIVITIES_SIMPLECONTINUOUSACTIVITYBASE_HXX
  22
  23 #include "activitybase.hxx"
  24 #include <canvas/elapsedtime.hxx>
  25
  26 namespace slideshow::internal
  27     {
  28         /** Simple, continuous animation.
  29
  30             This class implements a simple, continuous animation
  31             without considering repeats or acceleration on the
  32             perform call. Only useful as a base class, you
  33             probably want to use ContinuousActivityBase.
  34         */
  35         class SimpleContinuousActivityBase : public ActivityBase
  36         {
  37         public:
  38             explicit SimpleContinuousActivityBase( const ActivityParameters& rParms );
  39
  40             virtual double calcTimeLag() const override;
  41             virtual bool perform() override;
  42
  43         protected:
  44             /** Hook for derived classes
  45
  46                 This method will be called from perform().
  47
  48                 @param nSimpleTime
  49                 Simple animation time, without repeat,
  50                 acceleration or deceleration applied. This value
  51                 is always in the [0,1] range, the repeat is
  52                 accounted for with the nRepeatCount parameter.
  53
  54                 @param nRepeatCount
  55                 Number of full repeats already performed
  56             */
  57             virtual void simplePerform( double nSimpleTime, sal_uInt32 nRepeatCount ) const = 0;
  58
  59             virtual void startAnimation() override;
  60
  61         private:
  62             /// Time elapsed since activity started
  63             ::canvas::tools::ElapsedTime    maTimer;
  64
  65             /// Simple duration of activity
  66             const double                    mnMinSimpleDuration;
  67
  68             /// Minimal number of frames to show (see ActivityParameters)
  69             const sal_uInt32                mnMinNumberOfFrames;
  70
  71             /// Actual number of frames shown until now.
  72             sal_uInt32                      mnCurrPerformCalls;
  73         };
  74
  75 }
  76
  77 #endif // INCLUDED_SLIDESHOW_SOURCE_ENGINE_ACTIVITIES_SIMPLECONTINUOUSACTIVITYBASE_HXX
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */