Class: Yuki::Animation::Dim2AnimationDiscreet

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

Overview

Class that perform a 2D animation (from point a to point b)

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, property, a_x, a_y, b_x, b_y, distortion: :UNICITY_DISTORTION, time_source: :SCENE_TIME_SOURCE) ⇒ Dim2AnimationDiscreet

Create a new ScalarAnimation convert it to another number (between 0 & 1) in order to distord time

Parameters:

  • time_to_process (Float) —

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

  • on (Object) —

    object that will receive the property

  • property (Symbol) —

    name of the property to affect (add the = sign in the symbol name)

  • a_x (Float, Symbol) —

    origin x position

  • a_y (Float, Symbol) —

    origin y position

  • b_x (Float, Symbol) —

    destination x position

  • b_y (Float, Symbol) —

    destination y position

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

    callable taking one paramater (between 0 & 1) and

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

    callable taking no parameter and giving the current time



525
526
# File 'docs/4_Systems_005_Animation.rb', line 525

def initialize(time_to_process, on, property, a_x, a_y, b_x, b_y, 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)


530
531
# File 'docs/4_Systems_005_Animation.rb', line 530

def start(begin_offset = 0)
end