bn::palette_bitmap_bg_horizontal_scale_loop_action class
#include <bn_palette_bitmap_bg_actions.h>

Modifies the horizontal scale of a palette_bitmap_bg_ptr from a minimum to a maximum. When the horizontal scale 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<palette_bitmap_bg_ptr, fixed, palette_bitmap_bg_horizontal_scale_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

palette_bitmap_bg_horizontal_scale_loop_action(const palette_bitmap_bg_ptr& bg, int duration_updates, fixed final_horizontal_scale)
Constructor.
palette_bitmap_bg_horizontal_scale_loop_action(palette_bitmap_bg_ptr&& bg, int duration_updates, fixed final_horizontal_scale)
Constructor.

Public functions

auto bg() const -> const palette_bitmap_bg_ptr&
Returns the palette_bitmap_bg_ptr to modify.
auto final_horizontal_scale() const -> fixed
When the horizontal scale of the given palette_bitmap_bg_ptr is equal to this returned parameter, it goes back to its initial state and vice versa.

Function documentation

bn::palette_bitmap_bg_horizontal_scale_loop_action::palette_bitmap_bg_horizontal_scale_loop_action(const palette_bitmap_bg_ptr& bg, int duration_updates, fixed final_horizontal_scale)

Constructor.

Parameters
bg palette_bitmap_bg_ptr to copy.
duration_updates How many times the action has to be updated before changing the direction of the horizontal scale delta.
final_horizontal_scale When the horizontal scale of the given palette_bitmap_bg_ptr is equal to this parameter, it goes back to its initial state and vice versa.

bn::palette_bitmap_bg_horizontal_scale_loop_action::palette_bitmap_bg_horizontal_scale_loop_action(palette_bitmap_bg_ptr&& bg, int duration_updates, fixed final_horizontal_scale)

Constructor.

Parameters
bg palette_bitmap_bg_ptr to move.
duration_updates How many times the action has to be updated before changing the direction of the horizontal scale delta.
final_horizontal_scale When the horizontal scale of the given palette_bitmap_bg_ptr is equal to this parameter, it goes back to its initial state and vice versa.