tweening

import {...} from "@canvas-commons/core/lib/tweening";

Interpolation and timing of tweens.

Interfaces

• InterpolationFunction
• Spring
• TimingFunction

Variables

BeatSpring

const BeatSpring: Spring = ...

---

BounceSpring

const BounceSpring: Spring = ...

---

easeInBack

const easeInBack: TimingFunction = ...

---

easeInBounce

const easeInBounce: TimingFunction = ...

---

easeInElastic

const easeInElastic: TimingFunction = ...

---

easeInOutBack

const easeInOutBack: TimingFunction = ...

---

easeInOutBounce

const easeInOutBounce: TimingFunction = ...

---

easeInOutElastic

const easeInOutElastic: TimingFunction = ...

---

easeOutBack

const easeOutBack: TimingFunction = ...

---

easeOutBounce

const easeOutBounce: TimingFunction = ...

---

easeOutElastic

const easeOutElastic: TimingFunction = ...

---

JumpSpring

const JumpSpring: Spring = ...

---

PlopSpring

const PlopSpring: Spring = ...

---

SmoothSpring

const SmoothSpring: Spring = ...

---

StrikeSpring

const StrikeSpring: Spring = ...

---

SwingSpring

const SwingSpring: Spring = ...

Functions

arcLerp

public arcLerpvalue: numberreverse: booleanratio: number: Vector2

Parameters

• value: number
• reverse: boolean
• ratio: number

---

boolLerp

public boolLerpfrom: Tto: Tvalue: number: T

Parameters

• from: T
• to: T
• value: number

---

clamp

public clampmin: numbermax: numbervalue: number: number

Parameters

• min: number
• max: number
• value: number

---

clampRemap

public clampRemapfromIn: numbertoIn: numberfromOut: numbertoOut: numbervalue: number: number

Parameters

• fromIn: number
• toIn: number
• fromOut: number
• toOut: number
• value: number

---

cos

public cosvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

createEaseInBack

public createEaseInBacks: number = 1.70158: TimingFunction

Parameters

• s: number = 1.70158

---

createEaseInBounce

public createEaseInBouncen: number = 7.5625d: number = 2.75: TimingFunction

Parameters

• n: number = 7.5625
• d: number = 2.75

---

createEaseInElastic

public createEaseInElastics: number = 2.094395: TimingFunction

Parameters

• s: number = 2.094395

---

createEaseInOutBack

public createEaseInOutBacks: number = 1.70158v: number = 1.525: TimingFunction

Parameters

• s: number = 1.70158
• v: number = 1.525

---

createEaseInOutBounce

public createEaseInOutBouncen: number = 7.5625d: number = 2.75: TimingFunction

Parameters

• n: number = 7.5625
• d: number = 2.75

---

createEaseInOutElastic

public createEaseInOutElastics: number = 1.39626: TimingFunction

Parameters

• s: number = 1.39626

---

createEaseOutBack

public createEaseOutBacks: number = 1.70158: TimingFunction

Parameters

• s: number = 1.70158

---

createEaseOutBounce

public createEaseOutBouncen: number = 7.5625d: number = 2.75: TimingFunction

Parameters

• n: number = 7.5625
• d: number = 2.75

---

createEaseOutElastic

public createEaseOutElastics: number = 2.094395: TimingFunction

Parameters

• s: number = 2.094395

---

deepLerp

public deepLerpfrom: TFromto: TTovalue: number: TFromTTo

public deepLerpfrom: TFromto: TTovalue: numbersuppressWarnings: boolean: TFromTTo

public deepLerpfrom: Tto: Tvalue: number: T

public deepLerpfrom: Tto: Tvalue: numbersuppressWarnings: boolean: T

Interpolate between any two Records, including objects and Maps, even with mismatched keys.

Any old key that is missing in to will be removed immediately once value is not 0. Any new key that is missing in from will be added once value reaches 1.

Parameters

• from: TFrom

  The input to favor when value is 0.

• to: TTo

  The input to favor when value is 1.

• value: number

  On a scale between 0 and 1, how closely to favor from vs to.

---

easeInCirc

public easeInCircvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInCubic

public easeInCubicvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInExpo

public easeInExpovalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInOutCirc

public easeInOutCircvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInOutCubic

public easeInOutCubicvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInOutExpo

public easeInOutExpovalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInOutQuad

public easeInOutQuadvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInOutQuart

public easeInOutQuartvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInOutQuint

public easeInOutQuintvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInOutSine

public easeInOutSinevalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInQuad

public easeInQuadvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInQuart

public easeInQuartvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInQuint

public easeInQuintvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeInSine

public easeInSinevalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeOutCirc

public easeOutCircvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeOutCubic

public easeOutCubicvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeOutExpo

public easeOutExpovalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeOutQuad

public easeOutQuadvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeOutQuart

public easeOutQuartvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeOutQuint

public easeOutQuintvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

easeOutSine

public easeOutSinevalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

linear

public linearvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

makeSpring

public makeSpringmass: numberstiffness: numberdamping: numberinitialVelocity?: number: Spring

Parameters

• mass: number
• stiffness: number
• damping: number
• initialVelocity?: number

---

map

public mapfrom: numberto: numbervalue: number: number

Parameters

• from: number
• to: number
• value: number

---

remap

public remapfromIn: numbertoIn: numberfromOut: numbertoOut: numbervalue: number: number

Parameters

• fromIn: number
• toIn: number
• fromOut: number
• toOut: number
• value: number

---

sin

public sinvalue: numberfrom: number = 0to: number = 1: number

Parameters

• value: number
• from: number = 0
• to: number = 1

---

spring

public springspring: Springnullfrom: numberto: numbersettleTolerance: numberonProgress: ProgressFunctiononEnd?: ProgressFunction: ThreadGenerator

public springspring: Springnullfrom: numberto: numberonProgress: ProgressFunctiononEnd?: ProgressFunction: ThreadGenerator

Parameters

• spring: Springnull
• from: number
• to: number
• settleTolerance: number
• onProgress: ProgressFunction
• onEnd?: ProgressFunction

---

textLerp

public textLerpfromString: stringtoString: stringvalue: number: string

Parameters

• fromString: string
• toString: string
• value: number

---

tween

public tweenseconds: numberonProgress: value: numbertime: number => voidonEnd?: value: numbertime: number => void: ThreadGenerator

Parameters

• seconds: number
• onProgress: value: numbertime: number => void
• onEnd?: value: numbertime: number => void