Update orbit-camera.js

orbit-camera.js

@@ -1,91 +1,45 @@
-// orbit-camera.js (fixed to clamp world Y at minY, with debug logs)
-
-///////////////////////////////////////////////////////////////////////////////
-//                             Orbit Camera Script                           //
-///////////////////////////////////////////////////////////////////////////////
+// orbit-camera.js
 
 var OrbitCamera = pc.createScript('orbitCamera');
 
-OrbitCamera.attributes.add('distanceMax', { type: 'number', default: 20, title: 'Distance Max', description: 'Setting this at 0 will give an infinite distance limit' });
+// Camera attributes
+OrbitCamera.attributes.add('distanceMax', { type: 'number', default: 20, title: 'Distance Max' });
 OrbitCamera.attributes.add('distanceMin', { type: 'number', default: 1, title: 'Distance Min' });
 OrbitCamera.attributes.add('pitchAngleMax', { type: 'number', default: 90, title: 'Pitch Angle Max (degrees)' });
-// Note: This default will be overridden by your JSON config. In your JSON you set minAngle to -90.
 OrbitCamera.attributes.add('pitchAngleMin', { type: 'number', default: 0, title: 'Pitch Angle Min (degrees)' });
 OrbitCamera.attributes.add('yawAngleMax', { type: 'number', default: 360, title: 'Yaw Angle Max (degrees)' });
 OrbitCamera.attributes.add('yawAngleMin', { type: 'number', default: -360, title: 'Yaw Angle Min (degrees)' });
-OrbitCamera.attributes.add('minY', { type: 'number', default: 0, title: 'Minimum Y', description: 'Minimum Y value for the camera during orbiting or translation' });
-
-OrbitCamera.attributes.add('inertiaFactor', {
-    type: 'number',
-    default: 0.2,
-    title: 'Inertia Factor',
-    description: 'Higher value means that the camera will continue moving after the user has stopped dragging. 0 is fully responsive.'
-});
-
-OrbitCamera.attributes.add('focusEntity', {
-    type: 'entity',
-    title: 'Focus Entity',
-    description: 'Entity for the camera to focus on. If blank, then the camera will use the whole scene'
-});
+OrbitCamera.attributes.add('minY', { type: 'number', default: 0, title: 'Minimum Y', description: 'Minimum Y value for camera world position' });
 
-OrbitCamera.attributes.add('frameOnStart', {
-    type: 'boolean',
-    default: true,
-    title: 'Frame on Start',
-    description: 'Frames the entity or scene at the start of the application."'
-});
+OrbitCamera.attributes.add('inertiaFactor', { type: 'number', default: 0.2, title: 'Inertia Factor' });
+OrbitCamera.attributes.add('focusEntity', { type: 'entity', title: 'Focus Entity' });
+OrbitCamera.attributes.add('frameOnStart', { type: 'boolean', default: true, title: 'Frame on Start' });
 
-// Property to get and set the distance between the pivot point and camera
 Object.defineProperty(OrbitCamera.prototype, 'distance', {
-    get: function () {
-        return this._targetDistance;
-    },
-    set: function (value) {
-        this._targetDistance = this._clampDistance(value);
-    }
+    get: function () { return this._targetDistance; },
+    set: function (value) { this._targetDistance = this._clampDistance(value); }
 });
 
-// Property to get and set the camera orthoHeight (clamped above 0)
 Object.defineProperty(OrbitCamera.prototype, 'orthoHeight', {
-    get: function () {
-        return this.entity.camera.orthoHeight;
-    },
-    set: function (value) {
-        this.entity.camera.orthoHeight = Math.max(0, value);
-    }
+    get: function () { return this.entity.camera.orthoHeight; },
+    set: function (value) { this.entity.camera.orthoHeight = Math.max(0, value); }
 });
 
