Ra::Core::Animation::KeyFramedValueController Class Reference

#include <Core/Animation/KeyFramedValueController.hpp>

Collaboration diagram for Ra::Core::Animation::KeyFramedValueController:

Public Types
using	KeyFrame = Ra::Core::Animation::KeyFramedValueBase
using	InsertCallback = std::function<void( const Scalar& )>
using	UpdateCallback = std::function<void( const Scalar& )>

Public Member Functions
	KeyFramedValueController (KeyFrame *value=nullptr, std::string &&name="__INVALID__", InsertCallback inserter=[](const Scalar &) {}, UpdateCallback updater=[](const Scalar &) {})
void	insertKeyFrame (Scalar t)
void	updateKeyFrame (Scalar t)

Public Attributes
KeyFrame *	m_value
std::string	m_name
InsertCallback	m_inserter
UpdateCallback	m_updater

Detailed Description

The KeyFrameController class provides a way to call callback functions on KeyFramedValues upon keyframe insertion, modification or a modification of the current time.

Definition at line 16 of file KeyFramedValueController.hpp.

Member Typedef Documentation

InsertCallback

using Ra::Core::Animation::KeyFramedValueController::InsertCallback = std::function<void( const Scalar& )>

Definition at line 20 of file KeyFramedValueController.hpp.

KeyFrame

using Ra::Core::Animation::KeyFramedValueController::KeyFrame = Ra::Core::Animation::KeyFramedValueBase

Definition at line 19 of file KeyFramedValueController.hpp.

UpdateCallback

using Ra::Core::Animation::KeyFramedValueController::UpdateCallback = std::function<void( const Scalar& )>

Definition at line 21 of file KeyFramedValueController.hpp.

Constructor & Destructor Documentation

KeyFramedValueController()

Ra::Core::Animation::KeyFramedValueController::KeyFramedValueController ( KeyFrame * value = nullptr, std::string && name = "__INVALID__", InsertCallback inserter = []( const Scalar& ) {}, UpdateCallback updater = []( const Scalar& ) {} )

inline

Definition at line 23 of file KeyFramedValueController.hpp.

Member Function Documentation

insertKeyFrame()

void Ra::Core::Animation::KeyFramedValueController::insertKeyFrame ( Scalar t )

inline

Calls the InsertCallback to insert a keyframe at tie t.

Definition at line 36 of file KeyFramedValueController.hpp.

updateKeyFrame()

void Ra::Core::Animation::KeyFramedValueController::updateKeyFrame ( Scalar t )

inline

Calls the UpdateCallback to update the value at time t.

Definition at line 41 of file KeyFramedValueController.hpp.

Member Data Documentation

m_inserter

InsertCallback Ra::Core::Animation::KeyFramedValueController::m_inserter

The callback fonction to call for keyframe insertion.

Definition at line 56 of file KeyFramedValueController.hpp.

m_name

std::string Ra::Core::Animation::KeyFramedValueController::m_name

The name for the managed KeyFramedValue.

Definition at line 51 of file KeyFramedValueController.hpp.

m_updater

UpdateCallback Ra::Core::Animation::KeyFramedValueController::m_updater

The callback fonction to call for value update.

Definition at line 61 of file KeyFramedValueController.hpp.

m_value

KeyFrame* Ra::Core::Animation::KeyFramedValueController::m_value

The KeyFramedValue to manage.

Definition at line 46 of file KeyFramedValueController.hpp.

---

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

• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Core/Animation/KeyFramedValueController.hpp