WallTransition

WallTransition is a method of transitioning between two values (numbers, or arrays of numbers) with a bounce. Unlike a SpringTransition The transition will not overshoot the target, but bounce back against it. The behavior of the bounce is specified by the transition options.

Overview

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

WallTransition(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.

restitution()

The percentage of momentum transferred to the wall

reset(state, velocity)

Resets the state and velocity

Parameters
state
Number|Array
State
velocity
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()

Getter

Returns
Number|Array
state

set(state, definition, callback)

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

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