slideshow/source/engine/activities/activityparameters.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: activityparameters.hxx,v $
  10  * $Revision: 1.7 $
  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_ACTIVITYPARAMETERS_HXX
  32 #define INCLUDED_SLIDESHOW_ACTIVITYPARAMETERS_HXX
  33
  34 #include "event.hxx"
  35 #include "eventqueue.hxx"
  36 #include "expressionnode.hxx"
  37 #include "wakeupevent.hxx"
  38
  39 #include <boost/optional.hpp>
  40 #include <vector>
  41
  42 namespace slideshow {
  43 namespace internal {
  44
  45 /** Parameter struct for animation activities
  46
  47     This struct contains all common parameters needed to
  48     initialize the activities generated by the ActivityFactory.
  49 */
  50 struct ActivityParameters
  51 {
  52     /** Create
  53
  54         @param rEndEvent
  55         Event to be fired, when the activity ends.
  56
  57         @param rEventQueue
  58         Queue to add end event to
  59
  60         @param nMinDuration
  61         Minimal duration of the activity (might actually be
  62         longer because of nMinNumberOfFrames). Note that this
  63         duration must always be the <em>simple</em> duration,
  64         i.e. without any repeat.
  65
  66         @param rRepeats
  67         Number of repeats. If this parameter is invalid,
  68         infinite repeat is assumed.
  69
  70         @param nAccelerationFraction
  71         Value between 0 and 1, denoting the fraction of the
  72         total simple duration, which the animation should
  73         accelerate.
  74
  75         @param nDecelerationFraction
  76         Value between 0 and 1, denoting the fraction of the
  77         total simple duration, which the animation should
  78         decelerate. Note that the ranges
  79         [0,nAccelerationFraction] and
  80         [nDecelerationFraction,1] must be non-overlapping!
  81
  82         @param bAutoReverse
  83         When true, at the end of the simple duration, the
  84         animation plays reversed to the start value. Note that
  85         nMinDuration still specifies the simple duration,
  86         i.e. when bAutoReverse is true, the implicit duration
  87         doubles.
  88     */
  89     ActivityParameters(
  90         const EventSharedPtr&                       rEndEvent,
  91         EventQueue&                                 rEventQueue,
  92         ActivitiesQueue&                            rActivitiesQueue,
  93         double                                      nMinDuration,
  94         ::boost::optional<double> const&            rRepeats,
  95         double                                      nAccelerationFraction,
  96         double                                      nDecelerationFraction,
  97         sal_uInt32                                  nMinNumberOfFrames,
  98         bool                                        bAutoReverse )
  99         : mrEndEvent( rEndEvent ),
 100           mpWakeupEvent(),
 101           mrEventQueue( rEventQueue ),
 102           mrActivitiesQueue( rActivitiesQueue ),
 103           mpFormula(),
 104           maDiscreteTimes(),
 105           mnMinDuration( nMinDuration ),
 106           mrRepeats( rRepeats ),
 107           mnAccelerationFraction( nAccelerationFraction ),
 108           mnDecelerationFraction( nDecelerationFraction ),
 109           mnMinNumberOfFrames( nMinNumberOfFrames ),
 110           mbAutoReverse( bAutoReverse ) {}
 111
 112     /// End event to fire, when activity is over
 113     const EventSharedPtr&                       mrEndEvent;
 114     /// Wakeup event to use for discrete activities
 115     WakeupEventSharedPtr                        mpWakeupEvent;
 116
 117     /// EventQueue to add events to
 118     EventQueue&                                 mrEventQueue;
 119
 120     /// ActivitiesQueue to add events to
 121     ActivitiesQueue&                            mrActivitiesQueue;
 122
 123     /// Optional formula
 124     ExpressionNodeSharedPtr                     mpFormula;
 125
 126     /// Key times, for discrete and key time activities
 127     ::std::vector< double >                     maDiscreteTimes;
 128
 129     /// Total duration of activity (including all repeats)
 130     const double                                mnMinDuration;
 131     ::boost::optional<double> const&            mrRepeats;
 132     const double                                mnAccelerationFraction;
 133     const double                                mnDecelerationFraction;
 134
 135     /// Minimal number of frames this activity must render
 136     const sal_uInt32                            mnMinNumberOfFrames;
 137
 138     /// When true, activity is played reversed after mnDuration.
 139     const bool                                  mbAutoReverse;
 140 };
 141
 142 } // namespace internal
 143 } // namespace presentation
 144
 145 #endif /* INCLUDED_SLIDESHOW_ACTIVITYPARAMETERS_HXX */
 146