LibreOffice Module slideshow (master) 1
Public Member Functions | Public Attributes | List of all members
slideshow::internal::ActivityParameters Struct Reference

Parameter struct for animation activities. More...

#include <activityparameters.hxx>

Collaboration diagram for slideshow::internal::ActivityParameters:
[legend]

Public Member Functions

 ActivityParameters (const EventSharedPtr &rEndEvent, EventQueue &rEventQueue, ActivitiesQueue &rActivitiesQueue, double nMinDuration, ::std::optional< double > const &rRepeats, double nAccelerationFraction, double nDecelerationFraction, sal_uInt32 nMinNumberOfFrames, bool bAutoReverse)
 Create. More...
 

Public Attributes

const EventSharedPtrmrEndEvent
 End event to fire, when activity is over. More...
 
WakeupEventSharedPtr mpWakeupEvent
 Wakeup event to use for discrete activities. More...
 
EventQueuemrEventQueue
 EventQueue to add events to. More...
 
ActivitiesQueuemrActivitiesQueue
 ActivitiesQueue to add events to. More...
 
std::shared_ptr< ExpressionNodempFormula
 Optional formula. More...
 
::std::vector< double > maDiscreteTimes
 Key times, for discrete and key time activities. More...
 
const double mnMinDuration
 Total duration of activity (including all repeats) More...
 
::std::optional< double > const & mrRepeats
 
const double mnAccelerationFraction
 
const double mnDecelerationFraction
 
const sal_uInt32 mnMinNumberOfFrames
 Minimal number of frames this activity must render. More...
 
const bool mbAutoReverse
 When true, activity is played reversed after mnDuration. More...
 

Detailed Description

Parameter struct for animation activities.

This struct contains all common parameters needed to initialize the activities generated by the ActivityFactory.

Definition at line 38 of file activityparameters.hxx.

Constructor & Destructor Documentation

◆ ActivityParameters()

slideshow::internal::ActivityParameters::ActivityParameters ( const EventSharedPtr rEndEvent,
EventQueue rEventQueue,
ActivitiesQueue rActivitiesQueue,
double  nMinDuration,
::std::optional< double > const &  rRepeats,
double  nAccelerationFraction,
double  nDecelerationFraction,
sal_uInt32  nMinNumberOfFrames,
bool  bAutoReverse 
)
inline

Create.

Parameters
rEndEventEvent to be fired, when the activity ends.
rEventQueueQueue to add end event to
nMinDurationMinimal duration of the activity (might actually be longer because of nMinNumberOfFrames). Note that this duration must always be the simple duration, i.e. without any repeat.
rRepeatsNumber of repeats. If this parameter is invalid, infinite repeat is assumed.
nAccelerationFractionValue between 0 and 1, denoting the fraction of the total simple duration, which the animation should accelerate.
nDecelerationFractionValue 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!
bAutoReverseWhen true, at the end of the simple duration, the animation plays reversed to the start value. Note that nMinDuration still specifies the simple duration, i.e. when bAutoReverse is true, the implicit duration doubles.

Definition at line 77 of file activityparameters.hxx.

Member Data Documentation

◆ maDiscreteTimes

::std::vector< double > slideshow::internal::ActivityParameters::maDiscreteTimes

Key times, for discrete and key time activities.

Definition at line 115 of file activityparameters.hxx.

Referenced by slideshow::internal::ContinuousKeyTimeActivityBase::ContinuousKeyTimeActivityBase().

◆ mbAutoReverse

const bool slideshow::internal::ActivityParameters::mbAutoReverse

When true, activity is played reversed after mnDuration.

Definition at line 127 of file activityparameters.hxx.

◆ mnAccelerationFraction

const double slideshow::internal::ActivityParameters::mnAccelerationFraction

Definition at line 120 of file activityparameters.hxx.

◆ mnDecelerationFraction

const double slideshow::internal::ActivityParameters::mnDecelerationFraction

Definition at line 121 of file activityparameters.hxx.

◆ mnMinDuration

const double slideshow::internal::ActivityParameters::mnMinDuration

Total duration of activity (including all repeats)

Definition at line 118 of file activityparameters.hxx.

◆ mnMinNumberOfFrames

const sal_uInt32 slideshow::internal::ActivityParameters::mnMinNumberOfFrames

Minimal number of frames this activity must render.

Definition at line 124 of file activityparameters.hxx.

◆ mpFormula

std::shared_ptr<ExpressionNode> slideshow::internal::ActivityParameters::mpFormula

Optional formula.

Definition at line 112 of file activityparameters.hxx.

◆ mpWakeupEvent

WakeupEventSharedPtr slideshow::internal::ActivityParameters::mpWakeupEvent

Wakeup event to use for discrete activities.

Definition at line 103 of file activityparameters.hxx.

◆ mrActivitiesQueue

ActivitiesQueue& slideshow::internal::ActivityParameters::mrActivitiesQueue

ActivitiesQueue to add events to.

Definition at line 109 of file activityparameters.hxx.

◆ mrEndEvent

const EventSharedPtr& slideshow::internal::ActivityParameters::mrEndEvent

End event to fire, when activity is over.

Definition at line 101 of file activityparameters.hxx.

◆ mrEventQueue

EventQueue& slideshow::internal::ActivityParameters::mrEventQueue

EventQueue to add events to.

Definition at line 106 of file activityparameters.hxx.

◆ mrRepeats

::std::optional<double> const& slideshow::internal::ActivityParameters::mrRepeats

Definition at line 119 of file activityparameters.hxx.


The documentation for this struct was generated from the following file: