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

Modifies the top-left position of a regular_bg_ptr until it has a given state.

Base classes

template<typename Value, typename Property, class PropertyManager>
class to_value_template_action<regular_bg_ptr, fixed_point, regular_bg_top_left_position_manager>
Modifies the property of a value until it has a given state.

Constructors, destructors, conversion operators

regular_bg_top_left_move_to_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_to_action(regular_bg_ptr&& bg, int duration_updates, fixed final_top_left_x, fixed final_top_left_y)
Constructor.
regular_bg_top_left_move_to_action(const regular_bg_ptr& bg, int duration_updates, const fixed_point& final_top_left_position)
Constructor.
regular_bg_top_left_move_to_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&
Returns the top-left position of the given regular_bg_ptr when the action is updated the given number of times.

Function documentation

bn::regular_bg_top_left_move_to_action::regular_bg_top_left_move_to_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 Number of times that the action must be updated until the top-left position of the given regular_bg_ptr is equal to (final_x, final_y).
final_top_left_x Horizontal top-left position of the given regular_bg_ptr when the action is updated duration_updates times.
final_top_left_y Vertical top-left position of the given regular_bg_ptr when the action is updated duration_updates times.

bn::regular_bg_top_left_move_to_action::regular_bg_top_left_move_to_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 Number of times that the action must be updated until the top-left position of the given regular_bg_ptr is equal to (final_x, final_y).
final_top_left_x Horizontal top-left position of the given regular_bg_ptr when the action is updated duration_updates times.
final_top_left_y Vertical top-left position of the given regular_bg_ptr when the action is updated duration_updates times.

bn::regular_bg_top_left_move_to_action::regular_bg_top_left_move_to_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 Number of times that the action must be updated until the top-left position of the given regular_bg_ptr is equal to final_top_left_position.
final_top_left_position Top-left position of the given regular_bg_ptr when the action is updated duration_updates times.

bn::regular_bg_top_left_move_to_action::regular_bg_top_left_move_to_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 Number of times that the action must be updated until the top-left position of the given regular_bg_ptr is equal to final_top_left_position.
final_top_left_position Top-left position of the given regular_bg_ptr when the action is updated duration_updates times.