@merci-michel/mm-utils-math

1.0.0 • Public • Published

mm-utils

List of maths utils used for our project 🙌


Math

Generic maths utils.

Example of usage

import { clamp } from 'mm-utils/maths';
const clampedVal = clamp(val, -1, 1);

clamp

Clamp a value between two bounds

function clamp(v, min, max);

distance

Distance between two points

function distance(x1, y1, x2, y2) 

lerp

Linear interpolation between two values (lerping)

function lerp(x, y, r)

lightenDarkenColor

Lighten or darken a color

function lightenDarkenColor(col, amt)

map

Re-maps a number from one range to another

function map(v, start1, stop1, start2, stop2) 

modAbs

Loop on an index value

function modAbs(index, length)

normalize

Normalize a value between two bounds

function normalize(min, max, x)

parabola

Remap the 0..1 interval into 0..1 parabola, such that the corners are remaped to 0 and the center to 1 In other words, parabola(0) = parabola(1) = 0, and parabola(1/2) = 1

function parabola(k, x)

randomFloat

Generate a random float

function randomFloat(minValue, maxValue, precision = 2)

randomHexColor

Generate a random hexadecimal color

function randomHexColor()

randomInt

Generate a random integer

function randomInt(min, max)

smoothStep

Smooth a value

function smoothStep(v, min, max) 

Readme

Keywords

none

Package Sidebar

Install

npm i @merci-michel/mm-utils-math

Weekly Downloads

1

Version

1.0.0

License

MIT

Last publish

Collaborators

  • pqml
  • nikitaskar
  • jordandelcros
  • pfer
  • gpolguere