mathAPI
constmathAPI:object
Defined in: packages/threeplay/src/core/math.ts:134
The math helpers exposed on the engine (and on window in global mode).
Type Declaration
Section titled “Type Declaration”chance
Section titled “chance”chance: (
p) =>boolean
true with probability p (0–1).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”boolean
choose
Section titled “choose”choose: <
T>(list) =>T
A random element of a list.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”readonly T[]
Returns
Section titled “Returns”T
clamp: (
v,min,max) =>number
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”number
deg2rad
Section titled “deg2rad”deg2rad: (
deg) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings
Section titled “easings”easings:
object
Common easings for tween().
easings.easeInBack
Section titled “easings.easeInBack”easeInBack: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeInBounce
Section titled “easings.easeInBounce”easeInBounce: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeInCubic
Section titled “easings.easeInCubic”easeInCubic: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeInOutCubic
Section titled “easings.easeInOutCubic”easeInOutCubic: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeInOutQuad
Section titled “easings.easeInOutQuad”easeInOutQuad: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeInOutSine
Section titled “easings.easeInOutSine”easeInOutSine: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeInQuad
Section titled “easings.easeInQuad”easeInQuad: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeInSine
Section titled “easings.easeInSine”easeInSine: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeOutBack
Section titled “easings.easeOutBack”easeOutBack: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeOutBounce
Section titled “easings.easeOutBounce”easeOutBounce:
Easing=bounceOut
easings.easeOutCubic
Section titled “easings.easeOutCubic”easeOutCubic: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeOutElastic
Section titled “easings.easeOutElastic”easeOutElastic: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeOutQuad
Section titled “easings.easeOutQuad”easeOutQuad: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.easeOutSine
Section titled “easings.easeOutSine”easeOutSine: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
easings.linear
Section titled “easings.linear”linear: (
t) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
lerp: (
a,b,t) =>number
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”number
map: (
v,l1,h1,l2,h2) =>number
Maps v from the range [l1, h1] to [l2, h2].
Parameters
Section titled “Parameters”number
number
number
number
number
Returns
Section titled “Returns”number
rad2deg
Section titled “rad2deg”rad2deg: (
rad) =>number
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
rand: (
a?,b?) =>number
rand() 0–1, rand(n) 0–n, rand(a, b) a–b.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”number
randi: (
a?,b?) =>number
Like rand but returns an integer; randi(a, b) includes a, excludes b.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”number
rgb: (
r?,g?,b?) =>Color
A color (a THREE.Color): rgb(255, 120, 0) in 0–255, or anything three.js
understands: rgb("#ff7800"), rgb("tomato"), rgb(0xff7800), rgb([255, 120, 0]).
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”Color
vec2: (
x?,y?) =>Vector2
A 2D vector (a THREE.Vector2), used for screen and HUD coordinates.
Parameters
Section titled “Parameters”number | { x: number; y: number; }
number
Returns
Section titled “Returns”Vector2
vec3: (
x?,y?,z?) =>Vector3
A 3D vector (a THREE.Vector3). vec3() is (0,0,0), vec3(1) is (1,1,1),
vec3(v) copies another vector.
Parameters
Section titled “Parameters”number | { x: number; y: number; z: number; }
number
number
Returns
Section titled “Returns”Vector3
wave: (
lo,hi,t) =>number
Oscillates between lo and hi as t advances (one cycle every 2π).
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”number