qxLib
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
qx::base_easing_sequence< T > Class Template Reference

qx::base_easing_element queue More...

#include <easing_sequence.h>

Public Member Functions

void push_back (easing_element_type element) noexcept
 Add easing element to queue. More...
 
template<class... args_t>
void emplace_back (args_t &&... args) noexcept
 Add easing element to queue by constructing in-place. More...
 
void clear () noexcept
 Clear elements queue.
 
void start () noexcept
 Start easing element sequence playing.
 
void pause () noexcept
 Pause easing element sequence playing.
 
void resume () noexcept
 Resume easing element sequence playing.
 
void skip () noexcept
 Skip current element.
 
void reset () noexcept
 Reset sequence.
 
void update (T fDeltaTime) noexcept
 Update easing element sequence. More...
 
void set_looped (bool bLooped) noexcept
 Set loop state. More...
 
void set_speed (T fSpeed) noexcept
 Set updating speed value. More...
 
get () const noexcept
 Get value of current sequence element. More...
 
get_fraction () const noexcept
 Get a fraction indicating how much of the sequence has played. More...
 
get_speed () const noexcept
 Get updating speed value. More...
 
bool is_not_started () const noexcept
 Is sequence not started. More...
 
bool is_started () const noexcept
 Is sequence started. More...
 
bool is_paused () const noexcept
 Is sequence paused. More...
 
bool is_finished () const noexcept
 Is sequence finished. More...
 
bool is_looped () const noexcept
 Is sequence looped. More...
 

Detailed Description

template<class T>
class qx::base_easing_sequence< T >

qx::base_easing_element queue

~

Template Parameters
T- floating point ish value
Author
Khrapov
Date
04.05.2021

Definition at line 30 of file easing_sequence.h.

Member Function Documentation

◆ emplace_back()

template<class T >
template<class... args_t>
void qx::base_easing_sequence< T >::emplace_back ( args_t &&...  args)
inlinenoexcept

Add easing element to queue by constructing in-place.

Template Parameters
args_t- template parameter pack type
Parameters
args- arguments for constructing

Definition at line 22 of file easing_sequence.inl.

◆ get()

template<class T >
T qx::base_easing_sequence< T >::get
inlinenoexcept

Get value of current sequence element.

Return values
-value of current sequence element

Definition at line 116 of file easing_sequence.inl.

◆ get_fraction()

template<class T >
T qx::base_easing_sequence< T >::get_fraction
inlinenoexcept

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

Return values
-fraction [0.0, 1.0]

Definition at line 133 of file easing_sequence.inl.

◆ get_speed()

template<class T >
T qx::base_easing_sequence< T >::get_speed
inlinenoexcept

Get updating speed value.

Return values
-speed

Definition at line 150 of file easing_sequence.inl.

◆ is_finished()

template<class T >
bool qx::base_easing_sequence< T >::is_finished
inlinenoexcept

Is sequence finished.

Return values
-true if sequence is finished

Definition at line 199 of file easing_sequence.inl.

◆ is_looped()

template<class T >
bool qx::base_easing_sequence< T >::is_looped
inlinenoexcept

Is sequence looped.

Return values
-true if sequence is looped

Definition at line 216 of file easing_sequence.inl.

◆ is_not_started()

template<class T >
bool qx::base_easing_sequence< T >::is_not_started
inlinenoexcept

Is sequence not started.

Return values
-true if sequence is not started

Definition at line 156 of file easing_sequence.inl.

◆ is_paused()

template<class T >
bool qx::base_easing_sequence< T >::is_paused
inlinenoexcept

Is sequence paused.

Return values
-true if sequence is paused

Definition at line 190 of file easing_sequence.inl.

◆ is_started()

template<class T >
bool qx::base_easing_sequence< T >::is_started
inlinenoexcept

Is sequence started.

Return values
-true if sequence is started

Definition at line 173 of file easing_sequence.inl.

◆ push_back()

template<class T >
void qx::base_easing_sequence< T >::push_back ( easing_element_type  element)
inlinenoexcept

Add easing element to queue.

Parameters
element- easing element

Definition at line 14 of file easing_sequence.inl.

◆ set_looped()

template<class T >
void qx::base_easing_sequence< T >::set_looped ( bool  bLooped)
inlinenoexcept

Set loop state.

Parameters
bLooped- true if loop

Definition at line 104 of file easing_sequence.inl.

◆ set_speed()

template<class T >
void qx::base_easing_sequence< T >::set_speed ( fSpeed)
inlinenoexcept

Set updating speed value.

Parameters
fSpeed- speed

Definition at line 110 of file easing_sequence.inl.

◆ update()

template<class T >
void qx::base_easing_sequence< T >::update ( fDeltaTime)
inlinenoexcept

Update easing element sequence.

Parameters
fDeltaTime- delta time

Definition at line 78 of file easing_sequence.inl.


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