bn::affine_bg_vertical_scale_loop_action class

Modifies the vertical scale of an affine_bg_ptr from a minimum to a maximum. When the vertical 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<affine_bg_ptr, fixed, affine_bg_vertical_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

affine_bg_vertical_scale_loop_action(const affine_bg_ptr& bg, int duration_updates, fixed final_vertical_scale)
Constructor.
affine_bg_vertical_scale_loop_action(affine_bg_ptr&& bg, int duration_updates, fixed final_vertical_scale)
Constructor.

Public functions

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

Function documentation

bn::affine_bg_vertical_scale_loop_action::affine_bg_vertical_scale_loop_action(const affine_bg_ptr& bg, int duration_updates, fixed final_vertical_scale)

Constructor.

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

bn::affine_bg_vertical_scale_loop_action::affine_bg_vertical_scale_loop_action(affine_bg_ptr&& bg, int duration_updates, fixed final_vertical_scale)

Constructor.

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