@needle-tools/engine 2.51.0-pre → 2.53.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.53.0-pre] - 2022-12-08
+- Add: InstantiateIdProvider constructor can now take string too for initializing seed
+- Add: USDZExpoter component enabling ``Open in Quicklook`` option by default when running on iOS Safari
+- Fix: Light intensity
+- Fix: Add workaround texture image encoding issue: https://github.com/needle-tools/needle-engine-support/issues/109
+- Fix: OrbitControls.enableKeys
+- Fix: Remove warning message about missing ``serializable`` when the reference is really missing
+- Fix: ``context.domX`` and ``domY`` using wrong values when in AR mode
+
+## [2.52.0-pre] - 2022-12-05
+- Add iOS platform util methods
+- Add ``?debugrig`` to render XRRig gizmo
+- Add support for Spritesheet Animation
+- Add: EventTrigger implementations for onPointerClick, onPointerEnter, onPointerExit, onPointerDown, onPointerUp
+- Add: RemoteSkybox environmentBlurriness setting
+- Fix: Renderer reflection probe event order issue not applying reflection probes when enabling/disabling object because reflection probes have not been enabled
+- Fix: remove log in ParticleSystemModules
+
 ## [2.51.0-pre] - 2022-11-30
 - Change: remove nebula, dat.gui and symlink package dependencies
 - Change: Light does not change renderer shadowtype anymore

package/dist/needle-engine.d.ts

@@ -308,6 +308,8 @@ declare module "engine/engine_utils" {
     }
     export function isMobileDevice(): boolean;
     export function isMozillaXR(): boolean;
