bn::bg_palette_rotate_loop_action class

Modifies the number of colors to rotate to the right in a bg_palette_ptrç from a minimum to a maximum. When the number of colors to rotate to the right is equal to the given final state, it goes back to its initial state and vice versa.

Base classes

template<typename Value, typename Property, class PropertyManager>
class loop_value_template_action<bg_palette_ptr, int, bg_palette_rotate_manager>
Modifies the property of a value by delta from a minimum to a maximum. When the property is equal to the given final state, it goes back to its initial state and vice versa.

Constructors, destructors, conversion operators

bg_palette_rotate_loop_action(const bg_palette_ptr& palette, int duration_updates, int final_count)
Constructor.
bg_palette_rotate_loop_action(bg_palette_ptr&& palette, int duration_updates, int final_count)
Constructor.

Public functions

auto palette() const -> const bg_palette_ptr&
Returns the bg_palette_ptr to modify.
auto final_count() const -> int
When the number of colors to rotate to the right is equal to the returned parameter, it goes back to its initial state and vice versa.

Function documentation

bn::bg_palette_rotate_loop_action::bg_palette_rotate_loop_action(const bg_palette_ptr& palette, int duration_updates, int final_count)

Constructor.

Parameters
palette bg_palette_ptr to copy.
duration_updates How much times the action has to be updated before changing the direction of the number of colors to rotate delta.
final_count When the the number of colors to rotate to the right is equal to this parameter, it goes back to its initial state and vice versa.

This count must be in the range [1 - colors_count() .. colors_count() - 1].

bn::bg_palette_rotate_loop_action::bg_palette_rotate_loop_action(bg_palette_ptr&& palette, int duration_updates, int final_count)

Constructor.

Parameters
palette bg_palette_ptr to move.
duration_updates How much times the action has to be updated before changing the direction of the number of colors to rotate delta.
final_count When the the number of colors to rotate to the right is equal to this parameter, it goes back to its initial state and vice versa.

This count must be in the range [1 - colors_count() .. colors_count() - 1].