tweening

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

Interpolation and timing of tweens.

Interfaces

InterpolationFunction
Spring
TimingFunction

Variables

`BeatSpring`

`BounceSpring`

                            
                              
                                const 
                                BounceSpring
                                : 
                                Spring
                                 = 
                                ...

`JumpSpring`

`PlopSpring`

`SmoothSpring`

                            
                              
                                const 
                                SmoothSpring
                                : 
                                Spring
                                 = 
                                ...

`StrikeSpring`

                            
                              
                                const 
                                StrikeSpring
                                : 
                                Spring
                                 = 
                                ...

`SwingSpring`

                            
                              
                                const 
                                SwingSpring
                                : 
                                Spring
                                 = 
                                ...

Functions

`arcLerp`

Parameters

value : number
reverse : boolean
ratio : number

`clamp`

Parameters

min : number
max : number
value : number

`clampRemap`

Parameters

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

`cos`

Parameters

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

`createEaseInBack`

                            
                                public 
                                createEaseInBack
                                
                                      s
                                      : 
                                      number
                                       = 
                                      1.70158
                                    
                                : 
                                TimingFunction

Parameters

s : number = 1.70158

`createEaseInBounce`

                            
                                public 
                                createEaseInBounce
                                
                                      n
                                      : 
                                      number
                                       = 
                                      7.5625
                                    
                                      d
                                      : 
                                      number
                                       = 
                                      2.75
                                    
                                : 
                                TimingFunction

Parameters

n : number = 7.5625
d : number = 2.75

`createEaseInElastic`

                            
                                public 
                                createEaseInElastic
                                
                                      s
                                      : 
                                      number
                                       = 
                                      2.094395
                                    
                                : 
                                TimingFunction

Parameters

s : number = 2.094395

`createEaseInOutBack`

                            
                                public 
                                createEaseInOutBack
                                
                                      s
                                      : 
                                      number
                                       = 
                                      1.70158
                                    
                                      v
                                      : 
                                      number
                                       = 
                                      1.525
                                    
                                : 
                                TimingFunction

Parameters

s : number = 1.70158
v : number = 1.525

`createEaseInOutBounce`

                            
                                public 
                                createEaseInOutBounce
                                
                                      n
                                      : 
                                      number
                                       = 
                                      7.5625
                                    
                                      d
                                      : 
                                      number
                                       = 
                                      2.75
                                    
                                : 
                                TimingFunction

Parameters

n : number = 7.5625
d : number = 2.75

`createEaseInOutElastic`

                            
                                public 
                                createEaseInOutElastic
                                
                                      s
                                      : 
                                      number
                                       = 
                                      1.39626
                                    
                                : 
                                TimingFunction

Parameters

s : number = 1.39626

`createEaseOutBack`

                            
                                public 
                                createEaseOutBack
                                
                                      s
                                      : 
                                      number
                                       = 
                                      1.70158
                                    
                                : 
                                TimingFunction

Parameters

s : number = 1.70158

`createEaseOutBounce`

                            
                                public 
                                createEaseOutBounce
                                
                                      n
                                      : 
                                      number
                                       = 
                                      7.5625
                                    
                                      d
                                      : 
                                      number
                                       = 
                                      2.75
                                    
                                : 
                                TimingFunction

Parameters

n : number = 7.5625
d : number = 2.75

`createEaseOutElastic`

                            
                                public 
                                createEaseOutElastic
                                
                                      s
                                      : 
                                      number
                                       = 
                                      2.094395
                                    
                                : 
                                TimingFunction

Parameters

s : number = 2.094395

`deepLerp`

                            
                                public 
                                deepLerp
                                
                                      TFrom
                                       extends 
                                      Record
                                      
                                            any
                                          
                                            unknown
                                          
                                      TTo
                                       extends 
                                      Record
                                      
                                            any
                                          
                                            unknown
                                          
                                      from
                                      : 
                                      TFrom
                                    
                                      to
                                      : 
                                      TTo
                                    
                                      value
                                      : 
                                      number
                                    
                                : 
                                
                                      TFrom
                                    
                                      TTo
                                    
                                public 
                                deepLerp
                                
                                      TFrom
                                       extends 
                                      Record
                                      
                                            any
                                          
                                            unknown
                                          
                                      TTo
                                       extends 
                                      Record
                                      
                                            any
                                          
                                            unknown
                                          
                                      from
                                      : 
                                      TFrom
                                    
                                      to
                                      : 
                                      TTo
                                    
                                      value
                                      : 
                                      number
                                    
                                      suppressWarnings
                                      : 
                                      boolean
                                    
                                : 
                                
                                      TFrom
                                    
                                      TTo
                                    
                                public 
                                deepLerp
                                
                                      T
                                    
                                      from
                                      : 
                                      T
                                    
                                      to
                                      : 
                                      T
                                    
                                      value
                                      : 
                                      number
                                    
                                : 
                                T
                              
                                public 
                                deepLerp
                                
                                      T
                                    
                                      from
                                      : 
                                      T
                                    
                                      to
                                      : 
                                      T
                                    
                                      value
                                      : 
                                      number
                                    
                                      suppressWarnings
                                      : 
                                      boolean
                                    
                                : 
                                T

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

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

