@needle-tools/engine 2.50.0-pre → 2.52.0-pre

package/CHANGELOG.md

@@ -4,6 +4,32 @@ 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.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
+- Change: update threejs to 146
+- Change: update threejs types
+- Change: Screencapture should not start on click when not connected to networked room
+- Change: WebXR returns ar supported when using Mozilla WebXR
+- Fix DragControls drag interaction not disabling OrbitControls at right time
+- Fix physics collider position in certain cases
+- Fix Rigidbody not syncing physics position when parent transform changes
+- Fix Timeline awake / active and enable
+- Fix: OrbitControls calulcating target position with middle mouse click in worldspace instead of localspace causing wrong movement when parent is transformed
+- Fix: Raycast in Mozilla WebXR / using window sizes instead of dom element sizes
+- Fix input with scrolled window
+- Fix: destroy local avatar on end of webxr session (https://github.com/needle-tools/needle-engine-support/issues/117)
+- Fix: WebXRAvatar setting correct XRFlags
+
 ## [2.50.0-pre] - 2022-11-28
 - Add warning to Light when soft shadows change renderer shadow type
 - Add: RemoteSkybox can now load jpg and png textures as skybox

package/dist/needle-engine.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="webxr" />
 declare module "engine/engine_math" {
     class MathHelper {
         random(): number;
@@ -56,6 +57,7 @@ declare module "engine/engine_physics.types" {
 declare module "engine/engine_three_utils" {
     import * as THREE from "three";
     import { Vector3, Texture, ShaderMaterial } from "three";
+    export function slerp(vec: Vector3, end: Vector3, t: number): THREE.Vector3;
     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;
@@ -108,8 +110,8 @@ declare module "engine/engine_types" {
     }
     export interface INeedleEngineComponent extends HTMLElement {
         getAROverlayContainer(): HTMLElement;
-        onEnterAR(session: THREE.XRSession, overlayContainer: HTMLElement): any;
-        onExitAR(session: THREE.XRSession): any;
+        onEnterAR(session: XRSession, overlayContainer: HTMLElement): any;
+        onExitAR(session: XRSession): any;
     }
     export interface IGameObject extends Object3D {
         guid: string | undefined;
@@ -158,7 +160,7 @@ declare module "engine/engine_types" {
         earlyUpdate?(): void;
         update?(): void;
         lateUpdate?(): void;
-        onBeforeRender?(frame: THREE.XRFrame | null): void;
+        onBeforeRender?(frame: XRFrame | null): void;
         onAfterRender?(): void;
         onCollisionEnter?(col: Collision): any;
         onCollisionExit?(col: Collision): any;
@@ -306,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;
@@ -1381,7 +1385,7 @@ declare module "engine-components/Component" {
         earlyUpdate?(): void;
         update?(): void;
         lateUpdate?(): void;
-        onBeforeRender?(frame: THREE.XRFrame | null): void;
+        onBeforeRender?(frame: XRFrame | null): void;
         onAfterRender?(): void;
         onCollisionEnter?(col: Collision): any;
         onCollisionExit?(col: Collision): any;
@@ -1847,7 +1851,7 @@ declare module "engine/engine_setup" {
         xrSessionMode: XRSessionMode | undefined;
         get isInVR(): boolean;
         get isInAR(): boolean;
-        get xrSession(): THREE.XRSession | null;
+        get xrSession(): XRSession | null;
         get arOverlayElement(): HTMLElement;
         /** Current event of the update cycle */
         get currentFrameEvent(): FrameEvent;
@@ -1940,12 +1944,12 @@ declare module "engine/engine_element_overlay" {
         constructor();
         private arContainer;
         closeARCallback: any;
-        currentSession: THREE.XRSession | null;
+        currentSession: XRSession | null;
         registeredCloseEventElements: Element[];
         private _createdAROnlyElements;
         private _reparentedObjects;
         requestEndAR(): void;
-        onBegin(context: Context, overlayContainer: HTMLElement, session: THREE.XRSession): void;
+        onBegin(context: Context, overlayContainer: HTMLElement, session: XRSession): void;
         onEnd(_context: Context): void;
         findOrCreateARContainer(element: HTMLElement): HTMLElement;
         private onRequestedEndAR;
@@ -2553,10 +2557,10 @@ declare module "engine/engine_element" {
         private registerEventFromAttribute;
         getAROverlayContainer(): HTMLElement;
         getVROverlayContainer(): HTMLElement | null;
-        onEnterAR(session: THREE.XRSession, overlayContainer: HTMLElement): void;
-        onExitAR(session: THREE.XRSession): void;
-        onEnterVR(session: THREE.XRSession): void;
-        onExitVR(session: THREE.XRSession): void;
+        onEnterAR(session: XRSession, overlayContainer: HTMLElement): void;
+        onExitAR(session: XRSession): void;
+        onEnterVR(session: XRSession): void;
+        onExitVR(session: XRSession): void;
         private onElementsChanged;
         private onSetupAR;
         private onSetupVR;
@@ -2675,8 +2679,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;
@@ -2685,8 +2691,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?;
@@ -3057,8 +3067,7 @@ declare module "engine-components/Voip" {
 }
 declare module "engine-components/WebARSessionRoot" {
     import { Behaviour } from "engine-components/Component";
-    import { XRSession } from 'three';
-    import { Matrix4, Object3D, XRPose } from "three";
+    import { Matrix4, Object3D } from "three";
     import { WebAR } from "engine-components/WebXR";
     export class WebARSessionRoot extends Behaviour {
         webAR: WebAR | null;
@@ -3412,9 +3421,10 @@ declare module "engine-components/ui/EventSystem" {
     import { Context } from "engine/engine_setup";
     import { Raycaster } from "engine-components/ui/Raycaster";
     export class EventSystem extends Behaviour {
+        private static _eventSystemMap;
         static didSearchEventSystem: boolean;
         static createIfNoneExists(context: Context): void;
-        static systems: EventSystem[];
+        static get systems(): EventSystem[];
         static ensureUpdateMeshUI(instance: any, context: Context): void;
         static markUIDirty(_context: Context): void;
         static get instance(): EventSystem | null;
@@ -3591,6 +3601,7 @@ declare module "engine-components/Renderer" {
         private applySettings;
         private _reflectionProbe;
         private updateReflectionProbe;
+        private _updateReflectionProbe;
         private setVisibility;
         private isMultiMaterialObject;
         private isMeshOrSkinnedMesh;
@@ -3648,7 +3659,7 @@ declare module "engine-components/ui/RaycastUtils" {
     }
 }
 declare module "engine-components/WebXRController" {
-    import { Group, Intersection, Mesh, Object3D, Quaternion, Ray, Vector3, XRInputSource, XRSession } from "three";
+    import { Group, Intersection, Mesh, Object3D, Quaternion, Ray, Vector3 } from "three";
     import { OculusHandPointerModel } from 'three/examples/jsm/webxr/OculusHandPointerModel.js';
     import { XRControllerModel, XRControllerModelFactory } from 'three/examples/jsm/webxr/XRControllerModelFactory.js';
     import { Behaviour, GameObject } from "engine-components/Component";
@@ -3796,6 +3807,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 {
@@ -3803,7 +3828,7 @@ declare module "engine-components/WebXRRig" {
     }
 }
 declare module "engine-components/WebXR" {
-    import { Object3D, Quaternion, XRFrame, XRSession, XRViewerPose } from 'three';
+    import { Object3D, Quaternion } from 'three';
     import { AssetReference } from "engine/engine_addressables";
     import { Behaviour } from "engine-components/Component";
     import { WebXRController } from "engine-components/WebXRController";
@@ -4020,8 +4045,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" {
@@ -4033,20 +4067,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 {
@@ -5011,6 +5031,7 @@ declare module "engine-components/Skybox" {
         url?: string;
         allowDrop: boolean;
         background: boolean;
+        backgroundBlurriness: number;
         environment: boolean;
         private _loader?;
         private _prevLoadedEnvironment?;
@@ -5118,6 +5139,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,
@@ -5129,20 +5151,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;
@@ -6154,6 +6191,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";