MythTV  master
Signals | Public Member Functions | Protected Slots | Protected Attributes | List of all members
AbstractAnimation Class Referenceabstract

Base animation class that is driven by a Myth pulse and implements variable speed. More...

#include <galleryslide.h>

Inheritance diagram for AbstractAnimation:
Inheritance graph
[legend]
Collaboration diagram for AbstractAnimation:
Collaboration graph
[legend]

Signals

void finished ()
 Signals animation has finished. More...
 

Public Member Functions

 AbstractAnimation ()=default
 
virtual void Start (bool forwards, float speed=1.0)
 Initialise & start base animation. More...
 
virtual void Stop ()
 
virtual void SetSpeed (float speed)
 
virtual void Pulse (int interval)=0
 
virtual void Clear ()
 

Protected Slots

virtual void Finished ()
 To be called when animation completes. More...
 

Protected Attributes

bool m_forwards {true}
 Play direction. More...
 
bool m_running {false}
 True whilst animation is active. More...
 
float m_speed {0.0F}
 Real-time = 1.0, Double-speed = 2.0. More...
 

Detailed Description

Base animation class that is driven by a Myth pulse and implements variable speed.

Definition at line 27 of file galleryslide.h.

Constructor & Destructor Documentation

◆ AbstractAnimation()

AbstractAnimation::AbstractAnimation ( )
default

Member Function Documentation

◆ Start()

void AbstractAnimation::Start ( bool  forwards,
float  speed = 1.0 
)
virtual

Initialise & start base animation.

Parameters
forwardsDirection
speedFactor, 1 = real-time, 2 = double-time

Reimplemented in ParallelAnimation, SequentialAnimation, GroupAnimation, and Animation.

Definition at line 29 of file galleryslide.cpp.

Referenced by Animation::Start(), GroupAnimation::Start(), and ParallelAnimation::Start().

◆ Stop()

virtual void AbstractAnimation::Stop ( void  )
inlinevirtual

Definition at line 33 of file galleryslide.h.

◆ SetSpeed()

virtual void AbstractAnimation::SetSpeed ( float  speed)
inlinevirtual

◆ Pulse()

virtual void AbstractAnimation::Pulse ( int  interval)
pure virtual

◆ Clear()

virtual void AbstractAnimation::Clear ( void  )
inlinevirtual

Reimplemented in GroupAnimation.

Definition at line 36 of file galleryslide.h.

◆ Finished

virtual void AbstractAnimation::Finished ( )
inlineprotectedvirtualslot

To be called when animation completes.

Definition at line 40 of file galleryslide.h.

Referenced by GroupAnimation::Add(), SequentialAnimation::Finished(), ParallelAnimation::Finished(), and Animation::Pulse().

◆ finished

void AbstractAnimation::finished ( )
signal

Signals animation has finished.

Referenced by GroupAnimation::Add(), and Finished().

Member Data Documentation

◆ m_forwards

bool AbstractAnimation::m_forwards {true}
protected

◆ m_running

bool AbstractAnimation::m_running {false}
protected

◆ m_speed

float AbstractAnimation::m_speed {0.0F}
protected

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