bn::sprite_rotate_to_action class

Modifies the rotation angle 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_rotation_manager>
Modifies the property of a value until it has a given state.

Constructors, destructors, conversion operators

sprite_rotate_to_action(const sprite_ptr& sprite, int duration_updates, fixed final_rotation_angle)
Constructor.
sprite_rotate_to_action(sprite_ptr&& sprite, int duration_updates, fixed final_rotation_angle)
Constructor.

Public functions

auto sprite() const -> const sprite_ptr&
Returns the sprite_ptr to modify.
auto final_rotation_angle() const -> fixed
Returns the rotation angle of the given sprite_ptr when the action is updated the given number of times.

Function documentation

bn::sprite_rotate_to_action::sprite_rotate_to_action(const sprite_ptr& sprite, int duration_updates, fixed final_rotation_angle)

Constructor.

Parameters
sprite sprite_ptr to copy.
duration_updates Number of times that the action must be updated until the rotation angle of the given sprite_ptr is equal to final_rotation_angle.
final_rotation_angle Rotation angle when the action is updated duration_updates times.

This rotation angle must be in the range [0..360].

bn::sprite_rotate_to_action::sprite_rotate_to_action(sprite_ptr&& sprite, int duration_updates, fixed final_rotation_angle)

Constructor.

Parameters
sprite sprite_ptr to move.
duration_updates Number of times that the action must be updated until the rotation angle of the given sprite_ptr is equal to final_rotation_angle.
final_rotation_angle Rotation angle when the action is updated duration_updates times.

This rotation angle must be in the range [0..360].