Add progress indicator to examples

Author: AlexeyBond

addons/wfc/examples/assets/kenny-nature-kit/meshlib.meshlib

@@ -1,9 +1,10 @@
-[gd_scene load_steps=11 format=3 uid="uid://dvfxwumivfg4a"]
+[gd_scene load_steps=12 format=3 uid="uid://dvfxwumivfg4a"]
 
 [ext_resource type="MeshLibrary" uid="uid://310b3aggjq0d" path="res://addons/wfc/examples/assets/kenny-nature-kit/meshlib.meshlib" id="1_in0m7"]
 [ext_resource type="Script" path="res://addons/wfc/nodes/generator_2d.gd" id="2_3emk2"]
 [ext_resource type="Script" path="res://addons/wfc/problems/2d/rules_2d.gd" id="3_o4j22"]
 [ext_resource type="Script" path="res://addons/wfc/solver/solver_settings.gd" id="4_hielr"]
+[ext_resource type="PackedScene" uid="uid://dt2nffs32s7o1" path="res://addons/wfc/examples/helpers/progress_indicator.tscn" id="5_o86r7"]
 
 [sub_resource type="GDScript" id="GDScript_f3n0e"]
 script/source = "extends Node3D
@@ -86,7 +87,7 @@ start_on_ready = true
 render_intermediate_results = true
 
 [node name="Node3D" type="Node3D" parent="."]
-transform = Transform3D(0.719961, 0, -0.694014, 0, 1, 0, 0.694014, 0, 0.719961, 0, 0, 0)
+transform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)
 
 [node name="Camera3D" type="Camera3D" parent="Node3D"]
 transform = Transform3D(1, 0, 0, 0, 0.714082, 0.700062, 0, -0.700062, 0.714082, 0, 16.1111, 23.1593)
