bn::sprite_vertical_scale_to_action class

Modifies the vertical scale of a sprite_ptr until it has a given state.

Base classes

template<typename Value, typename Property, class PropertyManager>
class to_value_template_action<sprite_ptr, fixed, sprite_vertical_scale_manager>
Modifies the property of a value until it has a given state.

Constructors, destructors, conversion operators

sprite_vertical_scale_to_action(const sprite_ptr& sprite, int duration_updates, fixed final_vertical_scale)
Constructor.
sprite_vertical_scale_to_action(sprite_ptr&& sprite, int duration_updates, fixed final_vertical_scale)
Constructor.

Public functions

auto sprite() const -> const sprite_ptr&
Returns the sprite_ptr to modify.
auto final_vertical_scale() const -> fixed
Returns the vertical scale of the given sprite_ptr when the action is updated the given number of times.

Function documentation

bn::sprite_vertical_scale_to_action::sprite_vertical_scale_to_action(const sprite_ptr& sprite, int duration_updates, fixed final_vertical_scale)

Constructor.

Parameters
sprite sprite_ptr to copy.
duration_updates Number of times that the action must be updated until the vertical scale of the given sprite_ptr is equal to final_vertical_scale.
final_vertical_scale Vertical scale when the action is updated duration_updates times.

bn::sprite_vertical_scale_to_action::sprite_vertical_scale_to_action(sprite_ptr&& sprite, int duration_updates, fixed final_vertical_scale)

Constructor.

Parameters
sprite sprite_ptr to move.
duration_updates Number of times that the action must be updated until the vertical scale of the given sprite_ptr is equal to final_vertical_scale.
final_vertical_scale Vertical scale when the action is updated duration_updates times.