@needle-tools/engine 2.40.0-pre → 2.42.0-pre

package/CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.42.0-pre] - 2022-11-09
+- add ``Graphics.copyTexture``
+- add ``Renderer.allowProgressiveLoad``
+- add ``Gizmos.DrawBox`` and ``DrawBox3``
+- add particles burst emission
+- add particles color interpolation between two gradients
+- fix: reflection probe material caching for when material is being changed at certain times outside of animation loop and cache applied wrong material
+- fix: AnimationCurve evaluation when time and keyframe are both exactly 0
+- change: reflection probe now requires anchor override
+- change: bump threejs dependency 
+
+## [2.41.0-pre] - 2022-11-07
+- Add: start adding particle systems support again
+- Change: update dependency version to needle gltf-transform-extensions package
+- Change: light set to soft shadows now changes renderer shadow mode to ``VSMShadowMap`` (can be disabled by setting ``Light.allowChangingShadowMapType`` to false)
+- Fix: WebXR creating AR button when called from script in awake 
+- Fix: ``AnimationCurve.evaluate``
+
 ## [2.40.0-pre] - 2022-11-05
 - Add support for deleting all room state by calling ``context.connection.sendDeleteRemoteStateAll()`` (requires backend to update ``@needle-tools/needle-tiny-networking-ws`` to ``^1.1.0-pre``)
 - Add Hinge joint

package/dist/needle-engine.d.ts