@@ -98,3 +99,6 @@ transform = Transform3D(-0.0221687, 0.410729, -0.911488, 1.68154e-09, 0.911712,
 libraries = {
 "": SubResource("AnimationLibrary_dt8hv")
 }
+
+[node name="progressIndicator" parent="." node_paths=PackedStringArray("generator") instance=ExtResource("5_o86r7")]
+generator = NodePath("../generator")

addons/wfc/examples/demo_wfc_2d_gridmap.tscn

@@ -1,10 +1,11 @@
-[gd_scene load_steps=10 format=3 uid="uid://5lfhjokuwwss"]
+[gd_scene load_steps=11 format=3 uid="uid://5lfhjokuwwss"]
 
 [ext_resource type="Script" path="res://addons/wfc/nodes/generator_2d.gd" id="1_coqxp"]
 [ext_resource type="Script" path="res://addons/wfc/problems/2d/mappers/mapper_2d_layered_tilemap.gd" id="2_qtvm1"]
 [ext_resource type="Script" path="res://addons/wfc/runners/runner_multithreaded_settings.gd" id="2_uvgvv"]
 [ext_resource type="TileSet" uid="uid://dgefkshuslimj" path="res://addons/wfc/examples/assets/kenney-tiny-dungeon/tile-set.tres" id="3_6hook"]
 [ext_resource type="Script" path="res://addons/wfc/problems/2d/rules_2d.gd" id="3_t7txd"]
+[ext_resource type="PackedScene" uid="uid://dt2nffs32s7o1" path="res://addons/wfc/examples/helpers/progress_indicator.tscn" id="6_d5dbh"]
 
 [sub_resource type="GDScript" id="GDScript_sq3cg"]
 script/source = "extends Node2D
@@ -105,3 +106,6 @@ layer_2/y_sort_enabled = false
 layer_2/y_sort_origin = 0
 layer_2/z_index = 0
 layer_2/tile_data = PackedInt32Array()
+
+[node name="progressIndicator" parent="." node_paths=PackedStringArray("generator") instance=ExtResource("6_d5dbh")]
+generator = NodePath("../generator")

addons/wfc/examples/demo_wfc_2d_layered_tilemap.tscn

@@ -1,11 +1,12 @@
-[gd_scene load_steps=12 format=3 uid="uid://cgk72c7csqgm5"]
+[gd_scene load_steps=13 format=3 uid="uid://cgk72c7csqgm5"]
 
 [ext_resource type="TileSet" uid="uid://dgefkshuslimj" path="res://addons/wfc/examples/assets/kenney-tiny-dungeon/tile-set.tres" id="1_pba0u"]
 [ext_resource type="Script" path="res://addons/wfc/problems/2d/rules_2d.gd" id="2_4g6b2"]
 [ext_resource type="Script" path="res://addons/wfc/problems/2d/preconditions/precondition_2d_dungeon_settings.gd" id="2_71acl"]
 [ext_resource type="Script" path="res://addons/wfc/nodes/generator_2d.gd" id="2_rmjmh"]
 [ext_resource type="Script" path="res://addons/wfc/solver/solver_settings.gd" id="2_xn8gl"]
 [ext_resource type="Script" path="res://addons/wfc/runners/runner_multithreaded_settings.gd" id="3_iuw6v"]
+[ext_resource type="PackedScene" uid="uid://dt2nffs32s7o1" path="res://addons/wfc/examples/helpers/progress_indicator.tscn" id="7_8vira"]
 
 [sub_resource type="GDScript" id="GDScript_sq3cg"]
 script/source = "extends Node2D
@@ -68,3 +69,6 @@ visible = false
 tile_set = ExtResource("1_pba0u")
 format = 2
 layer_0/tile_data = PackedInt32Array(1835014, 0, 4, 1835015, 0, 4, 1835016, 0, 4, 1835017, 0, 4, 1835018, 0, 4, 1835019, 0, 4, 1835020, 0, 4, 1835021, 0, 4, 1835022, 0, 4, 1900559, 0, 4, 1900560, 0, 4, 1900561, 0, 4, 1900562, 0, 4, 1835027, 0, 4, 1835028, 0, 4, 1835029, 0, 4, 1835030, 0, 4, 1835031, 0, 4, 1835032, 0, 4, 1835033, 0, 4, 1835034, 0, 4, 1835035, 0, 4, 1835036, 0, 4, 1835037, 0, 4, 1835038, 0, 4, 1835039, 0, 4, 1769504, 0, 4, 1769505, 0, 4, 1769506, 0, 4, 1703971, 0, 4, 1703972, 0, 4, 1638437, 0, 4, 1638438, 0, 4, 1638439, 0, 4, 1638440, 0, 4, 1572905, 0, 4, 1572906, 0, 4, 1572907, 0, 4, 1572908, 0, 4, 1507373, 0, 4, 1507374, 0, 4, 1441839, 0, 4, 1441840, 0, 4, 1441841, 0, 4, 1376306, 0, 4, 1376307, 0, 4, 1376308, 0, 4, 1310773, 0, 4, 1310774, 0, 4, 1310775, 0, 4, 1245240, 0, 4, 1245241, 0, 4, 1245242, 0, 4, 1179707, 0, 4, 1179708, 0, 4, 1179709, 0, 4, 1179710, 0, 4, 1179711, 0, 4, 1179712, 0, 4, 1179713, 0, 4, 1179714, 0, 4, 1179715, 0, 4, 1179716, 0, 4, 1179717, 0, 4, 1179718, 0, 4, 1179719, 0, 4, 1179720, 0, 4, 1179721, 0, 4, 1179722, 0, 4, 1179723, 0, 4, 1245260, 0, 4, 1245261, 0, 4, 1245262, 0, 4, 1245263, 0, 4, 1245264, 0, 4, 1310801, 0, 4, 1310802, 0, 4, 1376339, 0, 4, 1376340, 0, 4, 1376341, 0, 4, 1376342, 0, 4, 1441878, 0, 4, 1441879, 0, 4, 1441880, 0, 4, 1507416, 0, 4, 1572953, 0, 4, 1638490, 0, 4, 1704027, 0, 4, 1769563, 0, 4, 1835099, 0, 4, 1900635, 0, 4, 1966172, 0, 4, 2031708, 0, 4, 2097244, 0, 4, 2162779, 0, 4, 2228315, 0, 4, 2293850, 0, 4, 2359386, 0, 4, 2424921, 0, 4, 2490457, 0, 4, 2555992, 0, 4, 2621528, 0, 4, 2687063, 0, 4, 2752599, 0, 4, 2818134, 0, 4, 2883669, 0, 4, 2883668, 0, 4, 2949203, 0, 4, 3014739, 0, 4, 3080274, 0, 4, 3080273, 0, 4, 3080272, 0, 4, 3145808, 0, 4, 3145807, 0, 4, 3145806, 0, 4, 3080269, 0, 4, 3080268, 0, 4, 3080267, 0, 4, 3014730, 0, 4, 3014729, 0, 4, 2949192, 0, 4, 2883655, 0, 4, 2883654, 0, 4, 2818117, 0, 4, 2818116, 0, 4, 2752579, 0, 4, 2752578, 0, 4, 2687041, 0, 4, 2687040, 0, 4, 2687039, 0, 4, 2621502, 0, 4, 2621501, 0, 4, 2621500, 0, 4, 2621499, 0, 4, 2621498, 0, 4, 2621497, 0, 4, 2621496, 0, 4, 2621495, 0, 4, 2621494, 0, 4, 2555957, 0, 4, 2555956, 0, 4, 2555955, 0, 4, 2555954, 0, 4, 2555953, 0, 4, 2555952, 0, 4, 2555951, 0, 4, 2555950, 0, 4, 2621485, 0, 4, 2621484, 0, 4, 2621483, 0, 4, 2621482, 0, 4, 2687017, 0, 4, 2687016, 0, 4, 2752551, 0, 4, 2752550, 0, 4, 2752549, 0, 4, 2818084, 0, 4, 2883619, 0, 4, 2949154, 0, 4, 3014689, 0, 4, 3014688, 0, 4, 3080223, 0, 4, 3145759, 0, 4, 3211294, 0, 4, 3276829, 0, 4, 3342364, 0, 4, 3407899, 0, 4, 3407898, 0, 4, 3473434, 0, 4, 3538970, 0, 4, 3538969, 0, 4, 3604504, 0, 4, 3670039, 0, 4, 3670038, 0, 4, 3670037, 0, 4, 3735573, 0, 4, 3735572, 0, 4, 3735571, 0, 4, 3801106, 0, 4, 3801105, 0, 4, 3801104, 0, 4, 3866639, 0, 4, 3866638, 0, 4, 3932173, 0, 4, 3866636, 0, 4, 3801099, 0, 4, 3735562, 0, 4, 3670025, 0, 4, 3604488, 0, 4, 3538951, 0, 4, 3473415, 0, 4, 3407878, 0, 4, 3342342, 0, 4, 3276806, 0, 4, 3211270, 0, 4, 3145734, 0, 4, 3080199, 0, 4, 3014663, 0, 4, 3014664, 0, 4, 2949129, 0, 4, 2949130, 0, 4, 2883594, 0, 4, 2883595, 0, 4, 2883596, 0, 4, 2818061, 0, 4, 2818062, 0, 4, 2818063, 0, 4, 2818064, 0, 4, 2818065, 0, 4, 2752530, 0, 4, 2686994, 0, 4, 2686995, 0, 4, 2621460, 0, 4, 2555925, 0, 4, 2555926, 0, 4, 2490391, 0, 4, 2424856, 0, 4, 2359321, 0, 4, 2949172, 0, 4, 2949171, 0, 4, 2949170, 0, 4, 2883633, 0, 4, 2883632, 0, 4, 2883631, 0, 4, 2883630, 0, 4, 2883629, 0, 4, 2949164, 0, 4, 3014699, 0, 4, 3014698, 0, 4, 3080234, 0, 4, 3080233, 0, 4, 3145768, 0, 4, 3211304, 0, 4, 3276839, 0, 4, 3342374, 0, 4, 3407909, 0, 4, 3473444, 0, 4, 3538980, 0, 4, 3538979, 0, 4, 3604515, 0, 4, 3604516, 0, 4, 3670053, 0, 4, 3735590, 0, 4, 3801127, 0, 4, 3801128, 0, 4, 3866665, 0, 4, 3866666, 0, 4, 3932203, 0, 4, 3932204, 0, 4, 3932205, 0, 4, 3932206, 0, 4, 3932207, 0, 4, 3932208, 0, 4, 3866673, 0, 4, 3866674, 0, 4, 3801139, 0, 4, 3801140, 0, 4, 3735604, 0, 4, 3670069, 0, 4, 3604534, 0, 4, 3538999, 0, 4, 3539000, 0, 4, 3473465, 0, 4, 3407929, 0, 4, 3407930, 0, 4, 3342394, 0, 4, 3342395, 0, 4, 3276860, 0, 4, 3276861, 0, 4, 3276862, 0, 4, 3276863, 0, 4, 3276864, 0, 4, 3342401, 0, 4, 3342402, 0, 4, 3407939, 0, 4, 3473476, 0, 4, 3473477, 0, 4, 3539014, 0, 4, 3539015, 0, 4, 3604552, 0, 4, 3670089, 0, 4, 3670090, 0, 4, 3670091, 0, 4, 3670092, 0, 4, 3735628, 0, 4, 3735629, 0, 4, 3735630, 0, 4, 3735631, 0, 4, 3735632, 0, 4, 3735633, 0, 4, 3735634, 0, 4, 3735635, 0, 4, 3735636, 0, 4, 196623, 0, 4, 262159, 0, 4, 262160, 0, 4, 327697, 0, 4, 393234, 0, 4, 458770, 0, 4, 524307, 0, 4, 589844, 0, 4, 655381, 0, 4, 720918, 0, 4, 786455, 0, 4, 851992, 0, 4, 917529, 0, 4, 917530, 0, 4, 917531, 0, 4, 917532, 0, 4, 983069, 0, 4, 983070, 0, 4, 983071, 0, 4, 983072, 0, 4, 983073, 0, 4, 983074, 0, 4, 983075, 0, 4, 983076, 0, 4, 917541, 0, 4, 917542, 0, 4, 917543, 0, 4, 917544, 0, 4, 852009, 0, 4, 852010, 0, 4, 852011, 0, 4, 852012, 0, 4, 852013, 0, 4, 786478, 0, 4, 786479, 0, 4, 786480, 0, 4, 720945, 0, 4, 720946, 0, 4, 720947, 0, 4, 720948, 0, 4, 655413, 0, 4, 655414, 0, 4, 655415, 0, 4, 655416, 0, 4, 655417, 0, 4, 589882, 0, 4, 589883, 0, 4, 524348, 0, 4, 524349, 0, 4, 458814, 0, 4, 393279, 0, 4, 327744, 0, 4, 327745, 0, 4, 262210, 0, 4, 262211, 0, 4, 262212, 0, 4, 196677, 0, 4, 196678, 0, 4, 196679, 0, 4, 262216, 0, 4, 262217, 0, 4, 262218, 0, 4, 327755, 0, 4, 327756, 0, 4, 327757, 0, 4, 393294, 0, 4, 458831, 0, 4, 458832, 0, 4, 458833, 0, 4, 458834, 0, 4, 524371, 0, 4, 589908, 0, 4, 589909, 0, 4, 589910, 0, 4, 655447, 0, 4, 655448, 0, 4, 655449, 0, 4, 720986, 0, 4, 720987, 0, 4, 720988, 0, 4, 720989, 0, 4, 786526, 0, 4, 786527, 0, 4, 852063, 0, 4, 852064, 0, 4, 917601, 0, 4, 917602, 0, 4, 983139, 0, 4, 1048676, 0, 4, 1114212, 0, 4, 1179749, 0, 4, 1245286, 0, 4, 1310823, 0, 4, 1376360, 0, 4, 1441897, 0, 4, 1507433, 0, 4, 1572969, 0, 4, 1638506, 0, 4, 1704042, 0, 4, 1769579, 0, 4, 1835115, 0, 4, 1900651, 0, 4, 1966187, 0, 4, 2031723, 0, 4, 2097258, 0, 4, 2162794, 0, 4, 2228330, 0, 4, 2293866, 0, 4, 2359401, 0, 4, 2424936, 0, 4, 2490472, 0, 4, 2556007, 0, 4, 2621542, 0, 4, 2687077, 0, 4, 2752613, 0, 4, 2818148, 0, 4, 2883684, 0, 4, 2949219, 0, 4, 3014754, 0, 4, 3080289, 0, 4, 3145824, 0, 4, 3211359, 0, 4, 3276895, 0, 4, 3342430, 0, 4, 3407965, 0, 4, 3473501, 0, 4, 3539036, 0, 4, 3604571, 0, 4, 3670107, 0, 4, 3670106, 0, 4, 3670105, 0, 4, 3670104, 0, 4, 3735639, 0, 4, 3735638, 0, 4, 3670102, 0, 4, 3670101, 0, 4, 3735637, 0, 4)
+
+[node name="progressIndicator" parent="." node_paths=PackedStringArray("generator") instance=ExtResource("7_8vira")]
+generator = NodePath("../generator")

addons/wfc/examples/demo_wfc_2d_tilemap.tscn

@@ -0,0 +1,35 @@
+[gd_scene load_steps=3 format=3 uid="uid://dt2nffs32s7o1"]
+
+[sub_resource type="GDScript" id="GDScript_3tvrq"]
+script/source = "extends CanvasLayer
+
+@export
+var generator: WFC2DGenerator
+
+func _ready():
+	%ProgressBar.min_value = 0
+	%ProgressBar.max_value = 1.0
+	%ProgressBar.step = 0.001
+
+func _process(delta):
+	%ProgressBar.value = generator.get_progress()
+"
+
+[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")]
+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"]
+unique_name_in_owner = true
+custom_minimum_size = Vector2(500, 0)
+layout_mode = 2
+theme_override_styles/fill = SubResource("StyleBoxFlat_6msag")

addons/wfc/examples/helpers/progress_indicator.tscn

@@ -183,3 +183,9 @@ func _ready():
 func _process(_delta):
 	if _runner != null and _runner.is_running():
 		_runner.update()
+
+func get_progress() -> float:
+	if _runner == null:
+		return 0
+
+	return _runner.get_progress()