bn::bg_palette_rotate_to_action class

Modifies the number of colors to rotate to the right in a bg_palette_ptr until it has a given state.

Base classes

template<typename Value, typename Property, class PropertyManager>
class to_value_template_action<bg_palette_ptr, int, bg_palette_rotate_manager>
Modifies the property of a value until it has a given state.

Constructors, destructors, conversion operators

bg_palette_rotate_to_action(const bg_palette_ptr& palette, int duration_updates, int final_count)
Constructor.
bg_palette_rotate_to_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
Returns the number of colors to rotate to the right when the action is updated the given number of times.

Function documentation

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

Constructor.

Parameters
palette bg_palette_ptr to copy.
duration_updates Number of times that the action must be updated until the number of colors to rotate to the right is equal to final_count.
final_count Number of colors to rotate to the right when the action is updated duration_updates times.

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

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

Constructor.

Parameters
palette bg_palette_ptr to move.
duration_updates Number of times that the action must be updated until the number of colors to rotate to the right is equal to final_count.
final_count Number of colors to rotate to the right when the action is updated duration_updates times.

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