fix(vr): review - discard cancels a nudge, an unmoved nudge stages nothing

Author: tommy-xr

shock2vr/src/interaction.rs

@@ -1938,6 +1938,8 @@ impl VrInteraction {
         let Some(tool) = self.pose_tool.as_mut() else {
             return;
         };
+        // A nudge in progress would stage again on release.
+        tool.cancel_nudge();
         let Some(staged) = tool.staged.take() else {
             return;
         };
@@ -4556,7 +4558,7 @@ mod tests {
         assert!(tool.staged.is_none(), "only the view");
         assert_eq!(grip(&interaction).offset, before.offset);
 
-        // Test hold, the squeeze still held from the bench: no nudge.
+        // A squeeze held as test hold starts: no nudge.
         let personal = crate::world_scale::WorldScale::active().personal();
         interaction.stage_grip(before.clone().rescaled(1.0 / personal));
         interaction.pose_tool_button(Handedness::Left, crate::hand_buttons::HandButton::Lower);
@@ -4666,6 +4668,31 @@ mod tests {
         assert!(tool.test_hold.unwrap().nudge.is_none());
         assert_eq!(grip(&interaction).offset, nudged.offset);
         assert!((tool.item_placed.unwrap().position - rest.position).magnitude() < 1e-5);
+
+        // Discarded mid-nudge: back to the grip from before, and letting go
+        // stages nothing.
+        input.left_hand.rotation = Quaternion::from_angle_z(Deg(15.0));
+        input.left_hand.squeeze_value = 0.0;
+        step(&mut interaction, &input);
+        input.left_hand.squeeze_value = 1.0;
+        step(&mut interaction, &input);
+        input.left_hand.position += vec3(0.0, -0.05, 0.0);
+        step(&mut interaction, &input);
+        assert!(
+            interaction
+                .pose_tool
+                .as_ref()
+                .unwrap()
+                .test_hold
+                .unwrap()
+                .nudge
+                .is_some()
+        );
+        interaction.pose_tool_button(Handedness::Left, crate::hand_buttons::HandButton::Upper);
+        input.left_hand.squeeze_value = 0.0;
+        step(&mut interaction, &input);
+        assert!(interaction.pose_tool.as_ref().unwrap().staged.is_none());
+        assert_eq!(grip(&interaction).offset, before.offset);
     }
 
     /// A gun's rest snapshot stores the hand exactly where it was tracked:

shock2vr/src/interaction/pose_tool.rs

@@ -72,6 +72,9 @@ const BEAM_MISS_LENGTH: f32 = 1.0;
 /// `weapon_muzzle`'s, shared with dark_explorer).
 const AIM_LINE_HALO: f32 = 0.004;
 const AIM_LINE_CORE: f32 = 0.0012;
+/// A test-hold nudge let go within this of where it started stages nothing.
+const NUDGE_MIN_MM: f32 = 0.1;
+const NUDGE_MIN_DEG: f32 = 0.01;
 
 /// Whether a hand's controller is held, so aims the panel ray. The runtime
 /// must track it; the posing hand's is set down once that hand is tracked.
@@ -564,11 +567,8 @@ impl GripPoseTool {
         self.triggers = [panel::TriggerArbiter::new(); 2];
         self.requested = true;
         self.pinch_lost = true;
-        self.squeezed = true;
+        self.cancel_nudge();
         self.turning = None;
-        if let Some(hold) = self.test_hold.as_mut() {
-            hold.nudge = None;
-        }
         self.stick_armed = false;
         self.poke = Default::default();
         // Frames from before the pause are not part of a steady window now.
@@ -749,12 +749,22 @@ impl GripPoseTool {
         self.squeezed = squeeze;
     }
 
+    /// Drop a nudge in progress unstaged (pausing, discarding); the squeeze
+    /// acts again only once let go.
+    pub fn cancel_nudge(&mut self) {
+        if let Some(hold) = self.test_hold.as_mut() {
+            hold.nudge = None;
+        }
+        self.squeezed = true;
+    }
+
     /// Test hold's nudge: from the leading edge of the free controller's
     /// squeeze (`controller`, its world pose, `None` while it aims no ray)
     /// the item, at `item` as held now, keeps its pose relative to that
     /// controller. Returns where the item is as the squeeze lets go, for the
-    /// grip to hold it there. Losing either controller drops the nudge
-    /// unstaged, and the squeeze is disarmed until let go in hand.
+    /// grip to hold it there, unless that is still where it is held (a
+    /// squeeze without a move is no edit). Losing either controller drops
+    /// the nudge unstaged, and the squeeze is disarmed until let go in hand.
     pub fn nudge_with(
         &mut self,
         controller: Option<GripPose>,
@@ -776,7 +786,15 @@ impl GripPoseTool {
             }
             None
         } else {
-            hold.nudge.take().map(|nudge| nudge.item())
+            hold.nudge
+                .take()
+                .map(|nudge| nudge.item())
+                .filter(|released| {
+                    millimetres((released.position - item.position).magnitude()) > NUDGE_MIN_MM
+                        || crate::weapon_muzzle::turn_deg(
+                            item.rotation.normalize().conjugate() * released.rotation,
+                        ) > NUDGE_MIN_DEG
+                })
         };
         self.squeezed = squeeze;
         released
@@ -2139,6 +2157,11 @@ mod tests {
         let released = tool.nudge_with(Some(moved), item, false).expect("released");
         assert!(close(released, expected));
         assert!(tool.test_hold.unwrap().nudge.is_none());
+        // A squeeze let go without a move is no edit.
+        assert!(tool.nudge_with(Some(moved), expected, true).is_none());
+        assert!(tool.test_hold.unwrap().nudge.is_some());
+        assert!(tool.nudge_with(Some(moved), expected, false).is_none());
+        assert!(tool.test_hold.unwrap().nudge.is_none());
     }
 
     /// Losing either controller mid-nudge drops it with nothing to stage,

tools/shock2-sdk/test/vr-grip-pose-tool.e2e.test.ts

@@ -1362,7 +1362,7 @@ test(
     const freeAt = (position: Vec3, rotation: Quat) => setHandWorldPose(game, player, "left", position, rotation);
     await freeAt(add(grabbedAt, scale([0, 0.05, 0], 1 / unit)), grabbedTurn);
     await game.step({ frames: 2 });
-    assert.equal((await tool()).test_hold?.nudging, false, "held over from the bench");
+    assert.equal((await tool()).test_hold?.nudging, false, "held as test hold starts");
     assert.ok(distance(await gunAt(), held) < 1e-4, "the gun stays in the glove");
 
     // Let go and squeeze again: the gun follows the left controller.