@needle-tools/engine 2.37.0-pre → 2.38.0-pre.1

package/CHANGELOG.md

@@ -4,6 +4,27 @@ 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.38.0-pre] - 2022-11-02
+- Add ``context.isInAR`` and ``context.isInVR`` properties
+- Add physics capsule collider support
+- Add basic character controller implementation (experimental)
+- Add ``context.input.getMouseWheelDeltaY()``
+- Add: SmoothFollow option to restrict following on certain axes only for position
+- Add: ``Rigidbody.teleport`` method to properly reset internal state
+- Add: load glbs using build hash (appended as ``?v=123``)
+- Change: Collision event args now exposes contacts array
+- Fix Exit AR (X) button not showing up
+- Fix physics collider center offset
+- Fix removing colliders and rigidbodies throwing error (when trying to access properties for already removed bodies)
+- Fix bug in AnimatorController causing broken animations when the same clip is used in multiple states (caused by ``mixer.uncacheCip``)
+- Fix rigidbody friction allowing for physical bodies being transported on e.g. platforms
+- Fix ``onTriggerStay`` being invoked with the correct collider argument
+- Fix AnimatorController exit time not being used properly
+- Fix AnimatorController not checking all possible transitions if one transition did match conditions but could not be made due to exit time setting
+- Fix ``Renderer.sharedMaterials`` not handling SkinnedMeshRenderer
+- Fix environment blend mode for mozilla XR browser on iOS
+- Fix: Camera now removing self from being set as currently rendering in ``onDisable``
+
 ## [2.37.0-pre] - 2022-10-28
 - Add: rapier physics backend and overall improved physics system like constraint support, fixed physics collider updates and synchronization between rendering and physics world or animation of physical bodies 
 - Remove: cannon-es

package/dist/needle-engine.d.ts

@@ -40,6 +40,13 @@ declare module "engine/engine_physics.types" {
         FreezeRotation = 112,
         FreezeAll = 126
     }
