Physics raycast hitResult add shape (#2004)

* feat: hitResult add shape

Author: luzhuang

packages/core/src/physics/HitResult.ts

@@ -1,5 +1,6 @@
 import { Entity } from "../Entity";
 import { Vector3 } from "@galacean/engine-math";
+import { ColliderShape } from "./shape";
 
 /**
  * Structure used to get information back from a raycast or a sweep.
@@ -13,4 +14,6 @@ export class HitResult {
   point: Vector3 = new Vector3();
   /** The normal of the surface the ray hit. */
   normal: Vector3 = new Vector3();
+  /** The shape of the collider that was hit. */
+  shape: ColliderShape = null;
 }

packages/core/src/physics/PhysicsScene.ts

@@ -315,7 +315,9 @@ export class PhysicsScene {
 
     if (hitResult != undefined) {
       const result = this._nativePhysicsScene.raycast(ray, distance, onRaycast, (idx, distance, position, normal) => {
-        hitResult.entity = this._scene.engine._physicalObjectsMap[idx]._collider.entity;
+        const hitShape = this._scene.engine._physicalObjectsMap[idx];
+        hitResult.entity = hitShape._collider.entity;
+        hitResult.shape = hitShape;
         hitResult.distance = distance;
         hitResult.normal.copyFrom(normal);
         hitResult.point.copyFrom(position);
@@ -325,6 +327,7 @@ export class PhysicsScene {
         return true;
       } else {
         hitResult.entity = null;
+        hitResult.shape = null;
         hitResult.distance = 0;
         hitResult.point.set(0, 0, 0);
         hitResult.normal.set(0, 0, 0);

tests/src/core/physics/PhysicsManager.test.ts

@@ -190,6 +190,7 @@ describe("Physics Test", () => {
       expect(outHitResult.point.z).to.be.closeTo(0.5, 0.01);
       expect(outHitResult.normal).to.be.deep.include({ x: 0, y: 0, z: 0 });
       expect(outHitResult.entity).to.be.eq(raycastTestRoot);
+      expect(outHitResult.shape).to.be.eq(box);
 
       // Test that raycast with outHitResult works correctly.
       expect(engineLite.physicsManager.raycast(ray, Number.MAX_VALUE, outHitResult)).to.eq(true);
@@ -199,20 +200,23 @@ describe("Physics Test", () => {
       expect(outHitResult.point.z).to.be.closeTo(0.5, 0.01);
       expect(outHitResult.normal).to.be.deep.include({ x: 0, y: 0, z: 0 });
       expect(outHitResult.entity).to.be.eq(raycastTestRoot);
+      expect(outHitResult.shape).to.be.eq(box);
 
       // Test that raycast nothing if layer is not match.
       expect(engineLite.physicsManager.raycast(ray, Number.MAX_VALUE, Layer.Layer1, outHitResult)).to.eq(false);
       expect(outHitResult.distance).to.be.eq(0);
       expect(outHitResult.point).to.be.deep.include({ x: 0, y: 0, z: 0 });
       expect(outHitResult.normal).to.be.deep.include({ x: 0, y: 0, z: 0 });
       expect(outHitResult.entity).to.be.null;
+      expect(outHitResult.shape).to.be.null;
 
       // Test that return origin point if origin is inside collider.
       ray = new Ray(new Vector3(0.25, -0.5, 0.5), new Vector3(0, -1, 0));
       expect(engineLite.physicsManager.raycast(ray, outHitResult)).to.eq(true);
       expect(outHitResult.distance).to.be.eq(0);
       expect(outHitResult.point).to.be.deep.include({ x: 0.25, y: -0.5, z: 0.5 });
       expect(outHitResult.entity).to.be.eq(raycastTestRoot);
+      expect(outHitResult.shape).to.be.eq(box);
 
       // Test that raycast nothing if distance is less than distance of origin to detected collider.
       expect(engineLite.physicsManager.raycast(ray, 0, Layer.Everything, outHitResult)).to.eq(true);