Type Parameters

TFrom extends Record any unknown
TTo extends Record any unknown

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.

`easeInBack`

Parameters

value : number
from ?: number
to ?: number

`easeInBounce`

                            
                                public 
                                easeInBounce
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      ?: 
                                      number
                                    
                                      to
                                      ?: 
                                      number
                                    
                                : 
                                number

Parameters

value : number
from ?: number
to ?: number

`easeInCirc`

Parameters

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

`easeInCubic`

                            
                                public 
                                easeInCubic
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInElastic`

                            
                                public 
                                easeInElastic
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      ?: 
                                      number
                                    
                                      to
                                      ?: 
                                      number
                                    
                                : 
                                number

Parameters

value : number
from ?: number
to ?: number

`easeInExpo`

Parameters

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

`easeInOutBack`

                            
                                public 
                                easeInOutBack
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      ?: 
                                      number
                                    
                                      to
                                      ?: 
                                      number
                                    
                                : 
                                number

Parameters

value : number
from ?: number
to ?: number

`easeInOutBounce`

                            
                                public 
                                easeInOutBounce
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      ?: 
                                      number
                                    
                                      to
                                      ?: 
                                      number
                                    
                                : 
                                number

Parameters

value : number
from ?: number
to ?: number

`easeInOutCirc`

                            
                                public 
                                easeInOutCirc
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInOutCubic`

                            
                                public 
                                easeInOutCubic
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInOutElastic`

                            
                                public 
                                easeInOutElastic
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      ?: 
                                      number
                                    
                                      to
                                      ?: 
                                      number
                                    
                                : 
                                number

Parameters

value : number
from ?: number
to ?: number

`easeInOutExpo`

                            
                                public 
                                easeInOutExpo
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInOutQuad`

                            
                                public 
                                easeInOutQuad
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInOutQuart`

                            
                                public 
                                easeInOutQuart
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInOutQuint`

                            
                                public 
                                easeInOutQuint
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInOutSine`

                            
                                public 
                                easeInOutSine
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInQuad`

Parameters

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

`easeInQuart`

                            
                                public 
                                easeInQuart
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInQuint`

                            
                                public 
                                easeInQuint
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeInSine`

Parameters

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

`easeOutBack`

                            
                                public 
                                easeOutBack
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      ?: 
                                      number
                                    
                                      to
                                      ?: 
                                      number
                                    
                                : 
                                number

Parameters

value : number
from ?: number
to ?: number

`easeOutBounce`

                            
                                public 
                                easeOutBounce
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      ?: 
                                      number
                                    
                                      to
                                      ?: 
                                      number
                                    
                                : 
                                number

Parameters

value : number
from ?: number
to ?: number

`easeOutCirc`

                            
                                public 
                                easeOutCirc
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeOutCubic`

                            
                                public 
                                easeOutCubic
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeOutElastic`

                            
                                public 
                                easeOutElastic
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      ?: 
                                      number
                                    
                                      to
                                      ?: 
                                      number
                                    
                                : 
                                number

Parameters

value : number
from ?: number
to ?: number

