bn::bgs_mosaic_vertical_stretch_loop_action class

Modifies the vertical stretch of the mosaic applied to the backgrounds from a minimum to a maximum. When the vertical stretch is equal to the given final state, it goes back to its initial state and vice versa.

Base classes

template<typename Property, class PropertyManager>
class loop_template_action<fixed, bgs_mosaic_vertical_stretch_manager>
Modifies the property 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

bgs_mosaic_vertical_stretch_loop_action(int duration_updates, fixed final_vertical_stretch)
Constructor.

Public functions

auto final_vertical_stretch() const -> fixed
When the vertical stretch is equal to the returned parameter, it goes back to its initial state and vice versa.

Function documentation

bn::bgs_mosaic_vertical_stretch_loop_action::bgs_mosaic_vertical_stretch_loop_action(int duration_updates, fixed final_vertical_stretch)

Constructor.

Parameters
duration_updates How many times the action has to be updated before changing the direction of the vertical stretch delta.
final_vertical_stretch When the vertical stretch is equal to this parameter, it goes back to its initial state and vice versa.

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