AnimationBase Class Reference

Base class for an animation. More...

#include <animation.h>

Inheritance diagram for AnimationBase:

Public Member Functions
	AnimationBase ()=default
	AnimationBase (AnimationBase &&) noexcept=default
	AnimationBase (const AnimationBase &)=delete
virtual	~AnimationBase () noexcept=default
void	add_callback (AnimationCallback callback)
	Register a callback for the animation.
void	clear_callbacks ()
	Clear all callbacks.
virtual bool	next ()=0
	Periodic call to the animation.
AnimationBase &	operator= (AnimationBase &&) noexcept=default
AnimationBase &	operator= (const AnimationBase &)=delete
virtual void	resume ()=0
	Resume the animation.
virtual EGT_NODISCARD bool	running () const
	Returns true if the animation is currently running.
virtual void	start ()=0
	Start the animation.
virtual void	stop ()=0
	Stop the animation.

Protected Attributes
std::vector< AnimationCallback >	m_callbacks
	Registered callbacks for the animation.
bool	m_running {false}
	The running state of the animation.

Detailed Description

Base class for an animation.

Constructor & Destructor Documentation

AnimationBase() [1/3]

AnimationBase ( )

default

AnimationBase() [2/3]

AnimationBase ( const AnimationBase &  )

delete

AnimationBase() [3/3]

AnimationBase ( AnimationBase &&  )

defaultnoexcept

~AnimationBase()

virtual ~AnimationBase ( )

virtualdefaultnoexcept

Member Function Documentation

add_callback()

void add_callback ( AnimationCallback  callback )

inline

Register a callback for the animation.

More than one callback can be registered.

The callback will be called for each step of the animation, usually only when the animation value has actually changed.

Todo:

Need to implement removing callbacks, similar to Object class.

clear_callbacks()

void clear_callbacks ( )

inline

Clear all callbacks.

next()

virtual bool next ( )

pure virtual

Periodic call to the animation.

This must be called until it returns false. When it returns false, the animation is done.

Implemented in Animation, AnimationSequence, and AnimationDelay.

operator=() [1/2]

AnimationBase & operator= ( AnimationBase &&  )

defaultnoexcept

operator=() [2/2]

AnimationBase & operator= ( const AnimationBase &  )

delete

resume()

virtual void resume ( )

pure virtual

Resume the animation.

Implemented in Animation, AnimationSequence, AutoAnimation, and AnimationDelay.

running()

virtual EGT_NODISCARD bool running ( ) const

inlinevirtual

Returns true if the animation is currently running.

start()

virtual void start ( )

pure virtual

Start the animation.

Implemented in Animation, AnimationSequence, AutoAnimation, and AnimationDelay.

stop()

virtual void stop ( )

pure virtual

Stop the animation.

Implemented in Animation, AnimationSequence, AutoAnimation, and AnimationDelay.

Member Data Documentation

m_callbacks

std::vector<AnimationCallback> m_callbacks

protected

Registered callbacks for the animation.

m_running

bool m_running {false}

protected

The running state of the animation.