New GestureListener an OnTouchEvent parameters.

ThomasGorisse · ThomasGorisse · commit 0210e2899a7d · 2024-03-26T23:43:19.000+01:00
diff --git a/arsceneview/src/main/java/io/github/sceneview/ar/ARScene.kt b/arsceneview/src/main/java/io/github/sceneview/ar/ARScene.kt
@@ -1,5 +1,7 @@
 package io.github.sceneview.ar
 
+import android.view.MotionEvent
+import android.widget.FrameLayout
 import androidx.activity.ComponentActivity
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Box
@@ -32,6 +34,7 @@ import io.github.sceneview.ar.arcore.getUpdatedTrackables
 import io.github.sceneview.ar.camera.ARCameraStream
 import io.github.sceneview.ar.node.ARCameraNode
 import io.github.sceneview.collision.CollisionSystem
+import io.github.sceneview.collision.HitResult
 import io.github.sceneview.environment.Environment
 import io.github.sceneview.gesture.GestureDetector
 import io.github.sceneview.loaders.EnvironmentLoader
@@ -233,6 +236,7 @@ fun ARScene(
      * The listener invoked for all the gesture detector callbacks.
      */
     onGestureListener: GestureDetector.OnGestureListener? = rememberOnGestureListener(),
+    onTouchEvent: ((e: MotionEvent, hitResult: HitResult?) -> Boolean)? = null,
     activity: ComponentActivity? = LocalContext.current as? ComponentActivity,
     lifecycle: Lifecycle = LocalLifecycleOwner.current.lifecycle,
     onViewUpdated: (ARSceneView.() -> Unit)? = null,
@@ -263,8 +267,6 @@ fun ARScene(
                     environment,
                     isOpaque,
                     collisionSystem,
-                    gestureDetector,
-                    onGestureListener,
                     cameraStream,
                     sessionFeatures,
                     sessionCameraConfig,
@@ -275,6 +277,8 @@ fun ARScene(
                     onSessionPaused,
                     onSessionFailed,
                     onTrackingFailureChanged,
+                    onGestureListener,
+                    onTouchEvent,
                     onSessionUpdated
                 ).also {
                     onViewCreated?.invoke(it)
@@ -288,6 +292,7 @@ fun ARScene(
                 sceneView.environment = environment
                 sceneView.viewNodeWindowManager = viewNodeWindowManager
                 sceneView.onGestureListener = onGestureListener
+                sceneView.onTouchEvent = onTouchEvent
 
                 sceneView.planeRenderer.isEnabled = planeRenderer
 
diff --git a/arsceneview/src/main/java/io/github/sceneview/ar/ARSceneView.kt b/arsceneview/src/main/java/io/github/sceneview/ar/ARSceneView.kt
@@ -151,18 +151,6 @@ open class ARSceneView @JvmOverloads constructor(
      * Physics system to handle collision between nodes, hit testing on a nodes,...
      */
     sharedCollisionSystem: CollisionSystem? = null,
-    /**
-     * Detects various gestures and events.
-     *
-     * The gesture listener callback will notify users when a particular motion event has occurred.
-     *
-     * Responds to Android touch events with listeners.
-     */
-    sharedGestureDetector: GestureDetector? = null,
-    /**
-     * The listener invoked for all the gesture detector callbacks.
-     */
-    sharedOnGestureListener: GestureDetector.OnGestureListener? = null,
     /**
      * The [ARCameraStream] to render the camera texture.
      *
@@ -231,6 +219,13 @@ open class ARSceneView @JvmOverloads constructor(
      * [TrackingState.TRACKING]
      */
     var onTrackingFailureChanged: ((trackingFailureReason: TrackingFailureReason?) -> Unit)? = null,
+    /**
+     * The listener invoked for all the gesture detector callbacks.
+     *
+     * Responds to Android touch events with listeners.
+     */
+    onGestureListener: GestureDetector.OnGestureListener? = null,
+    onTouchEvent: ((e: MotionEvent, hitResult: io.github.sceneview.collision.HitResult?) -> Boolean)? = null,
     /**
      * Updates of the state of the ARCore system.
      *
@@ -628,6 +623,7 @@ open class ARSceneView @JvmOverloads constructor(
 
         fun createARCameraStream(materialLoader: MaterialLoader) = ARCameraStream(materialLoader)
 
-        fun createAREnvironment(engine: Engine) = createEnvironment(engine, isOpaque = true, skybox = null)
+        fun createAREnvironment(engine: Engine) =
+            createEnvironment(engine, isOpaque = true, skybox = null)
     }
 }
diff --git a/sceneview/src/main/java/io/github/sceneview/Scene.kt b/sceneview/src/main/java/io/github/sceneview/Scene.kt
@@ -2,8 +2,11 @@ package io.github.sceneview
 
 import android.content.Context
 import android.opengl.EGLContext
+import android.os.Build
 import android.view.MotionEvent
+import android.widget.FrameLayout
 import androidx.activity.ComponentActivity
+import androidx.annotation.RequiresApi
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Box
 import androidx.compose.runtime.Composable
@@ -20,20 +23,19 @@ import androidx.lifecycle.Lifecycle
 import com.google.android.filament.Engine
 import com.google.android.filament.IndirectLight
 import com.google.android.filament.MaterialInstance
+import com.google.android.filament.RenderableManager
 import com.google.android.filament.Renderer
 import com.google.android.filament.Scene
 import com.google.android.filament.View
 import com.google.android.filament.utils.Manipulator
 import dev.romainguy.kotlin.math.Float2
 import io.github.sceneview.collision.CollisionSystem
+import io.github.sceneview.collision.HitResult
 import io.github.sceneview.environment.Environment
 import io.github.sceneview.gesture.GestureDetector
-import io.github.sceneview.gesture.HitTestGestureDetector
 import io.github.sceneview.gesture.MoveGestureDetector
-import io.github.sceneview.gesture.PickGestureDetector
 import io.github.sceneview.gesture.RotateGestureDetector
 import io.github.sceneview.gesture.ScaleGestureDetector
-import io.github.sceneview.gesture.SelectedNodeGestureDetector
 import io.github.sceneview.loaders.EnvironmentLoader
 import io.github.sceneview.loaders.MaterialLoader
 import io.github.sceneview.loaders.ModelLoader
@@ -179,14 +181,8 @@ fun Scene(
      * The gesture listener callback will notify users when a particular motion event has occurred.
      * Responds to Android touch events with listeners.
      */
-    gestureDetector: GestureDetector = rememberHitTestGestureDetector(
-        LocalContext.current,
-        collisionSystem
-    ),
-    /**
-     * The listener invoked for all the gesture detector callbacks.
-     */
     onGestureListener: GestureDetector.OnGestureListener? = rememberOnGestureListener(),
+    onTouchEvent: ((e: MotionEvent, hitResult: HitResult?) -> Boolean)? = null,
     activity: ComponentActivity? = LocalContext.current as? ComponentActivity,
     lifecycle: Lifecycle = LocalLifecycleOwner.current.lifecycle,
     /**
@@ -229,6 +225,7 @@ fun Scene(
                     cameraManipulator,
                     viewNodeWindowManager,
                     onGestureListener,
+                    onTouchEvent,
                     activity,
                     lifecycle,
                 ).also {
@@ -244,6 +241,7 @@ fun Scene(
                 sceneView.cameraManipulator = cameraManipulator
                 sceneView.viewNodeWindowManager = viewNodeWindowManager
                 sceneView.onGestureListener = onGestureListener
+                sceneView.onTouchEvent = onTouchEvent
                 sceneView.onFrame = onFrame
 
                 onViewUpdated?.invoke(sceneView)
diff --git a/sceneview/src/main/java/io/github/sceneview/SceneView.kt b/sceneview/src/main/java/io/github/sceneview/SceneView.kt
@@ -203,8 +203,11 @@ open class SceneView @JvmOverloads constructor(
     var viewNodeWindowManager: ViewNode.WindowManager? = null,
     /**
      * The listener invoked for all the gesture detector callbacks.
+     *
+     * Responds to Android touch events with listeners.
      */
-    sharedOnGestureListener: GestureDetector.OnGestureListener? = null,
+    onGestureListener: GestureDetector.OnGestureListener? = null,
+    var onTouchEvent: ((e: MotionEvent, hitResult: HitResult?) -> Boolean)? = null,
     sharedActivity: ComponentActivity? = null,
     sharedLifecycle: Lifecycle? = null,
 ) : SurfaceView(context, attrs, defStyleAttr, defStyleRes) {
@@ -414,16 +417,41 @@ open class SceneView @JvmOverloads constructor(
      * The gesture listener callback will notify users when a particular motion event has occurred.
      * Responds to Android touch events with listeners.
      */
-    var gestureDetector =
-        (sharedGestureDetector ?: HitTestGestureDetector(context, collisionSystem)).apply {
-            listener = sharedOnGestureListener
-        }
+    var gestureDetector: GestureDetector? =
+        GestureDetector(context = context, listener = onGestureListener)
+        private set
 
     /**
      * The listener invoked for all the gesture detector callbacks.
+     *
+     * Responds to Android touch events with listeners.
+     */
+    var onGestureListener: GestureDetector.OnGestureListener?
+        get() = gestureDetector?.listener
+        set(value) {
+            gestureDetector?.listener = value
+        }
+
+    var cameraGestureDetector: CameraGestureDetector? =
+        CameraGestureDetector(viewHeight = ::getHeight, manipulator = cameraManipulator)
+        private set
+
+    /**
+     * Helper that enables camera interaction similar to sketchfab or Google Maps.
+     *
+     * Needs to be a callable function because it can be reinitialized in case of viewport change
+     * or camera node manual position changed.
+     *
+     * The first onTouch event will make the first manipulator build. So you can change the camera
+     * position before any user gesture.
+     *
+     * Clients notify the camera manipulator of various mouse or touch events, then periodically
+     * call its getLookAt() method so that they can adjust their camera(s). Three modes are
+     * supported: ORBIT, MAP, and FREE_FLIGHT. To construct a manipulator instance, the desired mode
+     * is passed into the create method.
      */
-    var onGestureListener
-        get() = gestureDetector.listener
+    var cameraManipulator: Manipulator?
+        get() = cameraGestureDetector?.manipulator
         set(value) {
             gestureDetector.listener = value
         }
@@ -665,24 +693,31 @@ open class SceneView @JvmOverloads constructor(
         super.onDetachedFromWindow()
     }
 
-    protected open fun onResized(width: Int, height: Int) {
-        view.viewport = Viewport(0, 0, width, height)
-        cameraNode.updateProjection()
-        updateCameraManipulator()
-    }
-
     @SuppressLint("ClickableViewAccessibility")
-    override fun onTouchEvent(motionEvent: MotionEvent): Boolean {
+    override fun onTouchEvent(event: MotionEvent): Boolean {
         // This makes sure that the view's onTouchListener is called.
-        if (!super.onTouchEvent(motionEvent)) {
-            lastTouchEvent = motionEvent
-            gestureDetector.onTouchEvent(motionEvent)
-            cameraGestureDetector?.onTouchEvent(motionEvent)
+        if (!super.onTouchEvent(event)) {
+            lastTouchEvent = event
+            val hitResult = collisionSystem.hitTest(event).firstOrNull {
+                it.node.isTouchable
+            }
+            if (onTouchEvent?.invoke(event, hitResult) != true &&
+                hitResult?.node?.onTouchEvent(event, hitResult) != true
+            ) {
+                gestureDetector?.onTouchEvent(event, hitResult)
+                cameraGestureDetector?.onTouchEvent(event)
+            }
+
             return true
         }
         return false
     }
 
+    protected open fun onResized(width: Int, height: Int) {
+        view.viewport = Viewport(0, 0, width, height)
+        cameraNode.updateProjection()
+    }
+
     internal fun addNode(node: Node) {
         node.collisionSystem = collisionSystem
         addEntities(node.sceneEntities)
diff --git a/sceneview/src/main/java/io/github/sceneview/gesture/GestureDetector.kt b/sceneview/src/main/java/io/github/sceneview/gesture/GestureDetector.kt
@@ -2,11 +2,9 @@ package io.github.sceneview.gesture
 
 import android.content.Context
 import android.view.MotionEvent
-import com.google.android.filament.View
 import dev.romainguy.kotlin.math.Float2
-import io.github.sceneview.collision.CollisionSystem
+import io.github.sceneview.collision.HitResult
 import io.github.sceneview.node.Node
-import io.github.sceneview.utils.pickNode
 
 /**
  * Detects various gestures and events using the supplied {@link MotionEvent}s.
@@ -17,10 +15,7 @@ import io.github.sceneview.utils.pickNode
  *
  * Responds to Android touch events with listeners.
  */
-open class GestureDetector(
-    context: Context,
-    var nodeSelector: (e: MotionEvent, (node: Node?) -> Unit) -> Unit
-) {
+open class GestureDetector(context: Context, var listener: OnGestureListener?) {
     interface OnGestureListener {
         fun onDown(e: MotionEvent, node: Node?)
         fun onShowPress(e: MotionEvent, node: Node?)
@@ -65,7 +60,6 @@ open class GestureDetector(
         override fun onScaleEnd(detector: ScaleGestureDetector, e: MotionEvent, node: Node?) {}
     }
 
-    var listener: OnGestureListener? = null
     var touchedNode: Node? = null
 
     private var lastTouchEvent: MotionEvent? = null
@@ -221,16 +215,14 @@ open class GestureDetector(
         }
     )
 
-    fun onTouchEvent(event: MotionEvent): Boolean {
+    fun onTouchEvent(event: MotionEvent, hitResult: HitResult?) {
         lastTouchEvent = event
-        nodeSelector(event) { node ->
-            touchedNode = node
-            gestureDetector.onTouchEvent(event)
-            moveGestureDetector.onTouchEvent(event)
-            rotateGestureDetector.onTouchEvent(event)
-            scaleGestureDetector.onTouchEvent(event)
-        }
-        return true
+        touchedNode = hitResult?.node
+
+        gestureDetector.onTouchEvent(event)
+        moveGestureDetector.onTouchEvent(event)
+        rotateGestureDetector.onTouchEvent(event)
+        scaleGestureDetector.onTouchEvent(event)
     }
 }
 
diff --git a/sceneview/src/main/java/io/github/sceneview/node/Node.kt b/sceneview/src/main/java/io/github/sceneview/node/Node.kt
@@ -26,6 +26,7 @@ import io.github.sceneview.animation.NodeAnimator
 import io.github.sceneview.collision.Collider
 import io.github.sceneview.collision.CollisionShape
 import io.github.sceneview.collision.CollisionSystem
+import io.github.sceneview.collision.HitResult
 import io.github.sceneview.collision.Matrix
 import io.github.sceneview.collision.TransformProvider
 import io.github.sceneview.gesture.MoveGestureDetector
@@ -47,6 +48,8 @@ import io.github.sceneview.math.slerp
 import io.github.sceneview.math.times
 import io.github.sceneview.math.toMatrix
 import io.github.sceneview.math.toQuaternion
+import io.github.sceneview.safeDestroyEntity
+import io.github.sceneview.safeDestroyTransformable
 import io.github.sceneview.utils.intervalSeconds
 import kotlin.reflect.KProperty1
 
@@ -386,6 +389,7 @@ open class Node(
     var onAddedToScene: ((scene: Scene) -> Unit)? = null
     var onRemovedFromScene: ((scene: Scene) -> Unit)? = null
 
+    var onTouch: ((e: MotionEvent, hitResult: HitResult) -> Boolean)? = null
     var onDown: ((e: MotionEvent) -> Boolean)? = null
     var onShowPress: ((e: MotionEvent) -> Unit)? = null
     var onSingleTapUp: ((e: MotionEvent) -> Boolean)? = null
@@ -830,6 +834,10 @@ open class Node(
         childNodes.forEach { it.onWorldTransformChanged() }
     }
 
+
+    open fun onTouchEvent(e: MotionEvent, hitResult: HitResult) =
+        onTouch?.invoke(e, hitResult) ?: false
+
     override fun onDown(e: MotionEvent) = onDown?.invoke(e) ?: false
     override fun onShowPress(e: MotionEvent) {
         onShowPress?.invoke(e)
