@needle-tools/engine 2.31.0-pre → 2.32.0-pre

package/CHANGELOG.md

@@ -4,6 +4,19 @@ 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.32.0-pre] - 2022-10-15
+- Add: start implementing trigger callbacks for ``onTriggerEnter``, ``onTriggerExit`` and ``onTriggerStay``
+- Change: ``GameObject.setActive`` now updates ``isActiveAndEnabled`` state and executes ``awake`` and ``onEnable`` calls when the object was activated for the first time (e.g. when instantiating from an previously inactive prefab)
+- Change: improve collision callback events for components (``onCollisionEnter``, ``onCollisionExit`` and ``onCollisionStay``)
+- Change: this.context.input keycode enums are now strings
+- Fix: local dev error overlay now also displays errors that happen before web component is completely loaded (e.g. when script has import error)
+- Fix: Rigidbody force is now correctly applied when the component was just instantiated (from inactive prefab) and added to the physics world for the first time
+- Fix: DragControls component keyboard events ("space" and "d" for modifying height and rotation)
+
+## [2.31.1-pre] - 2022-10-14
+- Change: Rigidbody now tracks position changes to detect when to update/override simulated physics body
+- Fix: loading relative font paths when exported via Asset context menu
+
 ## [2.31.0-pre] - 2022-10-13
 - Add: inital ScreenCapture component for sharing screens and camera streams across all connected users
 - Add: ``onCollisionEnter``, ``onCollisionStay`` and ``onCollisionExit`` event methods to components

package/dist/needle-engine.d.ts

