@needle-tools/engine 2.41.0-pre → 2.43.0-pre

package/CHANGELOG.md

@@ -4,6 +4,30 @@ 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.43.0-pre] - 2022-11-10
+- Add: particles emission over distance
+- Add: particles can enable trail (settings are not yet applied tho) 
+- Add: camera now useses culling mask settings
+- Add: particle VelocityOverLife
+- Add: particle basic texture sheet animation support
+- Change: ensure ``time.deltaTime`` is always > 0 and nevery exactly 0
+- Fix: progressbar handle progress event not reporting total file size
+- Fix: layer on camera did affect visibility
+- Fix: cloning animatorcontrollers in builds did fail because of legacy AnimatorAction name check
+- Fix: ``RGBAColor.lerpColors`` did produce wrong alpha value
+- Fix: custom shader ``_ZTest`` value is now applied as threejs depthTest function
+
+## [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

package/dist/needle-engine.d.ts

@@ -23,6 +23,7 @@ declare module "engine-components/js-extensions/RGBAColor" {
         clone(): this;
         copy(col: RGBAColor | Color): this;
         lerp(color: Color, alpha: number): this;
+        lerpColors(color1: Color, color2: Color, alpha: number): this;
         multiply(color: Color): this;
     }
 }
@@ -53,7 +54,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;
@@ -70,7 +71,23 @@ 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 function isAnimationAction(obj: object): boolean;
+    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" {
@@ -194,6 +211,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;
@@ -768,30 +791,16 @@ declare module "engine/engine_gameobject" {
 }
 declare module "engine/engine_gizmos" {
     import * as THREE from 'three';
-    import { ColorRepresentation } from 'three';
-    import { Vec3 } from "engine/engine_types";
+    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, color?: ColorRepresentation, duration?: number, depthTest?: boolean, lengthFactor?: number): 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;
+        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;
 }
@@ -1824,6 +1833,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;
@@ -1894,6 +1906,23 @@ declare module "engine/engine_setup" {
         private executeCoroutines;
     }
 }
