External module mathf

Index

Classes

Interfaces

Type aliases

EasingFunction

Functions

Type aliases

EasingFunction

EasingFunction: function

Type declaration

- (percent: number): number
- Parameters
  - percent: number
  Returns number

Functions

absZero

absZero(value: number): number

- Defined in mathf/mathf.ts:44
Parameters
- value: number
Returns number

angleDegree

angleDegree(x1: number, y1: number, x2: number, y2: number): number

- Defined in mathf/mathf.ts:305
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
Returns number

The angle in degrees.

angleDistanceDegree

angleDistanceDegree(angle0: number, angle1: number, max: number): number

- Defined in mathf/mathf.ts:327
Parameters
- angle0: number
- angle1: number
- Optional max: number
Returns number

angleDistanceRadian

angleDistanceRadian(angle0: number, angle1: number, max: number): number

- Defined in mathf/mathf.ts:353
Parameters
- angle0: number
- angle1: number
- Optional max: number
Returns number

Distance in radians

angleRadians

angleRadians(x1: number, y1: number, x2: number, y2: number): number

- Defined in mathf/mathf.ts:293
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
Returns number

The angle in radians.

aspectRatio

aspectRatio(box: dimensionalBox): number

- Defined in mathf/mathf.ts:694
Parameters
- box: dimensionalBox
Returns number

asymptoticAverage

asymptoticAverage(current: number, target: number, amount: number): number

- Defined in mathf/mathf.ts:1359
Parameters
- current: number
- target: number
- amount: number
Returns number

boxCollision

boxCollision(a: box, b: box): boolean

- Defined in mathf/mathf.ts:389
Parameters
- a: box
- b: box
Returns boolean

Whether the areas are colliding.

calculate2dPointRotation

calculate2dPointRotation(cx: number, cy: number, x: number, y: number, angle: number): object

- Defined in mathf/mathf.ts:504
Parameters
- cx: number
- cy: number
- x: number
- y: number
- angle: number
Returns object
- x: number
- y: number

calculate2dPointRotationWithDistance

calculate2dPointRotationWithDistance(cx: number, cy: number, x: number, y: number, angle: number, distance: number): object

- Defined in mathf/mathf.ts:534
Parameters
- cx: number
- cy: number
- x: number
- y: number
- angle: number
- distance: number
Returns object
- x: number
- y: number

calculateBackgroundContain

calculateBackgroundContain(parentBox: dimensionalBox, childBox: dimensionalBox): number

- Defined in mathf/mathf.ts:1324
Parameters
- parentBox: dimensionalBox
- childBox: dimensionalBox
Returns number

calculateBackgroundCover

calculateBackgroundCover(parentBox: dimensionalBox, childBox: dimensionalBox): backgroundCoverBox

- Defined in mathf/mathf.ts:1243
Parameters
- parentBox: dimensionalBox
- childBox: dimensionalBox
Returns backgroundCoverBox

backgroundCoverBox The dimensions required to transform the child element to background cover.

calculateCenterOffset

calculateCenterOffset(parent: number, child: number): number

- Defined in mathf/mathf.ts:655
Parameters
- parent: number
- child: number
Returns number

The offset value.

ceilToPrecision

ceilToPrecision(value: number, precision: number): number

- Defined in mathf/mathf.ts:266
Parameters
- value: number
- precision: number
Returns number

childProgress

childProgress(progress: number, start: number, end: number, noClamp?: boolean): number

- Defined in mathf/mathf.ts:200
Parameters
- progress: number
- start: number
- end: number
- Default value noClamp: boolean = false
Returns number

clamp

clamp(min: number, max: number, num: number): number

- Defined in mathf/mathf.ts:157
Parameters
- min: number
- max: number
- num: number
Returns number

A number within the min and max range.

clamp01

clamp01(progress: number): number

- Defined in mathf/mathf.ts:790
Parameters
- progress: number
Returns number

progress A value within 0-1.

clampAsPercent

