feat: SceneService now provides direct access to intro, loading, game, main menu, game menu scenes, closes #1315

AlmasB · AlmasB · commit 847bdd367e7e · 2024-01-05T20:27:50.000Z
diff --git a/fxgl-scene/src/main/kotlin/com/almasb/fxgl/scene/SceneService.kt b/fxgl-scene/src/main/kotlin/com/almasb/fxgl/scene/SceneService.kt
@@ -12,6 +12,7 @@ import com.almasb.fxgl.input.Input
 import com.almasb.fxgl.time.Timer
 import javafx.beans.property.ReadOnlyDoubleProperty
 import javafx.scene.Group
+import java.util.Optional
 
 /**
  * Provides access to pushing / popping subscene stack, global input, timer, overlay root and application
@@ -71,6 +72,31 @@ abstract class SceneService : EngineService() {
      */
     abstract val currentScene: Scene
 
+    /**
+     * @return intro scene constructed for this game if present
+     */
+    abstract val introScene: Optional<Scene>
+
+    /**
+     * @return loading scene constructed for this game if present
+     */
+    abstract val loadingScene: Optional<Scene>
+
+    /**
+     * @return game scene constructed for this game
+     */
+    abstract val gameScene: Scene
+
+    /**
+     * @return main menu scene constructed for this game if present
+     */
+    abstract val mainMenuScene: Optional<Scene>
+
+    /**
+     * @return game menu scene constructed for this game if present
+     */
+    abstract val gameMenuScene: Optional<Scene>
+
     /**
      * @return true if [scene] is in this scene service hierarchy
      */
