bn::regular_bg_top_left_move_loop_action class
#include <bn_regular_bg_actions.h>

Modifies the top-left position of a regular_bg_ptr from a minimum to a maximum. When the top-left position 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<regular_bg_ptr, fixed_point, regular_bg_top_left_position_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

regular_bg_top_left_move_loop_action(const regular_bg_ptr& bg, int duration_updates, fixed final_top_left_x, fixed final_top_left_y)
Constructor.
regular_bg_top_left_move_loop_action(regular_bg_ptr&& bg, int duration_updates, fixed final_top_left_x, fixed final_top_left_y)
Constructor.
regular_bg_top_left_move_loop_action(const regular_bg_ptr& bg, int duration_updates, const fixed_point& final_top_left_position)
Constructor.
regular_bg_top_left_move_loop_action(regular_bg_ptr&& bg, int duration_updates, const fixed_point& final_top_left_position)
Constructor.

Public functions

auto bg() const -> const regular_bg_ptr&
Returns the regular_bg_ptr to modify.
auto final_top_left_position() const -> const fixed_point&
When the top-left position of the given regular_bg_ptr is equal to this returned parameter, it goes back to its initial state and vice versa.

Function documentation

bn::regular_bg_top_left_move_loop_action::regular_bg_top_left_move_loop_action(const regular_bg_ptr& bg, int duration_updates, fixed final_top_left_x, fixed final_top_left_y)

Constructor.

Parameters
bg regular_bg_ptr to copy.
duration_updates How many times the action has to be updated before changing the direction of the top-left position delta.
final_top_left_x When the horizontal top-left position of the given regular_bg_ptr is equal to this parameter, it goes back to its initial state and vice versa.
final_top_left_y When the vertical top-left position of the given regular_bg_ptr is equal to this parameter, it goes back to its initial state and vice versa.

bn::regular_bg_top_left_move_loop_action::regular_bg_top_left_move_loop_action(regular_bg_ptr&& bg, int duration_updates, fixed final_top_left_x, fixed final_top_left_y)

Constructor.

Parameters
bg regular_bg_ptr to move.
duration_updates How many times the action has to be updated before changing the direction of the top-left position delta.
final_top_left_x When the horizontal top-left position of the given regular_bg_ptr is equal to this parameter, it goes back to its initial state and vice versa.
final_top_left_y When the vertical top-left position of the given regular_bg_ptr is equal to this parameter, it goes back to its initial state and vice versa.

bn::regular_bg_top_left_move_loop_action::regular_bg_top_left_move_loop_action(const regular_bg_ptr& bg, int duration_updates, const fixed_point& final_top_left_position)

Constructor.

Parameters
bg regular_bg_ptr to copy.
duration_updates How many times the action has to be updated before changing the direction of the top-left position delta.
final_top_left_position When the top-left position of the given regular_bg_ptr is equal to this parameter, it goes back to its initial state and vice versa.

bn::regular_bg_top_left_move_loop_action::regular_bg_top_left_move_loop_action(regular_bg_ptr&& bg, int duration_updates, const fixed_point& final_top_left_position)

Constructor.

Parameters
bg regular_bg_ptr to move.
duration_updates How many times the action has to be updated before changing the direction of the top-left position delta.
final_top_left_position When the top-left position of the given regular_bg_ptr is equal to this parameter, it goes back to its initial state and vice versa.