bg_palette_rotate_to_action class
#include <bn_bg_palette_actions.h>
Modifies the number of colors to rotate to the right in a bg_
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::
Constructor.
| Parameters | |
|---|---|
| palette | bg_ |
| 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 - rotate_range_size() .. rotate_range_size() - 1].
bn::
Constructor.
| Parameters | |
|---|---|
| palette | bg_ |
| 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 - rotate_range_size() .. rotate_range_size() - 1].