-// Property to get and set the pitch (in degrees) of the camera around the pivot.
 Object.defineProperty(OrbitCamera.prototype, 'pitch', {
-    get: function () {
-        return this._targetPitch;
-    },
-    set: function (value) {
-        this._targetPitch = this._clampPitchAngle(value);
-    }
+    get: function () { return this._targetPitch; },
+    set: function (value) { this._targetPitch = this._clampPitchAngle(value); }
 });
 
-// Property to get and set the yaw (in degrees) of the camera around the pivot.
 Object.defineProperty(OrbitCamera.prototype, 'yaw', {
-    get: function () {
-        return this._targetYaw;
-    },
-    set: function (value) {
-        this._targetYaw = this._clampYawAngle(value);
-    }
+    get: function () { return this._targetYaw; },
+    set: function (value) { this._targetYaw = this._clampYawAngle(value); }
 });
 
-// Property to get and set the world position of the pivot point that the camera orbits around.
 Object.defineProperty(OrbitCamera.prototype, 'pivotPoint', {
-    get: function () {
-        return this._pivotPoint;
-    },
-    set: function (value) {
-        this._pivotPoint.copy(value);
-    }
+    get: function () { return this._pivotPoint; },
+    set: function (value) { this._pivotPoint.copy(value); }
 });
 
