pu::ui::SigmoidIncrementer< T > Class Template Reference

Type used to vary a value, from an initial value to a final one, following the shape of a sigmoid function. More...

#include <ui_Types.hpp>

Public Member Functions
constexpr	SigmoidIncrementer ()
	Creates a new SigmoidIncrementer with all values reset.
void	Start (const u32 f_steps, const T target_initial_val, const T target_incr)
	Starts the incrementation process from an initial value to a final one, with a specified number of steps.
void	StartFromZero (const u32 f_steps, const T target_final_val)
	Starts the incrementation process from 0 to a final value, with a specified number of steps.
void	StartToZero (const u32 f_steps, const T target_initial_val)
	Starts the incrementation process from an initial value to 0, with a specified number of steps.
bool	Increment (T &target)
	Increments the target value (performs a step in the incrementation process).
bool	IsDone ()
	Checks whether the incrementation process has finished.

Static Public Attributes
static constexpr double	AllowedError = 0.4f
	Allowed error for the initial/final point reach precision.

Detailed Description

template<typename T>
class pu::ui::SigmoidIncrementer< T >

Type used to vary a value, from an initial value to a final one, following the shape of a sigmoid function.

Template Parameters

T	Type of the value to vary.

Constructor & Destructor Documentation

SigmoidIncrementer()

template<typename T>

pu::ui::SigmoidIncrementer< T >::SigmoidIncrementer ( )

inlineconstexpr

Creates a new SigmoidIncrementer with all values reset.

Member Function Documentation

Increment()

template<typename T>

bool pu::ui::SigmoidIncrementer< T >::Increment ( T & target )

inline

Increments the target value (performs a step in the incrementation process).

Parameters

target

Output variable where the current value will be stored.

Note

If the incrementation process has already finished, this will do nothing and return false.

Returns

Whether the target value has reached the final value.

IsDone()

template<typename T>

bool pu::ui::SigmoidIncrementer< T >::IsDone ( )

inline

Checks whether the incrementation process has finished.

Returns

Whether the incrementation process has finished.

Start()

template<typename T>

void pu::ui::SigmoidIncrementer< T >::Start ( const u32 f_steps, const T target_initial_val, const T target_incr )

inline

Starts the incrementation process from an initial value to a final one, with a specified number of steps.

Parameters

f_steps	Number of steps to reach the final value.
target_initial_val	Initial value.
target_incr	Final increment from the initial value (final value - initial value).

StartFromZero()

template<typename T>

void pu::ui::SigmoidIncrementer< T >::StartFromZero ( const u32 f_steps, const T target_final_val )

inline

Starts the incrementation process from 0 to a final value, with a specified number of steps.

Parameters

f_steps	Number of steps to reach the final value.
target_final_val	Final value.

StartToZero()

template<typename T>

void pu::ui::SigmoidIncrementer< T >::StartToZero ( const u32 f_steps, const T target_initial_val )

inline

Starts the incrementation process from an initial value to 0, with a specified number of steps.

Parameters

f_steps	Number of steps to reach the final value.
target_initial_val	Initial value.

Member Data Documentation

AllowedError

template<typename T>

double pu::ui::SigmoidIncrementer< T >::AllowedError = 0.4f

staticconstexpr

Allowed error for the initial/final point reach precision.

---

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

• Plutonium/include/pu/ui/ui_Types.hpp