bn::bgs_mosaic_horizontal_stretch_to_action class
#include <bn_bgs_mosaic_actions.h>

Modifies the horizontal 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_horizontal_stretch_manager>
Modifies the property until it has a given state.

Constructors, destructors, conversion operators

bgs_mosaic_horizontal_stretch_to_action(int duration_updates, fixed final_horizontal_stretch)
Constructor.

Public functions

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

Function documentation

bn::bgs_mosaic_horizontal_stretch_to_action::bgs_mosaic_horizontal_stretch_to_action(int duration_updates, fixed final_horizontal_stretch)

Constructor.

Parameters
duration_updates Number of times that the action must be updated until the horizontal stretch is equal to final_horizontal_stretch.
final_horizontal_stretch Horizontal stretch when the action is updated duration_updates times.

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