+declare module "engine/engine_util_decorator" {
+    import { IComponent } from "engine/engine_types";
+    type setter = (v: any) => void;
+    type getter = () => any;
+    /** create accessor callbacks for a field */
+    export const validate: (set?: setter, get?: getter) => (target: IComponent | any, propertyKey: string, descriptor?: undefined) => void;
+}
+declare module "engine/api" {
+    export { InstancingUtil } from "engine/engine_instancing";
+    export * from "engine/engine_gameobject";
+    export * from "engine/engine_components";
+    export { AssetReference } from "engine/engine_addressables";
+    export { FrameEvent } from "engine/engine_setup";
+    export * from "engine/debug/debug";
+    export { validate } from "engine/engine_util_decorator";
+    export { Gizmos } from "engine/engine_gizmos";
+}
 declare module "engine/engine_element_loading" {
     import { LoadingProgressArgs } from "engine/engine_setup";
     export class LoadingElementOptions {
@@ -2460,23 +2489,6 @@ declare module "engine/engine_element" {
         private onBeforeBeginLoading;
     }
 }
-declare module "engine/engine_util_decorator" {
-    import { IComponent } from "engine/engine_types";
-    type setter = (v: any) => void;
-    type getter = () => any;
-    /** create accessor callbacks for a field */
-    export const validate: (set?: setter, get?: getter) => (target: IComponent | any, propertyKey: string, descriptor?: undefined) => void;
-}
-declare module "engine/api" {
-    export { InstancingUtil } from "engine/engine_instancing";
-    export * from "engine/engine_gameobject";
-    export * from "engine/engine_components";
-    export { AssetReference } from "engine/engine_addressables";
-    export { FrameEvent } from "engine/engine_setup";
-    export * from "engine/debug/debug";
-    export { validate } from "engine/engine_util_decorator";
-    export { Gizmos } from "engine/engine_gizmos";
-}
 declare module "engine-components/AlignmentConstraint" {
     import { Behaviour } from "engine-components/Component";
     export class AlignmentConstraint extends Behaviour {
@@ -2592,6 +2604,9 @@ declare module "engine-components/Camera" {
         orthographic: boolean;
         orthographicSize: number;
         ARBackgroundAlpha: number;
+        set cullingMask(val: number);
+        get cullingMask(): number;
+        private _cullingMask;
         private _nearClipPlane;
         private _farClipPlane;
         get backgroundColor(): RGBAColor | null;
@@ -3471,6 +3486,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;
@@ -4158,10 +4174,11 @@ declare module "engine-components/OffsetConstraint" {
 }
 declare module "engine-components/ParticleSystemModules" {
     import * as THREE from "three";
-    import { Object3D, Vector3 } from "three";
+    import { Object3D, Quaternion, Vector3 } from "three";
     import { RGBAColor } from "engine-components/js-extensions/RGBAColor";
     import { AnimationCurve } from "engine-components/AnimationCurve";
     import { Vec3 } from "engine/engine_types";
+    import { EmitterShape, Particle, ShapeJSON } from "three.quarks";
     type Color4 = {
         r: number;
         g: number;
@@ -4176,6 +4193,20 @@ declare module "engine-components/ParticleSystemModules" {
         time: number;
         alpha: number;
     };
+    export interface IParticleSystem {
+        get currentParticles(): number;
+        get maxParticles(): number;
+        get time(): number;
+        get duration(): number;
+        readonly main: MainModule;
+        get container(): Object3D;
+        get worldQuaternion(): Quaternion;
+        get worldQuaternionInverted(): Quaternion;
+    }
+    export enum ParticleSystemRenderMode {
+        Billboard = 0,
+        Mesh = 4
+    }
     export class Gradient {
         alphaKeys: Array<AlphaKey>;
         colorKeys: Array<ColorKey>;
@@ -4242,7 +4273,8 @@ declare module "engine-components/ParticleSystemModules" {
         gradient: Gradient;
         gradientMin: Gradient;
         gradientMax: Gradient;
-        private _temp;
+        private static _temp;
+        private static _temp2;
         evaluate(t01: number, lerpFactor?: number): RGBAColor;
     }
     type ParticleSystemScalingMode = {
@@ -4297,21 +4329,39 @@ declare module "engine-components/ParticleSystemModules" {
         stopAction: 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;
+        get burstCount(): number;
+        bursts: ParticleBurst[];
         rateOverTime: MinMaxCurve;
         rateOverTimeMultiplier: number;
         rateOverDistance: MinMaxCurve;
         rateOverDistanceMultiplier: number;
-        currentParticles: number;
-        maxParticles: number;
-        private _time;
-        private _summed;
-        /** called by nebula */
-        init(): void;
-        /** called by nebula */
-        getValue(deltaTime: number): number;
+        /** set from system */
+        system: IParticleSystem;
+        get time(): number;
+        getBurst(): number;
     }
     export class ColorOverLifetimeModule {
         enabled: boolean;
@@ -4322,16 +4372,21 @@ declare module "engine-components/ParticleSystemModules" {
         separateAxes: boolean;
         size: MinMaxCurve;
         sizeMultiplier: number;
-        sizeX: MinMaxCurve;
-        sizeXMultiplier: number;
-        sizeY: MinMaxCurve;
-        sizeYMultiplier: number;
-        sizeZ: MinMaxCurve;
-        sizeZMultiplier: number;
+        x: MinMaxCurve;
+        xMultiplier: number;
+        y: MinMaxCurve;
+        yMultiplier: number;
+        z: MinMaxCurve;
+        zMultiplier: number;
         private _time;
-        evaluate(t01: number, target: Vec3): Vec3;
+        private _temp;
+        evaluate(t01: number, target?: Vec3): Vec3;
     }
-    export class ShapeModule {
+    export class ShapeModule implements EmitterShape {
+        get type(): string;
+        initialize(particle: Particle): void;
+        toJSON(): ShapeJSON;
+        clone(): EmitterShape;
         shapeType: ParticleSystemShapeType;
         enabled: boolean;
         alignToDirection: boolean;
@@ -4354,10 +4409,9 @@ declare module "engine-components/ParticleSystemModules" {
         private _temp;
         /** called by nebula on initialize */
         get vector(): THREE.Vector3;
-        /** called by nebula */
         getPosition(): void;
         private _dir;
-        getDirection(position: any): Vec3;
+        getDirection(position: any): Vector3;
     }
     import { Context } from "engine/engine_setup";
     export class NoiseModule {
@@ -4392,27 +4446,118 @@ declare module "engine-components/ParticleSystemModules" {
         update(context: Context): void;
         /** nebula implementations: */
         private _temp;
-        applyNoise(index: number, pos: Vec3, vel: Vec3, deltaTime: number, age: number, life: number): void;
+        apply(_index: number, pos: Vec3, vel: Vec3, _deltaTime: number, age: number, life: number): void;
+    }
+    export class TrailModule {
+        enabled: boolean;
+    }
+    export class VelocityOverLifetimeModule {
+        enabled: boolean;
+        space: ParticleSystemSimulationSpace;
+        speedModifier: MinMaxCurve;
+        speedModifierMultiplier: number;
+        x: MinMaxCurve;
+        xMultiplier: number;
+        y: MinMaxCurve;
+        yMultiplier: number;
+        z: MinMaxCurve;
+        zMultiplier: number;
+        private _system?;
+        update(system: IParticleSystem): void;
+        private _temp;
+        apply(_index: number, _pos: Vec3, vel: Vec3, _dt: number, age: number, life: number): void;
+    }
+    enum ParticleSystemAnimationTimeMode {
+        Lifetime = 0,
+        Speed = 1,
+        FPS = 2
+    }
+    enum ParticleSystemAnimationRowMode {
+        Custom = 0,
+        Random = 1,
+        MeshIndex = 2
+    }
+    enum ParticleSystemAnimationType {
+        WholeSheet = 0,
+        SingleRow = 1
+    }
+    export class TextureSheetAnimationModule {
+        animation: ParticleSystemAnimationType;
+        enabled: boolean;
+        cycleCount: number;
+        frameOverTime: MinMaxCurve;
+        frameOverTimeMultiplier: number;
+        numTilesX: number;
+        numTilesY: number;
+        startFrame: MinMaxCurve;
+        startFrameMultiplier: number;
+        rowMode: ParticleSystemAnimationRowMode;
+        rowIndex: number;
+        spriteCount: number;
+        timeMode: ParticleSystemAnimationTimeMode;
+        private sampleOnceAtStart;
+        getStartIndex(): number;
+        evaluate(t01: number): number | undefined;
+        private getIndex;
+    }
+    export class RotationOverLifetimeModule {
+        enabled: boolean;
+        separateAxes: boolean;
+        x: MinMaxCurve;
+        xMultiplier: number;
+        y: MinMaxCurve;
+        yMultiplier: number;
+        z: MinMaxCurve;
+        zMultiplier: number;
+        evaluate(t01: number): number;
     }
 }
 declare module "engine-components/ParticleSystem" {
     import { Behaviour } from "engine-components/Component";
-    import { MainModule, EmissionModule, ShapeModule, ColorOverLifetimeModule, SizeOverLifetimeModule, NoiseModule } from "engine-components/ParticleSystemModules";
-    import { SpriteMaterial } from "three";
+    import * as THREE from "three";
+    import { MainModule, EmissionModule, ShapeModule, ColorOverLifetimeModule, SizeOverLifetimeModule, NoiseModule, IParticleSystem, ParticleSystemRenderMode, TrailModule, VelocityOverLifetimeModule, TextureSheetAnimationModule, RotationOverLifetimeModule } from "engine-components/ParticleSystemModules";
+    import { Mesh, Object3D, Quaternion, SpriteMaterial } from "three";
     export class ParticleSystemRenderer extends Behaviour {
+        renderMode?: ParticleSystemRenderMode;
         particleMaterial?: SpriteMaterial;
-    }
-    export class ParticleSystem extends Behaviour {
-        colorOverLifetime: ColorOverLifetimeModule;
-        main: MainModule;
-        emission: EmissionModule;
-        sizeOverLifetime: SizeOverLifetimeModule;
-        shape: ShapeModule;
-        noise: NoiseModule;
-        renderer: ParticleSystemRenderer;
-        private _system;
-        private _emitter;
-        private _size;
+        particleMesh?: Mesh | string;
+        get transparent(): boolean;
+        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;
+        readonly trails: TrailModule;
+        readonly velocityOverLifetime: VelocityOverLifetimeModule;
+        readonly textureSheetAnimation: TextureSheetAnimationModule;
+        readonly rotationOverLifetime: RotationOverLifetimeModule;
+        get renderer(): ParticleSystemRenderer;
+        get currentParticles(): number;
+        get maxParticles(): number;
+        get time(): number;
+        get duration(): number;
+        get deltaTime(): number;
+        get scale(): number;
+        get cameraScale(): number;
+        private _cameraScale;
+        get container(): Object3D;
+        private __worldQuaternion;
+        get worldQuaternion(): Quaternion;
+        private _worldQuaternionInverted;
+        get worldQuaternionInverted(): Quaternion;
+        private _renderer;
+        private _batchSystem?;
+        private _particleSystem?;
+        private _interface;
+        private _container;
+        private _time;
+        /** called from deserialization */
+        private set bursts(value);
+        private _bursts?;
         awake(): void;
         onEnable(): void;
         onDisable(): void;
@@ -5700,11 +5845,16 @@ declare module "engine-components/codegen/components" {
     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 { TrailModule } from "engine-components/ParticleSystemModules";
+    export { VelocityOverLifetimeModule } from "engine-components/ParticleSystemModules";
+    export { TextureSheetAnimationModule } from "engine-components/ParticleSystemModules";
+    export { RotationOverLifetimeModule } from "engine-components/ParticleSystemModules";
     export { PlayerColor } from "engine-components/PlayerColor";
     export { ReflectionProbe } from "engine-components/ReflectionProbe";
     export { FieldWithDefault } from "engine-components/Renderer";