mun-three-utils v1.0.3

mun-three-utils

This is a collection of utilitites we use at MUN when working with three.js. Many of them are adapted from Jack Rugile.

Installation

npm install --save mun-three-utils

ES6

import * as THREEUTILS from 'mun-three-utils

ES5

var THREEUTILS = require(mun-three-utils)

Table of Contents

-Calc -Ease

Calc

This utility provides commonly used calculations for three.js.

• rand
• randInt

rand(min, max, ease)

Returns a random float between two values, with the option of easing bias.

randInt(min, max, ease)

Returns a random integer between two values, with the option of easing bias.

randArr(arr)

Returns a random item from an array.

map(val, inputMin, inputMax, outputMin, outputMax)

Returns a mapped value from and input min/max to an output min/max.

clamp(val, min, max)

Restricts a value to a min/max range.

lerp(current, target, mix)

Linearly interpolates between two vectors.

roundToUpperInterval(value, interval)

Round up a value to the next highest interval.

roundToLowerInterval(value, interval)

Round down a value to the next lowest interval.

roundToNearestInterval(value, interval)

Round a value to the nearest interval.

intersectSphere(a, b)

Check if two sphere are intersecting in 3D space.

getIndexFromCoords(x, y, w)

Convert from grid coords to index.

getCoordsFromIndex(i, w)

Convert from index to grid coords.

visibleHeightAtZDepth(depth, camera)

Returns the visible height in your scene at a given distance from a PerspectiveCamera.

visibleWidthAtZDepth(depth, camera)

Returns the visible width in your scene at a given distance from a PerspectiveCamera.

Ease

A collection of commonly used easing functions.

inQuad(t, b, c, d)

Returns an eased float value based on inQuad.

outQuad(t, b, c, d)

Returns an eased float value based on outQuad.

inOutQuad(t, b, c, d)

Returns an eased float value based on inOutQuad.

inCubic(t, b, c, d)

Returns an eased float value based on inCubic.

outCubic(t, b, c, d)

Returns an eased float value based on outCubic.

inOutCubic(t, b, c, d)

Returns an eased float value based on inOutCubic.

inQuart(t, b, c, d)

Returns an eased float value based on inQuart.

outQuart(t, b, c, d)

Returns an eased float value based on outQuart.

inOutQuart(t, b, c, d)

Returns an eased float value based on inOutQuart.

inQuint(t, b, c, d)

Returns an eased float value based on inQuint.

outQuint(t, b, c, d)

Returns an eased float value based on outQuint.

inOutQuint(t, b, c, d)

Returns an eased float value based on inOutQuint.

inSine(t, b, c, d)

Returns an eased float value based on inSine.

outSine(t, b, c, d)

Returns an eased float value based on outSine.

inOutSine(t, b, c, d)

Returns an eased float value based on inOutSine.

inExpo(t, b, c, d)

Returns an eased float value based on inExpo.

outExpo(t, b, c, d)

Returns an eased float value based on outExpo.

inCirc(t, b, c, d)

Returns an eased float value based on inCirc.

outCirc(t, b, c, d)

Returns an eased float value based on outCirc.

inOutCirc(t, b, c, d)

Returns an eased float value based on inOutCirc.

inOutExpo(t, b, c, d)

Returns an eased float value based on inOutExpo.

inElastic(t, b, c, d)

Returns an eased float value based on inElastic.

outElastic(t, b, c, d)

Returns an eased float value based on outElastic.

inOutElastic(t, b, c, d)

Returns an eased float value based on inOutElastic.

inBack(t, b, c, d)

Returns an eased float value based on inBack.

outBack(t, b, c, d)

Returns an eased float value based on outBack.

inOutBack(t, b, c, d)

Returns an eased float value based on inOutBack.