diff --git a/fxgl-scene/src/test/kotlin/com/almasb/fxgl/notification/NotificationServiceTest.kt b/fxgl-scene/src/test/kotlin/com/almasb/fxgl/notification/NotificationServiceTest.kt
@@ -25,6 +25,7 @@ import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import java.lang.invoke.MethodHandles
+import java.util.*
 
 /**
  *
@@ -64,6 +65,21 @@ class NotificationServiceTest {
             override val currentScene: Scene
                 get() = object : Scene() {}
 
+            override val introScene: Optional<Scene>
+                get() = Optional.ofNullable(object : Scene() {})
+
+            override val loadingScene: Optional<Scene>
+                get() = Optional.ofNullable(object : Scene() {})
+
+            override val mainMenuScene: Optional<Scene>
+                get() = Optional.ofNullable(object : Scene() {})
+
+            override val gameMenuScene: Optional<Scene>
+                get() = Optional.ofNullable(object : Scene() {})
+
+            override val gameScene: Scene
+                get() = object : Scene() {}
+
             override fun isInHierarchy(scene: Scene): Boolean {
                 return false
             }
diff --git a/fxgl-scene/src/test/kotlin/com/almasb/fxgl/scene/SceneTest.kt b/fxgl-scene/src/test/kotlin/com/almasb/fxgl/scene/SceneTest.kt
@@ -7,13 +7,7 @@
 package com.almasb.fxgl.scene
 
 import com.almasb.fxgl.core.Updatable
-import com.almasb.fxgl.event.EventBus
-import com.almasb.fxgl.input.Input
-import com.almasb.fxgl.time.Timer
-import javafx.beans.property.ReadOnlyDoubleProperty
-import javafx.beans.property.ReadOnlyDoubleWrapper
 import javafx.beans.property.SimpleDoubleProperty
-import javafx.scene.Group
 import javafx.scene.Node
 import javafx.scene.layout.Region
 import javafx.scene.shape.Rectangle
@@ -62,36 +56,6 @@ class SceneTest {
 
     @Test
     fun `Default methods are noop`() {
-        val sceneService = object : SceneService() {
-            override val overlayRoot: Group
-                get() = Group()
-            override fun prefWidthProperty(): ReadOnlyDoubleProperty {
-                return ReadOnlyDoubleWrapper(600.0).readOnlyProperty
-            }
-            override fun prefHeightProperty(): ReadOnlyDoubleProperty {
-                return ReadOnlyDoubleWrapper(600.0).readOnlyProperty
-            }
-
-            override val eventBus: EventBus
-                get() = EventBus()
-            override val input: Input
-                get() = Input()
-            override val timer: Timer
-                get() = Timer()
-
-            override val currentScene: Scene
-                get() = object : Scene() {}
-
-            override fun isInHierarchy(scene: Scene): Boolean {
-                return false
-            }
-
-            override fun pushSubScene(subScene: SubScene) {
-            }
-
-            override fun popSubScene() {
-            }
-        }
         val scene = object : Scene() {}
 
         scene.onCreate()
diff --git a/fxgl/src/main/kotlin/com/almasb/fxgl/app/FXGLApplication.kt b/fxgl/src/main/kotlin/com/almasb/fxgl/app/FXGLApplication.kt
@@ -58,7 +58,9 @@ import javafx.util.Duration
 import java.nio.file.Files
 import java.nio.file.Paths
 import java.time.LocalDateTime
+import java.util.*
 import javax.imageio.ImageIO
+import kotlin.collections.HashMap
 import kotlin.system.measureNanoTime
 
 /**
@@ -377,13 +379,28 @@ class FXGLApplication : Application() {
         override val currentScene: Scene
             get() = mainWindow.currentScene
 
-        internal lateinit var gameScene: GameScene
+        private lateinit var gameSceneRef: GameScene
         private lateinit var loadScene: LoadingScene
 
         private var intro: FXGLScene? = null
         private var mainMenu: SubScene? = null
         private var gameMenu: SubScene? = null
 
+        override val introScene: Optional<Scene>
+            get() = Optional.ofNullable(intro)
+
+        override val loadingScene: Optional<Scene>
+            get() = Optional.ofNullable(loadScene)
+
+        override val mainMenuScene: Optional<Scene>
+            get() = Optional.ofNullable(mainMenu)
+
+        override val gameMenuScene: Optional<Scene>
+            get() = Optional.ofNullable(gameMenu)
+
+        override val gameScene: GameScene
+            get() = gameSceneRef
+
         internal val window: MainWindow
             get() = mainWindow
 
@@ -432,13 +449,13 @@ class FXGLApplication : Application() {
             val sceneFactory = settings.sceneFactory
 
             loadScene = sceneFactory.newLoadingScene()
-            gameScene = GameScene(settings.width, settings.height,
+            gameSceneRef = GameScene(settings.width, settings.height,
                     GameWorld(),
                     PhysicsWorld(settings.height, settings.pixelsPerMeter, settings.collisionDetectionStrategy),
                     settings.is3D
             )
 
-            gameScene.isSingleStep = settings.isSingleStep
+            gameSceneRef.isSingleStep = settings.isSingleStep
 
             if (settings.isClickFeedbackEnabled) {
                 addClickFeedbackHandler()
@@ -475,7 +492,7 @@ class FXGLApplication : Application() {
                                 canSwitchGameMenu = false
                                 popSubScene()
 
-                            } else if (mainWindow.currentScene === gameScene) {
+                            } else if (mainWindow.currentScene === gameSceneRef) {
                                 canSwitchGameMenu = false
                                 pushSubScene(gameMenu!!)
                             }
@@ -489,7 +506,7 @@ class FXGLApplication : Application() {
                     }
                 }
 
-                gameScene.input.addEventHandler(KeyEvent.ANY, menuKeyHandler)
+                gameSceneRef.input.addEventHandler(KeyEvent.ANY, menuKeyHandler)
                 gameMenu!!.input.addEventHandler(KeyEvent.ANY, menuKeyHandler)
             }
 
@@ -505,8 +522,8 @@ class FXGLApplication : Application() {
         }
 
         private fun addClickFeedbackHandler() {
-            gameScene.input.addEventHandler(MouseEvent.MOUSE_PRESSED, EventHandler {
-                val circle = Circle(gameScene.input.mouseXUI, gameScene.input.mouseYUI, 5.0, null)
+            gameSceneRef.input.addEventHandler(MouseEvent.MOUSE_PRESSED, EventHandler {
+                val circle = Circle(gameSceneRef.input.mouseXUI, gameSceneRef.input.mouseYUI, 5.0, null)
                 circle.stroke = Color.GOLD
                 circle.strokeWidth = 2.0
                 circle.opacityProperty().bind(SimpleDoubleProperty(1.0).subtract(circle.radiusProperty().divide(35.0)))
@@ -618,7 +635,7 @@ class FXGLApplication : Application() {
         private fun clearPreviousGame() {
             log.debug("Clearing previous game")
 
-            gameScene.reset()
+            gameSceneRef.reset()
         }
 
         fun saveGame(dataFile: DataFile) {
@@ -681,7 +698,7 @@ class FXGLApplication : Application() {
         }
 
         fun gotoPlay() {
-            mainWindow.setScene(gameScene)
+            mainWindow.setScene(gameSceneRef)
         }
 
         /**
