Needle Engine 3.32.10-alpha

Changes between version 3.32.9-alpha and 3.32.10-alpha

src/engine-components/AnimationCurve.ts CHANGED Viewed

@@ -23,6 +23,22 @@
     @serializable(Keyframe)
     keys!: Array<Keyframe>;
+    clone() {
+        const curve = new AnimationCurve();
+        curve.keys = this.keys?.map(k => {
+            const key = new Keyframe();
+            key.time = k.time;
+            key.value = k.value;
+            key.inTangent = k.inTangent;
+            key.inWeight = k.inWeight;
+            key.outTangent = k.outTangent;
+            key.outWeight = k.outWeight;
+            key.weightedMode = k.weightedMode;
+            return key;
+        }) || [];
+        return curve;
+    }
     get duration(): number {
         if (!this.keys || this.keys.length == 0) return 0;
         return this.keys[this.keys.length - 1].time;
@@ -38,9 +54,9 @@
         for (let i = 0; i < this.keys.length; i++) {
             const kf = this.keys[i];
             if (kf.time <= time) {
-                const hasNextKeyframe = i+1 < this.keys.length;
+                const hasNextKeyframe = i + 1 < this.keys.length;
                 if (hasNextKeyframe) {
-                    const nextKf = this.keys[i+1];
+                    const nextKf = this.keys[i + 1];
                     // if the next
                     if (nextKf.time < time) continue;
                     // tangents are set to Infinity if interpolation is set to constant - in that case we should always return the floored value

src/engine-components/Component.ts CHANGED Viewed

@@ -552,7 +552,11 @@
     /** @internal */
     constructor() {
-        this.__internalNewInstanceCreated();
+        this.__didAwake = false;
+        this.__didStart = false;
+        this.__didEnable = false;
+        this.__isEnabled = undefined;
+        this.__destroyed = false;
     }

src/engine/engine_context.ts CHANGED Viewed

@@ -18,7 +18,7 @@
 import { getLoader } from './engine_gltf.js';
 import { Input } from './engine_input.js';
 import { invokeLifecycleFunctions } from './engine_lifecycle_functions_internal.js';
-import { type ILightDataRegistry,LightDataRegistry } from './engine_lightdata.js';
+import { type ILightDataRegistry, LightDataRegistry } from './engine_lightdata.js';
 import * as looputils from './engine_mainloop_utils.js';
 import { NetworkConnection } from './engine_networking.js';
 import { isLocalNetwork } from './engine_networking_utils.js';
@@ -30,7 +30,7 @@
 import { type CoroutineData, type GLTF, type ICamera, type IComponent, type IContext, type ILight, INeedleXRSession, type LoadedGLTF } from "./engine_types.js";
 import * as utils from "./engine_utils.js";
 import { delay, getParam } from './engine_utils.js';
-import type { INeedleXRSessionEventReceiver } from './engine_xr.js';
+import type { INeedleXRSessionEventReceiver, NeedleXRSession } from './engine_xr.js';
 const debug = utils.getParam("debugcontext");
@@ -242,8 +242,10 @@
 	}
 	get isInXR() { return this.renderer?.xr?.isPresenting || false; }
 	/** shorthand for `NeedleXRSession.active`
-	 * Automatically set by NeedleXRSession when a XR session is active */
-	xr: INeedleXRSession | null = null;
+	 * Automatically set by NeedleXRSession when a XR session is active
+	 * @returns the active XR session or null if no session is active
+	 * */
+	xr: NeedleXRSession | null = null;
 	get xrSessionMode() { return this.xr?.mode; }
 	get isInVR() { return this.xrSessionMode === "immersive-vr"; }
 	get isInAR() { return this.xrSessionMode === "immersive-ar"; }

src/engine/engine_types.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import type { Camera, Color, Material, Mesh,Object3D, Quaternion, Ray, Scene, WebGLRenderer } from "three";
+import type { Camera, Color, Material, Mesh, Object3D, Quaternion, Ray, Scene, WebGLRenderer } from "three";
 import { Vector3 } from "three";
 import { type GLTF as GLTF3 } from "three/examples/jsm/loaders/GLTFLoader.js";
@@ -6,7 +6,7 @@
 import { CollisionDetectionMode, type PhysicsMaterial, RigidbodyConstraints } from "./engine_physics.types.js";
 import { RenderTexture } from "./engine_texture.js";
 import { CircularBuffer } from "./engine_utils.js";
-import { type INeedleXRSessionEventReceiver } from "./engine_xr.js";
+import type { INeedleXRSessionEventReceiver, NeedleXRSession } from "./engine_xr.js";
 export type GLTF = GLTF3 & {
     // asset: { generator: string, version: string }
@@ -98,15 +98,7 @@
     stopAllCoroutinesFrom(script: IComponent);
 }
-export interface INeedleXRSession {
-    get running(): boolean;
-    readonly mode: XRSessionMode;
-    readonly session: XRSession;
-    get isVR();
-    get isAR();
-    get isPassThrough();
-}
+export type INeedleXRSession = NeedleXRSession;
 export declare interface INeedleEngineComponent extends HTMLElement {
     getAROverlayContainer(): HTMLElement;

src/engine/xr/NeedleXRSession.ts CHANGED Viewed

@@ -32,6 +32,7 @@
 export type NeedleXRHitTestResult = { hit: XRHitTestResult, position: Vector3, quaternion: Quaternion };
 const debug = getParam("debugwebxr");
+const debugFPS = getParam("stats");
 // TODO: move this into the IComponent interface!?
 export interface INeedleXRSessionEventReceiver extends Pick<IComponent, "destroyed"> {
@@ -765,6 +766,7 @@
         const newController = new NeedleXRController(this, newInputSource, index);
         this.controllers.push(newController);
+        this.controllers.sort((a, b) => a.index - b.index);
         this._newControllers.push(newController);
         this.invokeControllerEvent(newController, this._controllerAdded, "added");
@@ -883,7 +885,7 @@
             this.updateActiveXRRig();
         }
-        if (debug && this.rig) {
+        if ((debug || debugFPS) && this.rig) {
             const pos = this.rig.gameObject.worldPosition;
             const forward = this.rig.gameObject.worldForward;
             pos.add(forward.multiplyScalar(1.5));

@@ -1,7 +1,7 @@
 import * as THREE from "three";
-import { AxesHelper, BufferGeometry, Color, Material, Matrix4, Mesh, MeshStandardMaterial, Object3D, OneMinusDstAlphaFactor, PlaneGeometry, Quaternion, Sprite, SpriteMaterial, Vector3, Vector4 } from "three";
-import type { BatchedRenderer, Behavior, BehaviorPlugin, BillBoardSettings, BurstParameters, ColorGenerator, EmissionState, EmitSubParticleSystem, EmitterShape, FunctionColorGenerator, FunctionJSON, FunctionValueGenerator, IntervalValue, MeshSettings, Particle, ParticleEmitter, ParticleSystemParameters, PointEmitter, RecordState, RotationGenerator, SizeOverLife, TrailSettings, ValueGenerator,VFXBatchSettings } from "three.quarks";
-import { BatchedParticleRenderer, ConstantColor, ConstantValue, ParticleSystem as _ParticleSystem, RenderMode,TrailBatch, TrailParticle } from "three.quarks";
+import { AxesHelper, BackSide, BufferGeometry, Color, FrontSide, Material, Matrix4, Mesh, MeshBasicMaterial, MeshStandardMaterial, Object3D, OneMinusDstAlphaFactor, PlaneGeometry, Quaternion, Sprite, SpriteMaterial, Vector3, Vector4 } from "three";
+import type { BatchedRenderer, Behavior, BehaviorPlugin, BillBoardSettings, BurstParameters, ColorGenerator, EmissionState, EmitSubParticleSystem, EmitterShape, FunctionColorGenerator, FunctionJSON, FunctionValueGenerator, IntervalValue, MeshSettings, Particle, ParticleEmitter, ParticleSystemParameters, PointEmitter, RecordState, RotationGenerator, SizeOverLife, TrailSettings, ValueGenerator, VFXBatchSettings } from "three.quarks";
+import { BatchedParticleRenderer, ConstantColor, ConstantValue, ParticleSystem as _ParticleSystem, RenderMode, TrailBatch, TrailParticle } from "three.quarks";
 import { isDevEnvironment, showBalloonWarning } from "../engine/debug/index.js";
 import { Gizmos } from "../engine/engine_gizmos.js";
@@ -17,7 +17,7 @@
 import { NEEDLE_progressive } from "../engine/extensions/NEEDLE_progressive.js";
 import { Behaviour, GameObject } from "./Component.js";
 import { RGBAColor } from "./js-extensions/RGBAColor.js";
-import { ColorBySpeedModule, ColorOverLifetimeModule, EmissionModule, InheritVelocityModule, type IParticleSystem, LimitVelocityOverLifetimeModule, MainModule, MinMaxCurve, MinMaxGradient, NoiseModule, ParticleBurst, ParticleSystemRenderMode, ParticleSystemScalingMode,ParticleSystemShapeType, ParticleSystemSimulationSpace, RotationBySpeedModule, RotationOverLifetimeModule, ShapeModule, SizeBySpeedModule, SizeOverLifetimeModule, TextureSheetAnimationModule, TrailModule, VelocityOverLifetimeModule } from "./ParticleSystemModules.js"
+import { ColorBySpeedModule, ColorOverLifetimeModule, EmissionModule, InheritVelocityModule, type IParticleSystem, LimitVelocityOverLifetimeModule, MainModule, MinMaxCurve, MinMaxGradient, NoiseModule, ParticleBurst, ParticleSystemRenderMode, ParticleSystemScalingMode, ParticleSystemShapeType, ParticleSystemSimulationSpace, RotationBySpeedModule, RotationOverLifetimeModule, ShapeModule, SizeBySpeedModule, SizeOverLifetimeModule, TextureSheetAnimationModule, TrailModule, VelocityOverLifetimeModule } from "./ParticleSystemModules.js"
 import { ParticleSubEmitter } from "./ParticleSystemSubEmitter.js";
 const debug = getParam("debugparticles");
@@ -25,7 +25,7 @@
 const debugProgressiveLoading = getParam("debugprogressive");
-export type { Particle as QParticle,Behavior as QParticleBehaviour } from "three.quarks"
+export type { Particle as QParticle, Behavior as QParticleBehaviour } from "three.quarks"
@@ -80,23 +80,17 @@
         return res;
     }
-    private static _havePatchedQuarkShaders = false;
     getMaterial(trailEnabled: boolean = false) {
+        const material = (trailEnabled === true && this.trailMaterial) ? this.trailMaterial : this.particleMaterial;
-        if (!ParticleSystemRenderer._havePatchedQuarkShaders) {
-            ParticleSystemRenderer._havePatchedQuarkShaders = true;
-            // HACK patch three.quarks fo three152+, see https://github.com/Alchemist0823/three.quarks/issues/56#issuecomment-1560825038
-            const _rebuild = TrailBatch.prototype.rebuildMaterial;
-            TrailBatch.prototype.rebuildMaterial = function () {
-                _rebuild.call(this);
-                this.material.defines.MAP_UV = "uv";
+        if (material) {
+            if (trailEnabled) {
+                // the particle material for trails must be DoubleSide or BackSide (since otherwise the trail is invisible)
+                if (material.side === FrontSide)
+                    material.side = BackSide;
             }
         }
-        const material = (trailEnabled === true && this.trailMaterial) ? this.trailMaterial : this.particleMaterial;
         // progressive load on start
         // TODO: figure out how to do this before particle system rendering so we only load textures for visible materials
         if (material && !suppressProgressiveLoading && material["_didRequestTextureLOD"] === undefined) {
@@ -397,7 +391,7 @@
                 let size = particle.size;
                 if (size <= 0 && !this.system.trails.sizeAffectsWidth) {
                     // Not sure where we get to 100* from, tested in SOC trong com
-                    size = 100 * this.system.trails.widthOverTrail.evaluate(.5, trailParticle[$trailWidthRandom]);
+                    size = 20 * this.system.trails.widthOverTrail.evaluate(.5, trailParticle[$trailWidthRandom]);
                 }
                 state.size = this.system.trails.getWidth(size, age01, pos01, trailParticle[$trailWidthRandom]);
                 state.color.copy(particle.color);
@@ -429,8 +423,7 @@
     initialize(particle: Particle): void {
         const simulationSpeed = this.system.main.simulationSpeed;
-        const factor = 1;
-        particle.startSpeed = this.system.main.startSpeed.evaluate(Math.random(), Math.random()) * factor;
+        particle.startSpeed = this.system.main.startSpeed.evaluate(Math.random(), Math.random());
         particle.velocity.copy(this.system.shape.getDirection(particle.position)).multiplyScalar(particle.startSpeed);
         if (this.system.inheritVelocity?.enabled) {
             this.system.inheritVelocity.applyInitial(particle.velocity);
@@ -615,8 +608,7 @@
         if (mat && mat["map"]) {
             const original = mat["map"]! as THREE.Texture;
             // cache the last original one so we're not creating tons of clones
-            if (this.clonedTexture.original !== original || !this.clonedTexture.clone)
-            {
+            if (this.clonedTexture.original !== original || !this.clonedTexture.clone) {
                 const tex = original.clone();
                 tex.premultiplyAlpha = false;
                 tex.colorSpace = THREE.LinearSRGBColorSpace;
@@ -755,7 +747,7 @@
     readonly limitVelocityOverLifetime!: LimitVelocityOverLifetimeModule;
     @serializable(InheritVelocityModule)
-    readonly inheritVelocity!: InheritVelocityModule;
+    inheritVelocity!: InheritVelocityModule;
     @serializable(ColorBySpeedModule)
     readonly colorBySpeed!: ColorBySpeedModule;
@@ -934,6 +926,8 @@
     }
     awake(): void {
+        this._worldPositionFrame = -1;
         this._renderer = this.gameObject.getComponent(ParticleSystemRenderer) as ParticleSystemRenderer;
         if (!this.main) {
@@ -967,9 +961,12 @@
         const emitter = this._particleSystem.emitter;
         this.context.scene.add(emitter);
-        this.inheritVelocity?.awake();
-        this.inheritVelocity.system = this;
+        if (this.inheritVelocity.system && this.inheritVelocity.system !== this) {
+            this.inheritVelocity = this.inheritVelocity.clone();
+        }
+        this.inheritVelocity.awake(this);
         if (debug) {
             console.log(this);
             this.gameObject.add(new AxesHelper(1))
@@ -1113,7 +1110,6 @@
         this.shape.update(this, this.context, this.main.simulationSpace, this.gameObject);
         this.noise.update(this.context);
-        this.inheritVelocity.system = this;
         this.inheritVelocity?.update(this.context);
         this.velocityOverLifetime.update(this);
     }

src/engine-components/ParticleSystemModules.ts CHANGED Viewed

@@ -180,6 +180,19 @@
     @serializable()
     curveMultiplier?: number;
+    clone() {
+        const clone = new MinMaxCurve();
+        clone.mode = this.mode;
+        clone.constant = this.constant;
+        clone.constantMin = this.constantMin;
+        clone.constantMax = this.constantMax;
+        clone.curve = this.curve?.clone();
+        clone.curveMin = this.curveMin?.clone();
+        clone.curveMax = this.curveMax?.clone();
+        clone.curveMultiplier = this.curveMultiplier;
+        return clone;
+    }
     evaluate(t01: number, lerpFactor?: number): number {
         const t = lerpFactor === undefined ? Math.random() : lerpFactor;
         switch (this.mode) {
@@ -600,6 +613,7 @@
     }
     getPosition(): void {
         this._vector.set(0, 0, 0);
         const pos = this._temp.copy(this.position);
         const isWorldSpace = this._space === ParticleSystemSimulationSpace.World;
         if (isWorldSpace) {
@@ -742,7 +756,7 @@
         vec.z = z;
     }
-    private randomCirclePoint(pos:Vec3, radius:number, thickness:number, arg:number, vec:Vec3){
+    private randomCirclePoint(pos: Vec3, radius: number, thickness: number, arg: number, vec: Vec3) {
         const u = Math.random();
         const theta = 2 * Math.PI * u * (arg / 360);
         const r = Mathf.lerp(1, 1 - (Math.pow(1 - Math.random(), Math.PI)), thickness) * (radius);
@@ -973,7 +987,7 @@
     @serializable()
     worldSpace: boolean = false;
-    getWidth(size: number, _life01: number, pos01: number, t : number) {
+    getWidth(size: number, _life01: number, pos01: number, t: number) {
         const res = this.widthOverTrail.evaluate(pos01, t);
         size *= res;
         return size;
@@ -1385,29 +1399,54 @@
     @serializable()
     mode!: ParticleSystemInheritVelocityMode;
+    clone() {
+        const ni = new InheritVelocityModule();
+        ni.enabled = this.enabled;
+        ni.curve = this.curve?.clone();
+        ni.curveMultiplier = this.curveMultiplier;
+        ni.mode = this.mode;
+        return ni;
+    }
     system!: IParticleSystem;
-    private _lastWorldPosition: Vector3 | null = null;
-    private _velocity: Vector3 = new Vector3();
-    private _temp: Vector3 = new Vector3();
+    private get _lastWorldPosition() {
+        if (!this.system['_iv_lastWorldPosition']) {
+            this.system['_iv_lastWorldPosition'] = new Vector3();
+        }
+        return this.system['_iv_lastWorldPosition'];
+    }
+    private get _velocity() {
+        if (!this.system['_iv_velocity']) {
+            this.system['_iv_velocity'] = new Vector3();
+        }
+        return this.system['_iv_velocity'];
+    }
-    awake() {
-        this._lastWorldPosition = null!;
-        this._velocity = new Vector3();
-        this._temp = new Vector3();
+    private readonly _temp: Vector3 = new Vector3();
+    private _firstUpdate: boolean = true;
+    awake(system: IParticleSystem) {
+        this.system = system;
+        this.reset();
     }
-    update (_context: Context) {
+    reset() {
+        this._firstUpdate = true;
+    }
+    update(_context: Context) {
         if (!this.enabled) return;
         if (this.system.worldspace === false) return;
-        if (this._lastWorldPosition) {
+        if (this._firstUpdate) {
+            this._firstUpdate = false;
+            this._velocity.set(0, 0, 0);
+            this._lastWorldPosition.copy(this.system.worldPos);
+        }
+        else if (this._lastWorldPosition) {
             this._velocity.copy(this.system.worldPos).sub(this._lastWorldPosition).multiplyScalar(1 / this.system.deltaTime);
             this._lastWorldPosition.copy(this.system.worldPos);
         }
-        else {
-            this._velocity.set(0, 0, 0);
-            this._lastWorldPosition = this.system.worldPos.clone();
-        }
     }
     // TODO: make work for subsystems
@@ -1421,8 +1460,10 @@
         }
     }
+    private _frames = 0;
     applyCurrent(vel: Vector3, t01: number, lerpFactor: number) {
         if (!this.enabled) return;
+        if (!this.system) return;
         if (this.system.worldspace === false) return;
         if (this.mode === ParticleSystemInheritVelocityMode.Current) {
             const factor = this.curve.evaluate(t01, lerpFactor);

src/engine-components/export/usdz/USDZExporter.ts CHANGED Viewed

@@ -403,7 +403,7 @@
         const scale = 1 / sessionRoot!.arScale;
         if (debug) console.log("AR Session Root scale", scale, target);
         target.matrix.makeScale(scale, scale, scale);
-        if (sessionRoot.invertForward) {
+        if (sessionRoot.invertForward == false) {
             target.matrix.multiply(new Matrix4().makeRotationY(Math.PI));
         }
     }

src/engine-components/webxr/WebARSessionRoot.ts CHANGED Viewed

@@ -36,7 +36,7 @@
     }
     private _arScale: number = 1;
-    /** When enabled the scene will be rotated by 180° in the Y axes */
+    /** When enabled the placed scene forward direction will towards the XRRig */
     @serializable()
     invertForward: boolean = false;
@@ -357,7 +357,7 @@
             rigObject.updateMatrix();
             // if invert forward is disabled we need to invert the forward rotation
             // we want to look into positive Z direction (if invertForward is enabled we look into negative Z direction)
-            if (!this.invertForward)
+            if (this.invertForward == false)
                 rigObject.matrix.premultiply(invertForwardMatrix);
             rigObject.matrix.premultiply(this._startOffset);

src/engine-components/webxr/WebXR.ts CHANGED Viewed

@@ -75,8 +75,8 @@
     onEnable(): void {
         if (this.useQuicklookExport) {
-            this._usdzExporter = GameObject.findObjectOfType(USDZExporter) || undefined;
-            if (!this._usdzExporter) {
+            const existingUSDZExporter = GameObject.findObjectOfType(USDZExporter);
+            if (!existingUSDZExporter) {
                 // if no USDZ Exporter is found we add one and assign the scene to be exported
                 if (debug) console.log("WebXR: Adding USDZExporter");
                 this._usdzExporter = GameObject.addNewComponent(this.gameObject, USDZExporter);
@@ -106,6 +106,7 @@
     onDisable(): void {
         // remove the container automatically if it was added to the shadow root
         this._container?.remove();
+        this._usdzExporter?.destroy();
     }
     private async handleOfferSession() {

src/engine-components/webxr/controllers/XRControllerFollow.ts CHANGED Viewed

@@ -29,6 +29,9 @@
      */
     controlVisibility: boolean = true;
+    /** when true it will use the grip space, otherwise the ray space */
+    useGripSpace = false;
     onUpdateXR(args: NeedleXREventArgs): void {
         // try to get the controller
@@ -49,8 +52,14 @@
             // we're following a controller (or hand)
             if (this.controlVisibility)
                 this.gameObject.visible = true;
-            this.gameObject.worldPosition = ctrl.gripWorldPosition;
-            this.gameObject.worldQuaternion = ctrl.gripWorldQuaternion;
+            if (this.useGripSpace) {
+                this.gameObject.worldPosition = ctrl.gripWorldPosition;
+                this.gameObject.worldQuaternion = ctrl.gripWorldQuaternion;
+            }
+            else {
+                this.gameObject.worldPosition = ctrl.rayWorldPosition;
+                this.gameObject.worldQuaternion = ctrl.rayWorldQuaternion;
+            }
         }
     }