clampAsPercent(percent: number): number

- Defined in mathf/mathf.ts:768
Parameters
- percent: number
Returns number

percent A value within 0-1.

clampAsProgress

clampAsProgress(progress: number): number

- Defined in mathf/mathf.ts:779
Parameters
- progress: number
Returns number

progress A value within 0-1.

collisionCircVsBox

collisionCircVsBox(circ: circ, rect: box): boolean

- Defined in mathf/mathf.ts:404
Parameters
- circ: circ
- rect: box
Returns boolean

collisionPointVersusConvexPolygon

collisionPointVersusConvexPolygon(point: point, poly: Array<point>): boolean

- Defined in mathf/mathf.ts:422
Parameters
- point: point
- poly: Array<point>
Returns boolean

Whether the point is inside the polygon or not.

colorRgbToRgb

colorRgbToRgb(colorRgb: ColorRGB): Array<number>

- Defined in mathf/color.ts:42
Parameters
- colorRgb: ColorRGB
Returns Array<number>

cssToRgba

cssToRgba(css: string): ColorRGBA | null

- Defined in mathf/color.ts:196
Parameters
- css: string
Returns ColorRGBA | null

damp

damp(value1: number, value2: number, amount: number, damp: number): number

- Defined in mathf/mathf.ts:1098
Parameters
- value1: number
- value2: number
- amount: number
- damp: number
Returns number

degreeToRadian

degreeToRadian(deg: number): number

- Defined in mathf/mathf.ts:370
Parameters
- deg: number
Returns number

The converted radian.

direction

direction(previous: number, current: number): number

- Defined in mathf/mathf.ts:610
Parameters
- previous: number
- current: number
Returns number

distance

distance(x1: number, y1: number, x2: number, y2: number): number

- Defined in mathf/mathf.ts:587
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
Returns number

The distance between point 1 and point 2.

ease

ease(start: number, end: number, progress: number, easeFunction?: Function): number

- Defined in mathf/mathf.ts:1176
Parameters
- start: number
- end: number
- progress: number
- Default value easeFunction: Function = EASE.linear
Returns number

fade

fade(t: number): number

- Defined in mathf/perlin-noise.ts:11
Parameters
- t: number
Returns number

fixDigits

fixDigits(value: string | number, digits: number): number

- Defined in mathf/mathf.ts:59
Parameters
- value: string | number
- digits: number
Returns number

flipCoin

flipCoin(): number

- Defined in mathf/mathf.ts:100
Returns number

floorToPrecision

floorToPrecision(value: number, precision: number): number

- Defined in mathf/mathf.ts:250
Parameters
- value: number
- precision: number
Returns number

generateRandomPoints

generateRandomPoints(num: number, minX: number, maxX: number, minY: number, maxY: number): point[]

- Defined in mathf/mathf.ts:562
Parameters
- num: number
- minX: number
- maxX: number
- minY: number
- maxY: number
Returns point[]

An array of objects containing x, y values.

getProgressInRangeByValue

getProgressInRangeByValue(val: number, min: number, max: number): number

- Defined in mathf/mathf.ts:838
Parameters
- val: number
- min: number
- max: number
Returns number

The progress within the range.

getRandomFloat

getRandomFloat(min: number, max: number): number

- Defined in mathf/mathf.ts:111
Parameters
- min: number
- max: number
Returns number

A random number between the provided range.

getRandomInt

getRandomInt(min: number, max: number): number

- Defined in mathf/mathf.ts:121
Parameters
- min: number
- max: number
Returns number

A random integer betwen the provided range.

getUniqueRandomInt

getUniqueRandomInt(min: number, max: number, not: number): number

- Defined in mathf/mathf.ts:132
Parameters
- min: number
- max: number
- not: number
Returns number

getValueInRangeByProgress

getValueInRangeByProgress(progress: number, min: number, max: number): number

- Defined in mathf/mathf.ts:810
Parameters
- progress: number
- min: number
- max: number
Returns number

The value within the range.

