MathUtils
constMathUtils:object
Defined in: MathUtils.ts:18
Common math utility functions.
Type Declaration
Section titled “Type Declaration”approach()
Section titled “approach()”
readonlyapproach(current,target,step):number
Move current toward target by at most step.
Parameters
Section titled “Parameters”current
Section titled “current”number
target
Section titled “target”number
number
Returns
Section titled “Returns”number
clamp()
Section titled “clamp()”
readonlyclamp(value,min,max):number
Clamp a value between min and max.
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”number
degToRad()
Section titled “degToRad()”
readonlydegToRad(degrees):number
Convert degrees to radians.
Parameters
Section titled “Parameters”degrees
Section titled “degrees”number
Returns
Section titled “Returns”number
inverseLerp()
Section titled “inverseLerp()”
readonlyinverseLerp(a,b,v):number
Return the clamped interpolation factor that produces v between a and b.
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”number
lerp()
Section titled “lerp()”
readonlylerp(a,b,t):number
Linear interpolation between a and b.
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”number
lerpAngle()
Section titled “lerpAngle()”
readonlylerpAngle(a,b,t):number
Interpolate between angles in radians along the shortest path.
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”number
pingPong()
Section titled “pingPong()”
readonlypingPong(t,length):number
Bounce t between 0 and length.
Parameters
Section titled “Parameters”number
length
Section titled “length”number
Returns
Section titled “Returns”number
radToDeg()
Section titled “radToDeg()”
readonlyradToDeg(radians):number
Convert radians to degrees.
Parameters
Section titled “Parameters”radians
Section titled “radians”number
Returns
Section titled “Returns”number
randomInt()
Section titled “randomInt()”
readonlyrandomInt(min,max):number
Random integer in [min, max] (inclusive).
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”number
randomRange()
Section titled “randomRange()”
readonlyrandomRange(min,max):number
Random float in [min, max).
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”number
remap()
Section titled “remap()”
readonlyremap(value,inMin,inMax,outMin,outMax):number
Remap a value from one range to another.
Parameters
Section titled “Parameters”number
number
number
outMin
Section titled “outMin”number
outMax
Section titled “outMax”number
Returns
Section titled “Returns”number
shortestAngleBetween()
Section titled “shortestAngleBetween()”
readonlyshortestAngleBetween(a,b):number
Signed shortest angular delta from a to b, in radians.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”number
smoothDamp()
Section titled “smoothDamp()”
readonlysmoothDamp(current,target,velocity,smoothTime,deltaTime,maxSpeed?):SmoothDampResult
Smoothly damp current toward target without overshooting. Pass the returned velocity back into the next call.
Parameters
Section titled “Parameters”current
Section titled “current”number
target
Section titled “target”number
velocity
Section titled “velocity”number
smoothTime
Section titled “smoothTime”number
deltaTime
Section titled “deltaTime”number
maxSpeed?
Section titled “maxSpeed?”number = Infinity
Returns
Section titled “Returns”wrap()
Section titled “wrap()”
readonlywrap(value,min,max):number
Wrap value into the range [min, max).
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”number