Class: Yuki::Animation::ToneAnimation

Inherits:
TimedAnimation show all
Defined in:
docs/4_Systems_005_Animation.rb

Overview

Animation responsible of changing tone of an object over time

Instance Attribute Summary

Attributes inherited from TimedAnimation

#begin_time, #end_time, #time_source

Attributes included from Yuki::AnimationMixin

#player, #resolver

Instance Method Summary collapse

Methods inherited from TimedAnimation

#done?, #duration, #parallel_add, #play_before, #update

Methods included from Yuki::AnimationMixin

#begin_offset_for_next_animation, #done?, #duration, #update

Constructor Details

#initialize(time_to_process, on, a, b, distortion: :UNICITY_DISTORTION, time_source: :SCENE_TIME_SOURCE) ⇒ ToneAnimation

Create a new ToneAnimation

Parameters:

  • time_to_process (Float) —

    number of seconds (with generic time) to process the animation

  • on (Object) —

    object that will receive the property

  • a (Array(Integer, Integer, Integer, Integer)) —

    origin_tone

  • b (Array(Integer, Integer, Integer, Integer)) —

    tone wanted

  • distortion (#call, Symbol) (defaults to: :UNICITY_DISTORTION) —

    callable taking one parameter (between 0 & 1) and converts it to another number (between 0 & 1) to distort time

  • time_source (#call, Symbol) (defaults to: :SCENE_TIME_SOURCE) —

    callable taking no parameter and giving the current time



1049
1050
# File 'docs/4_Systems_005_Animation.rb', line 1049

def initialize(time_to_process, on, a, b, distortion: :UNICITY_DISTORTION, time_source: :SCENE_TIME_SOURCE)
end

Instance Method Details

#start(begin_offset = 0) ⇒ self

Start the animation (initialize it)

Parameters:

  • begin_offset (Float) (defaults to: 0) —

    offset that prevents the animation from starting before now + begin_offset seconds

Returns:

  • (self)


1054
1055
# File 'docs/4_Systems_005_Animation.rb', line 1054

def start(begin_offset = 0)
end

#update_internal(time_factor)

Update the animation, interpolating the tone values

Parameters:

  • time_factor (Float) —

    number between 0 and 1 indicating the progression of the animation



1058
1059
# File 'docs/4_Systems_005_Animation.rb', line 1058

def update_internal(time_factor)
end