@needle-tools/engine
Version:
Needle Engine is a web-based runtime for 3D apps. It runs on your machine for development with great integrations into editors like Unity or Blender - and can be deployed onto any device! It is flexible, extensible and networking and XR are built-in.
283 lines (245 loc) • 8.73 kB
text/typescript
import type { Quaternion, Vector2, Vector3, Vector4 } from "three";
import type { Vec3 } from "./engine_types.js";
declare type Vector = Vector3 | Vector4 | Vector2 | Quaternion;
class MathHelper {
random<T>(arr: Array<T>): T | null;
random(min?: number, max?: number): number;
random<T>(arrayOrMin?: number | Array<T>, max?: number): number | T | null {
if (Array.isArray(arrayOrMin)) {
if(arrayOrMin.length <= 0) return null;
return arrayOrMin[Math.floor(Math.random() * arrayOrMin.length)];
}
else {
if (arrayOrMin !== undefined && max !== undefined) {
return Math.random() * (max - arrayOrMin) + arrayOrMin;
}
}
return Math.random();
}
randomVector3(target: Vector3, min: number = 0, max: number = 1) {
target.x = this.random(min, max);
target.y = this.random(min, max);
target.z = this.random(min, max);
}
clamp(value: number, min: number, max: number) {
if (value < min) {
return min;
}
else if (value > max) {
return max;
}
return value;
}
clamp01(value: number) {
return this.clamp(value, 0, 1);
}
/**
* Linear interpolate
*/
lerp(value1: number, value2: number, t: number) {
t = t < 0 ? 0 : t;
t = t > 1 ? 1 : t;
return value1 + (value2 - value1) * t;
}
/**
*
*/
inverseLerp(value1: number, value2: number, t: number) {
return (t - value1) / (value2 - value1);
}
/**
* Remaps a value from one range to another.
* @param value The value to remap.
* @param min1 The minimum value of the current range.
* @param max1 The maximum value of the current range.
* @param min2 The minimum value of the target range.
* @param max2 The maximum value of the target range.
*/
remap(value: number, min1: number, max1: number, min2: number, max2: number) {
return min2 + (max2 - min2) * (value - min1) / (max1 - min1);
}
moveTowards(value1: number, value2: number, amount: number) {
value1 += amount;
if (amount < 0 && value1 < value2) value1 = value2;
else if (amount > 0 && value1 > value2) value1 = value2;
return value1;
}
readonly Rad2Deg = 180 / Math.PI;
readonly Deg2Rad = Math.PI / 180;
readonly Epsilon = 0.00001;
/**
* Converts radians to degrees
*/
toDegrees(radians: number) {
return radians * 180 / Math.PI;
}
/**
* Converts degrees to radians
*/
toRadians(degrees: number) {
return degrees * Math.PI / 180;
}
tan(radians: number) {
return Math.tan(radians);
}
gammaToLinear(gamma: number) {
return Math.pow(gamma, 2.2);
}
linearToGamma(linear: number) {
return Math.pow(linear, 1 / 2.2);
}
approximately(v1: Vector, v2: Vector, epsilon = Number.EPSILON) {
for (const key of vectorKeys) {
const a = v1[key];
const b = v2[key];
if (a === undefined || b === undefined) break;
const diff = Math.abs(a - b);
if (diff > epsilon) {
return false;
}
}
return true;
}
easeInOutCubic(x: number) {
return x < 0.5 ? 4 * x * x * x : 1 - Math.pow(-2 * x + 2, 3) / 2;
}
};
const vectorKeys = ["x", "y", "z", "w"]
export const Mathf = new MathHelper();
class LowPassFilter {
y: number | null;
s: number | null;
alpha = 0;
constructor(alpha: number) {
this.setAlpha(alpha);
this.y = null;
this.s = null;
}
setAlpha(alpha: number) {
if (alpha <= 0 || alpha > 1.0) {
throw new Error();
}
this.alpha = alpha;
}
filter(value: number, alpha: number) {
if (alpha) {
this.setAlpha(alpha);
}
let s: number;
if (!this.y) {
s = value;
} else {
s = this.alpha * value + (1.0 - this.alpha) * this.s!;
}
this.y = value;
this.s = s;
return s;
}
lastValue() {
return this.y;
}
reset(value: number) {
this.y = value;
this.s = value;
}
}
/**
* OneEuroFilter is a simple low-pass filter for noisy signals. It uses a one-euro filter to smooth the signal.
*/
export class OneEuroFilter {
/**
* An estimate of the frequency in Hz of the signal (> 0), if timestamps are not available.
*/
freq: number;
/**
* Min cutoff frequency in Hz (> 0). Lower values allow to remove more jitter.
*/
minCutOff: number;
/**
* Parameter to reduce latency (> 0). Higher values make the filter react faster to changes.
*/
beta: number;
/**
* Used to filter the derivates. 1 Hz by default. Change this parameter if you know what you are doing.
*/
dCutOff: number;
/**
* The low-pass filter for the signal.
*/
x: LowPassFilter;
/**
* The low-pass filter for the derivates.
*/
dx: LowPassFilter;
/**
* The last time the filter was called.
*/
lasttime: number | null;
/** Create a new OneEuroFilter
* @param freq - An estimate of the frequency in Hz of the signal (> 0), if timestamps are not available.
* @param minCutOff - Min cutoff frequency in Hz (> 0). Lower values allow to remove more jitter.
* @param beta - Parameter to reduce latency (> 0). Higher values make the filter react faster to changes.
* @param dCutOff - Used to filter the derivates. 1 Hz by default. Change this parameter if you know what you are doing.
*/
constructor(freq: number, minCutOff = 1.0, beta = 0.0, dCutOff = 1.0) {
if (freq <= 0 || minCutOff <= 0 || dCutOff <= 0) {
throw new Error();
}
this.freq = freq;
this.minCutOff = minCutOff;
this.beta = beta;
this.dCutOff = dCutOff;
this.x = new LowPassFilter(this.alpha(this.minCutOff));
this.dx = new LowPassFilter(this.alpha(this.dCutOff));
this.lasttime = null;
}
alpha(cutOff: number) {
const te = 1.0 / this.freq;
const tau = 1.0 / (2 * Math.PI * cutOff);
return 1.0 / (1.0 + tau / te);
}
/** Filter your value: call with your value and the current timestamp (e.g. from this.context.time.time) */
filter(x: number, time: number | null = null) {
if (this.lasttime && time) {
this.freq = 1.0 / (time - this.lasttime);
}
this.lasttime = time;
const prevX = this.x.lastValue();
const dx = !prevX ? 0.0 : (x - prevX) * this.freq;
const edx = this.dx.filter(dx, this.alpha(this.dCutOff));
const cutOff = this.minCutOff + this.beta * Math.abs(edx);
return this.x.filter(x, this.alpha(cutOff));
}
reset(x?: number) {
if (x != undefined) this.x.reset(x);
this.x.alpha = this.alpha(this.minCutOff);
this.dx.alpha = this.alpha(this.dCutOff);
this.lasttime = null;
}
}
export class OneEuroFilterXYZ {
readonly x: OneEuroFilter;
readonly y: OneEuroFilter;
readonly z: OneEuroFilter;
/** Create a new OneEuroFilter
* @param freq - An estimate of the frequency in Hz of the signal (> 0), if timestamps are not available.
* @param minCutOff - Min cutoff frequency in Hz (> 0). Lower values allow to remove more jitter.
* @param beta - Parameter to reduce latency (> 0). Higher values make the filter react faster to changes.
* @param dCutOff - Used to filter the derivates. 1 Hz by default. Change this parameter if you know what you are doing.
*/
constructor(freq: number, minCutOff = 1.0, beta = 0.0, dCutOff = 1.0) {
this.x = new OneEuroFilter(freq, minCutOff, beta, dCutOff);
this.y = new OneEuroFilter(freq, minCutOff, beta, dCutOff);
this.z = new OneEuroFilter(freq, minCutOff, beta, dCutOff);
}
filter(value: Vec3, target: Vec3, time: number | null = null) {
target.x = this.x.filter(value.x, time);
target.y = this.y.filter(value.y, time);
target.z = this.z.filter(value.z, time);
}
reset(value?: Vec3) {
this.x.reset(value?.x);
this.y.reset(value?.y);
this.z.reset(value?.z);
}
}