bn::bg_palette_rotate_toggle_action class
#include <bn_bg_palette_actions.h>

Changes the number of colors to rotate to the right in a bg_palette_ptr when the action is updated a given number of times.

Base classes

template<typename Value, typename Property, class PropertyManager>
class toggle_value_template_action<bg_palette_ptr, int, bg_palette_rotate_manager>
Changes the property of a value when the action is updated a given number of times.

Constructors, destructors, conversion operators

bg_palette_rotate_toggle_action(const bg_palette_ptr& palette, int duration_updates, int new_count)
Constructor.
bg_palette_rotate_toggle_action(bg_palette_ptr&& palette, int duration_updates, int new_count)
Constructor.

Public functions

auto palette() const -> const bg_palette_ptr&
Returns the bg_palette_ptr to modify.
auto new_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_toggle_action::bg_palette_rotate_toggle_action(const bg_palette_ptr& palette, int duration_updates, int new_count)

Constructor.

Parameters
palette bg_palette_ptr to copy.
duration_updates How much times the action has to be updated to change the number of colors to rotate to the right.
new_count New number of colors to rotate to the right when the action is updated duration_updates times.

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

bn::bg_palette_rotate_toggle_action::bg_palette_rotate_toggle_action(bg_palette_ptr&& palette, int duration_updates, int new_count)

Constructor.

Parameters
palette bg_palette_ptr to move.
duration_updates How much times the action has to be updated to change the number of colors to rotate to the right.
new_count New number of colors to rotate to the right when the action is updated duration_updates times.

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