grad

grad(hash: number, x: number, y: number, z: number): number

- Defined in mathf/perlin-noise.ts:19
Parameters
- hash: number
- x: number
- y: number
- z: number
Returns number

hexToRgbNormalized

hexToRgbNormalized(hexValue: number): any[]

- Defined in mathf/color.ts:30
Parameters
- hexValue: number
Returns any[]

hexToRgba

hexToRgba(hex: string, a?: number): ColorRGBA | null

- Defined in mathf/color.ts:164
Parameters
- hex: string
- Default value a: number = 1
Returns ColorRGBA | null

int

int(value: number): number

- Defined in mathf/mathf.ts:75
Parameters
- value: number
Returns number

int0

int0(value: number): number

- Defined in mathf/mathf.ts:93
Parameters
- value: number
Returns number

interpolateRange

interpolateRange(range1Value: number, range1Min: number, range1Max: number, range2Min: number, range2Max: number): number

- Defined in mathf/mathf.ts:1042
Parameters
- range1Value: number
- range1Min: number
- range1Max: number
- range2Min: number
- range2Max: number
Returns number

inverseLerp

inverseLerp(a: number, b: number, value: number, noClamp?: boolean): number

- Defined in mathf/mathf.ts:918
Parameters
- a: number
- b: number
- value: number
- Default value noClamp: boolean = false
Returns number

A normalized value between 0-1

inverseProgress

inverseProgress(value: number): number

- Defined in mathf/mathf.ts:906
Parameters
- value: number
Returns number

isBetween

isBetween(testValue: number, range1: number, range2: number, inclusive?: boolean): boolean

- Defined in mathf/mathf.ts:706
Parameters
- testValue: number
- range1: number
- range2: number
- Default value inclusive: boolean = true
Returns boolean

Whether the test value is between range1 and range2.

lerp

lerp(value1: number, value2: number, amount: number): number

- Defined in mathf/mathf.ts:892
Parameters
- value1: number
- value2: number
- amount: number
Returns number

The interporalated value.

lerp

lerp(t: number, a: number, b: number): number

- Defined in mathf/perlin-noise.ts:15
Parameters
- t: number
- a: number
- b: number
Returns number

lerpEase

lerpEase(value1: number, value2: number, amount: number, easeFunction?: Function): number

- Defined in mathf/mathf.ts:1074
Parameters
- value1: number
- value2: number
- amount: number
- Default value easeFunction: Function = EASE.linear
Returns number

mix

mix(a: number, b: number, blend: number): number

- Defined in mathf/mathf.ts:945
Parameters
- a: number
- b: number
- blend: number
Returns number

noise3

noise3(x: number, y: number, z?: number): number

- Defined in mathf/perlin-noise.ts:37
Parameters
- x: number
- y: number
- Default value z: number = 0
Returns number

A value between 0 and 1.

normalize

normalize(val: number, min: number, max: number): number

- Defined in mathf/mathf.ts:851
Parameters
- val: number
- min: number
- max: number
Returns number

normalizedRgbToHex

normalizedRgbToHex(rgb: Array<number>): number

- Defined in mathf/color.ts:53
Parameters
- rgb: Array<number>
Returns number

normalizedRgbToRgb

normalizedRgbToRgb(rgb: Array<number>): Array<number>

- Defined in mathf/color.ts:79
Parameters
- rgb: Array<number>
Returns Array<number>

radianToDegree

radianToDegree(radian: number): number

- Defined in mathf/mathf.ts:379
Parameters
- radian: number
Returns number

The converted degree.

remap

remap(minA: number, maxA: number, minB: number, maxB: number, valueB: number): number

- Defined in mathf/mathf.ts:1433
Parameters
- minA: number
- maxA: number
- minB: number
- maxB: number
- valueB: number
Returns number

resizeDimensionalBoxToHeight

resizeDimensionalBoxToHeight(box: dimensionalBox, height: number): dimensionalBox

