Improve progress indicator

Author: AlexeyBond

addons/wfc/examples/demo_wfc_2d_tilemap.tscn

@@ -38,7 +38,7 @@ room_half_size_base = Vector2i(2, 2)
 room_half_size_variation = Vector2i(2, 2)
 room_probability = 0.5
 road_len_base = 15
-road_len_variation = 5
+road_len_variation = 10
 fork_probability = 0.5
 full_fork_probability = 0.5
 passable_area_ratio = 0.1

addons/wfc/examples/helpers/progress_indicator.tscn

@@ -1,4 +1,4 @@
-[gd_scene load_steps=3 format=3 uid="uid://dt2nffs32s7o1"]
+[gd_scene load_steps=4 format=3 uid="uid://dt2nffs32s7o1"]
 
 [sub_resource type="GDScript" id="GDScript_3tvrq"]
 script/source = "extends CanvasLayer
@@ -11,25 +11,50 @@ func _ready():
 	%ProgressBar.max_value = 1.0
 	%ProgressBar.step = 0.001
 
+	generator.started.connect(on_start)
+	generator.done.connect(on_done)
+
 func _process(delta):
 	%ProgressBar.value = generator.get_progress()
+
+var start_time: int = 0
+
+func on_start():
+	%StatusLabel.text = \"Started\"
+	start_time = Time.get_ticks_msec()
+
+func on_done():
+	var delta = Time.get_ticks_msec() - start_time
+
+	%StatusLabel.text = \"Done in %.2f second(s)\" % (0.001 * delta)
 "
 
 [sub_resource type="StyleBoxFlat" id="StyleBoxFlat_6msag"]
 bg_color = Color(0.6, 0.6, 0.6, 0.807843)
 
-[node name="progressIndicator" type="CanvasLayer" node_paths=PackedStringArray("generator")]
+[sub_resource type="StyleBoxFlat" id="StyleBoxFlat_xru5r"]
+bg_color = Color(0.6, 0.6, 0.6, 0.858824)
+
+[node name="progressIndicator" type="CanvasLayer"]
 script = SubResource("GDScript_3tvrq")
-generator = NodePath("")
 
 [node name="CenterContainer" type="CenterContainer" parent="."]
 custom_minimum_size = Vector2(0, 100)
 anchors_preset = 10
 anchor_right = 1.0
 grow_horizontal = 2
 
-[node name="ProgressBar" type="ProgressBar" parent="CenterContainer"]
+[node name="VBoxContainer" type="VBoxContainer" parent="CenterContainer"]
+layout_mode = 2
+
+[node name="ProgressBar" type="ProgressBar" parent="CenterContainer/VBoxContainer"]
 unique_name_in_owner = true
 custom_minimum_size = Vector2(500, 0)
 layout_mode = 2
 theme_override_styles/fill = SubResource("StyleBoxFlat_6msag")
+
+[node name="StatusLabel" type="Label" parent="CenterContainer/VBoxContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+theme_override_styles/normal = SubResource("StyleBoxFlat_xru5r")
+text = "Not started"

addons/wfc/nodes/generator_2d.gd

@@ -46,6 +46,7 @@ var render_intermediate_results: bool = false
 @export_category("Debug mode")
 var print_rules: bool = false
 
+signal started
 signal done
 
 
@@ -118,48 +119,50 @@ func start():
 
 	if not rules.is_ready():
 		assert(positive_sample != null)
-		
+
 		var positive_sample_node: Node = get_node(positive_sample)
 		assert(positive_sample_node != null)
-		
+
 		if rules == null:
 			rules = WFCRules2D.new()
 		else:
 			rules = rules.duplicate(false) as WFCRules2D
 
 			assert(rules != null)
-		
+
 		if rules.mapper == null:
 			rules.mapper = _create_mapper(target_node)
 		if not rules.mapper.is_ready():
 			rules.mapper.learn_from(positive_sample_node)
 		rules.learn_from(positive_sample_node)
-		
+
 		if rules.complete_matrices and negative_sample != null and not negative_sample.is_empty():
 			var negative_sample_node: Node = get_node(negative_sample)
-			
+
 			if negative_sample_node != null:
 				rules.learn_negative_from(negative_sample_node)
 
 		if print_rules and OS.is_debug_build():
 			print_debug('Rules learned:\n', rules.format())
-			
+
 			print_debug('Influence range: ', rules.get_influence_range())
 
 	var problem_settings: WFC2DProblem.WFC2DProblemSettings = WFC2DProblem.WFC2DProblemSettings.new()
-	
+
 	problem_settings.rules = rules
 	problem_settings.rect = rect
 
 	var precondition: WFC2DPrecondition = _create_precondition(problem_settings, target_node)
 
+	started.emit()
+
 	# TODO: Call this in separate thread if long-running generators will be used to generate preconditions
 	precondition.prepare()
 
 	var problem: WFC2DProblem = _create_problem(problem_settings, target_node, precondition)
 
 	_runner = _create_runner()
-	
+
 	_runner.start(problem)
 
 	_runner.all_solved.connect(func(): done.emit())
@@ -173,7 +176,7 @@ func _on_solved(problem: WFC2DProblem, state: WFCSolverState):
 func _on_partial_solution(problem: WFC2DProblem, state: WFCSolverState):
 	if not render_intermediate_results:
 		return
-	
+
 	_on_solved(problem, state)
 
 func _ready():