bn::bgs_mosaic_vertical_stretch_to_action class

Modifies the vertical stretch of the mosaic applied to the backgrounds until it has a given state.

Base classes

template<typename Property, class PropertyManager>
class to_template_action<fixed, bgs_mosaic_vertical_stretch_manager>
Modifies the property until it has a given state.

Constructors, destructors, conversion operators

bgs_mosaic_vertical_stretch_to_action(int duration_updates, fixed final_vertical_stretch)

Public functions

auto final_vertical_stretch() const -> fixed
Returns the vertical stretch when the action is updated the given number of times.

Function documentation

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


duration_updates Number of times that the action must be updated until the vertical stretch is equal to final_vertical_stretch.
final_vertical_stretch Vertical stretch when the action is updated duration_updates times.

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