@@ -1,12 +1,15 @@
 declare module "engine/engine_math" {
     class MathHelper {
         random(): number;
-        clamp(value: any, min: any, max: any): any;
-        clamp01(value: any): any;
-        lerp(value1: any, value2: any, amount: any): any;
-        moveTowards(value1: any, value2: any, amount: any): any;
-        toDegrees(radians: any): number;
-        toRadians(degrees: any): number;
+        clamp(value: number, min: number, max: number): number;
+        clamp01(value: number): number;
+        lerp(value1: number, value2: number, amount: number): number;
+        remap(value: number, min1: number, max1: number, min2: number, max2: number): number;
+        moveTowards(value1: number, value2: number, amount: number): number;
+        toDegrees(radians: number): number;
+        toRadians(degrees: number): number;
+        gammaToLinear(gamma: number): number;
+        linearToGamma(linear: number): number;
     }
     const Mathf: MathHelper;
     export { Mathf };
@@ -50,7 +53,7 @@ declare module "engine/engine_physics.types" {
 }
 declare module "engine/engine_three_utils" {
     import * as THREE from "three";
-    import { Vector3 } from "three";
+    import { Vector3, Texture, ShaderMaterial } from "three";
     export function lookAtInverse(obj: THREE.Object3D, target: Vector3): void;
     export function getWorldPosition(obj: THREE.Object3D, vec?: THREE.Vector3 | null, updateParents?: boolean): THREE.Vector3;
     export function setWorldPosition(obj: THREE.Object3D, val: THREE.Vector3): void;
@@ -67,7 +70,22 @@ declare module "engine/engine_three_utils" {
     export function setWorldRotation(obj: THREE.Object3D, val: THREE.Vector3): void;
     export function setWorldRotationXYZ(obj: THREE.Object3D, x: number, y: number, z: number, degrees?: boolean): void;
     export function logHierarchy(root: THREE.Object3D | null | undefined, collapsible?: boolean): void;
+    export class Graphics {
+        private static planeGeometry;
+        private static renderer;
+        private static perspectiveCam;
+        private static scene;
+        private static readonly vertex;
+        private static readonly fragment;
+        private static readonly blipMaterial;
+        static createBlitMaterial(fragment: string): ShaderMaterial;
+        private static readonly mesh;
+        static copyTexture(texture: Texture, blitMaterial?: ShaderMaterial): THREE.Texture;
+        static textureToCanvas(texture: Texture, force: boolean): HTMLCanvasElement | null;
+    }
+    /**@obsolete use Graphics.copyTexture */
     export function copyTexture(texture: THREE.Texture): THREE.Texture;
+    /**@obsolete use Graphics.textureToCanvas */
     export function textureToCanvas(texture: THREE.Texture, force?: boolean): HTMLCanvasElement | null;
 }
 declare module "engine/engine_types" {
@@ -191,6 +209,12 @@ declare module "engine/engine_types" {
         y: number;
         z: number;
     };
+    export type Vec4 = {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
     export class ContactPoint {
         private readonly _point;
         private readonly _normal;
@@ -261,6 +285,7 @@ declare module "engine/engine_utils" {
         revoke(): void;
         dispose(): void;
     }
+    export function isMobileDevice(): boolean;
 }
 declare module "engine/extensions/extension_resolver" {
     import { GLTFParser } from "three/examples/jsm/loaders/GLTFLoader";
@@ -762,6 +787,21 @@ declare module "engine/engine_gameobject" {
     export function foreachComponent(instance: THREE.Object3D, cb: (comp: Component) => any, recursive?: boolean): any;
     export function instantiate(instance: GameObject | Object3D | null, opts?: InstantiateOptions | null): GameObject | null;
 }
+declare module "engine/engine_gizmos" {
+    import * as THREE from 'three';
+    import { ColorRepresentation, Box3 } from 'three';
+    import { Vec3, Vec4 } from "engine/engine_types";
+    export class Gizmos {
+        static DrawRay(origin: Vec3, dir: Vec3, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
+        static DrawDirection(pt: Vec3, direction: Vec3 | Vec4, color?: ColorRepresentation, duration?: number, depthTest?: boolean, lengthFactor?: number): void;
+        static DrawLine(pt0: Vec3, pt1: Vec3, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
+        static DrawWireSphere(center: Vec3, radius: number, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
+        static DrawSphere(center: Vec3, radius: number, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
+        static DrawBox(center: Vec3, size: Vec3, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
+        static DrawBox3(box: Box3, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
+    }
+    export function CreateWireCube(col?: THREE.ColorRepresentation | null): THREE.LineSegments;
+}
 declare module "engine/engine_physics" {
     import { Camera, Intersection, Layers, Mesh, Object3D, Ray, Raycaster, Vector2, Vector3 } from 'three';
     import { Context } from "engine/engine_setup";
@@ -1791,6 +1831,9 @@ declare module "engine/engine_setup" {
         get isInAR(): boolean;
         get xrSession(): THREE.XRSession | null;
         get arOverlayElement(): HTMLElement;
+        /** Current event of the update cycle */
+        get currentFrameEvent(): FrameEvent;
+        private _currentFrameEvent;
         scene: THREE.Scene;
         renderer: THREE.WebGLRenderer;
         composer: EffectComposer | null;
@@ -2434,34 +2477,6 @@ declare module "engine/engine_util_decorator" {
     /** create accessor callbacks for a field */
     export const validate: (set?: setter, get?: getter) => (target: IComponent | any, propertyKey: string, descriptor?: undefined) => void;
 }
-declare module "engine/engine_gizmos" {
-    import * as THREE from 'three';
-    import { ColorRepresentation } from 'three';
-    import { Vec3 } from "engine/engine_types";
-    export class Gizmos {
-        static DrawRay(origin: Vec3, dir: Vec3, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
-        static DrawLine(pt0: {
-            x: number;
-            y: number;
-            z: number;
-        }, pt1: {
-            x: number;
-            y: number;
-            z: number;
-        }, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
-        static DrawWireSphere(center: {
-            x: number;
-            y: number;
-            z: number;
-        }, radius: number, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
-        static DrawSphere(center: {
-            x: number;
-            y: number;
-            z: number;
-        }, radius: number, color?: ColorRepresentation, duration?: number, depthTest?: boolean): void;
-    }
-    export function CreateWireCube(col?: THREE.ColorRepresentation | null): THREE.LineSegments;
-}
 declare module "engine/api" {
     export { InstancingUtil } from "engine/engine_instancing";
     export * from "engine/engine_gameobject";
@@ -3466,6 +3481,7 @@ declare module "engine-components/Renderer" {
         get lightmap(): Texture | null;
         set lightmap(tex: Texture | null | undefined);
         get hasLightmap(): boolean;
+        allowProgressiveLoading: boolean;
         awake(): void;
         private _isInstancingEnabled;
         private handles;
@@ -4088,6 +4104,8 @@ declare module "engine-components/Light" {
         private onWebXREnded;
         createLight(): void;
         updateMainLightRoutine(): Generator<undefined, void, unknown>;
+        static allowChangingRendererShadowMapType: boolean;
+        private updateShadowSoftHard;
         private setDirectionalLight;
     }
 }
@@ -4151,62 +4169,212 @@ declare module "engine-components/OffsetConstraint" {
 }
 declare module "engine-components/ParticleSystemModules" {
     import * as THREE from "three";
+    import { Object3D, Vector3 } from "three";
+    import { RGBAColor } from "engine-components/js-extensions/RGBAColor";
+    import { AnimationCurve } from "engine-components/AnimationCurve";
+    import { Vec3 } from "engine/engine_types";
+    type Color4 = {
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    };
+    type ColorKey = {
+        time: number;
+        color: Color4;
+    };
+    type AlphaKey = {
+        time: number;
+        alpha: number;
+    };
+    export interface IParticleSystem {
+        get currentParticles(): number;
+        get maxParticles(): number;
+        get time(): number;
+        get duration(): number;
+        readonly main: MainModule;
+    }
+    export enum ParticleSystemRenderMode {
+        Billboard = 0,
+        Mesh = 4
+    }
+    export class Gradient {
+        alphaKeys: Array<AlphaKey>;
+        colorKeys: Array<ColorKey>;
+        get duration(): number;
+        evaluate(time: number, target: RGBAColor): RGBAColor;
+    }
+    export enum ParticleSystemCurveMode {
+        Constant = 0,
+        Curve = 1,
+        TwoCurves = 2,
+        TwoConstants = 3
+    }
+    export enum ParticleSystemGradientMode {
+        Color = 0,
+        Gradient = 1,
+        TwoColors = 2,
+        TwoGradients = 3,
+        RandomColor = 4
+    }
+    export enum ParticleSystemSimulationSpace {
+        Local = 0,
+        World = 1,
+        Custom = 2
+    }
+    export enum ParticleSystemShapeType {
+        Sphere = 0,
+        SphereShell = 1,
+        Hemisphere = 2,
+        HemisphereShell = 3,
+        Cone = 4,
+        Box = 5,
+        Mesh = 6,
+        ConeShell = 7,
+        ConeVolume = 8,
+        ConeVolumeShell = 9,
+        Circle = 10,
+        CircleEdge = 11,
+        SingleSidedEdge = 12,
+        MeshRenderer = 13,
+        SkinnedMeshRenderer = 14,
+        BoxShell = 15,
+        BoxEdge = 16,
+        Donut = 17,
+        Rectangle = 18,
+        Sprite = 19,
+        SpriteRenderer = 20
+    }
+    export class MinMaxCurve {
+        mode: ParticleSystemCurveMode;
+        constant: number;
+        constantMin: number;
+        constantMax: number;
+        curve?: AnimationCurve;
+        curveMin?: AnimationCurve;
+        curveMax?: AnimationCurve;
+        curveMultiplier?: number;
+        evaluate(t01: number, lerpFactor?: number): number;
+    }
+    export class MinMaxGradient {
+        mode: ParticleSystemGradientMode;
+        color: RGBAColor;
+        colorMin: RGBAColor;
+        colorMax: RGBAColor;
+        gradient: Gradient;
+        gradientMin: Gradient;
+        gradientMax: Gradient;
+        private static _temp;
+        private static _temp2;
+        evaluate(t01: number, lerpFactor?: number): RGBAColor;
+    }
+    type ParticleSystemScalingMode = {
+        Hierarchy: number;
+        Local: number;
+        Shape: number;
+    };
     export class MainModule {
-        randomizeRotationDirection: number;
+        cullingMode: number;
         duration: number;
+        emitterVelocityMode: number;
+        flipRotation: number;
+        gravityModifier: MinMaxCurve;
+        gravityModifierMultiplier: number;
         loop: boolean;
+        maxParticles: number;
+        playOnAwake: boolean;
         prewarm: boolean;
-        startDelay: undefined;
+        ringBufferLoopRange: {
+            x: number;
+            y: number;
+        };
+        ringBufferMode: boolean;
+        scalingMode: ParticleSystemScalingMode;
+        simulationSpace: ParticleSystemSimulationSpace;
+        simulationSpeed: number;
+        startColor: MinMaxGradient;
+        startDelay: MinMaxCurve;
         startDelayMultiplier: number;
-        startLifetime: undefined;
+        startLifetime: MinMaxCurve;
         startLifetimeMultiplier: number;
-        startSpeed: undefined;
-        startSpeedMultiplier: number;
+        startRotation: MinMaxCurve;
+        startRotationMultiplier: number;
+        startRotation3D: boolean;
+        startRotationX: MinMaxCurve;
+        startRotationXMultiplier: number;
+        startRotationY: MinMaxCurve;
+        startRotationYMultiplier: number;
+        startRotationZ: MinMaxCurve;
+        startRotationZMultiplier: number;
+        startSize: MinMaxCurve;
         startSize3D: boolean;
-        startSize: undefined;
         startSizeMultiplier: number;
-        startSizeX: undefined;
+        startSizeX: MinMaxCurve;
         startSizeXMultiplier: number;
-        startSizeY: undefined;
+        startSizeY: MinMaxCurve;
         startSizeYMultiplier: number;
-        startSizeZ: undefined;
+        startSizeZ: MinMaxCurve;
         startSizeZMultiplier: number;
-        startRotation3D: boolean;
-        startRotation: undefined;
-        startRotationMultiplier: number;
-        startRotationX: undefined;
-        startRotationXMultiplier: number;
-        startRotationY: undefined;
-        startRotationYMultiplier: number;
-        startRotationZ: undefined;
-        startRotationZMultiplier: number;
-        flipRotation: number;
-        startColor: THREE.Color;
-        startColor1: THREE.Color | undefined;
-        gravityModifier: undefined;
-        gravityModifierMultiplier: number;
-        simulationSpace: number;
-        customSimulationSpace: null;
-        simulationSpeed: number;
-        useUnscaledTime: boolean;
-        scalingMode: number;
-        playOnAwake: boolean;
-        maxParticles: number;
-        emitterVelocityMode: number;
+        startSpeed: MinMaxCurve;
+        startSpeedMultiplier: number;
         stopAction: number;
-        ringBufferMode: number;
-        ringBufferLoopRange: THREE.Vector2;
-        cullingMode: number;
+        useUnscaledTime: boolean;
+    }
+    export class ParticleBurst {
+        cycleCount: number;
+        maxCount: number;
+        minCount: number;
+        probability: number;
+        repeatInterval: number;
+        time: number;
+        count: {
+            constant: number;
+            constantMax: number;
+            constantMin: number;
+            curve?: AnimationCurve;
+            curveMax?: AnimationCurve;
+            curveMin?: AnimationCurve;
+            curveMultiplier?: number;
+            mode: ParticleSystemCurveMode;
+        };
+        private _performed;
+        reset(): void;
+        run(time: number): number;
     }
     export class EmissionModule {
-        burstCount: number;
         enabled: boolean;
-        rate: number;
-        rateMutliplier: number;
-        rateOverDistance: number;
-        rateOverDistanceMultiplier: number;
-        rateOverTime: number;
+        get burstCount(): number;
+        bursts: ParticleBurst[];
+        rateOverTime: MinMaxCurve;
         rateOverTimeMultiplier: number;
+        rateOverDistance: MinMaxCurve;
+        rateOverDistanceMultiplier: number;
+        /** set from system */
+        system: IParticleSystem;
+        get time(): number;
+        private _summed;
+        /** called by nebula */
+        init(): void;
+        /** called by nebula */
+        getValue(deltaTime: number): number;
+    }
+    export class ColorOverLifetimeModule {
+        enabled: boolean;
+        color: MinMaxGradient;
+    }
+    export class SizeOverLifetimeModule {
+        enabled: boolean;
+        separateAxes: boolean;
+        size: MinMaxCurve;
+        sizeMultiplier: number;
+        sizeX: MinMaxCurve;
+        sizeXMultiplier: number;
+        sizeY: MinMaxCurve;
+        sizeYMultiplier: number;
+        sizeZ: MinMaxCurve;
+        sizeZMultiplier: number;
+        private _time;
+        evaluate(t01: number, target: Vec3): Vec3;
     }
     export class ShapeModule {
         shapeType: ParticleSystemShapeType;
@@ -4215,68 +4383,99 @@ declare module "engine-components/ParticleSystemModules" {
         angle: number;
         arc: number;
         arcmode: number;
-        box: THREE.Vector3;
-        boxThickness: THREE.Vector3;
-        position: THREE.Vector3;
-        rotation: THREE.Vector3;
-        scale: THREE.Vector3;
+        boxThickness: Vector3;
+        position: Vector3;
+        rotation: Vector3;
+        scale: Vector3;
         radius: number;
+        radiusThickness: number;
         sphericalDirectionAmount: number;
+        private _space?;
+        private readonly _worldSpacePosition;
+        update(_context: Context, simulationSpace: ParticleSystemSimulationSpace, obj: Object3D): void;
+        /** nebula implementations: */
+        /** initializer implementation */
+        private _vector;
+        private _temp;
+        /** called by nebula on initialize */
+        get vector(): THREE.Vector3;
+        /** called by nebula */
+        getPosition(): void;
+        private _dir;
+        getDirection(position: any): Vector3;
     }
-    export enum ParticleSystemShapeType {
-        Sphere = 0,
-        SphereShell = 1,
-        Hemisphere = 2,
-        HemisphereShell = 3,
-        Cone = 4,
-        Box = 5,
-        Mesh = 6,
-        ConeVolume = 7,
-        Circle = 10,
-        SingleSidedEdge = 11,
-        MeshRenderer = 12,
-        SkinnedMeshRenderer = 13,
-        BoxShell = 14,
-        BoxEdge = 15,
-        Donut = 16,
-        Rectangle = 17,
-        Sprite = 18,
-        SpriteRenderer = 19
+    import { Context } from "engine/engine_setup";
+    export class NoiseModule {
+        damping: boolean;
+        enabled: boolean;
+        frequency: number;
+        octaveCount: number;
+        octaveMultiplier: number;
+        octaveScale: number;
+        positionAmount: MinMaxCurve;
+        quality: number;
+        remap: MinMaxCurve;
+        remapEnabled: boolean;
+        remapMultiplier: number;
+        remapX: MinMaxCurve;
+        remapXMultiplier: number;
+        remapY: MinMaxCurve;
+        remapYMultiplier: number;
+        remapZ: MinMaxCurve;
+        remapZMultiplier: number;
+        scrollSpeedMultiplier: number;
+        separateAxes: boolean;
+        strengthMultiplier: number;
+        strengthX: MinMaxCurve;
+        strengthXMultiplier: number;
+        strengthY: MinMaxCurve;
+        strengthYMultiplier: number;
+        strengthZ: MinMaxCurve;
+        strengthZMultiplier: number;
+        private _noise?;
+        private _time;
+        update(context: Context): void;
+        /** nebula implementations: */
+        private _temp;
+        applyNoise(index: number, pos: Vec3, vel: Vec3, deltaTime: number, age: number, life: number): void;
     }
 }
 declare module "engine-components/ParticleSystem" {
     import { Behaviour } from "engine-components/Component";
     import * as THREE from "three";
-    import * as Modules from "engine-components/ParticleSystemModules";
+    import { MainModule, EmissionModule, ShapeModule, ColorOverLifetimeModule, SizeOverLifetimeModule, NoiseModule, IParticleSystem, ParticleSystemRenderMode } from "engine-components/ParticleSystemModules";
+    import { Mesh, SpriteMaterial } from "three";
     export class ParticleSystemRenderer extends Behaviour {
-        get mainTexture(): THREE.Texture | null;
-        getMesh(_index: number): THREE.Mesh | null;
-        private sharedMaterial?;
-        private mesh?;
-        awake(): void;
-    }
-    export class ParticleSystem extends Behaviour {
-        main: Modules.MainModule;
-        emission: Modules.EmissionModule;
-        shape: Modules.ShapeModule;
-        private renderer;
-        private geometry;
-        private material;
-        private particlesMesh;
-        private positions;
-        private positionsArray;
-        private particleStates;
-        private activeCount;
-        private shapeRotation;
-        private tempVec3;
-        private tempQuat;
+        renderMode?: ParticleSystemRenderMode;
+        particleMaterial?: SpriteMaterial;
+        particleMesh?: Mesh | string;
+        getMesh(): THREE.Mesh<THREE.BufferGeometry, THREE.SpriteMaterial>;
+    }
+    export class ParticleSystem extends Behaviour implements IParticleSystem {
+        readonly colorOverLifetime: ColorOverLifetimeModule;
+        readonly main: MainModule;
+        readonly emission: EmissionModule;
+        readonly sizeOverLifetime: SizeOverLifetimeModule;
+        readonly shape: ShapeModule;
+        readonly noise: NoiseModule;
+        get renderer(): ParticleSystemRenderer;
+        get currentParticles(): any;
+        get maxParticles(): number;
+        get time(): number;
+        get duration(): number;
+        private _renderer;
+        private _system;
+        private _emitter;
+        private _size;
+        private _container?;
+        private _time;
+        /** called from deserialization */
+        private set bursts(value);
+        private _bursts?;
         awake(): void;
         onEnable(): void;
-        emit(deltaTime: number): void;
-        private initializeParticle;
-        private updateOverLifetime;
-        private assignPosition;
-        private assignVelocity;
+        onDisable(): void;
+        onBeforeRender(): void;
     }
 }
 declare module "engine/engine_coroutine" {
@@ -5556,9 +5755,16 @@ declare module "engine-components/codegen/components" {
     export { OrbitControls } from "engine-components/OrbitControls";
     export { ParticleSystemRenderer } from "engine-components/ParticleSystem";
     export { ParticleSystem } from "engine-components/ParticleSystem";
+    export { Gradient } from "engine-components/ParticleSystemModules";
+    export { MinMaxCurve } from "engine-components/ParticleSystemModules";
+    export { MinMaxGradient } from "engine-components/ParticleSystemModules";
     export { MainModule } from "engine-components/ParticleSystemModules";
+    export { ParticleBurst } from "engine-components/ParticleSystemModules";
     export { EmissionModule } from "engine-components/ParticleSystemModules";
+    export { ColorOverLifetimeModule } from "engine-components/ParticleSystemModules";
+    export { SizeOverLifetimeModule } from "engine-components/ParticleSystemModules";
     export { ShapeModule } from "engine-components/ParticleSystemModules";
+    export { NoiseModule } from "engine-components/ParticleSystemModules";
     export { PlayerColor } from "engine-components/PlayerColor";
     export { ReflectionProbe } from "engine-components/ReflectionProbe";
     export { FieldWithDefault } from "engine-components/Renderer";