Multi Zone Fixtures

Author: Liam Sherwin

core/components/FixtureManifest.gd

@@ -58,7 +58,7 @@ func create_zone(p_mode: String, p_zone: String) -> bool:
 
 
 ## Creates a parameter in the given mode and zone
-func add_parameter(p_mode: String, p_zone: String, p_parameter: String, p_channels: Array[int], p_categorys: String = "Control") -> bool:
+func add_parameter(p_mode: String, p_zone: String, p_parameter: String, p_channels: Array[int], p_category: String = "") -> bool:
 	if not _modes.has(p_mode) or not _modes[p_mode].zones.has(p_zone):
 		return false
 
@@ -67,20 +67,44 @@ func add_parameter(p_mode: String, p_zone: String, p_parameter: String, p_channe
 		"offsets": p_channels.duplicate(),
 		"functions": {}
 	}
-	_categorys.get_or_add(p_mode, {}).get_or_add(p_zone, {})[p_parameter] = p_categorys
+	
+	_categorys.get_or_add(p_mode, {}).get_or_add(p_zone, {})[p_parameter] = p_category
 
 	return true
 
 
+## Duplicates a parameter to another zone
+func duplicate_parameter(p_mode: String, p_parameter: String, p_from_zone: String, p_to_zone: String, p_channels: Array[int]) -> bool:
+	if not _modes.has(p_mode) or not _modes[p_mode].zones.has(p_from_zone):
+		return false
+
+	var new_parameter: Dictionary = _modes[p_mode].zones[p_from_zone][p_parameter].duplicate(true)
+	create_zone(p_mode, p_to_zone)
+
+	new_parameter.offsets = p_channels
+	_modes[p_mode].zones[p_to_zone][p_parameter] = new_parameter
+
+	return true
+
+
+## Removes a parameter
+func remove_parameter(p_mode: String, p_zone: String, p_parameter: String) -> bool:
+	if not _modes.has(p_mode) or not _modes[p_mode].zones.has(p_zone):
+		return false
+	
+	return _modes[p_mode].zones[p_zone].erase(p_parameter)
+
+
 ## Adds a funtion to the given parameter
-func add_parameter_function(p_mode: String, p_zone: String, p_parameter: String, p_function: String, p_name: String, p_default: int, p_range: Array[int]) -> bool:
+func add_parameter_function(p_mode: String, p_zone: String, p_parameter: String, p_function: String, p_name: String, p_default: int, p_range: Array[int], p_can_fade: bool) -> bool:
 	if not _modes.has(p_mode) or not _modes[p_mode].zones.has(p_zone) or not _modes[p_mode].zones[p_zone].has(p_parameter):
 		return false
 
 	_modes[p_mode].zones[p_zone][p_parameter].functions[p_function] = {
 		"attribute": p_function,
 		"name": p_name,
 		"default": p_default,
+		"can_fade": p_can_fade,
 		"dmx_range": p_range.duplicate(),
 		"sets": []
 	}