+    export function isiOS(): boolean;
+    export function isSafari(): boolean;
 }
 declare module "engine/engine_networking_utils" {
     export function isLocalNetwork(hostname?: string): boolean;
@@ -424,6 +426,7 @@ declare module "engine/engine_serialization_core" {
         objectToNode?: ObjectToNodeMap;
         context?: Context;
         path?: string;
+        type?: Constructor<any>;
         /** holds information if a field was undefined before serialization. This gives us info if we might want to warn the user about missing attributes */
         implementationInformation?: ImplementationInformation;
         constructor(root: THREE.Object3D);
@@ -702,7 +705,7 @@ declare module "engine/engine_networking_instantiate" {
         set seed(val: number);
         private _originalSeed;
         private _seed;
-        constructor(seed: number);
+        constructor(seed: string | number);
         reset(): void;
         generateUUID(str?: string): any;
         initialize(strOrNumber: string | number): void;
@@ -2376,13 +2379,13 @@ declare module "engine/extensions/NEEDLE_render_objects" {
     }
     export const EXTENSION_NAME = "NEEDLE_render_objects";
 }
-declare module "engine/extensions/NEEDLE_deferred_texture" {
+declare module "engine/extensions/NEEDLE_progressive" {
     import { Material } from "three";
     import { GLTF, GLTFLoaderPlugin, GLTFParser } from "three/examples/jsm/loaders/GLTFLoader";
     import { SourceIdentifier } from "engine/engine_types";
     import { Context } from "engine/engine_setup";
-    export const EXTENSION_NAME = "NEEDLE_deferred_texture";
-    export class NEEDLE_deferred_texture implements GLTFLoaderPlugin {
+    export const EXTENSION_NAME = "NEEDLE_progressive";
+    export class NEEDLE_progressive implements GLTFLoaderPlugin {
         static assignTextureLOD(context: Context, source: SourceIdentifier | undefined, material: Material, level?: number): void;
         get name(): string;
         private parser;
@@ -2428,12 +2431,18 @@ declare module "engine-components/EventList" {
         removeAllEventListeners(): void;
     }
 }
+declare module "engine/engine_texture" {
+    import { WebGLRenderTarget } from "three";
+    export class RenderTexture extends WebGLRenderTarget {
+    }
+}
 declare module "engine/engine_serialization_builtin_serializer" {
     import * as THREE from "three";
     import { RGBAColor } from "engine-components/js-extensions/RGBAColor";
     import { SerializationContext, TypeSerializer } from "engine/engine_serialization_core";
     import { Behaviour, GameObject } from "engine-components/Component";
     import { EventList } from "engine-components/EventList";
+    import { RenderTexture } from "engine/engine_texture";
     class ColorSerializer extends TypeSerializer {
         constructor();
         onDeserialize(data: any): THREE.Color | RGBAColor | void;
@@ -2477,6 +2486,11 @@ declare module "engine/engine_serialization_builtin_serializer" {
         onDeserialize(data: EventListData, context: SerializationContext): EventList | undefined | null;
     }
     export const eventListSerializer: EventListSerializer;
+    export class RenderTextureSerializer extends TypeSerializer {
+        constructor();
+        onSerialize(_data: any, _context: SerializationContext): void;
+        onDeserialize(data: any, context: SerializationContext): RenderTexture | undefined;
+    }
 }
 declare module "engine/engine_serialization" {
     import { serializeObject, deserializeObject } from "engine/engine_serialization_core";
@@ -2677,8 +2691,10 @@ declare module "engine-components/Camera" {
         set fieldOfView(val: number);
         get nearClipPlane(): number;
         set nearClipPlane(val: number);
+        private _nearClipPlane;
         get farClipPlane(): number;
         set farClipPlane(val: number);
+        private _farClipPlane;
         get clearFlags(): ClearFlags;
         set clearFlags(val: ClearFlags);
         orthographic: boolean;
@@ -2687,8 +2703,12 @@ declare module "engine-components/Camera" {
         set cullingMask(val: number);
         get cullingMask(): number;
         private _cullingMask;
-        private _nearClipPlane;
-        private _farClipPlane;
+        set backgroundBlurriness(val: number | undefined);
+        get backgroundBlurriness(): number | undefined;
+        private _backgroundBlurriness?;
+        set backgroundIntensity(val: number | undefined);
+        get backgroundIntensity(): number | undefined;
+        private _backgroundIntensity?;
         get backgroundColor(): RGBAColor | null;
         set backgroundColor(val: RGBAColor | null);
         private _backgroundColor?;
@@ -3593,6 +3613,7 @@ declare module "engine-components/Renderer" {
         private applySettings;
         private _reflectionProbe;
         private updateReflectionProbe;
+        private _updateReflectionProbe;
         private setVisibility;
         private isMultiMaterialObject;
         private isMeshOrSkinnedMesh;
@@ -3798,6 +3819,20 @@ declare module "engine-components/WebXRController" {
         update(): void;
     }
 }
+declare module "engine-components/Gizmos" {
+    import { Behaviour } from "engine-components/Component";
+    import * as THREE from "three";
+    export class BoxGizmo extends Behaviour {
+        objectBounds: boolean;
+        color?: THREE.Color;
+        isGizmo: boolean;
+        private _gizmoObject;
+        private _boxHelper;
+        onEnable(): void;
+        onDisable(): void;
+        private syncObjectBounds;
+    }
+}
 declare module "engine-components/WebXRRig" {
     import { Behaviour } from "engine-components/Component";
     export class XRRig extends Behaviour {
@@ -4022,8 +4057,17 @@ declare module "engine-components/EventType" {
     }
 }
 declare module "engine-components/EventTrigger" {
+    import { IPointerEventHandler, PointerEventData } from "engine-components/ui/PointerEvents";
     import { Behaviour } from "engine-components/Component";
-    export class EventTrigger extends Behaviour {
+    import { EventType } from "engine-components/EventType";
+    export class EventTrigger extends Behaviour implements IPointerEventHandler {
+        private triggers?;
+        invoke(type: EventType): void;
+        onPointerClick(_: PointerEventData): void;
+        onPointerEnter(_: PointerEventData): void;
+        onPointerExit(_: PointerEventData): void;
+        onPointerDown(_: PointerEventData): void;
+        onPointerUp(_: PointerEventData): void;
     }
 }
 declare module "engine-components/FlyControls" {
@@ -4035,20 +4079,6 @@ declare module "engine-components/FlyControls" {
         update(): void;
     }
 }
-declare module "engine-components/Gizmos" {
-    import { Behaviour } from "engine-components/Component";
-    import * as THREE from "three";
-    export class BoxGizmo extends Behaviour {
-        objectBounds: boolean;
-        color?: THREE.Color;
-        isGizmo: boolean;
-        private _gizmoObject;
-        private _boxHelper;
-        onEnable(): void;
-        onDisable(): void;
-        private syncObjectBounds;
-    }
-}
 declare module "engine-components/GridHelper" {
     import { Behaviour } from "engine-components/Component";
     export class GridHelper extends Behaviour {
@@ -5013,6 +5043,7 @@ declare module "engine-components/Skybox" {
         url?: string;
         allowDrop: boolean;
         background: boolean;
+        backgroundBlurriness: number;
         environment: boolean;
         private _loader?;
         private _prevLoadedEnvironment?;
@@ -5120,6 +5151,7 @@ declare module "engine-components/SpectatorCamera" {
 declare module "engine-components/SpriteRenderer" {
     import { Behaviour } from "engine-components/Component";
     import * as THREE from "three";
+    import { Vector2 } from "three";
     import { RGBAColor } from "engine-components/js-extensions/RGBAColor";
     export enum SpriteDrawMode {
         Simple = 0,
@@ -5131,20 +5163,35 @@ declare module "engine-components/SpriteRenderer" {
         y: number;
     }
     export class Sprite {
+        guid?: string;
         texture?: THREE.Texture;
         triangles: Array<number>;
         uv: Array<Vec2>;
         vertices: Array<Vec2>;
         _geometry?: THREE.BufferGeometry;
     }
+    class Slice {
+        name: string;
+        offset: Vector2;
+        size: Vector2;
+    }
+    export class SpriteSheet {
+        sprite?: Sprite;
+        index: number;
+        slices: Slice[];
+        update(): void;
+    }
     export class SpriteRenderer extends Behaviour {
         drawMode: SpriteDrawMode;
         size: Vec2;
         color?: RGBAColor;
         sharedMaterial?: THREE.Material;
-        get sprite(): Sprite | undefined;
-        set sprite(value: Sprite | undefined);
-        private _sprite?;
+        get sprite(): SpriteSheet | undefined;
+        set sprite(value: SpriteSheet | undefined | number);
+        set spriteIndex(value: number);
+        get spriteIndex(): number;
+        get spriteFrames(): number;
+        private _spriteSheet?;
         private _currentSprite?;
         awake(): void;
         start(): void;
@@ -5403,35 +5450,6 @@ declare module "engine-components/debug/LogStats" {
         run(): Generator<undefined, void, unknown>;
     }
 }
-declare module "engine-components/export/GltfExport" {
-    import { Behaviour } from "engine-components/Component";
-    import { Object3D } from "three";
-    import { BoxHelperComponent } from "engine-components/BoxHelperComponent";
-    type ExportOptions = {
-        binary: boolean;
-        pivot?: THREE.Vector3;
-    };
-    export const componentsArrayExportKey = "$___Export_Components";
-    export class GltfExportBox extends BoxHelperComponent {
-        sceneRoot?: THREE.Object3D;
-        start(): void;
-        updateGltfBox(): Generator<undefined, void, unknown>;
-    }
-    export class GltfExport extends Behaviour {
-        binary: boolean;
-        objects: Object3D[];
-        private exporter?;
-        private ext?;
-        exportNow(name: string): Promise<void>;
-        export(objectsToExport: Object3D[], opts?: ExportOptions): Promise<any>;
-        private static saveArrayBuffer;
-        private static saveJson;
-        private static save;
-        private static collectAnimations;
-        private static calculateCenter;
-        private static filterTopmostParent;
-    }
-}
 declare module "engine-components/timeline/SignalAsset" {
     import { EventList } from "engine-components/EventList";
     import { Behaviour } from "engine-components/Component";
@@ -5701,8 +5719,9 @@ declare module "engine-components/ui/Utils" {
         revoke: () => void;
     };
     /** internal method to proxy a field to detect changes */
+    /**@deprecated use watcher instead */
     export function onChange<T extends object>(caller: T, field: string, callback: (newValue: any, oldValue: any) => void): RevocableProxy;
-    /** internal method to schedula a function at a specific moment in the update loop */
+    /** internal method to schedule a function at a specific moment in the update loop */
     export function scheduleAction(caller: Behaviour, action: Function, timing?: FrameEvent): void;
 }
 declare module "engine-components/ui/RectTransform" {
@@ -5775,6 +5794,8 @@ declare module "engine-components/ui/Graphic" {
         protected onBeforeCreate(_opts: any): void;
         protected onCreate(opts: any): void;
         protected onAfterCreated(): void;
+        /** used internally to ensure textures assigned to UI use linear encoding */
+        static textureCache: Map<Texture, Texture>;
         protected setTexture(tex: Texture | null | undefined): Promise<void>;
         protected onAfterAddedToScene(): void;
     }
@@ -6068,6 +6089,167 @@ declare module "engine-components/ui/SpatialHtml" {
         start(): void;
     }
 }
+declare module "engine-components/export/gltf/GltfExport" {
+    import { Behaviour } from "engine-components/Component";
+    import { Object3D } from "three";
+    import { BoxHelperComponent } from "engine-components/BoxHelperComponent";
+    type ExportOptions = {
+        binary: boolean;
+        pivot?: THREE.Vector3;
+    };
+    export const componentsArrayExportKey = "$___Export_Components";
+    export class GltfExportBox extends BoxHelperComponent {
+        sceneRoot?: THREE.Object3D;
+        start(): void;
+        updateGltfBox(): Generator<undefined, void, unknown>;
+    }
+    export class GltfExport extends Behaviour {
+        binary: boolean;
+        objects: Object3D[];
+        private exporter?;
+        private ext?;
+        exportNow(name: string): Promise<void>;
+        export(objectsToExport: Object3D[], opts?: ExportOptions): Promise<any>;
+        private static saveArrayBuffer;
+        private static saveJson;
+        private static save;
+        private static collectAnimations;
+        private static calculateCenter;
+        private static filterTopmostParent;
+    }
+}
+declare module "engine-components/export/usdz/types" {
+    import { Object3D, Matrix4, Material, BufferGeometry } from "three";
+    /** implementation is in three */
+    export class USDZDocument {
+        name: string;
+        get isDocumentRoot(): boolean;
+        add(obj: USDZObject): any;
+        remove(obj: USDZObject): any;
+        traverse(callback: (obj: USDZObject) => void): any;
+        findById(uuid: string): USDZObject | undefined;
+        get isDynamic(): boolean;
+    }
+    /** implementation is in three */
+    export class USDZObject {
+        static createEmptyParent(parent: USDZObject): any;
+        uuid: string;
+        name: string;
+        matrix: Matrix4;
+        material: Material;
+        geometry: BufferGeometry;
+        parent: USDZObject | USDZDocument | null;
+        children: USDZObject[];
+        _eventListeners: {
+            [event: string]: Function[];
+        };
+        isDynamic: boolean;
+        is(obj: Object3D): boolean;
+        isEmpty(): boolean;
+        clone(): any;
+        getPath(): any;
+        add(child: USDZObject): any;
+        remove(child: USDZObject): any;
+        addEventListener(evt: string, listener: Function): any;
+        removeEventListener(evt: string, listener: Function): any;
+    }
+}
+declare module "engine-components/export/usdz/Extension" {
+    import { USDZObject } from "engine-components/export/usdz/types";
+    export interface IUSDZExporterExtension {
+        get extensionName(): string;
+        onBeforeBuildDocument?(context: any): any;
+        onAfterBuildDocument?(context: any): any;
+        onExportObject?(object: any, model: USDZObject, context: any): any;
+        onAfterSerialize?(context: any): any;
+        onAfterHierarchy?(context: any): any;
+    }
+}
+declare module "engine-components/export/usdz/extensions/Animation" {
+    import { Object3D } from "three";
+    import { USDZObject } from "three/examples/jsm/exporters/USDZExporter";
+    import { IUSDZExporterExtension } from "engine-components/export/usdz/Extension";
+    export interface UsdzAnimation {
+        createAnimation(ext: AnimationExtension, model: USDZObject, context: any): any;
+    }
+    export type AnimationClipCollection = Array<{
+        root: Object3D;
+        clips: Array<THREE.AnimationClip>;
+    }>;
+    export class RegisteredAnimationInfo {
+        get start(): number;
+        get duration(): number;
+        private ext;
+        private root;
+        private clip;
+        constructor(ext: AnimationExtension, root: THREE.Object3D, clip: THREE.AnimationClip);
+    }
+    export class TransformData {
+        clip: THREE.AnimationClip;
+        pos?: THREE.KeyframeTrack;
+        rot?: THREE.KeyframeTrack;
+        scale?: THREE.KeyframeTrack;
+        get frameRate(): number;
+        private ext;
+        private root;
+        private target;
+        constructor(ext: AnimationExtension, root: Object3D, target: Object3D, clip: THREE.AnimationClip);
+        addTrack(track: any): void;
+        getFrames(): number;
+        getDuration(): number;
+        getStartTime(arr: TransformData[]): number;
+    }
+    export class AnimationExtension implements IUSDZExporterExtension {
+        get extensionName(): string;
+        private dict;
+        private rootTargetMap;
+        getStartTime01(root: Object3D, clip: THREE.AnimationClip): number;
+        registerAnimation(root: Object3D, clip: THREE.AnimationClip): RegisteredAnimationInfo | null;
+        onAfterHierarchy(_context: any): void;
+        private serializers;
+        onAfterBuildDocument(_context: any): void;
+        onExportObject(object: any, model: USDZObject, _context: any): void;
+    }
+}
+declare module "engine-components/export/usdz/utils/quicklook" {
+    import { Context } from "engine/engine_setup";
+    export function ensureQuicklookLinkIsCreated(context: Context): HTMLAnchorElement;
+}
+declare module "engine-components/export/usdz/utils/timeutils" {
+    export function getFormattedDate(): string;
+}
+declare module "engine-components/export/usdz/utils/animationutils" {
+    import { Object3D } from "three";
+    import { AnimationExtension } from "engine-components/export/usdz/extensions/Animation";
+    export function registerAnimatorsImplictly(root: Object3D, ext: AnimationExtension): void;
+}
+declare module "engine-components/export/usdz/USDZExporter" {
+    import * as THREE from "three";
+    import { IUSDZExporterExtension } from "engine-components/export/usdz/Extension";
+    import { Behaviour } from "engine-components/Component";
+    export type QuickLookOverlay = {
+        callToAction?: string;
+        checkoutTitle?: string;
+        checkoutSubtitle?: string;
+    };
+    export class USDZExporter extends Behaviour {
+        objectToExport?: THREE.Object3D;
+        autoExportAnimations: boolean;
+        extensions: IUSDZExporterExtension[];
+        private link;
+        private webxr?;
+        start(): void;
+        onEnable(): void;
+        onDisable(): void;
+        exportAsync(): Promise<void>;
+        private lastCallback?;
+        private quicklookCallback;
+        private buildQuicklookOverlay;
+        private _arButton?;
+        private createQuicklookButton;
+        private resetStyles;
+    }
+}
 declare module "engine-components/codegen/components" {
     export class __Ignore {
     }
@@ -6156,6 +6338,7 @@ declare module "engine-components/codegen/components" {
     export { SpatialTrigger } from "engine-components/SpatialTrigger";
     export { SpectatorCamera } from "engine-components/SpectatorCamera";
     export { Sprite } from "engine-components/SpriteRenderer";
+    export { SpriteSheet } from "engine-components/SpriteRenderer";
     export { SpriteRenderer } from "engine-components/SpriteRenderer";
     export { SyncedCamera } from "engine-components/SyncedCamera";
     export { SyncedRoom } from "engine-components/SyncedRoom";
@@ -6193,8 +6376,6 @@ declare module "engine-components/codegen/components" {
     export { Avatar_MouthShapes } from "engine-components/avatar/Avatar_MouthShapes";
     export { Avatar_MustacheShake } from "engine-components/avatar/Avatar_MustacheShake";
     export { LogStats } from "engine-components/debug/LogStats";
-    export { GltfExportBox } from "engine-components/export/GltfExport";
-    export { GltfExport } from "engine-components/export/GltfExport";
     export { RGBAColor } from "engine-components/js-extensions/RGBAColor";
     export { PlayableDirector } from "engine-components/timeline/PlayableDirector";
     export { SignalAsset } from "engine-components/timeline/SignalAsset";
@@ -6230,6 +6411,12 @@ declare module "engine-components/codegen/components" {
     export { RectTransform } from "engine-components/ui/RectTransform";
     export { SpatialHtml } from "engine-components/ui/SpatialHtml";
     export { Text } from "engine-components/ui/Text";
+    export { GltfExportBox } from "engine-components/export/gltf/GltfExport";
+    export { GltfExport } from "engine-components/export/gltf/GltfExport";
+    export { USDZExporter } from "engine-components/export/usdz/USDZExporter";
+    export { RegisteredAnimationInfo } from "engine-components/export/usdz/extensions/Animation";
+    export { TransformData } from "engine-components/export/usdz/extensions/Animation";
+    export { AnimationExtension } from "engine-components/export/usdz/extensions/Animation";
 }
 declare module "needle-engine" {
     import "engine/engine_element";