feat: nodes that support View interface onUpdate() will now be updated by GameScene, even when added as a UI node

Author: AlmasB

fxgl/src/main/kotlin/com/almasb/fxgl/app/scene/GameScene.kt

@@ -7,6 +7,7 @@
 package com.almasb.fxgl.app.scene
 
 import com.almasb.fxgl.app.MainWindow
+import com.almasb.fxgl.core.View
 import com.almasb.fxgl.core.concurrent.Async
 import com.almasb.fxgl.core.math.FXGLMath
 import com.almasb.fxgl.dsl.FXGL.Companion.getAppHeight
@@ -81,6 +82,8 @@ internal constructor(width: Int, height: Int,
     val uiNodes: ObservableList<Node>
         get() = uiRoot.childrenUnmodifiable
 
+    private val updatableViews = arrayListOf<View>()
+
     /**
      * If set to true, Game Scene will require calling step()
      * to advance each frame.
@@ -229,6 +232,9 @@ internal constructor(width: Int, height: Int,
         physicsWorld.onUpdate(tpf)
         viewport.onUpdate(tpf)
 
+        // update UI nodes
+        updatableViews.forEach { it.onUpdate(tpf) }
+
         if (!is3D && isZSortingNeeded) {
             sortZ()
             isZSortingNeeded = false
@@ -259,6 +265,9 @@ internal constructor(width: Int, height: Int,
      */
     fun addUINode(node: Node) {
         uiRoot.children.add(node)
+
+        if (node is View)
+            updatableViews += node
     }
 
     /**
@@ -274,11 +283,13 @@ internal constructor(width: Int, height: Int,
     /**
      * Remove given node from the UI overlay.
      *
-     * @param n node to remove
-     * @return true iff the node has been removed
+     * @param node node to remove
      */
-    fun removeUINode(n: Node): Boolean {
-        return uiRoot.children.remove(n)
+    fun removeUINode(node: Node) {
+        uiRoot.children.remove(node)
+
+        if (node is View)
+            updatableViews -= node
     }
 
     /**
@@ -311,6 +322,7 @@ internal constructor(width: Int, height: Int,
      */
     fun clearUINodes() {
         uiRoot.children.clear()
+        updatableViews.clear()
     }
 
     /**

fxgl/src/test/kotlin/com/almasb/fxgl/app/GameSceneTest.kt

@@ -8,6 +8,7 @@ package com.almasb.fxgl.app
 
 import com.almasb.fxgl.app.scene.GameScene
 import com.almasb.fxgl.app.scene.GameView
+import com.almasb.fxgl.core.View
 import com.almasb.fxgl.entity.Entity
 import com.almasb.fxgl.entity.GameWorld
 import com.almasb.fxgl.particle.ParticleComponent
@@ -18,6 +19,7 @@ import com.almasb.fxgl.ui.UIController
 import javafx.scene.Group
 import javafx.scene.Node
 import javafx.scene.layout.Pane
+import javafx.scene.layout.Region
 import javafx.scene.shape.Rectangle
 import org.hamcrest.MatcherAssert.assertThat
 import org.hamcrest.Matchers.*
@@ -118,6 +120,19 @@ class GameSceneTest {
         assertTrue(gameScene.uiNodes.isEmpty())
     }
 
+    @Test
+    fun `UI nodes are updated`() {
+        val testView = TestView()
+
+        gameScene.addUINode(testView)
+
+        assertThat(testView.count, `is`(0.0))
+
+        gameScene.update(1.0)
+
+        assertThat(testView.count, `is`(1.0))
+    }
+
     @Test
     fun `Add and remove UI`() {
         val pane = Pane()
@@ -234,4 +249,19 @@ class GameSceneTest {
         assertThat(gameRoot.children[0], `is`(view1.node))
         assertThat(gameRoot.children[1], `is`(view2.node))
     }
+
+    private class TestView : Region(), View {
+        var count = 0.0
+
+        override fun onUpdate(tpf: Double) {
+            count = tpf
+        }
+
+        override fun dispose() {
+        }
+
+        override fun getNode(): Node {
+            return this
+        }
+    }
 }