Motion

Since version 4.0.0

source

Interpolator between two values with duration

class Motion

Properties

activated

Whether the interpolation is in active state.

duration

Duration of the interpolation

easing

Easing function of the interpolation

end

End(to) value of interpolation

loop

Whether to loop interpolation on finish

progress

Interpolation progress value (0 ~ 1)

range

Range of the interpolation

start

Start(from) value of interpolation

val

Current interpolated value

Methods

add

Add delta to start & end and current value.

reset

Set start, end to the given value and set progress to 0.

setNewEndByDelta

Set current value to start, and end to current value + delta, then reset progress to 0.

setRange

Set new range of the interpolation.

update

Update motion and progress it by given deltaTime

Constructor

Create new instance.

new Motion(options: { duration: undefined | number; easing: undefined | ((x: number) => number); loop: undefined | boolean; range: undefined | { max: number; min: number } }): Motion

Parameters

options

{ duration: undefined | number; easing: undefined | ((x: number) => number); loop: undefined | boolean; range: undefined | { max: number; min: number } }

{}

Options

options.duration

undefined | number

Duration of the interpolation

options.easing

undefined | Function

options.loop

undefined | boolean

Whether to loop interpolation on finish

options.range

undefined | Object

Range of the interpolation

Properties

activated

>=4.0.0

readonly

activated

boolean

Whether the interpolation is in active state.

source

duration

>=4.0.0

duration

number

Duration of the interpolation

source

easing

>=4.0.0

easing

((x: number) => number)

Easing function of the interpolation

source

end

>=4.0.0

readonly

end

number

End(to) value of interpolation

source

loop

>=4.0.0

loop

boolean

Whether to loop interpolation on finish

source

progress

>=4.0.0

readonly

progress

number

Interpolation progress value (0 ~ 1)

source

range

>=4.0.0

readonly

range

Range

Range of the interpolation

source

start

>=4.0.0

readonly

start

number

Start(from) value of interpolation

source

val

>=4.0.0

readonly

val

number

Current interpolated value

source

Methods

add

add

void

add(delta: number): void

Add delta to start & end and current value.

Parameters

delta

number

Delta value to add

source

reset

>=4.0.0

reset

void

reset(defaultVal: number): void

Set start, end to the given value and set progress to 0.

Parameters

defaultVal

number

Value to reset

source

setNewEndByDelta

setNewEndByDelta

void

setNewEndByDelta(delta: number): void

Set current value to start, and end to current value + delta, then reset progress to 0.

Parameters

delta

number

Delta value to add

source

setRange

setRange

void

setRange(min: number, max: number): void

Set new range of the interpolation.

Parameters

min

number

New minimum range

max

number

New maximum range

source

update

>=4.0.0

update

number

update(deltaTime: number): number

Update motion and progress it by given deltaTime

Parameters

deltaTime

number

number of milisec to update motion

Returns

Difference(delta) of the value from the last update.

source