- Defined in mathf/mathf.ts:746
Parameters
- box: dimensionalBox
- height: number
Returns dimensionalBox

resizeDimensionalBoxToWidth

resizeDimensionalBoxToWidth(box: dimensionalBox, width: number): dimensionalBox

- Defined in mathf/mathf.ts:728
Parameters
- box: dimensionalBox
- width: number
Returns dimensionalBox

rgbToHex

rgbToHex(rgb: ColorRGB | ColorRGBA): string

- Defined in mathf/color.ts:149
Parameters
- rgb: ColorRGB | ColorRGBA
Returns string

rgbToNormalizedRgb

rgbToNormalizedRgb(rgb: Array<number>): Array<number>

- Defined in mathf/color.ts:66
Parameters
- rgb: Array<number>
Returns Array<number>

rgbaEase

rgbaEase(start: ColorRGBA, end: ColorRGBA, t: number, ease: Function): ColorRGBA

- Defined in mathf/color.ts:119
Parameters
- start: ColorRGBA
- end: ColorRGBA
- t: number
- ease: Function
Returns ColorRGBA

rgbaLerp

rgbaLerp(start: ColorRGBA, end: ColorRGBA, t: number): ColorRGBA

- Defined in mathf/color.ts:100
Parameters
- start: ColorRGBA
- end: ColorRGBA
- t: number
Returns ColorRGBA

rgbaToCss

rgbaToCss(rgba: ColorRGBA): string

- Defined in mathf/color.ts:240
Parameters
- rgba: ColorRGBA
Returns string

roundToPrecision

roundToPrecision(value: number, precision: number): number

- Defined in mathf/mathf.ts:234
Parameters
- value: number
- precision: number
Returns number

scale

scale(n: number): number

- Defined in mathf/perlin-noise.ts:26
Parameters
- n: number
Returns number

scaleX

scaleX(x1: number, y1: number, y2: number): number

- Defined in mathf/mathf.ts:672
Parameters
- x1: number
- y1: number
- y2: number
Returns number

scaleY

scaleY(x1: number, y1: number, x2: number): number

- Defined in mathf/mathf.ts:686
Parameters
- x1: number
- y1: number
- x2: number
Returns number

sigmoid

sigmoid(value: number, mix: number): number

- Defined in mathf/mathf.ts:1419
Parameters
- value: number
- mix: number
Returns number

sinNormalized

sinNormalized(time: number): number

- Defined in mathf/mathf.ts:1058
Parameters
- time: number
Returns number

smoothStart2

smoothStart2(t: number): number

- Defined in mathf/mathf.ts:1370
Parameters
- t: number
Returns number

smoothStart3

smoothStart3(t: number): number

- Defined in mathf/mathf.ts:1384
Parameters
- t: number
Returns number

smoothStep

smoothStep(min: number, max: number, input: number): number

- Defined in mathf/mathf.ts:991
Parameters
- min: number
- max: number
- input: number
Returns number

smoothStep2

smoothStep2(value: number, mix: number, t: number): number

- Defined in mathf/mathf.ts:1406
Parameters
- value: number
- mix: number
- t: number
Returns number

smoothStop2

smoothStop2(t: number): number

- Defined in mathf/mathf.ts:1377
Parameters
- t: number
Returns number

smoothStop3

smoothStop3(t: number): number

- Defined in mathf/mathf.ts:1391
Parameters
- t: number
Returns number

step

step(edge: number, n: number): 0 | 1

- Defined in mathf/mathf.ts:960
Parameters
- edge: number
- n: number
Returns 0 | 1

sum

sum(values: number[]): number

- Defined in mathf/mathf.ts:1447
Parameters
- values: number[]
Returns number

toFixed

toFixed(value: number, precision: number): number

- Defined in mathf/mathf.ts:281
Parameters
- value: number
- precision: number
Returns number

wrap

wrap(value: number, min: number, max: number): number

- Defined in mathf/mathf.ts:1204
Parameters
- value: number
- min: number
- max: number
Returns number