SpringTransition

SpringTransition is a method of transitioning between two values (numbers, or arrays of numbers) with a bounce. The transition will overshoot the target state depending on the parameters of the transition.

Overview

Options
Methods
period
dampingRatio
velocity
reset
getVelocity
setVelocity
isActive
halt
get
set

SpringTransition(state)

Constructor Parameters

state

Number|Array

Initial state

Methods

period()

The amount of time in milliseconds taken for one complete oscillation when there is no damping Range : [0, Infinity]

dampingRatio()

The damping of the snap. Range : [0, 1] 0 = no damping, and the spring will oscillate forever 1 = critically damped (the spring will never oscillate)

velocity()

The initial velocity of the transition.

reset(pos, vel)

Resets the position and velocity

Parameters
pos
Number|Array.Number
positional state
vel
Number|Array
velocity

getVelocity()

Getter for velocity

Returns
Number|Array
velocity

setVelocity()

Setter for velocity

Returns
Number|Array
velocity

isActive()

Detects whether a transition is in progress

Returns
Boolean

halt()

Halt the transition

get()

Get the current position of the transition

Returns
Number|Array
state

set(endState, definition, callback)

Set the end position and transition, with optional callback on completion.

Parameters
endState
Number|Array
Final state
definition
Object
Transition definition
callback
Function
Callback