Update orbit-camera.js

orbit-camera.js

@@ -1,3 +1,4 @@
+// orbit-camera.js
 ///////////////////////////////////////////////////////////////////////////////
 //                             Orbit Camera Script                            //
 ////////////////////////////////////////////////////////////////////////////////
@@ -35,6 +36,7 @@ OrbitCamera.attributes.add('frameOnStart', {
 });
 
 // Property to get and set the distance between the pivot point and camera
+// Clamped between this.distanceMin and this.distanceMax
 Object.defineProperty(OrbitCamera.prototype, 'distance', {
     get: function () {
         return this._targetDistance;
@@ -55,12 +57,31 @@ Object.defineProperty(OrbitCamera.prototype, 'orthoHeight', {
 });
 
 // Property to get and set the pitch (in degrees) of the camera around the pivot.
+// The pitch value is clamped between pitchAngleMin and pitchAngleMax.
+// With your JSON (minAngle: -90, maxAngle: 0), the allowed pitch will be from -90 (overhead)
+// to 0 (horizontal). Additionally respects minY so camera never goes below ground.
 Object.defineProperty(OrbitCamera.prototype, 'pitch', {
     get: function () {
         return this._targetPitch;
     },
     set: function (value) {
-        this._targetPitch = this._clampPitchAngle(value);
+        // clamp to configured limits first
+        var clamped = this._clampPitchAngle(value);
+        // compute max downward pitch allowed by minY
+        if (this._pivotPoint && this._targetDistance > 0) {
+            // pivot height and distance
+            var pivotY = this._pivotPoint.y;
+            var dist = this._targetDistance;
+            // compute max pitch angle (radians) so that pivotY - sin(pitch)*dist >= minY
+            var maxDown = Math.asin(Math.max(0, Math.min(1, (pivotY - this.minY) / dist)));
+            // asin gives positive angle; downward pitch is negative, so use -maxDown
+            var maxDownDeg = - maxDown * pc.math.RAD_TO_DEG;
+            // ensure clamped is not below maxDownDeg
+            if (clamped < maxDownDeg) {
+                clamped = maxDownDeg;
+            }
+        }
+        this._targetPitch = clamped;
     }
 });
 
@@ -86,6 +107,7 @@ Object.defineProperty(OrbitCamera.prototype, 'pivotPoint', {
 
 // Moves the camera to look at an entity and all its children so they are all in view.
 OrbitCamera.prototype.focus = function (focusEntity) {
+    // Calculate a bounding box that encompasses all models to frame in the camera view.
     this._buildAabb(focusEntity);
     var halfExtents = this._modelsAabb.halfExtents;
     var radius = Math.max(halfExtents.x, Math.max(halfExtents.y, halfExtents.z));
@@ -96,6 +118,7 @@ OrbitCamera.prototype.focus = function (focusEntity) {
 
 OrbitCamera.distanceBetween = new pc.Vec3();
 
+// Set the camera position to a world position and look at a world position.
 OrbitCamera.prototype.resetAndLookAtPoint = function (resetPoint, lookAtPoint) {
     this.pivotPoint.copy(lookAtPoint);
     this.entity.setPosition(resetPoint);
@@ -156,6 +179,7 @@ OrbitCamera.prototype.initialize = function () {
     this._pivotPoint.copy(this._modelsAabb.center);
     var cameraQuat = this.entity.getRotation();
     this._yaw = this._calcYaw(cameraQuat);
+    // Compute pitch and clamp it immediately.
     this._pitch = this._clampPitchAngle(this._calcPitch(cameraQuat, this._yaw));
     this.entity.setLocalEulerAngles(this._pitch, this._yaw, 0);
     this._distance = 0;
@@ -172,26 +196,26 @@ OrbitCamera.prototype.initialize = function () {
 
     this._targetDistance = this._distance;
 
-    this.on('attr:distanceMin', function (value, prev) {
+    this.on('attr:distanceMin', function () {
         this._distance = this._clampDistance(this._distance);
     });
-    this.on('attr:distanceMax', function (value, prev) {
+    this.on('attr:distanceMax', function () {
         this._distance = this._clampDistance(this._distance);
     });
-    this.on('attr:pitchAngleMin', function (value, prev) {
+    this.on('attr:pitchAngleMin', function () {
         this._pitch = this._clampPitchAngle(this._pitch);
     });
-    this.on('attr:pitchAngleMax', function (value, prev) {
+    this.on('attr:pitchAngleMax', function () {
         this._pitch = this._clampPitchAngle(this._pitch);
     });
-    this.on('attr:focusEntity', function (value, prev) {
+    this.on('attr:focusEntity', function (value) {
         if (this.frameOnStart) {
             this.focus(value || this.app.root);
         } else {
             this.resetAndLookAtEntity(this.entity.getPosition(), value || this.app.root);
         }
     });
-    this.on('attr:frameOnStart', function (value, prev) {
+    this.on('attr:frameOnStart', function (value) {
         if (value) {
             this.focus(this.focusEntity || this.app.root);
         }
@@ -216,7 +240,7 @@ OrbitCamera.prototype._updatePosition = function () {
     position.copy(this.entity.forward);
     position.mulScalar(-this._distance);
     position.add(this.pivotPoint);
-    // Clamp the camera's Y position so it never goes below minY.
+    // Ensure world Y never drops below minY
     position.y = Math.max(position.y, this.minY);
     this.entity.setPosition(position);
 };
@@ -234,11 +258,11 @@ OrbitCamera.prototype._checkAspectRatio = function () {
 };
 
 OrbitCamera.prototype._buildAabb = function (entity) {
-    var i, m, meshInstances = [];
+    var meshInstances = [];
     var renders = entity.findComponents('render');
-    for (i = 0; i < renders.length; i++) {
+    for (var i = 0; i < renders.length; i++) {
         var render = renders[i];
-        for (m = 0; m < render.meshInstances.length; m++) {
+        for (var m = 0; m < render.meshInstances.length; m++) {
             meshInstances.push(render.meshInstances[m]);
         }
     }
@@ -251,9 +275,8 @@ OrbitCamera.prototype._buildAabb = function (entity) {
     }
     var gsplats = entity.findComponents('gsplat');
     for (i = 0; i < gsplats.length; i++) {
-        var gsplat = gsplats[i];
-        var instance = gsplat.instance;
-        if (instance?.meshInstance) {
+        var instance = gsplats[i].instance;
+        if (instance && instance.meshInstance) {
             meshInstances.push(instance.meshInstance);
         }
     }
@@ -279,27 +302,9 @@ OrbitCamera.prototype._clampDistance = function (distance) {
     return Math.max(distance, this.distanceMin);
 };
 
-// ----- FIXED PITCH CLAMPING WITH minY RESPECT -----
+// Clamp the pitch between pitchAngleMin and pitchAngleMax
 OrbitCamera.prototype._clampPitchAngle = function (pitch) {
-    // Clamp between configured pitchAngleMin/Max first
-    var clamped = pc.math.clamp(pitch, this.pitchAngleMin, this.pitchAngleMax);
-
-    // Then ensure resulting world-space Y >= minY
-    // simulate forward vector
-    var yaw = this._targetYaw;
-    var quat = new pc.Quat().setFromEulerAngles(clamped, yaw, 0);
-    var forward = new pc.Vec3();
-    quat.transformVector(pc.Vec3.FORWARD, forward);
-    var simulatedY = this._pivotPoint.y - forward.y * this._targetDistance;
-    if (simulatedY < this.minY) {
-        // compute max pitch that just reaches minY: asin((pivotY-minY)/distance)
-        var ratio = (this._pivotPoint.y - this.minY) / this._targetDistance;
-        ratio = pc.math.clamp(ratio, -1, 1);
-        var angle = Math.asin(ratio) * pc.math.RAD_TO_DEG;
-        return pc.math.clamp(angle, this.pitchAngleMin, this.pitchAngleMax);
-    }
-
-    return clamped;
+    return pc.math.clamp(pitch, this.pitchAngleMin, this.pitchAngleMax);
 };
 
 OrbitCamera.prototype._clampYawAngle = function (yaw) {
@@ -309,7 +314,7 @@ OrbitCamera.prototype._clampYawAngle = function (yaw) {
 OrbitCamera.quatWithoutYaw = new pc.Quat();
 OrbitCamera.yawOffset = new pc.Quat();
 
-// ----- REVISED PITCH CALCULATION -----
+// Compute pitch from quaternion and yaw
 OrbitCamera.prototype._calcPitch = function (quat, yaw) {
     var quatWithoutYaw = OrbitCamera.quatWithoutYaw;
     var yawOffset = OrbitCamera.yawOffset;
@@ -319,224 +324,3 @@ OrbitCamera.prototype._calcPitch = function (quat, yaw) {
     quatWithoutYaw.transformVector(pc.Vec3.FORWARD, transformedForward);
     return Math.atan2(-transformedForward.y, -transformedForward.z) * pc.math.RAD_TO_DEG;
 };
-
-
-
-////////////////////////////////////////////////////////////////////////////////
-//                       Orbit Camera Mouse Input Script                      //
-////////////////////////////////////////////////////////////////////////////////
-var OrbitCameraInputMouse = pc.createScript('orbitCameraInputMouse');
-
-OrbitCameraInputMouse.attributes.add('orbitSensitivity', {
-    type: 'number',
-    default: 0.3,
-    title: 'Orbit Sensitivity',
-    description: 'How fast the camera moves around the orbit. Higher is faster'
-});
-OrbitCameraInputMouse.attributes.add('distanceSensitivity', {
-    type: 'number',
-    default: 0.4,
-    title: 'Distance Sensitivity',
-    description: 'How fast the camera moves in and out. Higher is faster'
-});
-
-OrbitCameraInputMouse.prototype.initialize = function () {
-    this.orbitCamera = this.entity.script.orbitCamera;
-    if (this.orbitCamera) {
-        var self = this;
-        var onMouseOut = function (e) { self.onMouseOut(e); };
-        this.app.mouse.on(pc.EVENT_MOUSEDOWN, this.onMouseDown, this);
-        this.app.mouse.on(pc.EVENT_MOUSEUP, this.onMouseUp, this);
-        this.app.mouse.on(pc.EVENT_MOUSEMOVE, this.onMouseMove, this);
-        this.app.mouse.on(pc.EVENT_MOUSEWHEEL, this.onMouseWheel, this);
-        window.addEventListener('mouseout', onMouseOut, false);
-        this.on('destroy', function () {
-            this.app.mouse.off(pc.EVENT_MOUSEDOWN, this.onMouseDown, this);
-            this.app.mouse.off(pc.EVENT_MOUSEUP, this.onMouseUp, this);
-            this.app.mouse.off(pc.EVENT_MOUSEMOVE, this.onMouseMove, this);
-            this.app.mouse.off(pc.EVENT_MOUSEWHEEL, this.onMouseWheel, this);
-            window.removeEventListener('mouseout', onMouseOut, false);
-        });
-    }
-    this.app.mouse.disableContextMenu();
-    this.lookButtonDown = false;
-    this.panButtonDown = false;
-    this.lastPoint = new pc.Vec2();
-};
-
-OrbitCameraInputMouse.fromWorldPoint = new pc.Vec3();
-OrbitCameraInputMouse.toWorldPoint = new pc.Vec3();
-OrbitCameraInputMouse.worldDiff = new pc.Vec3();
-
-OrbitCameraInputMouse.prototype.pan = function (screenPoint) {
-    var fromWorldPoint = OrbitCameraInputMouse.fromWorldPoint;
-    var toWorldPoint = OrbitCameraInputMouse.toWorldPoint;
-    var worldDiff = OrbitCameraInputMouse.worldDiff;
-    var camera = this.entity.camera;
-    var distance = this.orbitCamera.distance;
-    camera.screenToWorld(screenPoint.x, screenPoint.y, distance, fromWorldPoint);
-    camera.screenToWorld(this.lastPoint.x, this.lastPoint.y, distance, toWorldPoint);
-    worldDiff.sub2(toWorldPoint, fromWorldPoint);
-    this.orbitCamera.pivotPoint.add(worldDiff);
-    var pitchRadians = this.orbitCamera.pitch * pc.math.DEG_TO_RAD;
-    var minPivotY = this.orbitCamera.distance * Math.sin(pitchRadians);
-    if (this.orbitCamera.pivotPoint.y < minPivotY) {
-        this.orbitCamera.pivotPoint.y = minPivotY;
-    }
-};
-
-OrbitCameraInputMouse.prototype.onMouseDown = function (event) {
-    switch (event.button) {
-        case pc.MOUSEBUTTON_LEFT:
-            this.panButtonDown = true;
-            break;
-        case pc.MOUSEBUTTON_MIDDLE:
-        case pc.MOUSEBUTTON_RIGHT:
-            this.lookButtonDown = true;
-            break;
-    }
-};
-OrbitCameraInputMouse.prototype.onMouseUp = function (event) {
-    switch (event.button) {
-        case pc.MOUSEBUTTON_LEFT:
-            this.panButtonDown = false;
-            break;
-        case pc.MOUSEBUTTON_MIDDLE:
-        case pc.MOUSEBUTTON_RIGHT:
-            this.lookButtonDown = false;
-            break;
-    }
-};
-
-OrbitCameraInputMouse.prototype.onMouseMove = function (event) {
-    if (this.lookButtonDown) {
-        var delta = -event.dy * this.orbitSensitivity;
-        var camY = this.entity.getPosition().y;
-        // block further downward orbit when at minY
-        if (!(delta < 0 && camY <= this.orbitCamera.minY)) {
-            this.orbitCamera.pitch += delta;
-        }
-    } else if (this.panButtonDown) {
-        this.pan(new pc.Vec2(event.x, event.y));
-    }
-    this.lastPoint.set(event.x, event.y);
-};
-
-OrbitCameraInputMouse.prototype.onMouseWheel = function (event) {
-    if (this.entity.camera.projection === pc.PROJECTION_PERSPECTIVE) {
-        this.orbitCamera.distance -= event.wheelDelta * this.distanceSensitivity * (this.orbitCamera.distance * 0.1);
-    } else {
-        this.orbitCamera.orthoHeight -= event.wheelDelta * this.distanceSensitivity * (this.orbitCamera.orthoHeight * 0.1);
-    }
-    event.event.preventDefault();
-};
-
-OrbitCameraInputMouse.prototype.onMouseOut = function (event) {
-    this.lookButtonDown = false;
-    this.panButtonDown = false;
-};
-
-
-////////////////////////////////////////////////////////////////////////////////
-//                       Orbit Camera Touch Input Script                      //
-////////////////////////////////////////////////////////////////////////////////
-var OrbitCameraInputTouch = pc.createScript('orbitCameraInputTouch');
-
-OrbitCameraInputTouch.attributes.add('orbitSensitivity', {
-    type: 'number',
-    default: 0.6,
-    title: 'Orbit Sensitivity',
-    description: 'How fast the camera moves around the orbit. Higher is faster'
-});
-OrbitCameraInputTouch.attributes.add('distanceSensitivity', {
-    type: 'number',
-    default: 0.5,
-    title: 'Distance Sensitivity',
-    description: 'How fast the camera moves in and out. Higher is faster'
-});
-
-OrbitCameraInputTouch.prototype.initialize = function () {
-    this.orbitCamera = this.entity.script.orbitCamera;
-    this.lastTouchPoint = new pc.Vec2();
-    this.lastPinchMidPoint = new pc.Vec2();
-    this.lastPinchDistance = 0;
-    if (this.orbitCamera && this.app.touch) {
-        this.app.touch.on(pc.EVENT_TOUCHSTART, this.onTouchStartEndCancel, this);
-        this.app.touch.on(pc.EVENT_TOUCHEND, this.onTouchStartEndCancel, this);
-        this.app.touch.on(pc.EVENT_TOUCHCANCEL, this.onTouchStartEndCancel, this);
-        this.app.touch.on(pc.EVENT_TOUCHMOVE, this.onTouchMove, this);
-        this.on('destroy', function () {
-            this.app.touch.off(pc.EVENT_TOUCHSTART, this.onTouchStartEndCancel, this);
-            this.app.touch.off(pc.EVENT_TOUCHEND, this.onTouchStartEndCancel, this);
-            this.app.touch.off(pc.EVENT_TOUCHCANCEL, this.onTouchStartEndCancel, this);
-            this.app.touch.off(pc.EVENT_TOUCHMOVE, this.onTouchMove, this);
-        });
-    }
-};
-
-OrbitCameraInputTouch.prototype.getPinchDistance = function (pointA, pointB) {
-    var dx = pointA.x - pointB.x;
-    var dy = pointA.y - pointB.y;
-    return Math.sqrt((dx * dx) + (dy * dy));
-};
-OrbitCameraInputTouch.prototype.calcMidPoint = function (pointA, pointB, result) {
-    result.set(pointB.x - pointA.x, pointB.y - pointA.y);
-    result.mulScalar(0.5);
-    result.x += pointA.x;
-    result.y += pointA.y;
-};
-OrbitCameraInputTouch.prototype.onTouchStartEndCancel = function (event) {
-    var touches = event.touches;
-    if (touches.length === 1) {
-        this.lastTouchPoint.set(touches[0].x, touches[0].y);
-    } else if (touches.length === 2) {
-        this.lastPinchDistance = this.getPinchDistance(touches[0], touches[1]);
-        this.calcMidPoint(touches[0], touches[1], this.lastPinchMidPoint);
-    }
-};
-
-OrbitCameraInputTouch.fromWorldPoint = new pc.Vec3();
-OrbitCameraInputTouch.toWorldPoint = new pc.Vec3();
-OrbitCameraInputTouch.worldDiff = new pc.Vec3();
-
-OrbitCameraInputTouch.prototype.pan = function (midPoint) {
-    var fromWorldPoint = OrbitCameraInputTouch.fromWorldPoint;
-    var toWorldPoint = OrbitCameraInputTouch.toWorldPoint;
-    var worldDiff = OrbitCameraInputTouch.worldDiff;
-    var camera = this.entity.camera;
-    var distance = this.orbitCamera.distance;
-    camera.screenToWorld(midPoint.x, midPoint.y, distance, fromWorldPoint);
-    camera.screenToWorld(this.lastPinchMidPoint.x, this.lastPinchMidPoint.y, distance, toWorldPoint);
-    worldDiff.sub2(toWorldPoint, fromWorldPoint);
-    this.orbitCamera.pivotPoint.add(worldDiff);
-    var pitchRadians = this.orbitCamera.pitch * pc.math.DEG_TO_RAD;
-    var minPivotY = this.orbitCamera.distance * Math.sin(pitchRadians);
-    if (this.orbitCamera.pivotPoint.y < minPivotY) {
-        this.orbitCamera.pivotPoint.y = minPivotY;
-    }
-};
-
-OrbitCameraInputTouch.pinchMidPoint = new pc.Vec2();
-
-OrbitCameraInputTouch.prototype.onTouchMove = function (event) {
-    var touches = event.touches;
-    if (touches.length === 1) {
-        var touch = touches[0];
-        var dy = touch.y - this.lastTouchPoint.y;
-        var delta = -dy * this.orbitSensitivity;
-        var camY = this.entity.getPosition().y;
-        // block further downward orbit when at minY
-        if (!(delta < 0 && camY <= this.orbitCamera.minY)) {
-            this.orbitCamera.pitch += delta;
-        }
-        this.lastTouchPoint.set(touch.x, touch.y);
-    } else if (touches.length === 2) {
-        var currentPinchDistance = this.getPinchDistance(touches[0], touches[1]);
-        var diffInPinchDistance = currentPinchDistance - this.lastPinchDistance;
-        this.lastPinchDistance = currentPinchDistance;
-        this.orbitCamera.distance -= (diffInPinchDistance * this.distanceSensitivity * 0.1) * (this.orbitCamera.distance * 0.1);
-        this.calcMidPoint(touches[0], touches[1], OrbitCameraInputTouch.pinchMidPoint);
-        this.pan(OrbitCameraInputTouch.pinchMidPoint);
-        this.lastPinchMidPoint.copy(OrbitCameraInputTouch.pinchMidPoint);
-    }
-};