CubbyFlow::Animation Class Reference

Abstract base class for animation-related class. More...

#include <Core/Animation/Animation.hpp>

Inheritance diagram for CubbyFlow::Animation:

Public Member Functions
	Animation ()=default
	Default constructor. More...
	Animation (const Animation &)=default
	Default copy constructor. More...
	Animation (Animation &&) noexcept=default
	Default move constructor. More...
virtual	~Animation ()=default
	Default virtual destructor. More...
Animation &	operator= (const Animation &)=default
	Default copy assignment operator. More...
Animation &	operator= (Animation &&) noexcept=default
	Default move assignment operator. More...
void	Update (const Frame &frame)
	Updates animation state for given frame. More...

Protected Member Functions
virtual void	OnUpdate (const Frame &frame)=0
	The implementation of this function should update the animation state for given Frame instance frame. More...

Detailed Description

Abstract base class for animation-related class.

This class represents the animation logic in very abstract level. Generally animation is a function of time and/or its previous state. This base class provides a virtual function Update() which can be overriden by its sub-classes to implement their own state update logic.

Constructor & Destructor Documentation

Animation() [1/3]

CubbyFlow::Animation::Animation ( )

default

Default constructor.

Animation() [2/3]

CubbyFlow::Animation::Animation ( const Animation &  )

default

Default copy constructor.

Animation() [3/3]

CubbyFlow::Animation::Animation ( Animation &&  )

defaultnoexcept

Default move constructor.

~Animation()

virtual CubbyFlow::Animation::~Animation ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

OnUpdate()

virtual void CubbyFlow::Animation::OnUpdate ( const Frame &  frame )

protectedpure virtual

The implementation of this function should update the animation state for given Frame instance frame.

This function is called from Animation::Update when state of this class instance needs to be updated. Thus, the inherited class should override this function and implement its logic for updating the animation state.

operator=() [1/2]

Animation& CubbyFlow::Animation::operator= ( const Animation &  )

default

Default copy assignment operator.

operator=() [2/2]

Animation& CubbyFlow::Animation::operator= ( Animation &&  )

defaultnoexcept

Default move assignment operator.

Update()

void CubbyFlow::Animation::Update

(

const Frame &

frame

)

Updates animation state for given frame.

This function updates animation state by calling Animation::OnUpdate function.

---

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

• Core/Animation/Animation.hpp