qx::base_easing_element< T > Class Template Reference

An updatable element representing the value of the easing function at a given time. More...

#include <easing_element.h>

Public Member Functions
	base_easing_element (const easing::func< T > &func, T fStart=T(0.f), T fEnd=T(1.f), T fSpeed=T(1.f)) noexcept
	base_easing_element object constructor More...
void	start () noexcept
	Mark element as active and let it update.
void	pause () noexcept
	Pause element if started.
void	resume () noexcept
	Resume updating if paused.
void	finish () noexcept
	Mark element as finished.
void	reset () noexcept
	Mark element as inactive.
T	update (T fDeltaTime) noexcept
	Update element corresponding to easing function. More...
void	set_speed (T fSpeed) noexcept
	Set speed value. More...
T	get () const noexcept
	Get current value of element. More...
T	get_fraction () const noexcept
	Get a fraction indicating how much of the element has played. More...
T	get_speed () const noexcept
	Get speed value. More...
status	get_status () const noexcept
	Get element status. More...
bool	is_not_started () const noexcept
	Check if element is not started. More...
bool	is_started () const noexcept
	Check if element is started. More...
bool	is_paused () const noexcept
	Check if element is paused. More...
bool	is_finished () const noexcept
	Check if element is finished. More...

Detailed Description

template<class T>
class qx::base_easing_element< T >

An updatable element representing the value of the easing function at a given time.

~

Template Parameters

T	- floating point ish value

Author

Khrapov

Date

04.05.2021

Definition at line 29 of file easing_element.h.

Constructor & Destructor Documentation

base_easing_element()

template<class T >

qx::base_easing_element< T >::base_easing_element ( const easing::func< T > &  func, T  fStart = T(0.f), T  fEnd = T(1.f), T  fSpeed = T(1.f)  )

inlinenoexcept

base_easing_element object constructor

Parameters

func	- easing function
fStart	- start value
fEnd	- end value
fSpeed	- speed of updating

Definition at line 14 of file easing_element.inl.

Member Function Documentation

get()

template<class T >

T qx::base_easing_element< T >::get

inlinenoexcept

Get current value of element.

Return values

-	current value of element

Definition at line 96 of file easing_element.inl.

get_fraction()

template<class T >

T qx::base_easing_element< T >::get_fraction

inlinenoexcept

Get a fraction indicating how much of the element has played.

Return values

-	fraction [0.0, 1.0]

Definition at line 102 of file easing_element.inl.

get_speed()

template<class T >

T qx::base_easing_element< T >::get_speed

inlinenoexcept

Get speed value.

Return values

-	speed value

Definition at line 108 of file easing_element.inl.

get_status()

template<class T >

base_easing_element< T >::status qx::base_easing_element< T >::get_status

inlinenoexcept

Get element status.

Return values

-	element status

Definition at line 114 of file easing_element.inl.

is_finished()

template<class T >

bool qx::base_easing_element< T >::is_finished

inlinenoexcept

Check if element is finished.

Return values

-	true if element is finished

Definition at line 138 of file easing_element.inl.

is_not_started()

template<class T >

bool qx::base_easing_element< T >::is_not_started

inlinenoexcept

Check if element is not started.

Return values

-	true if element is not started

Definition at line 120 of file easing_element.inl.

is_paused()

template<class T >

bool qx::base_easing_element< T >::is_paused

inlinenoexcept

Check if element is paused.

Return values

-	true if element is paused

Definition at line 132 of file easing_element.inl.

is_started()

template<class T >

bool qx::base_easing_element< T >::is_started

inlinenoexcept

Check if element is started.

Return values

-	true if element is started

Definition at line 126 of file easing_element.inl.

set_speed()

template<class T >

void qx::base_easing_element< T >::set_speed ( T  fSpeed )

inlinenoexcept

Set speed value.

Parameters

fSpeed

- new speed value

Definition at line 89 of file easing_element.inl.

update()

template<class T >

T qx::base_easing_element< T >::update ( T  fDeltaTime )

inlinenoexcept

Update element corresponding to easing function.

Parameters

fDeltaTime

- delta time

Return values

-	the portion of time that was not used

Definition at line 62 of file easing_element.inl.

---

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

• include/qx/easing/easing_element.h
• include/qx/easing/easing_element.inl