bn::bgs_mosaic_horizontal_stretch_toggle_action class

Changes the horizontal stretch of the mosaic applied to the backgrounds when the action is updated a given number of times.

Base classes

template<typename Property, class PropertyManager>
class toggle_template_action<fixed, bgs_mosaic_horizontal_stretch_manager>
Changes the property when the action is updated a given number of times.

Constructors, destructors, conversion operators

bgs_mosaic_horizontal_stretch_toggle_action(int duration_updates, fixed new_horizontal_stretch)
Constructor.

Public functions

auto new_horizontal_stretch() const -> fixed
Returns the horizontal stretch to set when the action is updated the given number of times.

Function documentation

bn::bgs_mosaic_horizontal_stretch_toggle_action::bgs_mosaic_horizontal_stretch_toggle_action(int duration_updates, fixed new_horizontal_stretch)

Constructor.

Parameters
duration_updates How much times the action has to be updated to change the horizontal stretch.
new_horizontal_stretch New horizontal stretch to set when the action is updated duration_updates times.

This horizontal stretch must be in the range [0..1].