slideshow/source/engine/activities/discreteactivitybase.hxx

   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: discreteactivitybase.hxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_DISCRETEACTIVITYBASE_HXX
  32 #define INCLUDED_SLIDESHOW_DISCRETEACTIVITYBASE_HXX
  33
  34 #include "activitybase.hxx"
  35 #include "wakeupevent.hxx"
  36
  37 #include <vector>
  38
  39
  40 namespace slideshow
  41 {
  42     namespace internal
  43     {
  44         /** Specialization of ActivityBase for discrete time activities.
  45
  46             A discrete time activity is one where time proceeds in
  47             discrete steps, i.e. at given time instants.
  48         */
  49         class DiscreteActivityBase : public ActivityBase
  50         {
  51         public:
  52             DiscreteActivityBase( const ActivityParameters& rParms );
  53
  54             /** Hook for derived classes.
  55
  56                 This method is called for each discrete time
  57                 instant, with nFrame denoting the frame number
  58                 (starting with 0)
  59
  60                 @param nFrame
  61                 Current frame number.
  62
  63                 @param nRepeatCount
  64                 Number of full repeats already performed
  65             */
  66             virtual void perform( sal_uInt32 nFrame, sal_uInt32 nRepeatCount ) const = 0;
  67             virtual void dispose();
  68             virtual bool perform();
  69
  70         protected:
  71             virtual void startAnimation();
  72
  73             sal_uInt32 calcFrameIndex( sal_uInt32               nCurrCalls,
  74                                        ::std::size_t    nVectorSize ) const;
  75
  76             sal_uInt32 calcRepeatCount( sal_uInt32              nCurrCalls,
  77                                         ::std::size_t   nVectorSize ) const;
  78
  79             ::std::size_t getNumberOfKeyTimes() const { return maDiscreteTimes.size(); }
  80
  81         private:
  82             WakeupEventSharedPtr                        mpWakeupEvent;
  83             const ::std::vector< double >       maDiscreteTimes;
  84             const double                                        mnSimpleDuration;
  85             sal_uInt32                                          mnCurrPerformCalls;
  86         };
  87     }
  88 }
  89
  90 #endif /* INCLUDED_SLIDESHOW_DISCRETEACTIVITYBASE_HXX */