syntax check, show an error icon if there are incomplete paths, #651

Author: AlmasB

fxgl-tools/src/main/kotlin/com/almasb/fxgl/tools/dialogues/DialoguePane.kt

@@ -91,6 +91,11 @@ class DialoguePane(graph: DialogueGraph = DialogueGraph()) : Pane() {
 
     val isDirtyProperty = SimpleBooleanProperty(false)
 
+    /**
+     * Are all outgoing links connected.
+     */
+    val isConnectedProperty = SimpleBooleanProperty(true)
+
     private val scale = Scale()
 
     private val dragScale = 1.35
@@ -363,6 +368,8 @@ class DialoguePane(graph: DialogueGraph = DialogueGraph()) : Pane() {
         val nodeView = nodeViewConstructor(node)
 
         addNodeView(nodeView, x, y)
+
+        evaluateGraphConnectivity()
     }
 
     private fun onRemoved(node: DialogueNode) {
@@ -383,6 +390,8 @@ class DialoguePane(graph: DialogueGraph = DialogueGraph()) : Pane() {
                 .from(Point2D(1.0, 1.0))
                 .to(Point2D.ZERO)
                 .buildAndPlay()
+
+        evaluateGraphConnectivity()
     }
 
     private fun onAdded(edge: DialogueEdge) {
@@ -401,6 +410,8 @@ class DialoguePane(graph: DialogueGraph = DialogueGraph()) : Pane() {
         val edgeView = EdgeView(edge, outPoint, inPoint)
 
         edgeViews.children.add(edgeView)
+
+        evaluateGraphConnectivity()
     }
 
     private fun onRemoved(edge: DialogueEdge) {
@@ -444,6 +455,18 @@ class DialoguePane(graph: DialogueGraph = DialogueGraph()) : Pane() {
         edgeView.source.disconnect()
 
         edgeViews.children -= edgeView
+
+        evaluateGraphConnectivity()
+    }
+
+    /**
+     * Checks that all outgoing links are connected.
+     */
+    private fun evaluateGraphConnectivity() {
+        isConnectedProperty.value = nodeViews.children
+                .map { it as NodeView }
+                .flatMap { it.outPoints }
+                .all { it.isConnected }
     }
 
     private fun getNodeView(node: DialogueNode): NodeView {

fxgl-tools/src/main/kotlin/com/almasb/fxgl/tools/dialogues/MainUI.kt

@@ -10,17 +10,15 @@ import com.almasb.fxgl.cutscene.dialogue.SerializableGraph
 import com.almasb.fxgl.dsl.*
 import com.almasb.fxgl.input.InputModifier
 import com.almasb.fxgl.input.UserAction
+import com.almasb.fxgl.tools.dialogues.ui.ErrorIcon
 import com.almasb.fxgl.tools.dialogues.ui.FXGLContextMenu
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.databind.SerializationFeature
 import javafx.beans.binding.Bindings
 import javafx.geometry.Pos
 import javafx.scene.Cursor
 import javafx.scene.Node
-import javafx.scene.control.Menu
-import javafx.scene.control.MenuBar
-import javafx.scene.control.Tab
-import javafx.scene.control.TabPane
+import javafx.scene.control.*
 import javafx.scene.input.KeyCode
 import javafx.scene.layout.BorderPane
 import javafx.scene.layout.HBox
@@ -30,6 +28,7 @@ import javafx.scene.paint.Color
 import javafx.scene.shape.Polygon
 import javafx.scene.shape.Rectangle
 import javafx.stage.FileChooser
+import javafx.util.Duration
 import java.io.File
 import java.nio.file.Files
 
@@ -42,6 +41,8 @@ class MainUI : BorderPane() {
     private val toolbar = HBox(35.0)
     private val tabPane = TabPane()
 
+    private val errorIcon = ErrorIcon()
+
     private val preferences by lazy { PreferencesSubScene() }
 
     private val currentTab: DialogueTab?
@@ -55,6 +56,22 @@ class MainUI : BorderPane() {
         toolbar.style = "-fx-background-color: black"
         toolbar.alignment = Pos.CENTER_LEFT
 
+        errorIcon.layoutXProperty().bind(FXGL.getSettings().actualWidthProperty().subtract(35))
+        errorIcon.layoutY = 40.0
+
+        val tooltip = Tooltip()
+        tooltip.showDelay = Duration.ZERO;
+        tooltip.text = "There are incomplete dialogue paths."
+
+        Tooltip.install(errorIcon, tooltip)
+
+        tabPane.selectionModel.selectedItemProperty().addListener { _, _, newTab ->
+            newTab?.let {
+                errorIcon.visibleProperty().unbind()
+                errorIcon.visibleProperty().bind((newTab as DialogueTab).pane.isConnectedProperty.not())
+            }
+        }
+
         val contextMenuFile = FXGLContextMenu()
         contextMenuFile.addItem("New (CTRL+N)") { openNewDialog() }
         contextMenuFile.addItem("Open... (CTRL+O)") { openLoadDialog() }
@@ -77,7 +94,7 @@ class MainUI : BorderPane() {
         contextMenuHelp.addItem("Check for Updates...") { FXGL.getFXApp().hostServices.showDocument("https://fxgl.itch.io/fxgl-dialogue-editor") }
         contextMenuHelp.addItem("About") { openAboutDialog() }
 
-        val pane = Pane(tabPane, toolbar)
+        val pane = Pane(tabPane, toolbar, errorIcon)
 
         val menuFile = EditorMenu("File") {
             contextMenuFile.show(pane, 0.0, toolbar.prefHeight)

fxgl-tools/src/main/kotlin/com/almasb/fxgl/tools/dialogues/ui/ErrorIcon.kt

@@ -0,0 +1,34 @@
+/*
+ * FXGL - JavaFX Game Library. The MIT License (MIT).
+ * Copyright (c) AlmasB (almaslvl@gmail.com).
+ * See LICENSE for details.
+ */
+
+package com.almasb.fxgl.tools.dialogues.ui
+
+import javafx.scene.layout.StackPane
+import javafx.scene.paint.Color
+import javafx.scene.shape.Circle
+import javafx.scene.text.Font
+import javafx.scene.text.FontWeight
+import javafx.scene.text.Text
+
+/**
+ *
+ * @author Almas Baimagambetov (almaslvl@gmail.com)
+ */
+class ErrorIcon : StackPane() {
+
+    init {
+        val bgCircle = Circle(10.0, Color.RED).also {
+            it.stroke = Color.WHITE
+        }
+
+        val symbol = Text("!").also {
+            it.font = Font.font("", FontWeight.BOLD, 14.0)
+            it.fill = Color.WHITE
+        }
+
+        children.addAll(bgCircle, symbol)
+    }
+}