feat: NotificationService now also accepts Node icon, closes #1149

Author: AlmasB

fxgl-samples/src/main/java/advanced/CustomServicesSample.java

@@ -9,6 +9,7 @@
 import com.almasb.fxgl.app.GameApplication;
 import com.almasb.fxgl.app.GameSettings;
 import com.almasb.fxgl.notification.NotificationService;
+import javafx.scene.Node;
 import javafx.scene.input.KeyCode;
 import javafx.scene.paint.Color;
 
@@ -37,6 +38,11 @@ public void pushNotification(String message) {
             System.out.println("Notify: " + message);
         }
 
+        @Override
+        public void pushNotification(String message, Node icon) {
+
+        }
+
         @Override
         public void setTextColor(Color textColor) {
 

fxgl-samples/src/main/java/intermediate/NotificationSample.java

@@ -13,17 +13,23 @@
 import static com.almasb.fxgl.dsl.FXGL.*;
 
 /**
+ * Shows how to use the notification service.
  *
  * @author Almas Baimagambetov (AlmasB) ([email protected])
  */
 public class NotificationSample extends GameApplication {
 
     @Override
-    protected void initSettings(GameSettings settings) { }
+    protected void initSettings(GameSettings settings) {
+        settings.setWidth(1280);
+        settings.setHeight(720);
+    }
 
     @Override
     protected void initInput() {
-        onKeyDown(KeyCode.F, "Notify", () -> getNotificationService().pushNotification("Hello! " + random(1, 10000)));
+        onKeyDown(KeyCode.F, () -> getNotificationService().pushNotification("Hello! " + random(1, 10000)));
+
+        onKeyDown(KeyCode.G, () -> getNotificationService().pushNotification("Hello! " + random(1, 10000), texture("brick.png", 32, 32)));
     }
 
     public static void main(String[] args) {

fxgl-scene/src/main/kotlin/com/almasb/fxgl/notification/Notification.kt

@@ -6,9 +6,14 @@
 
 package com.almasb.fxgl.notification
 
+import javafx.scene.Node
+
 /**
  * Represents a notification message.
  *
  * @author Almas Baimagambetov (AlmasB) ([email protected])
  */
-class Notification internal constructor(val message: String)
+class Notification internal constructor(
+        val message: String,
+        val icon: Node
+)

fxgl-scene/src/main/kotlin/com/almasb/fxgl/notification/NotificationService.kt

@@ -7,6 +7,7 @@
 package com.almasb.fxgl.notification
 
 import com.almasb.fxgl.core.EngineService
+import javafx.scene.Node
 import javafx.scene.paint.Color
 
 /**
@@ -30,4 +31,9 @@ abstract class NotificationService : EngineService() {
      * Push a notification with given [message].
      */
     abstract fun pushNotification(message: String)
+
+    /**
+     * Push a notification with given [message] and [icon].
+     */
+    abstract fun pushNotification(message: String, icon: Node)
 }

fxgl-scene/src/main/kotlin/com/almasb/fxgl/notification/impl/NotificationServiceProvider.kt

@@ -12,6 +12,8 @@ import com.almasb.fxgl.notification.Notification
 import com.almasb.fxgl.notification.NotificationService
 import com.almasb.fxgl.notification.view.NotificationView
 import com.almasb.fxgl.scene.SceneService
+import javafx.scene.Group
+import javafx.scene.Node
 import javafx.scene.paint.Color
 import javafx.util.Duration
 import java.util.*
@@ -63,7 +65,11 @@ class NotificationServiceProvider : NotificationService() {
      * @param message the text to show
      */
     override fun pushNotification(message: String) {
-        val notification = Notification(message)
+        pushNotification(message, Group())
+    }
+
+    override fun pushNotification(message: String, icon: Node) {
+        val notification = Notification(message, icon)
 
         queue.add(notification)
 

fxgl-scene/src/main/kotlin/com/almasb/fxgl/notification/view/XboxNotificationView.kt

@@ -10,6 +10,8 @@ import com.almasb.fxgl.animation.Animation
 import com.almasb.fxgl.animation.AnimationBuilder
 import com.almasb.fxgl.notification.Notification
 import javafx.geometry.Point2D
+import javafx.scene.Group
+import javafx.scene.Node
 import javafx.scene.shape.Circle
 import javafx.scene.shape.Rectangle
 import javafx.scene.text.Font
@@ -28,6 +30,8 @@ class XboxNotificationView : NotificationView() {
      */
     private val circle = Circle(30.0, 30.0, 30.0)
 
+    private val iconViewHolder = Group()
+
     private val bg = Rectangle(400.0, 57.0)
     private val bgClip = Rectangle(bg.width + 15.0, bg.height)
 
@@ -70,13 +74,13 @@ class XboxNotificationView : NotificationView() {
         translateX = appWidth / 2 - bg.width / 2 + 200
         translateY = 50.0
 
-        centerTextX(text1, 65.0, 395.0)
+        centerNodeX(text1, 65.0, 395.0)
 
         scaleX = 0.0
         scaleY = 0.0
 
         // make sure we only have circle for proper centering during the first animation
-        children.setAll(circle)
+        children.setAll(circle, iconViewHolder)
 
         // move the whole view to left
         translateThis = AnimationBuilder()
@@ -125,13 +129,24 @@ class XboxNotificationView : NotificationView() {
     private var animText2: Animation<*>? = null
     private var animText1: Animation<*>? = null
 
+    private var iconViewFadeIn: Animation<*>? = null
+
     override fun push(notification: Notification) {
         text2.text = notification.message
         text2.translateY = -35.0
 
+        iconViewHolder.children.setAll(notification.icon)
+        centerNodeX(iconViewHolder, 0.0, 60.0)
+        centerNodeY(iconViewHolder, 0.0, 60.0)
+
+        iconViewFadeIn = AnimationBuilder()
+                .duration(Duration.seconds(1.33))
+                .fadeIn(iconViewHolder)
+                .build()
+
         children.add(text2)
 
-        centerTextX(text2, 65.0, 395.0)
+        centerNodeX(text2, 65.0, 395.0)
 
         // move text 2 to replace text 1
         animText2 = AnimationBuilder()
@@ -159,6 +174,7 @@ class XboxNotificationView : NotificationView() {
 
         animText2!!.start()
         animText1!!.start()
+        iconViewFadeIn!!.start()
     }
 
     override fun playOutAnimation() {
@@ -169,9 +185,10 @@ class XboxNotificationView : NotificationView() {
 
         translateBG?.onFinished = Runnable {
 
-            children.setAll(circle)
+            children.setAll(circle, iconViewHolder)
 
             scale = AnimationBuilder()
+                    .onFinished { iconViewHolder.children.clear() }
                     .duration(Duration.seconds(0.3))
                     .scale(this)
                     .from(Point2D(1.0, 1.0))
@@ -192,9 +209,15 @@ class XboxNotificationView : NotificationView() {
 
         animText2?.onUpdate(tpf)
         animText1?.onUpdate(tpf)
+
+        iconViewFadeIn?.onUpdate(tpf)
+    }
+
+    private fun centerNodeX(node: Node, minX: Double, maxX: Double) {
+        node.translateX = (minX + maxX) / 2 - node.layoutBounds.width / 2
     }
 
-    private fun centerTextX(text: Text, minX: Double, maxX: Double) {
-        text.translateX = (minX + maxX) / 2 - text.layoutBounds.width / 2
+    private fun centerNodeY(node: Node, minY: Double, maxY: Double) {
+        node.translateY = (minY + maxY) / 2 - node.layoutBounds.height / 2
     }
 }