@needle-tools/engine 3.19.1 → 3.19.2

package/src/engine-components/OrbitControls.ts

@@ -13,8 +13,6 @@ import { ICameraController } from "../engine/engine_types.js";
 import { setCameraController } from "../engine/engine_camera.js";
 import { SyncedTransform } from "./SyncedTransform.js";
 import { tryGetUIComponent } from "./ui/Utils.js";
-import { GroundProjectedEnv } from "./GroundProjection.js";
-import { ShadowCatcher } from "./ShadowCatcher.js";
 import { GroundProjectedSkybox } from "three/examples/jsm/objects/GroundProjectedSkybox.js";
 
 const freeCam = getParam("freecam");
@@ -43,6 +41,9 @@ export class OrbitControls extends Behaviour implements ICameraController {
 
     autoRotate: boolean = false;
     autoRotateSpeed: number = 1.0;
+    /** When enabled the scene will be automatically fitted into the camera view in onEnable */
+    @serializable()
+    autoFit: boolean = false;
     enableKeys: boolean = true;
     enableDamping: boolean = true;
     dampingFactor: number = 0.1;
@@ -81,15 +82,18 @@ export class OrbitControls extends Behaviour implements ICameraController {
     private _afterHandleInputFn?: any;
     private _camera: Camera | null = null;
     private _syncedTransform?: SyncedTransform;
+    private _didStart = false;
 
     targetElement: HTMLElement | null = null;
 
     awake(): void {
+        this._didStart = false;
         this._lookTargetPosition = new Vector3();
         this._startedListeningToKeyEvents = false;
     }
 
     start() {
+        this._didStart = true;
         if (this.autoTarget) {
             if (this._controls) {
                 const camGo = GameObject.getComponent(this.gameObject, Camera);
@@ -99,10 +103,19 @@ export class OrbitControls extends Behaviour implements ICameraController {
                     const worldPosition = getWorldPosition(camGo.cam);
                     const distanceToCenter = worldPosition.length();
                     const forward = new Vector3(0, 0, -distanceToCenter).applyMatrix4(camGo.cam.matrixWorld);
-                    this.setTarget(forward, true);
                 }
+                if (this.autoTarget && !this.setFromTargetPosition()) {
+                    const opts = new RaycastOptions();
+                    // center of the screen:
+                    opts.screenPoint = new Vector2(0, 0);
+                    opts.lineThreshold = 0.1;
+                    const hits = this.context.physics.raycast(opts);
+                    if (hits.length > 0) {
+                        this.setTarget(hits[0].point, true);
+                    }
+                }
+                if (this.autoFit) this.fitCamera()
             }
-            this.startCoroutine(this.startRaycastDelayed());
         }
 
         this._eventSystem = EventSystem.get(this.context) ?? undefined;
@@ -173,6 +186,9 @@ export class OrbitControls extends Behaviour implements ICameraController {
             }
         }
         this._syncedTransform = GameObject.getComponent(this.gameObject, SyncedTransform) ?? undefined;
+        if (this._didStart) {
+            if (this.autoFit) this.fitCamera()
+        }
     }
 
     onDisable() {
@@ -207,20 +223,6 @@ export class OrbitControls extends Behaviour implements ICameraController {
         }
     }
 
-    // we need to wait one frame (when starting the scene for the very first time)
-    private * startRaycastDelayed() {
-        yield;
-        if (this.autoTarget && !this.setFromTargetPosition()) {
-            const opts = new RaycastOptions();
-            // center of the screen:
-            opts.screenPoint = new Vector2(0, 0);
-            opts.lineThreshold = 0.1;
-            const hits = this.context.physics.raycast(opts);
-            if (hits.length > 0) {
-                this.setTarget(hits[0].point, true);
-            }
-        }
-    }
 
     onBeforeRender() {
         if (!this._controls) return;
@@ -374,7 +376,7 @@ export class OrbitControls extends Behaviour implements ICameraController {
     // Adapted from https://discourse.threejs.org/t/camera-zoom-to-fit-object/936/24
     // Slower but better implementation that takes bones and exact vertex positions into account: https://github.com/google/model-viewer/blob/04e900c5027de8c5306fe1fe9627707f42811b05/packages/model-viewer/src/three-components/ModelScene.ts#L321
     /** Fits the camera to show the objects provided (defaults to the scene if no objects are passed in) */
-    fitCamera(objects?: Array<Object3D>, fitOffset: number = 1.1) {
+    fitCamera(objects?: Array<Object3D>, fitOffset: number = 1.1, immediate: boolean = true) {
         const camera = this._cameraObject as PerspectiveCamera;
         const controls = this._controls as ThreeOrbitControls | null;
         if (!objects?.length) objects = this.context.scene.children;
@@ -395,6 +397,8 @@ export class OrbitControls extends Behaviour implements ICameraController {
         const emptyChildren = [];
         function expandByObjectRecursive(obj: Object3D) {
             let allowExpanding = true;
+            // we dont want to check invisible objects
+            if (!obj.visible) return;
             // ignore Box3Helpers
             if (obj instanceof Box3Helper) allowExpanding = false;
             if (obj instanceof GridHelper) allowExpanding = false;
@@ -402,9 +406,16 @@ export class OrbitControls extends Behaviour implements ICameraController {
             if (obj instanceof GroundProjectedSkybox) allowExpanding = false;
             // // Ignore shadow catcher geometry
             if ((obj as Mesh).material instanceof ShadowMaterial) allowExpanding = false;
+            // ONLY fit meshes
+            if (!(obj instanceof Mesh)) allowExpanding = false;
+            // Ignore things parented to the camera + ignore the camera
+            if (obj === camera) return;
+            // We don't want to fit UI objects
+            if (obj["isUI"] === true) return;
             // If we encountered some geometry that should be ignored
             // Then we don't want to use that for expanding the view
             if (allowExpanding) {
+                console.log(obj.name, obj.type, obj);
                 // Temporary override children
                 const children_length = obj.children;
                 obj.children = emptyChildren;
@@ -453,7 +464,8 @@ export class OrbitControls extends Behaviour implements ICameraController {
 
         controls.maxDistance = distance * 10;
         controls.minDistance = distance * 0.01;
-        this.setTarget(center, true);
+
+        this.setTarget(center, immediate);
         this.autoTarget = false;
 
         // TODO: this doesnt take the Camera component nearClipPlane into account
@@ -463,7 +475,13 @@ export class OrbitControls extends Behaviour implements ICameraController {
         camera.updateMatrixWorld();
         camera.updateProjectionMatrix();
 
-        setWorldPosition(camera, controls.target.clone().sub(direction));
+        if (camera.parent) {
+            const cameraLocalPosition = camera.parent!.worldToLocal(controls.target.clone().sub(direction));
+            this.setCameraTarget(cameraLocalPosition, immediate);
+        }
+        else console.error(`Can not fit camera ${camera.name} because it has no parent`)
+
+        // setWorldPosition(camera, controls.target.clone().sub(direction));
 
         if (debugCameraFit) {
             const helper = new Box3Helper(box);