-// Moves the camera to look at an entity and all its children so they are all in view.
 OrbitCamera.prototype.focus = function (focusEntity) {
     this._buildAabb(focusEntity);
     var halfExtents = this._modelsAabb.halfExtents;
@@ -138,16 +92,24 @@ OrbitCamera.prototype.resetToPosition = function (position, lookAtPoint) {
     this._updatePosition();
 };
 
+// ==== Clamp helper for panning/orbiting so camera never under minY ====
+OrbitCamera.prototype.worldCameraYForPivot = function(pivot) {
+    var quat = new pc.Quat();
+    quat.setFromEulerAngles(this._pitch, this._yaw, 0);
+    var forward = new pc.Vec3();
+    quat.transformVector(pc.Vec3.FORWARD, forward);
+    var camPos = pivot.clone();
+    camPos.add(forward.clone().scale(-this._distance));
+    return camPos.y;
+};
+
 ////////////////////////////////////////////////////////////////////////////////
 //                          Private Methods                                   //
 ////////////////////////////////////////////////////////////////////////////////
 
 OrbitCamera.prototype.initialize = function () {
     var self = this;
-    var onWindowResize = function () {
-        self._checkAspectRatio();
-    };
-
+    var onWindowResize = function () { self._checkAspectRatio(); };
     window.addEventListener('resize', onWindowResize, false);
     this._checkAspectRatio();
     this._modelsAabb = new pc.BoundingBox();
@@ -162,7 +124,6 @@ OrbitCamera.prototype.initialize = function () {
     this._distance = 0;
     this._targetYaw = this._yaw;
     this._targetPitch = this._pitch;
-
     if (this.frameOnStart) {
         this.focus(this.focusEntity || this.app.root);
     } else {
@@ -170,36 +131,19 @@ OrbitCamera.prototype.initialize = function () {
         distanceBetween.sub2(this.entity.getPosition(), this._pivotPoint);
         this._distance = this._clampDistance(distanceBetween.length());
     }
-
     this._targetDistance = this._distance;
-
-    this.on('attr:distanceMin', function (value, prev) {
-        this._distance = this._clampDistance(this._distance);
-    });
-    this.on('attr:distanceMax', function (value, prev) {
-        this._distance = this._clampDistance(this._distance);
-    });
-    this.on('attr:pitchAngleMin', function (value, prev) {
-        this._pitch = this._clampPitchAngle(this._pitch);
-    });
-    this.on('attr:pitchAngleMax', function (value, prev) {
-        this._pitch = this._clampPitchAngle(this._pitch);
-    });
+    this.on('attr:distanceMin', function (value, prev) { this._distance = this._clampDistance(this._distance); });
+    this.on('attr:distanceMax', function (value, prev) { this._distance = this._clampDistance(this._distance); });
+    this.on('attr:pitchAngleMin', function (value, prev) { this._pitch = this._clampPitchAngle(this._pitch); });
+    this.on('attr:pitchAngleMax', function (value, prev) { this._pitch = this._clampPitchAngle(this._pitch); });
     this.on('attr:focusEntity', function (value, prev) {
-        if (this.frameOnStart) {
-            this.focus(value || this.app.root);
-        } else {
-            this.resetAndLookAtEntity(this.entity.getPosition(), value || this.app.root);
-        }
+        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) {
-        if (value) {
-            this.focus(this.focusEntity || this.app.root);
-        }
-    });
-    this.on('destroy', function () {
-        window.removeEventListener('resize', onWindowResize, false);
+        if (value) { this.focus(this.focusEntity || this.app.root); }
     });
+    this.on('destroy', function () { window.removeEventListener('resize', onWindowResize, false); });
 };
 
 OrbitCamera.prototype.update = function (dt) {
@@ -217,7 +161,7 @@ OrbitCamera.prototype._updatePosition = function () {
     position.copy(this.entity.forward);
     position.mulScalar(-this._distance);
     position.add(this.pivotPoint);
-    // Clamp camera's Y position so it never goes below minY (after all rotations)
+    // Clamp camera's Y position so it never goes below minY
     position.y = Math.max(position.y, this.minY);
     this.entity.setPosition(position);
 };
@@ -301,23 +245,11 @@ OrbitCamera.prototype._calcPitch = function (quat, yaw) {
     return Math.atan2(-transformedForward.y, -transformedForward.z) * pc.math.RAD_TO_DEG;
 };
 
-////////////////////////////////////////////////////////////////////////////////
-//                       Orbit Camera Mouse Input Script                      //
-////////////////////////////////////////////////////////////////////////////////
+// ===================== Orbit Camera Input Mouse Script ========================
 var OrbitCameraInputMouse = pc.createScript('orbitCameraInputMouse');
+OrbitCameraInputMouse.attributes.add('orbitSensitivity', { type: 'number', default: 0.3, title: 'Orbit Sensitivity' });
+OrbitCameraInputMouse.attributes.add('distanceSensitivity', { type: 'number', default: 0.4, title: 'Distance Sensitivity' });
 
-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) {
@@ -341,22 +273,10 @@ OrbitCameraInputMouse.prototype.initialize = function () {
     this.panButtonDown = false;
     this.lastPoint = new pc.Vec2();
 };
-
-// Returns the resulting camera world position Y for a pivot
-OrbitCamera.prototype.worldCameraYForPivot = function(pivot) {
-    var quat = new pc.Quat();
-    quat.setFromEulerAngles(this._pitch, this._yaw, 0);
-    var forward = new pc.Vec3();
-    quat.transformVector(pc.Vec3.FORWARD, forward);
-    var camPos = pivot.clone();
-    camPos.add(forward.clone().scale(-this._distance));
-    return camPos.y;
-};
-
-
 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;
@@ -367,53 +287,39 @@ OrbitCameraInputMouse.prototype.pan = function (screenPoint) {
     camera.screenToWorld(this.lastPoint.x, this.lastPoint.y, distance, toWorldPoint);
     worldDiff.sub2(toWorldPoint, fromWorldPoint);
 
-    // Try proposed new pivot
+    // Clamp so camera never goes below minY
     var proposedPivot = this.orbitCamera.pivotPoint.clone().add(worldDiff);
     var minY = this.orbitCamera.minY;
     var resultingY = this.orbitCamera.worldCameraYForPivot(proposedPivot);
+
     if (resultingY >= minY - 1e-4) {
         this.orbitCamera.pivotPoint.add(worldDiff);
     } else {
-        // Optionally, restrict only vertical panning
+        // Only allow horizontal pan if it would help
         worldDiff.y = 0;
         proposedPivot = this.orbitCamera.pivotPoint.clone().add(worldDiff);
         resultingY = this.orbitCamera.worldCameraYForPivot(proposedPivot);
         if (resultingY >= minY - 1e-4) {
             this.orbitCamera.pivotPoint.add(worldDiff);
         }
-        // else, do nothing (block pan)
-    }
-
-    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;
+        // Otherwise, suppress pan
     }
 };
+
 OrbitCameraInputMouse.prototype.onMouseDown = function (event) {
     switch (event.button) {
-        case pc.MOUSEBUTTON_LEFT:
-            this.panButtonDown = true;
-            break;
+        case pc.MOUSEBUTTON_LEFT: this.panButtonDown = true; break;
         case pc.MOUSEBUTTON_MIDDLE:
-        case pc.MOUSEBUTTON_RIGHT:
-            this.lookButtonDown = true;
-            break;
+        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_LEFT: this.panButtonDown = false; break;
         case pc.MOUSEBUTTON_MIDDLE:
-        case pc.MOUSEBUTTON_RIGHT:
-            this.lookButtonDown = false;
-            break;
+        case pc.MOUSEBUTTON_RIGHT: this.lookButtonDown = false; break;
     }
 };
-
-// ---------- PATCHED: orbit suppression at minY (mouse) ---------------
 OrbitCameraInputMouse.prototype.onMouseMove = function (event) {
     if (this.lookButtonDown) {
         var sens = this.orbitSensitivity;
@@ -425,14 +331,12 @@ OrbitCameraInputMouse.prototype.onMouseMove = function (event) {
         var currDist = this.orbitCamera.distance;
         var currPivot = this.orbitCamera.pivotPoint.clone();
 
-        // Compute the world position before the change
         var camQuat = new pc.Quat();
         camQuat.setFromEulerAngles(currPitch, currYaw, 0);
         var forward = new pc.Vec3();
         camQuat.transformVector(pc.Vec3.FORWARD, forward);
         var preY = currPivot.y + (-forward.y) * currDist;
 
-        // Compute the world position after applying the vertical delta
         var proposedPitch = currPitch - deltaPitch;
         var testQuat = new pc.Quat();
         testQuat.setFromEulerAngles(proposedPitch, currYaw, 0);
@@ -441,26 +345,18 @@ OrbitCameraInputMouse.prototype.onMouseMove = function (event) {
         var proposedY = currPivot.y + (-testForward.y) * currDist;
 
         var minY = this.orbitCamera.minY;
-        var isAtMinY = preY <= minY + 1e-4;
         var wouldGoBelow = proposedY < minY - 1e-4;
-        var suppressed = false;
-
-        // Only suppress if going *further* below minY (upward)
         if (wouldGoBelow && (proposedY < preY)) {
-            // Suppress vertical, allow horizontal (yaw)
             this.orbitCamera.yaw = currYaw - deltaYaw;
-            suppressed = true;
         } else {
             this.orbitCamera.pitch = proposedPitch;
             this.orbitCamera.yaw = currYaw - deltaYaw;
         }
-
     } 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) {
@@ -475,23 +371,10 @@ OrbitCameraInputMouse.prototype.onMouseOut = function (event) {
     this.panButtonDown = false;
 };
 
-////////////////////////////////////////////////////////////////////////////////
-//                       Orbit Camera Touch Input Script                      //
-////////////////////////////////////////////////////////////////////////////////
+// =================== Orbit Camera Input Touch 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.attributes.add('orbitSensitivity', { type: 'number', default: 0.6, title: 'Orbit Sensitivity' });
+OrbitCameraInputTouch.attributes.add('distanceSensitivity', { type: 'number', default: 0.5, title: 'Distance Sensitivity' });
 OrbitCameraInputTouch.prototype.initialize = function () {
     this.orbitCamera = this.entity.script.orbitCamera;
     this.lastTouchPoint = new pc.Vec2();
@@ -542,30 +425,25 @@ OrbitCameraInputTouch.prototype.pan = function (midPoint) {
     camera.screenToWorld(midPoint.x, midPoint.y, distance, fromWorldPoint);
     camera.screenToWorld(this.lastPinchMidPoint.x, this.lastPinchMidPoint.y, distance, toWorldPoint);
     worldDiff.sub2(toWorldPoint, fromWorldPoint);
-  
+
     var proposedPivot = this.orbitCamera.pivotPoint.clone().add(worldDiff);
     var minY = this.orbitCamera.minY;
     var resultingY = this.orbitCamera.worldCameraYForPivot(proposedPivot);
+
     if (resultingY >= minY - 1e-4) {
-      this.orbitCamera.pivotPoint.add(worldDiff);
-    } else {
-      worldDiff.y = 0;
-      proposedPivot = this.orbitCamera.pivotPoint.clone().add(worldDiff);
-      resultingY = this.orbitCamera.worldCameraYForPivot(proposedPivot);
-      if (resultingY >= minY - 1e-4) {
         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;
+    } else {
+        worldDiff.y = 0;
+        proposedPivot = this.orbitCamera.pivotPoint.clone().add(worldDiff);
+        resultingY = this.orbitCamera.worldCameraYForPivot(proposedPivot);
+        if (resultingY >= minY - 1e-4) {
+            this.orbitCamera.pivotPoint.add(worldDiff);
+        }
     }
 };
+
 OrbitCameraInputTouch.pinchMidPoint = new pc.Vec2();
 
-// ---------- PATCHED: orbit suppression at minY (touch) ---------------
 OrbitCameraInputTouch.prototype.onTouchMove = function (event) {
     var pinchMidPoint = OrbitCameraInputTouch.pinchMidPoint;
     var touches = event.touches;
@@ -580,14 +458,12 @@ OrbitCameraInputTouch.prototype.onTouchMove = function (event) {
         var currDist = this.orbitCamera.distance;
         var currPivot = this.orbitCamera.pivotPoint.clone();
 
-        // Compute the world position before the change
         var camQuat = new pc.Quat();
         camQuat.setFromEulerAngles(currPitch, currYaw, 0);
         var forward = new pc.Vec3();
         camQuat.transformVector(pc.Vec3.FORWARD, forward);
         var preY = currPivot.y + (-forward.y) * currDist;
 
-        // Compute the world position after applying the vertical delta
         var proposedPitch = currPitch - deltaPitch;
         var testQuat = new pc.Quat();
         testQuat.setFromEulerAngles(proposedPitch, currYaw, 0);
@@ -596,19 +472,13 @@ OrbitCameraInputTouch.prototype.onTouchMove = function (event) {
         var proposedY = currPivot.y + (-testForward.y) * currDist;
 
         var minY = this.orbitCamera.minY;
-        var isAtMinY = preY <= minY + 1e-4;
         var wouldGoBelow = proposedY < minY - 1e-4;
-        var suppressed = false;
-
         if (wouldGoBelow && (proposedY < preY)) {
-            // Suppress vertical, allow horizontal (yaw)
             this.orbitCamera.yaw = currYaw - deltaYaw;
-            suppressed = true;
         } else {
             this.orbitCamera.pitch = proposedPitch;
             this.orbitCamera.yaw = currYaw - deltaYaw;
         }
-        
         this.lastTouchPoint.set(touch.x, touch.y);
     } else if (touches.length === 2) {
         var currentPinchDistance = this.getPinchDistance(touches[0], touches[1]);
@@ -620,4 +490,4 @@ OrbitCameraInputTouch.prototype.onTouchMove = function (event) {
         this.lastPinchMidPoint.copy(pinchMidPoint);
     }
 };
-// ---------------------------------------------------------------------
+