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

Collection of common factory parameters. More...

#include <activitiesfactory.hxx>

Collaboration diagram for slideshow::internal::ActivitiesFactory::CommonParameters:
[legend]

Public Member Functions

 CommonParameters (EventSharedPtr xEndEvent, EventQueue &rEventQueue, ActivitiesQueue &rActivitiesQueue, double nMinDuration, sal_uInt32 nMinNumberOfFrames, bool bAutoReverse, ::std::optional< double > const &aRepeats, double nAcceleration, double nDeceleration, ShapeSharedPtr xShape, const ::basegfx::B2DVector &rSlideBounds)
 

Public Attributes

EventSharedPtr mpEndEvent
 End event to fire when animation is over. More...
 
EventQueuemrEventQueue
 Event queue to insert the end event into. More...
 
ActivitiesQueuemrActivitiesQueue
 Event queue to insert the end event into. More...
 
double mnMinDuration
 Simple duration of the activity. More...
 
sal_uInt32 mnMinNumberOfFrames
 Minimal number of frames for this activity. More...
 
::std::optional< double > const maRepeats
 Number of repeats for the simple duration. More...
 
double mnAcceleration
 Fraction of simple time to accelerate animation. More...
 
double mnDeceleration
 Fraction of simple time to decelerate animation. More...
 
ShapeSharedPtr mpShape
 Shape, to get bounds from. More...
 
::basegfx::B2DVector maSlideBounds
 LayerManager, to get page size from. More...
 
bool mbAutoReverse
 When true, activity is played reversed after mnDuration. More...
 

Detailed Description

Collection of common factory parameters.

Definition at line 47 of file activitiesfactory.hxx.

Constructor & Destructor Documentation

◆ CommonParameters()

slideshow::internal::ActivitiesFactory::CommonParameters::CommonParameters ( EventSharedPtr  xEndEvent,
EventQueue rEventQueue,
ActivitiesQueue rActivitiesQueue,
double  nMinDuration,
sal_uInt32  nMinNumberOfFrames,
bool  bAutoReverse,
::std::optional< double > const &  aRepeats,
double  nAcceleration,
double  nDeceleration,
ShapeSharedPtr  xShape,
const ::basegfx::B2DVector rSlideBounds 
)
inline

Definition at line 49 of file activitiesfactory.hxx.

Member Data Documentation

◆ maRepeats

::std::optional<double> const slideshow::internal::ActivitiesFactory::CommonParameters::maRepeats

Number of repeats for the simple duration.

This specified the number of repeats. The mnMinDuration times maRepeats yields the total duration of this activity. If this value is unspecified, the activity will repeat indefinitely.

Definition at line 111 of file activitiesfactory.hxx.

Referenced by slideshow::internal::ActivitiesFactory::createSimpleActivity().

◆ maSlideBounds

::basegfx::B2DVector slideshow::internal::ActivitiesFactory::CommonParameters::maSlideBounds

LayerManager, to get page size from.

Definition at line 123 of file activitiesfactory.hxx.

◆ mbAutoReverse

bool slideshow::internal::ActivitiesFactory::CommonParameters::mbAutoReverse

When true, activity is played reversed after mnDuration.

Definition at line 126 of file activitiesfactory.hxx.

Referenced by slideshow::internal::ActivitiesFactory::createSimpleActivity().

◆ mnAcceleration

double slideshow::internal::ActivitiesFactory::CommonParameters::mnAcceleration

Fraction of simple time to accelerate animation.

Definition at line 114 of file activitiesfactory.hxx.

Referenced by slideshow::internal::ActivitiesFactory::createSimpleActivity().

◆ mnDeceleration

double slideshow::internal::ActivitiesFactory::CommonParameters::mnDeceleration

Fraction of simple time to decelerate animation.

Definition at line 117 of file activitiesfactory.hxx.

Referenced by slideshow::internal::ActivitiesFactory::createSimpleActivity().

◆ mnMinDuration

double slideshow::internal::ActivitiesFactory::CommonParameters::mnMinDuration

Simple duration of the activity.

Specifies the minimal simple duration of the activity (minimal, because mnMinNumberOfFrames might prolong the activity). According to SMIL, this might also be indefinite, which for our framework does not make much sense, though (wouldn't have a clue, then, how to scale the animation over time).

Definition at line 91 of file activitiesfactory.hxx.

Referenced by slideshow::internal::ActivitiesFactory::createSimpleActivity().

◆ mnMinNumberOfFrames

sal_uInt32 slideshow::internal::ActivitiesFactory::CommonParameters::mnMinNumberOfFrames

Minimal number of frames for this activity.

This specifies the minimal number of frames this activity will display per simple duration. If less than this number are displayed until mnMinDuration is over, the activity will be prolonged until mnMinNumberOfFrames are rendered.

Definition at line 101 of file activitiesfactory.hxx.

Referenced by slideshow::internal::ActivitiesFactory::createSimpleActivity().

◆ mpEndEvent

EventSharedPtr slideshow::internal::ActivitiesFactory::CommonParameters::mpEndEvent

End event to fire when animation is over.

Definition at line 74 of file activitiesfactory.hxx.

Referenced by slideshow::internal::AnimationSetNode::createActivity(), and slideshow::internal::ActivitiesFactory::createSimpleActivity().

◆ mpShape

ShapeSharedPtr slideshow::internal::ActivitiesFactory::CommonParameters::mpShape

Shape, to get bounds from.

Definition at line 120 of file activitiesfactory.hxx.

◆ mrActivitiesQueue

ActivitiesQueue& slideshow::internal::ActivitiesFactory::CommonParameters::mrActivitiesQueue

Event queue to insert the end event into.

Definition at line 79 of file activitiesfactory.hxx.

Referenced by slideshow::internal::ActivitiesFactory::createSimpleActivity().

◆ mrEventQueue

EventQueue& slideshow::internal::ActivitiesFactory::CommonParameters::mrEventQueue

Event queue to insert the end event into.

Definition at line 77 of file activitiesfactory.hxx.

Referenced by slideshow::internal::ActivitiesFactory::createSimpleActivity().


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