`easeOutExpo`

                            
                                public 
                                easeOutExpo
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeOutQuad`

                            
                                public 
                                easeOutQuad
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeOutQuart`

                            
                                public 
                                easeOutQuart
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeOutQuint`

                            
                                public 
                                easeOutQuint
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`easeOutSine`

                            
                                public 
                                easeOutSine
                                
                                      value
                                      : 
                                      number
                                    
                                      from
                                      : 
                                      number
                                       = 
                                      0
                                    
                                      to
                                      : 
                                      number
                                       = 
                                      1
                                    
                                : 
                                number

Parameters

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

`linear`

Parameters

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

`makeSpring`

                            
                                public 
                                makeSpring
                                
                                      mass
                                      : 
                                      number
                                    
                                      stiffness
                                      : 
                                      number
                                    
                                      damping
                                      : 
                                      number
                                    
                                      initialVelocity
                                      ?: 
                                      number
                                    
                                : 
                                Spring

Parameters

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

`map`

Parameters

from : number
to : number
value : number

`remap`

Parameters

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

`sin`

Parameters

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

`spring`

                            
                                public 
                                spring
                                
                                      spring
                                      : 
                                      
                                            null
                                          
                                            Spring
                                          
                                      from
                                      : 
                                      number
                                    
                                      to
                                      : 
                                      number
                                    
                                      settleTolerance
                                      : 
                                      number
                                    
                                      onProgress
                                      : 
                                      ProgressFunction
                                    
                                      onEnd
                                      ?: 
                                      ProgressFunction
                                    
                                : 
                                ThreadGenerator
                              
                                public 
                                spring
                                
                                      spring
                                      : 
                                      
                                            null
                                          
                                            Spring
                                          
                                      from
                                      : 
                                      number
                                    
                                      to
                                      : 
                                      number
                                    
                                      onProgress
                                      : 
                                      ProgressFunction
                                    
                                      onEnd
                                      ?: 
                                      ProgressFunction
                                    
                                : 
                                ThreadGenerator

Parameters

spring : null Spring
from : number
to : number
settleTolerance : number
onProgress : ProgressFunction
onEnd ?: ProgressFunction

`textLerp`

Parameters

from : string
to : string
value : number

`tween`

                            
                                public 
                                tween
                                
                                      seconds
                                      : 
                                      number
                                    
                                      onProgress
                                      : 
                                      public 
                                      
                                      ()
                                    
                                      onEnd
                                      ?: 
                                      public 
                                      
                                      ()
                                    
                                : 
                                ThreadGenerator

Parameters

seconds : number
onProgress : public ()
onEnd ?: public ()

Interfaces
Variables
Functions

Interfaces ​

Variables ​

BeatSpring ​

BounceSpring ​

JumpSpring ​

PlopSpring ​

SmoothSpring ​

StrikeSpring ​

SwingSpring ​

Functions ​

arcLerp ​

Parameters

clamp ​

Parameters

clampRemap ​

Parameters

cos ​

Parameters

createEaseInBack ​

Parameters

createEaseInBounce ​

Parameters

createEaseInElastic ​

Parameters

createEaseInOutBack ​

Parameters

createEaseInOutBounce ​

Parameters

createEaseInOutElastic ​

Parameters

createEaseOutBack ​

Parameters

createEaseOutBounce ​

Parameters

createEaseOutElastic ​

Parameters

deepLerp ​

Type Parameters

Parameters

easeInBack ​

Parameters

easeInBounce ​

Parameters

easeInCirc ​

Parameters

easeInCubic ​

Parameters

easeInElastic ​

Parameters

easeInExpo ​

Parameters

easeInOutBack ​

Parameters

easeInOutBounce ​

Parameters

easeInOutCirc ​

Parameters

easeInOutCubic ​

Parameters

easeInOutElastic ​

Parameters

easeInOutExpo ​

Parameters

easeInOutQuad ​

Parameters

easeInOutQuart ​

Parameters

easeInOutQuint ​

Parameters

easeInOutSine ​

Parameters

easeInQuad ​

Parameters

easeInQuart ​

Parameters

easeInQuint ​

Parameters

easeInSine ​

Parameters

easeOutBack ​

Interfaces

Variables

`BeatSpring`

`BounceSpring`

`JumpSpring`

`PlopSpring`

`SmoothSpring`

`StrikeSpring`

`SwingSpring`

Functions

`arcLerp`

`clamp`

`clampRemap`

`cos`

`createEaseInBack`

`createEaseInBounce`

`createEaseInElastic`

`createEaseInOutBack`

`createEaseInOutBounce`

`createEaseInOutElastic`

`createEaseOutBack`

`createEaseOutBounce`

`createEaseOutElastic`

`deepLerp`

`easeInBack`

`easeInBounce`

`easeInCirc`

`easeInCubic`

`easeInElastic`

`easeInExpo`

`easeInOutBack`

`easeInOutBounce`

`easeInOutCirc`

`easeInOutCubic`

`easeInOutElastic`

`easeInOutExpo`

`easeInOutQuad`

`easeInOutQuart`

`easeInOutQuint`

`easeInOutSine`

`easeInQuad`

`easeInQuart`

`easeInQuint`

`easeInSine`

`easeOutBack`

`easeOutBounce`

`easeOutCirc`

`easeOutCubic`

`easeOutElastic`

`easeOutExpo`

`easeOutQuad`

`easeOutQuart`

`easeOutQuint`

`easeOutSine`

`linear`

`makeSpring`

`map`

`remap`

`sin`

`spring`

`textLerp`

`tween`