@@ -126,14 +150,24 @@ func has_function(p_mode: String, p_zone: String, p_parameter: String, p_functio
 	return _modes.get(p_mode, {}).get("zones", {}).get(p_zone, {}).get(p_parameter, {}).get("functions", {}).has(p_function)
 
 
+## Checks if this FixtureManifest has a function that can fade
+func function_can_fade(p_mode: String, p_zone: String, p_parameter: String, p_function: String) -> bool:
+	return _modes.get(p_mode, {}).get("zones", {}).get(p_zone, {}).get(p_parameter, {}).get("functions", {}).get(p_function, {}).get("can_fade", false)
+
+
 ## Returns the given mode
 func get_mode(p_mode: String) -> Dictionary:
 	return _modes.get(p_mode, {}).duplicate(true)
 
 
 ## Returns all the modes in this manifest
-func get_modes() -> Array:
-	return _modes.keys()
+func get_modes() -> Array[String]:
+	return Array(_modes.keys(), TYPE_STRING, "", null)
+
+
+## Returns all zones in this manifest
+func get_zones(p_mode) -> Array[String]:
+	return Array(_modes[p_mode].zones.keys(), TYPE_STRING, "", null)
 
 
 ## Gets all the categorys in a mode and zone
@@ -148,7 +182,6 @@ func get_parameter_functions(p_mode: String, p_zone: String, p_parameter: String
 
 	return _modes[p_mode].zones[p_zone][p_parameter].functions.keys()
 
-
 ## Overide this function to serialize your object
 func _serialize_request() -> Dictionary:
 	return {

core/components/fixtures/DMXFixture.gd

@@ -15,9 +15,9 @@ var _channel: int = 0
 ## The mode of this fixture
 var _mode: String = ""
 
-## Current override values of this fixture, post precedence calculation
-## { "zone": { "parameter": value } }## 
-var _current_override: Dictionary = {}
+## All the input value overrides as raw values
+## { "zone": { "parameter": { "value": float, "function": String } } }
+var _raw_override_layers: Dictionary[String, Dictionary] = {}
 
 ## The FixtureManifest for this fixture
 var _manifest: FixtureManifest = null
@@ -31,30 +31,22 @@ func _component_ready() -> void:
 
 
 ## Internal: Sets a parameter override to a float value
-func _set_override(parameter: String, value: float, zone: String = "root") -> void:
-	var split: PackedStringArray = parameter.split(".", true, 1)
-	if len(split) == 2:
-		var logical: String = split[0]
-		
-		_current_override.get_or_add(zone, {})[logical] = value
-		override_changed.emit(parameter, value, zone)
+func _set_override(p_parameter: String, p_function: String, p_value: float, p_zone: String = "root") -> void:
+	_raw_override_layers.get_or_add(p_zone, {})[p_parameter] = {"value": p_value, "function": p_function}
+	override_changed.emit(p_parameter, p_function, p_value, p_zone)
 
 
-#Internal: Erases the parameter override 
-func _erase_override(parameter: String, zone: String = "root") -> void:
-	var split: PackedStringArray = parameter.split(".", true, 1)
-	if len(split) == 2:
-		var logical: String = split[0]
-		
-		if _current_override.get_or_add(zone, {}).erase(logical) and not _current_override[zone]:
-			_current_override.erase(zone)
+## Internal: Erases the parameter override 
+func _erase_override(p_parameter: String, p_zone: String = "root") -> void:
+	if _raw_override_layers.get_or_add(p_zone, {}).erase(p_parameter) and not _raw_override_layers[p_zone]:
+		_raw_override_layers.erase(p_zone)
 
-		override_erased.emit(parameter, zone)
+	override_erased.emit(p_parameter, p_zone)
 
 
 ## Internal: Erases all overrides
 func _erase_all_overrides() -> void:
-	_current_override.clear()
+	_raw_override_layers.clear()
 	all_override_removed.emit()
 
 
@@ -87,12 +79,17 @@ func _set_manifest(p_manifest: FixtureManifest, p_mode: String) -> void:
 
 ## Gets all the override values
 func get_all_override_values() -> Dictionary:
-	return _current_override.duplicate(true)
+	return _raw_override_layers.duplicate(true)
 
 
 ## Checks if this DMXFixture has any overrides
 func has_overrides() -> bool:
-	return _current_override != {}
+	return _raw_override_layers != {}
+
+
+## Gets all the zones
+func get_zones() -> Array[String]:
+	return _manifest.get_zones(_mode)
 
 
 ## Gets all the parameters and there category from a zone
@@ -105,6 +102,11 @@ func get_parameter_functions(p_zone: String, p_parameter: String) -> Array:
 	return _manifest.get_parameter_functions(_mode, p_zone, p_parameter)
 
 
+## Checks if this DMXFixture has a function that can fade
+func function_can_fade(p_zone: String, p_parameter: String, p_function: String) -> bool:
+	return _manifest.function_can_fade(_mode, p_zone, p_parameter, p_function)
+
+
 ## Saves this DMXFixture to a dictonary
 func _serialize_request() -> Dictionary:
 	return {
@@ -122,3 +124,5 @@ func _load_request(p_serialized_data: Dictionary) -> void:
 		FixtureLibrary.request_manifest(manifest_uuid).then(func (manifest: FixtureManifest):
 			_set_manifest(manifest, _mode)
 		)
+	
+	_raw_override_layers = Dictionary(type_convert(p_serialized_data.get("raw_override_layers", {}), TYPE_DICTIONARY), TYPE_STRING, "", null, TYPE_DICTIONARY, "", null)

core/components/fixtures/Fixture.gd

@@ -6,13 +6,13 @@ class_name Fixture extends EngineComponent
 
 
 ## Emitted when parameters are changed
-signal parameter_changed(parameter: String, value: Variant, zone: String)
+signal parameter_changed(parameter: String, function: String, value: Variant, zone: String)
 
 ## Emitted when a parameter is erased
 signal parameter_erased(parameter: String, zone: String)
 
 ## Emited when a parameter override is changed or added
-signal override_changed(parameter: String, value: Variant, zone: String)
+signal override_changed(parameter: String, function: String, value: Variant, zone: String)
 
 ## Emitted when a parameter override is removed
 signal override_erased(parameter: String, zone: String)
@@ -35,42 +35,42 @@ func _init(p_uuid: String = UUID_Util.v4(), p_name: String = name) -> void:
 
 
 ## Sets a parameter to a float value
-func set_parameter(parameter: String, value: float, layer_id: String, zone: String = "root") -> Promise:
-	return rpc("set_parameter", [parameter, value, layer_id, zone])
+func set_parameter(p_parameter: String, p_function: String, p_value: float, p_layer_id: String, p_zone: String = "root") -> Promise:
+	return rpc("set_parameter", [p_parameter, p_function, p_value, p_layer_id, p_zone])
 
 
 ## Internal: Sets a parameter to a float value
-func _set_parameter(parameter: String, value: float, layer_id: String, zone: String = "root") -> void:
+func _set_parameter(p_parameter: String, p_value: float, p_layer_id: String, p_zone: String = "root") -> void:
 	return 
 
 
 ## Erases the parameter on the given layer
-func erase_parameter(parameter: String, layer_id: String, zone: String = "root") -> Promise:
-	return rpc("erase_parameter", [parameter, layer_id, zone])
+func erase_parameter(p_parameter: String, p_layer_id: String, p_zone: String = "root") -> Promise:
+	return rpc("erase_parameter", [p_parameter, p_layer_id, p_zone])
 
 
 ## Internal: Erases the parameter on the given layer
-func _erase_parameter(parameter: String, layer_id: String, zone: String = "root") -> void:
+func _erase_parameter(p_parameter: String, p_layer_id: String, p_zone: String = "root") -> void:
 	return 
 
 
 ## Sets a parameter override to a float value
-func set_override(parameter: String, value: float, zone: String = "root") -> Promise:
-	return rpc("set_override", [parameter, value, zone])
+func set_override(p_parameter: String, p_function: String, p_value: float, p_zone: String = "root") -> Promise:
+	return rpc("set_override", [p_parameter, p_function, p_value, p_zone])
 
 
 ## Internal: Sets a parameter override to a float value
-func _set_override(parameter: String, value: float, zone: String = "root") -> void:
+func _set_override(p_parameter: String, p_function: String, p_value: float, p_zone: String = "root") -> void:
 	return
 
 
 ## Erases the parameter override 
-func erase_override(parameter: String, zone: String = "root") -> Promise:
-	return rpc("erase_override", [parameter, zone])
+func erase_override(p_parameter: String, p_zone: String = "root") -> Promise:
+	return rpc("erase_override", [p_parameter, p_zone])
 
 
 ## Internal: Erases the parameter override 
-func _erase_override(parameter: String, zone: String = "root") -> void:
+func _erase_override(p_parameter: String, p_zone: String = "root") -> void:
 	return
 
 
@@ -94,6 +94,11 @@ func has_overrides() -> bool:
 	return false
 
 
+## Gets all the zones
+func get_zones() -> Array[String]:
+	return []
+
+
 ## Gets all the parameters and there category from a zone
 func get_parameter_categories(p_zone: String) -> Dictionary:
 	return {}
@@ -102,3 +107,8 @@ func get_parameter_categories(p_zone: String) -> Dictionary:
 ## Gets all the parameter functions
 func get_parameter_functions(p_zone: String, p_parameter: String) -> Array:
 	return []
+
+
+## Checks if this Fixture has a function that can fade
+func function_can_fade(p_zone: String, p_parameter: String, p_function: String) -> bool:
+	return false

core/engine/Engine.gd

@@ -46,7 +46,7 @@ var EngineConfig = {
 		},
 		{
 			"object": (Programmer),
-			"name": "programmer"
+			"name": "Programmer"
 		},
 		{
 			"object": (FixtureLibrary),

core/global/Programmer.gd

@@ -5,19 +5,57 @@ class_name CoreProgrammer extends Node
 ## Engine class for programming lights, colors, positions, etc.
 
 
+## Emitted when the programmer is cleared
+signal cleared()
+
+
 ## Save Modes
-enum SAVE_MODE {
+enum SaveMode {
 	MODIFIED,		## Only save fixtures that have been changed in the programmer
 	ALL,			## Save all values of the fixtures
 	ALL_NONE_ZERO	## Save all values of the fixtures, as long as they are not the zero value for that channel
 }
 
+## Random parameter modes
+enum RandomMode {
+	All,			## Sets all fixture's parameter to the same random value
+	Individual		## Uses a differnt random value for each fixture
+}
+
+
+## Network Config:
+var network_config: Dictionary = {
+	"callbacks": {
+		"on_cleared": _clear,
+	}
+}
+
 
 ## Clears the programmer
-func clear() -> void: 
-	Client.send_command("Programmer", "clear")
+func clear() -> Promise: 
+	return Client.send_command("Programmer", "clear")
+
+
+## Called when the programmer is cleared on the server
+func _clear() -> void:
+	cleared.emit()
 
 
 ## Function to set the fixture data at the given chanel key
-func set_parameter(p_fixtures: Array, p_parameter: String, p_value: float, p_zone: String) -> void:
-	Client.send_command("Programmer", "set_parameter", [p_fixtures, p_parameter, p_value, p_zone])
+func set_parameter(p_fixtures: Array, p_parameter: String, p_function: String, p_value: float, p_zone: String) -> Promise:
+	return Client.send_command("Programmer", "set_parameter", [p_fixtures, p_parameter, p_function, p_value, p_zone])
+
+
+## Sets a fixture parameter to a random value
+func set_parameter_random(p_fixtures: Array, p_parameter: String, p_function: String, p_zone: String, p_mode: RandomMode) -> Promise:
+	return Client.send_command("Programmer", "set_parameter_random", [p_fixtures, p_parameter, p_function, p_zone, p_mode])
+
+
+## Erases a parameter
+func erase_parameter(p_fixtures: Array, p_parameter: String, p_zone: String) -> Promise:
+	return Client.send_command("Programmer", "erase_parameter", [p_fixtures, p_parameter, p_zone])
+
+
+## Saves the current state of this programmer to a scene
+func save_to_scene(fixtures: Array, mode: SaveMode = SaveMode.MODIFIED) -> Promise:
+	return Client.send_command("Programmer", "save_to_scene", [fixtures, mode])

core/static/Utils.gd

@@ -162,6 +162,40 @@ static func sum_array(array: Array) -> Variant:
 	return sum
 
 
+## Sorts all the text in an array
+static func sort_text(arr: Array) -> Array:
+	arr.sort_custom(func(a, b): return a.naturalnocasecmp_to(b) < 0)
+	return arr
+
+
+## Sorts all the text in an array, with numbers
+static func sort_text_and_numbers(arr: Array) -> Array:
+	arr.sort_custom(func(a, b): return _split_sort_key(a) < _split_sort_key(b))
+	return arr
+
+
+## Helper function for sort_text_and_numbers
+static func _split_sort_key(s: String) -> Array:
+	var regex = RegEx.new()
+	regex.compile(r"\d+|\D+")
+	
+	var parts = []
+	for match in regex.search_all(s):
+		var sub = match.get_string()
+		parts.append(int(sub) if sub.is_valid_int() else sub)
+	
+	return parts
+
+
+## Moves an item to the start of an array
+static func array_move_to_start(arr: Array, item) -> Array:
+	var i = arr.find(item)
+	if i > 0:  # Ensures "root" is found and isn't already at index 0
+		arr.remove_at(i)
+		arr.insert(0, item)
+	return arr
+
+
 ## Connects all the callables to the signals in the dictionary. Stored as {"SignalName": Callable}
 static func connect_signals(signals: Dictionary, object: Object) -> void:
 	if is_instance_valid(object):