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

Changes the top-left position of a palette_bitmap_bg_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<palette_bitmap_bg_ptr, fixed_point, palette_bitmap_bg_top_left_position_manager>
Changes the property of a value when the action is updated a given number of times.

Constructors, destructors, conversion operators

palette_bitmap_bg_top_left_move_toggle_action(const palette_bitmap_bg_ptr& bg, int duration_updates, fixed new_top_left_x, fixed new_top_left_y)
Constructor.
palette_bitmap_bg_top_left_move_toggle_action(palette_bitmap_bg_ptr&& bg, int duration_updates, fixed new_top_left_x, fixed new_top_left_y)
Constructor.
palette_bitmap_bg_top_left_move_toggle_action(const palette_bitmap_bg_ptr& bg, int duration_updates, const fixed_point& new_top_left_position)
Constructor.
palette_bitmap_bg_top_left_move_toggle_action(palette_bitmap_bg_ptr&& bg, int duration_updates, const fixed_point& new_top_left_position)
Constructor.

Public functions

auto bg() const -> const palette_bitmap_bg_ptr&
Returns the palette_bitmap_bg_ptr to modify.
auto new_top_left_position() const -> const fixed_point&
Returns the top-left position of the given palette_bitmap_bg_ptr when the action is updated the given number of times.

Function documentation

bn::palette_bitmap_bg_top_left_move_toggle_action::palette_bitmap_bg_top_left_move_toggle_action(const palette_bitmap_bg_ptr& bg, int duration_updates, fixed new_top_left_x, fixed new_top_left_y)

Constructor.

Parameters
bg palette_bitmap_bg_ptr to copy.
duration_updates How many times the action has to be updated to change the top-left position of the given palette_bitmap_bg_ptr.
new_top_left_x New horizontal top-left position when the action is updated duration_updates times.
new_top_left_y New vertical top-left position when the action is updated duration_updates times.

bn::palette_bitmap_bg_top_left_move_toggle_action::palette_bitmap_bg_top_left_move_toggle_action(palette_bitmap_bg_ptr&& bg, int duration_updates, fixed new_top_left_x, fixed new_top_left_y)

Constructor.

Parameters
bg palette_bitmap_bg_ptr to move.
duration_updates How many times the action has to be updated to change the top-left position of the given palette_bitmap_bg_ptr.
new_top_left_x New horizontal top-left position when the action is updated duration_updates times.
new_top_left_y New vertical top-left position when the action is updated duration_updates times.

bn::palette_bitmap_bg_top_left_move_toggle_action::palette_bitmap_bg_top_left_move_toggle_action(const palette_bitmap_bg_ptr& bg, int duration_updates, const fixed_point& new_top_left_position)

Constructor.

Parameters
bg palette_bitmap_bg_ptr to copy.
duration_updates How many times the action has to be updated to change the top-left position of the given palette_bitmap_bg_ptr.
new_top_left_position New top-left position when the action is updated duration_updates times.

bn::palette_bitmap_bg_top_left_move_toggle_action::palette_bitmap_bg_top_left_move_toggle_action(palette_bitmap_bg_ptr&& bg, int duration_updates, const fixed_point& new_top_left_position)

Constructor.

Parameters
bg palette_bitmap_bg_ptr to move.
duration_updates How many times the action has to be updated to change the top-left position of the given palette_bitmap_bg_ptr.
new_top_left_position New top-left position when the action is updated duration_updates times.