kite3d/io.github.yuroyami.kite3d.math/MathUtils

MathUtils

A collection of math utility functions.

Ported from three.js MathUtils. Modelled as a Kotlin object so that ported three.js code keeps calling MathUtils.clamp(...) etc. verbatim.

Properties

DEG2RAD

const val DEG2RAD: Double

Multiply by this to convert degrees to radians.

RAD2DEG

const val RAD2DEG: Double

Multiply by this to convert radians to degrees.

Functions

ceilPowerOfTwo

fun ceilPowerOfTwo(value: Double): Double

Returns the smallest power of two greater than or equal to value (which must be greater than 0).

clamp

fun clamp(value: Double, minVal: Double, maxVal: Double): Double

Clamps value between minVal and maxVal.

damp

fun damp(x: Double, y: Double, lambda: Double, dt: Double): Double

Frame-rate-independent damping: smoothly moves x toward y using lambda and delta time dt in seconds.

degToRad

fun degToRad(degrees: Double): Double

Converts degrees to radians.

denormalize

fun denormalize(value: Double, type: ComponentType): Double

Denormalizes value according to the component storage type.

euclideanModulo

fun euclideanModulo(n: Double, m: Double): Double

Computes the Euclidean modulo ((n % m) + m) % m.

floorPowerOfTwo

fun floorPowerOfTwo(value: Double): Double

Returns the largest power of two less than or equal to value (which must be greater than 0).

generateUUID

fun generateUUID(): String

Generates a UUID.

inverseLerp

fun inverseLerp(x: Double, y: Double, value: Double): Double

Returns the fraction in [0, 1] that value represents between x and y. Returns 0 when x == y (rather than NaN).

isPowerOfTwo

fun isPowerOfTwo(value: Int): Boolean

Returns true if value is a power of two.

lerp

fun lerp(x: Double, y: Double, t: Double): Double

Linearly interpolates between x and y by t; t = 0 returns x, t = 1 returns y.

mapLinear

fun mapLinear(x: Double, a1: Double, a2: Double, b1: Double, b2: Double): Double

Linearly maps x from range [a1, a2] to range [b1, b2].

normalize

fun normalize(value: Double, type: ComponentType): Double

Normalizes value (in [0, 1] for unsigned, [-1, 1] for signed) according to the component storage type.

pingpong

fun pingpong(x: Double, length: Double = 1.0): Double

Returns a value that alternates ("ping-pongs") between 0 and length.

radToDeg

fun radToDeg(radians: Double): Double

Converts radians to degrees.

randFloat

fun randFloat(low: Double, high: Double): Double

Returns a random float in the interval [low, high).

randFloatSpread

fun randFloatSpread(range: Double): Double

Returns a random float in the interval (-range/2, range/2).

randInt

fun randInt(low: Int, high: Int): Int

Returns a random integer in the closed interval [low, high].

seededRandom

fun seededRandom(s: Int? = null): Double

Returns a deterministic pseudo-random float in [0, 1) (Mulberry32).

setQuaternionFromProperEuler

fun setQuaternionFromProperEuler(q: Quaternion, a: Double, b: Double, c: Double, order: ProperEulerOrder)

Sets the given quaternion q from the Intrinsic Proper Euler Angles defined by a, b, c and order.

smootherstep

fun smootherstep(x: Double, minVal: Double, maxVal: Double): Double

Smootherstep: a variation on smoothstep with zero 1st and 2nd derivatives at both ends.

smoothstep

fun smoothstep(x: Double, minVal: Double, maxVal: Double): Double

Smoothstep: a value in [0, 1] for x between minVal and maxVal, eased at both ends.