≡

Shaping

Shaping provides shaping functions to interpolate a value. These are useful for easing and transitions.

Class in src/Num.ts

Methods

STATIC bounceIn ( t, c )

Bounce in, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC bounceInOut ( t, c )

Bounce in-out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC bounceOut ( t, c )

Bounce out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC circularIn ( t, c )

Circular in, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC circularInOut ( t, c )

Circular in-out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC circularOut ( t, c )

Circular out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC cliff ( t, c, p )

Step function is a simple jump from 0 to 1 at a specific Pt in time.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number (default value: 0.5)

usually a value between 0 to 1, which specify the Pt to "jump". Default is 0.5 which is in the middle.

returns
number

source
in src/Num.ts

STATIC cosineApprox ( t, c )

A faster way to approximate cosine ease in-out using Blinn-Wyvill Approximation. Adapated from Golan Levin's polynomial shaping.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC cubicBezier ( t, c, p1, p2 )

Cubic bezier curve. This reuses the bezier functions in Curve class.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p1: PtLike (default value: [0.1, 0.7])

p2: PtLike (default value: [0.9, 0.2])

returns
number

source
in src/Num.ts

STATIC cubicIn ( t, c )

Cubic in, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC cubicInOut ( t, c )

Cubic in-out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC cubicOut ( t, c )

Cubic out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC elasticIn ( t, c, p )

Elastic in, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number (default value: 0.7)

elastic parmeter between 0 to 1. The lower the number, the more elastic it will be. Default is 0.7.

returns
number

source
in src/Num.ts

STATIC elasticInOut ( t, c, p )

Elastic in-out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number (default value: 0.6)

elastic parmeter between 0 to 1. The lower the number, the more elastic it will be. Default is 0.6.

returns
number

source
in src/Num.ts

STATIC elasticOut ( t, c, p )

Elastic out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number (default value: 0.7)

elastic parmeter between 0 to 1. The lower the number, the more elastic it will be. Default is 0.7.

returns
number

source
in src/Num.ts

STATIC exponentialIn ( t, c, p )

Exponential ease in, adapted from Golan Levin's polynomial shapers.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number (default value: 0.25)

a value between 0 to 1 to control the curve. Default is 0.25.

returns
number

source
in src/Num.ts

STATIC exponentialOut ( t, c, p )

Exponential ease out, adapted from Golan Levin's polynomial shapers.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number (default value: 0.25)

a value between 0 to 1 to control the curve. Default is 0.25.

returns
number

source
in src/Num.ts

STATIC linear ( t, c )

Linear mapping.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC logSigmoid ( t, c, p )

Logistic sigmoid, adapted from Golan Levin's shaping function.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number (default value: 0.7)

a parameter between 0 to 1 to control the steepness of the curve. Higher is steeper. Default is 0.7.

returns
number

source
in src/Num.ts

STATIC quadraticBezier ( t, c, p )

Quadratic bezier curve, adapted from Golan Levin's shaping functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number | PtLike (default value: [0.05, 0.95])

returns
number

source
in src/Num.ts

STATIC quadraticIn ( t, c )

Quadratic in, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC quadraticInOut ( t, c )

Quadratic in-out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC quadraticOut ( t, c )

Quadratic out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC quadraticTarget ( t, c, p1 )

Give a Pt, draw a quadratic curve that will pass through that Pt as closely as possible. Adapted from Golan Levin's shaping functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p1: PtLike (default value: [0.2, 0.35])

returns
number

source
in src/Num.ts

STATIC seat ( t, c, p )

Exponential seat curve, adapted from Golan Levin's shaping functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number (default value: 0.5)

a parameter between 0 to 1 to control the steepness of the curve. Higher is steeper. Default is 0.5.

returns
number

source
in src/Num.ts

STATIC sigmoid ( t, c, p )

Sigmoid curve changes its shape adapted from the input value, but always returns a value between 0 to 1.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

p: number (default value: 10)

the larger the value, the "steeper" the curve will be. Default is 10.

returns
number

source
in src/Num.ts

STATIC sineIn ( t, c )

Sinuous in, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC sineInOut ( t, c )

Sinuous in-out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC sineOut ( t, c )

Sinuous out, adapted from Robert Penner's easing functions.

parameters
t: number

a value between 0 to 1

c: number (default value: 1)

the value to shape, default is 1

returns
number

source
in src/Num.ts

STATIC step ( fn, steps, t, c, args )

Convert any shaping functions into a series of steps.

parameters
fn: Function

the original shaping function

steps: number

the number of steps

t: number

a value between 0 to 1

c: number

the value to shape, default is 1

args: any[]

optional paramters to pass to original function

returns
any

source
in src/Num.ts