diff options
Diffstat (limited to 'slideshow/source/engine/activities/activityparameters.hxx')
-rw-r--r-- | slideshow/source/engine/activities/activityparameters.hxx | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/slideshow/source/engine/activities/activityparameters.hxx b/slideshow/source/engine/activities/activityparameters.hxx index f09148988c11..0bab1359e9c4 100644 --- a/slideshow/source/engine/activities/activityparameters.hxx +++ b/slideshow/source/engine/activities/activityparameters.hxx @@ -2,7 +2,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -41,42 +41,42 @@ namespace slideshow { namespace internal { /** Parameter struct for animation activities - + This struct contains all common parameters needed to initialize the activities generated by the ActivityFactory. */ struct ActivityParameters -{ - /** Create - +{ + /** Create + @param rEndEvent Event to be fired, when the activity ends. - + @param rEventQueue Queue to add end event to - + @param nMinDuration Minimal duration of the activity (might actually be longer because of nMinNumberOfFrames). Note that this duration must always be the <em>simple</em> duration, i.e. without any repeat. - + @param rRepeats Number of repeats. If this parameter is invalid, infinite repeat is assumed. - + @param nAccelerationFraction Value between 0 and 1, denoting the fraction of the total simple duration, which the animation should accelerate. - - @param nDecelerationFraction + + @param nDecelerationFraction Value between 0 and 1, denoting the fraction of the total simple duration, which the animation should decelerate. Note that the ranges [0,nAccelerationFraction] and [nDecelerationFraction,1] must be non-overlapping! - + @param bAutoReverse When true, at the end of the simple duration, the animation plays reversed to the start value. Note that @@ -106,33 +106,33 @@ struct ActivityParameters mnDecelerationFraction( nDecelerationFraction ), mnMinNumberOfFrames( nMinNumberOfFrames ), mbAutoReverse( bAutoReverse ) {} - + /// End event to fire, when activity is over const EventSharedPtr& mrEndEvent; /// Wakeup event to use for discrete activities WakeupEventSharedPtr mpWakeupEvent; - + /// EventQueue to add events to EventQueue& mrEventQueue; - + /// ActivitiesQueue to add events to ActivitiesQueue& mrActivitiesQueue; - + /// Optional formula ExpressionNodeSharedPtr mpFormula; - + /// Key times, for discrete and key time activities ::std::vector< double > maDiscreteTimes; - + /// Total duration of activity (including all repeats) const double mnMinDuration; ::boost::optional<double> const& mrRepeats; const double mnAccelerationFraction; const double mnDecelerationFraction; - + /// Minimal number of frames this activity must render const sal_uInt32 mnMinNumberOfFrames; - + /// When true, activity is played reversed after mnDuration. const bool mbAutoReverse; }; |