+    export enum Axes {
+        None = 0,
+        X = 2,
+        Y = 4,
+        Z = 8,
+        All = -1
+    }
 }
 declare module "engine/engine_types" {
     import { Camera, Color, Material, Object3D, Vector3, Quaternion } from "three";
@@ -73,6 +80,7 @@ declare module "engine/engine_types" {
         get name(): string;
         get layer(): number;
         get destroyed(): boolean;
+        get tag(): string;
         context: any;
         get activeAndEnabled(): boolean;
         __internalNewInstanceCreated(): any;
@@ -105,6 +113,7 @@ declare module "engine/engine_types" {
         get worldQuaternion(): Quaternion;
     }
     export interface ICamera extends IComponent {
+        get isCamera(): boolean;
         applyClearFlagsIfIsActiveCamera(): unknown;
         buildCamera(): any;
         get cam(): Camera;
@@ -167,7 +176,7 @@ declare module "engine/engine_types" {
         constructor(localPt: Vec3, dist: number, normal: Vec3);
     }
     export class Collision {
-        private readonly contacts;
+        readonly contacts: ContactPoint[];
         constructor(obj: Object3D, otherCollider: ICollider, contacts: ContactPoint[]);
         readonly me: Object3D;
         private _collider;
@@ -423,6 +432,7 @@ declare module "engine/engine_input" {
         getIsTouch(i: number): boolean;
         getTouchesPressedCount(): number;
         getMouseWheelChanged(i?: number): boolean;
+        getMouseWheelDeltaY(i?: number): number;
         getPointerEvent(i: number): Event | undefined;
         private context;
         private _pointerDown;
@@ -440,6 +450,7 @@ declare module "engine/engine_input" {
         private _pointerIds;
         private _pointerTypes;
         private _mouseWheelChanged;
+        private _mouseWheelDeltaY;
         private _pointerEvent;
         getKeyDown(): string | null;
         getKeyPressed(): string | null;
@@ -768,6 +779,7 @@ declare module "engine/engine_physics" {
         raycast(options?: RaycastOptions | null): Array<Intersection>;
         private _tempPosition;
         private _tempQuaternion;
+        private _tempScale;
         private _tempMatrix;
         private static _didLoadPhysicsEngine;
         private _isUpdatingPhysicsWorld;
@@ -779,10 +791,13 @@ declare module "engine/engine_physics" {
         private collisionHandler?;
         private objects;
         private bodies;
+        private _meshCache;
         constructor(context: Context);
         createWorld(): Promise<void>;
+        clearCaches(): void;
         addBoxCollider(collider: ICollider, center: Vector3, size: Vector3): void;
         addSphereCollider(collider: ICollider, center: Vector3, radius: number): void;
+        addCapsuleCollider(collider: ICollider, center: Vector3, height: number, radius: number): void;
         addMeshCollider(collider: ICollider, mesh: Mesh, convex: boolean): void;
         private createCollider;
         private getRigidbody;
@@ -800,11 +815,14 @@ declare module "engine/engine_physics" {
         private syncPhysicsBody;
         private static _matricesBuffer;
         private getRigidbodyRelativeMatrix;
+        private static centerConnectionPos;
+        private static centerConnectionRot;
+        addFixedJoint(body1: IRigidbody, body2: IRigidbody, rel: {
+            x: number;
+            y: number;
+            z: number;
+        }): void;
     }
-    export interface IColliderProvider {
-        getCollider(obj: Object3D): ICollider;
-    }
-    export function registerColliderProvider(prov: IColliderProvider): void;
 }
 declare module "engine/engine_time" {
     export class Time {
@@ -1563,9 +1581,11 @@ declare module "engine/engine_addressables" {
         private _glbRoot?;
         private _uri;
         private _progressListeners;
+        private _hash?;
+        private _hashedUri;
         private _isLoadingRawBinary;
         private _rawBinary?;
-        constructor(uri: string);
+        constructor(uri: string, hash?: string);
         private onResolvePrefab;
         private get mustLoad();
         isLoaded(): boolean | ArrayBuffer;
@@ -1643,7 +1663,7 @@ declare module "engine/engine_setup" {
     import { Application } from "engine/engine_application";
     import { ILightDataRegistry } from "engine/engine_lightdata";
     import { PlayerViewManager } from "engine/engine_playerview";
-    import { ICamera as Camera, IComponent, ILight as Light } from "engine/engine_types";
+    import { ICamera, IComponent, ILight } from "engine/engine_types";
     export const build_scene_functions: {
         [name: string]: (context: Context) => Promise<void>;
     };
@@ -1666,6 +1686,7 @@ declare module "engine/engine_setup" {
         alias: string | undefined | null;
         domElement: HTMLElement | null;
         renderer?: THREE.WebGLRenderer;
+        hash?: string;
         constructor(domElement: HTMLElement | null);
     }
     export enum FrameEvent {
@@ -1674,7 +1695,8 @@ declare module "engine/engine_setup" {
         LateUpdate = 2,
         OnBeforeRender = 3,
         OnAfterRender = 4,
-        PhysicsStep = 10
+        PrePhysicsStep = 9,
+        PostPhysicsStep = 10
     }
     export enum XRSessionMode {
         ImmersiveVR = "immersive-vr",
@@ -1689,6 +1711,8 @@ declare module "engine/engine_setup" {
         name: string;
         alias: string | undefined | null;
         isManagedExternally: boolean;
+        /** used to append to loaded assets */
+        hash?: string;
         domElement: HTMLElement;
         get resolutionScaleFactor(): number;
         /** use to scale the resolution up or down of the renderer. default is 1 */
@@ -1700,6 +1724,8 @@ declare module "engine/engine_setup" {
         get domY(): number;
         get isInXR(): boolean;
         xrSessionMode: XRSessionMode | undefined;
+        get isInVR(): boolean;
+        get isInAR(): boolean;
         get xrSession(): THREE.XRSession | null;
         get arOverlayElement(): HTMLElement;
         scene: THREE.Scene;
@@ -1716,7 +1742,7 @@ declare module "engine/engine_setup" {
             [FrameEvent: number]: Array<CoroutineData>;
         };
         get mainCamera(): THREE.Camera | null;
-        mainCameraComponent: Camera | undefined;
+        mainCameraComponent: ICamera | undefined;
         post_setup_callbacks: Function[];
         pre_update_callbacks: Function[];
         pre_render_callbacks: Function[];
@@ -1734,7 +1760,7 @@ declare module "engine/engine_setup" {
          * @deprecated AssetDataBase is deprecated
          */
         assets: AssetDatabase;
-        mainLight: Light | null;
+        mainLight: ILight | null;
         rendererData: RendererData;
         addressables: Addressables;
         lightmaps: ILightDataRegistry;
@@ -1751,8 +1777,8 @@ declare module "engine/engine_setup" {
         unregisterCoroutineUpdate(coroutine: Generator, evt: FrameEvent): void;
         stopAllCoroutinesFrom(script: IComponent): void;
         private _cameraStack;
-        setCurrentCamera(cam: Camera): void;
-        removeCamera(cam?: Camera | null): void;
+        setCurrentCamera(cam: ICamera): void;
+        removeCamera(cam?: ICamera | null): void;
         private _onBeforeRenderListeners;
         /** use this to subscribe to onBeforeRender events on threejs objects */
         addBeforeRenderListener(target: THREE.Object3D, callback: OnBeforeRenderCallback): void;
@@ -2070,6 +2096,7 @@ declare module "engine-components/Animation" {
         start(): void;
         update(): void;
         getAction(name: string): THREE.AnimationAction | undefined | null;
+        get isPlaying(): boolean;
         play(clipOrNumber: AnimationClip | number | string, options?: PlayOptions): Promise<AnimationAction> | void;
         internalOnPlay(action: AnimationAction, options?: PlayOptions): Promise<AnimationAction>;
         private tryFindHandle;
@@ -2455,6 +2482,7 @@ declare module "engine-components/Camera" {
         Uninitialized = 4
     }
     export class Camera extends Behaviour implements ICamera {
+        get isCamera(): boolean;
         get aspect(): number;
         get fieldOfView(): number;
         set fieldOfView(val: number);
@@ -2479,6 +2507,7 @@ declare module "engine-components/Camera" {
         get cam(): THREE.PerspectiveCamera | THREE.OrthographicCamera;
         awake(): void;
         onEnable(): void;
+        onDisable(): void;
         buildCamera(): void;
         applyClearFlagsIfIsActiveCamera(): void;
         private environmentIsTransparent;
@@ -2599,8 +2628,13 @@ declare module "engine-components/RigidBody" {
         onDisable(): void;
         onDestroy(): void;
         onValidate(): void;
-        earlyUpdate(): void;
+        beforePhysics(): Generator<undefined, void, unknown>;
         private get body();
+        teleport(pt: {
+            x: number;
+            y: number;
+            z: number;
+        }, localspace?: boolean): void;
         resetForces(): void;
         resetTorques(): void;
         resetVelocities(): void;
@@ -2628,7 +2662,7 @@ declare module "engine-components/RigidBody" {
 declare module "engine-components/Collider" {
     import { Behaviour } from "engine-components/Component";
     import { Rigidbody } from "engine-components/RigidBody";
-    import { Mesh } from "three";
+    import { Mesh, Vector3 } from "three";
     import { ICollider } from "engine/engine_types";
     export class Collider extends Behaviour implements ICollider {
         get isCollider(): any;
@@ -2641,21 +2675,62 @@ declare module "engine-components/Collider" {
     }
     export class SphereCollider extends Collider {
         radius: number;
-        center: THREE.Vector3;
+        center: Vector3;
         onEnable(): void;
     }
     export class BoxCollider extends Collider {
-        size: THREE.Vector3;
-        center: THREE.Vector3;
+        size: Vector3;
+        center: Vector3;
         onEnable(): void;
     }
     export class MeshCollider extends Collider {
         sharedMesh?: Mesh;
         convex: boolean;
-        awake(): void;
+        onEnable(): void;
+    }
+    export class CapsuleCollider extends Collider {
+        center: Vector3;
+        radius: number;
+        height: number;
         onEnable(): void;
     }
 }
+declare module "engine-components/CharacterController" {
+    import { Vector3 } from "three";
+    import { Collision } from "engine/engine_types";
+    import { Behaviour } from "engine-components/Component";
+    import { Rigidbody } from "engine-components/RigidBody";
+    import { Animator } from "engine-components/Animator";
+    export class CharacterController extends Behaviour {
+        center: Vector3;
+        radius: number;
+        height: number;
+        private _rigidbody;
+        get rigidbody(): Rigidbody;
+        onEnable(): void;
+        move(vec: Vector3): void;
+        private _activeGroundCollisions;
+        onCollisionEnter(col: Collision): void;
+        onCollisionExit(col: Collision): void;
+        get isGrounded(): boolean;
+    }
+    export class CharacterControllerInput extends Behaviour {
+        controller?: CharacterController;
+        movementSpeed: number;
+        rotationSpeed: number;
+        jumpForce: number;
+        animator?: Animator;
+        lookForward: boolean;
+        private _currentSpeed;
+        private _currentAngularSpeed;
+        private _temp;
+        private _jumpCount;
+        private _currentRotation;
+        awake(): void;
+        update(): void;
+        private _raycastOptions;
+    }
+}
 declare module "engine-components/ui/PointerEvents" {
     export interface IInputEventArgs {
         get used(): boolean;
@@ -3834,6 +3909,23 @@ declare module "engine-components/GroundProjection" {
         updateProjection(): void;
     }
 }
+declare module "engine-components/Joints" {
+    import { Vector3 } from "three";
+    import { Behaviour } from "engine-components/Component";
+    import { Rigidbody } from "engine-components/RigidBody";
+    export abstract class Joint extends Behaviour {
+        connectedBody?: Rigidbody;
+        get rigidBody(): Rigidbody | null;
+        private _rigidBody;
+        connectedAnchor?: Vector3;
+        onEnable(): void;
+        private create;
+        protected abstract createJoint(self: Rigidbody, other: Rigidbody): any;
+    }
+    export class FixedJoint extends Joint {
+        protected createJoint(self: Rigidbody, other: Rigidbody): void;
+    }
+}
 declare module "engine-components/Light" {
     import { Behaviour } from "engine-components/Component";
     import * as THREE from "three";
@@ -3871,6 +3963,8 @@ declare module "engine-components/Light" {
         set shadowNormalBias(val: number);
         get shadowNormalBias(): number;
         private _shadowNormalBias;
+        /** when enabled this will remove the multiplication when setting the shadow bias settings initially */
+        private _overrideShadowBiasSettings;
         set shadows(val: LightShadows);
         get shadows(): LightShadows;
         private _shadows;
@@ -4308,14 +4402,15 @@ declare module "engine-components/Skybox" {
 declare module "engine-components/SmoothFollow" {
     import { Behaviour } from "engine-components/Component";
     import * as THREE from "three";
+    import { Axes } from "engine/engine_physics.types";
     export class SmoothFollow extends Behaviour {
         target: THREE.Object3D | null;
         followFactor: number;
         rotateFactor: number;
+        positionAxes: Axes;
         flipForward: boolean;
         private static _invertForward;
         private _firstUpdate;
-        onEnable(): void;
         onBeforeRender(): void;
         updateNow(hard: boolean): void;
     }
@@ -5332,10 +5427,13 @@ declare module "engine-components/codegen/components" {
     export { BasicIKConstraint } from "engine-components/BasicIKConstraint";
     export { BoxHelperComponent } from "engine-components/BoxHelperComponent";
     export { Camera } from "engine-components/Camera";
+    export { CharacterController } from "engine-components/CharacterController";
+    export { CharacterControllerInput } from "engine-components/CharacterController";
     export { Collider } from "engine-components/Collider";
     export { SphereCollider } from "engine-components/Collider";
     export { BoxCollider } from "engine-components/Collider";
     export { MeshCollider } from "engine-components/Collider";
+    export { CapsuleCollider } from "engine-components/Collider";
     export { DeleteBox } from "engine-components/DeleteBox";
     export { Deletable } from "engine-components/DeleteBox";
     export { DeviceFlag } from "engine-components/DeviceFlag";
@@ -5354,6 +5452,7 @@ declare module "engine-components/codegen/components" {
     export { GroundProjectedEnv } from "engine-components/GroundProjection";
     export { Interactable } from "engine-components/Interactable";
     export { UsageMarker } from "engine-components/Interactable";
+    export { FixedJoint } from "engine-components/Joints";
     export { Light } from "engine-components/Light";
     export { LODModel } from "engine-components/LODGroup";
     export { LODGroup } from "engine-components/LODGroup";