@@ -59,14 +59,16 @@ declare module "engine/engine_utils" {
     export function delay(milliseconds: number): Promise<void>;
     export function getPath(source: SourceIdentifier | undefined, uri: string): string;
     export type WriteCallback = (data: any) => void;
-    export class Watch {
+    export interface IWatch {
+        subscribeWrite(callback: WriteCallback): any;
+        apply(): any;
+        revoke(): any;
+        dispose(): any;
+    }
+    export class Watch implements IWatch {
+        private readonly _watches;
+        constructor(object: object, str: string[] | string);
         subscribeWrite(callback: WriteCallback): void;
-        private writeCallbacks;
-        constructor(object: object, prop: string);
-        private _applied;
-        private _object;
-        private _prop;
-        private _wrapperProp;
         apply(): void;
         revoke(): void;
         dispose(): void;
@@ -79,9 +81,10 @@ declare module "engine/engine_constants" {
 declare module "engine/engine_mainloop_utils" {
     import { Context } from "engine/engine_setup";
     import { Component } from "engine-components/Component";
+    import { Object3D } from 'three';
     export function processNewScripts(context: Context): void;
     export function processRemoveFromScene(script: Component): void;
-    export function processStart(context: Context): void;
+    export function processStart(context: Context, object?: Object3D): void;
     export function addScriptToArrays(script: any, context: Context): void;
     export function removeScriptFromContext(script: any, context: Context): void;
     export function updateIsActive(): void;
@@ -350,27 +353,6 @@ declare module "engine/engine_networking_instantiate" {
     export type PrefabProviderCallback = (guid: string) => Promise<GameObject | null>;
     export function registerPrefabProvider(key: string, fn: PrefabProviderCallback): void;
 }
-declare module "engine-components/ui/Utils" {
-    import { FrameEvent } from "engine/engine_setup";
-    import { Behaviour } from "engine-components/Component";
-    export function isUIObject(obj: THREE.Object3D): boolean;
-    export type RenderSettings = {
-        renderOnTop?: boolean;
-        doubleSided?: boolean;
-        depthWrite?: boolean;
-        castShadows?: boolean;
-        receiveShadows?: boolean;
-    };
-    export function updateRenderSettings(shadowComponent: THREE.Object3D, settings: RenderSettings): void;
-    export type RevocableProxy = {
-        proxy: any;
-        revoke: () => void;
-    };
-    /** internal method to proxy a field to detect changes */
-    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 */
-    export function scheduleAction(caller: Behaviour, action: Function, timing?: FrameEvent): void;
-}
 declare module "engine/engine_serialization_decorator" {
     import { Constructor } from "engine-components/Component";
     export type TypeResolver<T> = (data: any) => Constructor<T> | null;
@@ -386,6 +368,7 @@ declare module "engine-components/Rigidbody" {
     import { Behaviour } from "engine-components/Component";
     import * as CANNON from 'cannon-es';
     import * as THREE from 'three';
+    import { Vector3 } from "three";
     export class Rigidbody extends Behaviour {
         mass: number;
         set isKinematic(kinematic: boolean);
@@ -401,20 +384,25 @@ declare module "engine-components/Rigidbody" {
         private currentVelocity;
         private _smoothedVelocity;
         private lastWorldPosition;
-        private dirty;
-        private transformProxy?;
+        private _ignoreChange;
+        private _dirty;
+        private _positionWatch?;
+        private _matrixWatch?;
+        private _setMatrix;
+        constructor();
         awake(): void;
-        start(): void;
         onEnable(): void;
         onDisable(): void;
         onDestroy(): void;
-        earlyUpdate(): void;
         onBeforeRender(): void;
         initialize(): void;
         wakeUp(): void;
-        applyForce(vec: THREE.Vector3, rel: THREE.Vector3 | undefined): void;
+        applyForce(vec: THREE.Vector3, rel?: THREE.Vector3): void;
+        setForce(x: number, y: number, z: number): void;
         getVelocity(): THREE.Vector3;
-        setVelocity(x: number, y: number, z: number): void;
+        setVelocity(x: number | Vector3, y: number, z: number): void;
+        getTorque(): THREE.Vector3;
+        setTorque(x: number | Vector3, y: number, z: number): void;
         get smoothedVelocity(): THREE.Vector3;
         setAngularVelocity(x: number, y: number, z: number): void;
         private static copyVector3;
@@ -666,6 +654,8 @@ declare module "engine/engine_physics" {
         addSphereCollider(obj: THREE.Object3D, center: THREE.Vector3, radius: number, rb: Rigidbody | null): CANNON.Shape;
         addMeshCollider(_obj: THREE.Object3D): void;
         private isAlreadyRegistered;
+        private readonly tempMat1;
+        private readonly tempMat2;
         private addShape;
         step(deltaTime: number): void;
         private temp;
@@ -679,14 +669,16 @@ declare module "engine/engine_physics" {
         private onEndContact;
     }
     export class Collision {
+        private readonly invert;
         private readonly collision;
+        private readonly targetBody;
         readonly me: Object3D;
         private _normal?;
         get normal(): Vector3;
         private _collider?;
         get collider(): Collider;
         get gameObject(): Object3D;
-        constructor(obj: Object3D, collision: CannonCollision);
+        constructor(obj: Object3D, collision: CannonCollision, invert?: boolean);
     }
 }
 declare module "engine-components/Component" {
@@ -729,7 +721,7 @@ declare module "engine-components/Component" {
     }
     abstract class GameObject extends THREE.Object3D implements THREE.Object3D {
         guid: string | undefined;
-        static setActive(go: THREE.Object3D, active: boolean): void;
+        static setActive(go: THREE.Object3D, active: boolean, processStart?: boolean): void;
         static isActiveSelf(go: THREE.Object3D): boolean;
         static isActiveInHierarchy(go: THREE.Object3D): boolean;
         static markAsInstancedRendered(go: THREE.Object3D, instanced: boolean): void;
@@ -812,7 +804,11 @@ declare module "engine-components/Component" {
         onAfterRender?(): void;
         onCollisionEnter?(col: Collision): any;
         onCollisionExit?(col: Collision): any;
+        onCollisionExitRaw?(col: Collision): any;
         onCollisionStay?(col: Collision): any;
+        onTriggerEnter?(col: Collision): any;
+        onTriggerStay?(col: Collision): any;
+        onTriggerExit?(col: Collision): any;
         startCoroutine(routine: Generator, evt?: FrameEvent): Generator;
         stopCoroutine(routine: Generator, evt?: FrameEvent): void;
         get destroyed(): boolean;
@@ -830,9 +826,12 @@ declare module "engine-components/Component" {
         constructor();
         private _collisionExitRoutine;
         private _collisions;
+        private _triggerExitRoutine;
+        private _triggerCollisions;
+        get collisionsCount(): number;
         private __internalResetsCachedPhysicsData;
-        __internalHandleCollision(col: Collision): void;
-        sendExitCollisionEvent(obj: Object3D): void;
+        __internalHandleCollision(col: Collision, isTriggerCollision: boolean): void;
+        __internalHandleExitCollisionEvent(obj: Object3D, isTriggerCollision: boolean): void;
         private __waitForCollisionExit;
         private static _worldPositionBuffer;
         private static _worldQuaternionBuffer;
@@ -1048,9 +1047,9 @@ declare module "engine/engine_input" {
         private _pointerEvent;
         getKeyDown(): string | null;
         getKeyPressed(): string | null;
-        isKeyDown(keyCode: number): boolean;
-        isKeyUp(keyCode: number): boolean;
-        isKeyPressed(keyCode: number): boolean;
+        isKeyDown(keyCode: KeyCode | string | number): any;
+        isKeyUp(keyCode: KeyCode | string | number): boolean;
+        isKeyPressed(keyCode: KeyCode | string | number): any;
         createPointerDown(args: PointerEventArgs): void;
         createPointerMove(args: PointerEventArgs): void;
         createPointerUp(args: PointerEventArgs): void;
@@ -1078,105 +1077,90 @@ declare module "engine/engine_input" {
         private onDispatchEvent;
     }
     export enum KeyCode {
-        BACKSPACE = 8,
-        TAB = 9,
-        ENTER = 13,
-        SHIFT = 16,
-        CTRL = 17,
-        ALT = 18,
-        PAUSE = 19,
-        CAPS_LOCK = 20,
-        ESCAPE = 27,
-        SPACE = 32,
-        PAGE_UP = 33,
-        PAGE_DOWN = 34,
-        END = 35,
-        HOME = 36,
-        LEFT_ARROW = 37,
-        UP_ARROW = 38,
-        RIGHT_ARROW = 39,
-        DOWN_ARROW = 40,
-        INSERT = 45,
-        DELETE = 46,
-        KEY_0 = 48,
-        KEY_1 = 49,
-        KEY_2 = 50,
-        KEY_3 = 51,
-        KEY_4 = 52,
-        KEY_5 = 53,
-        KEY_6 = 54,
-        KEY_7 = 55,
-        KEY_8 = 56,
-        KEY_9 = 57,
-        KEY_A = 65,
-        KEY_B = 66,
-        KEY_C = 67,
-        KEY_D = 68,
-        KEY_E = 69,
-        KEY_F = 70,
-        KEY_G = 71,
-        KEY_H = 72,
-        KEY_I = 73,
-        KEY_J = 74,
-        KEY_K = 75,
-        KEY_L = 76,
-        KEY_M = 77,
-        KEY_N = 78,
-        KEY_O = 79,
-        KEY_P = 80,
-        KEY_Q = 81,
-        KEY_R = 82,
-        KEY_S = 83,
-        KEY_T = 84,
-        KEY_U = 85,
-        KEY_V = 86,
-        KEY_W = 87,
-        KEY_X = 88,
-        KEY_Y = 89,
-        KEY_Z = 90,
-        LEFT_META = 91,
-        RIGHT_META = 92,
-        SELECT = 93,
-        NUMPAD_0 = 96,
-        NUMPAD_1 = 97,
-        NUMPAD_2 = 98,
-        NUMPAD_3 = 99,
-        NUMPAD_4 = 100,
-        NUMPAD_5 = 101,
-        NUMPAD_6 = 102,
-        NUMPAD_7 = 103,
-        NUMPAD_8 = 104,
-        NUMPAD_9 = 105,
-        MULTIPLY = 106,
-        ADD = 107,
-        SUBTRACT = 109,
-        DECIMAL = 110,
-        DIVIDE = 111,
-        F1 = 112,
-        F2 = 113,
-        F3 = 114,
-        F4 = 115,
-        F5 = 116,
-        F6 = 117,
-        F7 = 118,
-        F8 = 119,
-        F9 = 120,
-        F10 = 121,
-        F11 = 122,
-        F12 = 123,
-        NUM_LOCK = 144,
-        SCROLL_LOCK = 145,
-        SEMICOLON = 186,
-        EQUALS = 187,
-        COMMA = 188,
-        DASH = 189,
-        PERIOD = 190,
-        FORWARD_SLASH = 191,
-        GRAVE_ACCENT = 192,
-        OPEN_BRACKET = 219,
-        BACK_SLASH = 220,
-        CLOSE_BRACKET = 221,
-        SINGLE_QUOTE = 222
+        BACKSPACE = "Backspace",
+        TAB = "Tab",
+        ENTER = "Enter",
+        SHIFT = "Shift",
+        CTRL = "Control",
+        ALT = "Alt",
+        PAUSE = "Pause",
+        CAPS_LOCK = "CapsLock",
+        ESCAPE = "Escape",
+        SPACE = " ",
+        PAGE_UP = "PageUp",
+        PAGE_DOWN = "PageDown",
+        END = "End",
+        HOME = "Home",
+        LEFT_ARROW = "ArrowLeft",
+        UP_ARROW = "ArrowUp",
+        RIGHT_ARROW = "ArrowRight",
+        DOWN_ARROW = "ArrowDown",
+        INSERT = "Insert",
+        DELETE = "Delete",
+        KEY_0 = "0",
+        KEY_1 = "1",
+        KEY_2 = "2",
+        KEY_3 = "3",
+        KEY_4 = "4",
+        KEY_5 = "5",
+        KEY_6 = "6",
+        KEY_7 = "7",
+        KEY_8 = "8",
+        KEY_9 = "9",
+        KEY_A = "a",
+        KEY_B = "b",
+        KEY_C = "c",
+        KEY_D = "d",
+        KEY_E = "e",
+        KEY_F = "f",
+        KEY_G = "g",
+        KEY_H = "h",
+        KEY_I = "i",
+        KEY_K = "k",
+        KEY_J = "j",
+        KEY_L = "l",
+        KEY_M = "m",
+        KEY_N = "n",
+        KEY_O = "o",
+        KEY_P = "p",
+        KEY_Q = "q",
+        KEY_R = "r",
+        KEY_S = "s",
+        KEY_T = "t",
+        KEY_U = "u",
+        KEY_V = "v",
+        KEY_W = "w",
+        KEY_X = "x",
+        KEY_Z = "z",
+        KEY_Y = "y",
+        SELECT = "Select",
+        NUMPAD_0 = "Numpad0",
+        NUMPAD_1 = "Numpad1",
+        NUMPAD_2 = "Numpad2",
+        NUMPAD_3 = "Numpad3",
+        NUMPAD_4 = "Numpad4",
+        NUMPAD_5 = "Numpad5",
+        NUMPAD_6 = "Numpad6",
+        NUMPAD_7 = "Numpad7",
+        NUMPAD_8 = "Numpad8",
+        NUMPAD_9 = "Numpad9",
+        MULTIPLY = "Multiply",
+        ADD = "Add",
+        SUBTRACT = "Subtract",
+        DECIMAL = "Decimal",
+        DIVIDE = "Divide",
+        F1 = "F1",
+        F2 = "F2",
+        F3 = "F3",
+        F4 = "F4",
+        F5 = "F5",
+        F6 = "F6",
+        F7 = "F7",
+        F8 = "F8",
+        F9 = "F9",
+        F10 = "F10",
+        F11 = "F11",
+        F12 = "F12"
     }
 }
 declare module "engine/engine_time" {
@@ -1236,9 +1220,11 @@ declare module "engine-components/OrbitControls" {
         private _cameraTargetPosition;
         private _inputs;
         private _enableTime;
+        private _startedListeningToKeyEvents;
         awake(): void;
         onEnable(): void;
         onDisable(): void;
+        onDestroy(): void;
         start(): void;
         private startRaycastDelayed;
         onBeforeRender(): void;
@@ -4612,6 +4598,27 @@ declare module "engine-components/ui/BaseUIComponent" {
         awake(): void;
     }
 }
+declare module "engine-components/ui/Utils" {
+    import { FrameEvent } from "engine/engine_setup";
+    import { Behaviour } from "engine-components/Component";
+    export function isUIObject(obj: THREE.Object3D): boolean;
+    export type RenderSettings = {
+        renderOnTop?: boolean;
+        doubleSided?: boolean;
+        depthWrite?: boolean;
+        castShadows?: boolean;
+        receiveShadows?: boolean;
+    };
+    export function updateRenderSettings(shadowComponent: THREE.Object3D, settings: RenderSettings): void;
+    export type RevocableProxy = {
+        proxy: any;
+        revoke: () => void;
+    };
+    /** internal method to proxy a field to detect changes */
+    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 */
+    export function scheduleAction(caller: Behaviour, action: Function, timing?: FrameEvent): void;
+}
 declare module "engine-components/ui/RectTransform" {
     import * as ThreeMeshUI from 'three-mesh-ui';
     import { BaseUIComponent } from "engine-components/ui/BaseUIComponent";