LibreOffice Module sd (master) 1
Public Member Functions | Public Attributes | List of all members
sd::slidesorter::controller::Animator::Animation Class Reference

Handle one animation function by using a timer for frequent calls to the animations operator(). More...

Public Member Functions

 Animation (Animator::AnimationFunctor aAnimation, const double nStartOffset, const double nDuration, const double nGlobalTime, const Animator::AnimationId nAnimationId, Animator::FinishFunctor aFinishFunctor)
 
bool Run (const double nGlobalTime)
 Run next animation step. More...
 
void Expire ()
 Typically called when an animation has finished, but also from Animator::Disposed(). More...
 
bool IsExpired () const
 

Public Attributes

Animator::AnimationFunctor maAnimation
 
Animator::FinishFunctor maFinishFunctor
 
const Animator::AnimationId mnAnimationId
 
const double mnDuration
 
const double mnEnd
 
const double mnGlobalTimeAtStart
 
bool mbIsExpired
 

Detailed Description

Handle one animation function by using a timer for frequent calls to the animations operator().

Definition at line 30 of file SlsAnimator.cxx.

Constructor & Destructor Documentation

◆ Animation()

sd::slidesorter::controller::Animator::Animation::Animation ( Animator::AnimationFunctor  aAnimation,
const double  nStartOffset,
const double  nDuration,
const double  nGlobalTime,
const Animator::AnimationId  nAnimationId,
Animator::FinishFunctor  aFinishFunctor 
)

Definition at line 225 of file SlsAnimator.cxx.

References maAnimation, mnEnd, nId, and Run().

Member Function Documentation

◆ Expire()

void sd::slidesorter::controller::Animator::Animation::Expire ( )

Typically called when an animation has finished, but also from Animator::Disposed().

The finish functor is called and the animation is marked as expired to prevent another run.

Definition at line 269 of file SlsAnimator.cxx.

◆ IsExpired()

bool sd::slidesorter::controller::Animator::Animation::IsExpired ( ) const
inline

Definition at line 50 of file SlsAnimator.cxx.

References mbIsExpired.

◆ Run()

bool sd::slidesorter::controller::Animator::Animation::Run ( const double  nGlobalTime)

Run next animation step.

If animation has reached its end it is expired.

Definition at line 243 of file SlsAnimator.cxx.

References maAnimation, and mnEnd.

Referenced by Animation().

Member Data Documentation

◆ maAnimation

Animator::AnimationFunctor sd::slidesorter::controller::Animator::Animation::maAnimation

Definition at line 52 of file SlsAnimator.cxx.

◆ maFinishFunctor

Animator::FinishFunctor sd::slidesorter::controller::Animator::Animation::maFinishFunctor

Definition at line 53 of file SlsAnimator.cxx.

◆ mbIsExpired

bool sd::slidesorter::controller::Animator::Animation::mbIsExpired

Definition at line 58 of file SlsAnimator.cxx.

Referenced by IsExpired().

◆ mnAnimationId

const Animator::AnimationId sd::slidesorter::controller::Animator::Animation::mnAnimationId

Definition at line 54 of file SlsAnimator.cxx.

◆ mnDuration

const double sd::slidesorter::controller::Animator::Animation::mnDuration

Definition at line 55 of file SlsAnimator.cxx.

◆ mnEnd

const double sd::slidesorter::controller::Animator::Animation::mnEnd

Definition at line 56 of file SlsAnimator.cxx.

◆ mnGlobalTimeAtStart

const double sd::slidesorter::controller::Animator::Animation::mnGlobalTimeAtStart

Definition at line 57 of file SlsAnimator.cxx.


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