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

Changes the position of a regular_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<regular_bg_ptr, fixed_point, regular_bg_position_manager>
Changes the property of a value when the action is updated a given number of times.

Constructors, destructors, conversion operators

regular_bg_move_toggle_action(const regular_bg_ptr& bg, int duration_updates, fixed new_x, fixed new_y)
Constructor.
regular_bg_move_toggle_action(regular_bg_ptr&& bg, int duration_updates, fixed new_x, fixed new_y)
Constructor.
regular_bg_move_toggle_action(const regular_bg_ptr& bg, int duration_updates, const fixed_point& new_position)
Constructor.
regular_bg_move_toggle_action(regular_bg_ptr&& bg, int duration_updates, const fixed_point& new_position)
Constructor.

Public functions

auto bg() const -> const regular_bg_ptr&
Returns the regular_bg_ptr to modify.
auto new_position() const -> const fixed_point&
Returns the position of the given regular_bg_ptr when the action is updated the given number of times.

Function documentation

bn::regular_bg_move_toggle_action::regular_bg_move_toggle_action(const regular_bg_ptr& bg, int duration_updates, fixed new_x, fixed new_y)

Constructor.

Parameters
bg regular_bg_ptr to copy.
duration_updates How many times the action has to be updated to change the position of the given regular_bg_ptr.
new_x New horizontal position when the action is updated duration_updates times.
new_y New vertical position when the action is updated duration_updates times.

bn::regular_bg_move_toggle_action::regular_bg_move_toggle_action(regular_bg_ptr&& bg, int duration_updates, fixed new_x, fixed new_y)

Constructor.

Parameters
bg regular_bg_ptr to move.
duration_updates How many times the action has to be updated to change the position of the given regular_bg_ptr.
new_x New horizontal position when the action is updated duration_updates times.
new_y New vertical position when the action is updated duration_updates times.

bn::regular_bg_move_toggle_action::regular_bg_move_toggle_action(const regular_bg_ptr& bg, int duration_updates, const fixed_point& new_position)

Constructor.

Parameters
bg regular_bg_ptr to copy.
duration_updates How many times the action has to be updated to change the position of the given regular_bg_ptr.
new_position New position when the action is updated duration_updates times.

bn::regular_bg_move_toggle_action::regular_bg_move_toggle_action(regular_bg_ptr&& bg, int duration_updates, const fixed_point& new_position)

Constructor.

Parameters
bg regular_bg_ptr to move.
duration_updates How many times the action has to be updated to change the position of the given regular_bg_ptr.
new_position New position when the action is updated duration_updates times.