XY Transition. More...

#include <colour_control.h>

Inheritance diagram for HF::Interfaces::ColourControl::XY_Transition:

Collaboration diagram for HF::Interfaces::ColourControl::XY_Transition:

Public Member Functions
	XY_Transition (IServer &_server, uint16_t period, int32_t X_step=0, int32_t Y_step=0, uint16_t n_steps=0, XY_Colour end=XY_Colour(0, 0))
	Constructor. More...

	XY_Transition ()=default
	Default constructor.

	~XY_Transition ()
	Empty destructor.

bool	run (uint16_t time)
	Run the transition. More...

bool	next ()
	Check if the transition should continue. More...

Public Member Functions inherited from HF::Interfaces::ColourControl::ITransition
	ITransition (IServer &_server, uint16_t period)
	Constructor. More...

Data Fields
int32_t	X_step
	X step. More...

int32_t	Y_step
	Y step. More...

uint16_t	n_steps
	Counter for the steps needed. More...

XY_Colour	end
	End value to stop the iteration. More...

Data Fields inherited from HF::Interfaces::ColourControl::ITransition
IServer &	server
	The server instance.

uint16_t	period
	Time period for the transition (in 100 msec units). More...

uint16_t	remaining_time
	Remaining time until the transition is ran. More...

Detailed Description

XY Transition.

Definition at line 1118 of file colour_control.h.

Constructor & Destructor Documentation

◆ XY_Transition()

HF::Interfaces::ColourControl::XY_Transition::XY_Transition	(	IServer &	_server,
		uint16_t	period,
		int32_t	X_step = `0`,
		int32_t	Y_step = `0`,
		uint16_t	n_steps = `0`,
		XY_Colour	end = `XY_Colour(0, 0)`
	)

inline

Constructor.

Parameters

[in]	_server	server instance.
[in]	period	the Transition period (units of 100msec).
[in]	X_step	the X step size for each transition iteration.
[in]	Y_step	the Y step size for each transition iteration.
[in]	n_steps	number of steps.
[in]	end	end value for the transition.

Definition at line 1135 of file colour_control.h.

                                                           :
                ITransition(_server, period), X_step(X_step), Y_step(Y_step),
                n_steps(n_steps), end(end)
             {}

Member Function Documentation

◆ next()

bool HF::Interfaces::ColourControl::XY_Transition::next ( )

inlinevirtual

Check if the transition should continue.

Return values

true	the transition continues.
false	the transition ended.

Implements HF::Interfaces::ColourControl::ITransition.

Definition at line 1152 of file colour_control.h.

References HF::Interfaces::ColourControl::ITransition::period.

             {
                return (period != 0 ? true : false);
             }

◆ run()

bool HF::Interfaces::ColourControl::XY_Transition::run ( uint16_t time )

virtual

Run the transition.

This will update the remaining time and check if the transition should run.

Parameters

[in] time time elapsed time since the last call.

Return values

true	run the transition specialization.
false	don't run the transition specialization.

Reimplemented from HF::Interfaces::ColourControl::ITransition.

Field Documentation

◆ end

XY_Colour HF::Interfaces::ColourControl::XY_Transition::end

End value to stop the iteration.

Definition at line 1123 of file colour_control.h.

◆ n_steps

uint16_t HF::Interfaces::ColourControl::XY_Transition::n_steps

Counter for the steps needed.

Definition at line 1122 of file colour_control.h.

◆ X_step

int32_t HF::Interfaces::ColourControl::XY_Transition::X_step

X step.

Definition at line 1120 of file colour_control.h.

◆ Y_step

int32_t HF::Interfaces::ColourControl::XY_Transition::Y_step

Y step.

Definition at line 1121 of file colour_control.h.

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

colour_control.h

Public Member Functions

Data Fields