add an ability to copy decal settings and use them as defaults

Author: romgerman

README.md

@@ -12,17 +12,19 @@
 
 ## Features
 
-### Works with both mesh instances and CSG geometry
+- Works with both mesh instances and CSG geometry
 
-### Auto detection of the collider thickness
+- Auto detection of the collider thickness
 
-![auto thickness detection](readme_images/Godot_v4.3-stable_win64_dyrHiUnnqW.png)
+	![auto thickness detection](readme_images/Godot_v4.3-stable_win64_dyrHiUnnqW.png)
 
-### List/Grid view
+- List/Grid view
 
-![list view](readme_images/Godot_v4.3-stable_win64_YetH25lbe2.png)
+	![list view](readme_images/Godot_v4.3-stable_win64_YetH25lbe2.png)
 
-![grid view](readme_images/Godot_v4.3-stable_win64_WdI7m5o6pS.png)
+	![grid view](readme_images/Godot_v4.3-stable_win64_WdI7m5o6pS.png)
+
+- Easily copy decal properties to use them as the defaults when placing decals
 
 ## Keybinds (when in decal placement mode)
 

addons/splasher/decal_props.gd

@@ -0,0 +1,51 @@
+extends Resource
+
+@export var size: Vector3
+
+@export var param_emission_energy: float
+@export var param_modulate: Color
+@export var param_albedo_mix: float
+@export var param_normal_fade: float
+
+@export var vertical_fade_upper_fade: float
+@export var vertical_fade_lower_fade: float
+
+@export var distance_fade_enabled: bool
+@export var distance_fade_begin: float
+@export var distance_fade_length: float
+
+@export var cull_mask: int
+
+func apply_to(decal: Decal) -> void:
+	decal.emission_energy = param_emission_energy
+	decal.modulate = param_modulate
+	decal.albedo_mix = param_albedo_mix
+	decal.normal_fade = param_normal_fade
+
+	decal.upper_fade = vertical_fade_upper_fade
+	decal.lower_fade = vertical_fade_lower_fade
+
+	decal.distance_fade_enabled = distance_fade_enabled
+	decal.distance_fade_begin = distance_fade_begin
+	decal.distance_fade_length = distance_fade_length
+
+	decal.cull_mask = cull_mask
+
+static func make_from(decal: Decal):
+	var props_res := new()
+
+	props_res.param_emission_energy = decal.emission_energy
+	props_res.param_modulate = decal.modulate
+	props_res.param_albedo_mix = decal.albedo_mix
+	props_res.param_normal_fade = decal.normal_fade
+
+	props_res.vertical_fade_upper_fade = decal.upper_fade
+	props_res.vertical_fade_lower_fade = decal.lower_fade
+
+	props_res.distance_fade_enabled = decal.distance_fade_enabled
+	props_res.distance_fade_begin = decal.distance_fade_begin
+	props_res.distance_fade_length = decal.distance_fade_length
+
+	props_res.cull_mask = decal.cull_mask
+
+	return props_res

addons/splasher/editor_manager.gd

@@ -2,6 +2,7 @@
 extends Node
 
 const ObservableList := preload("res://addons/splasher/ui/observable_list.gd")
+const DecalPropsResource := preload("res://addons/splasher/decal_props.gd")
 
 class StoredSettings:
 	var storage: Dictionary = {}
@@ -22,7 +23,7 @@ class StoredSettings:
 	func emit_changed(prop_name: String, new_value: Variant, old_value: Variant) -> void:
 		changed.emit(prop_name, new_value, old_value)
 
-class DecalSettings extends StoredSettings:
+class DecalPlacementSettings extends StoredSettings:
 	# Automatically determine decal's thickness based on the size of a collider
 	var p_auto_thickness: bool:
 		get:
@@ -69,8 +70,9 @@ var scale_step = 0.5
 var rotation_step = 0.05
 var snap_step = 0.5
 
-var decal_settings := DecalSettings.new()
+var decal_placement_settings := DecalPlacementSettings.new()
 var plugin_settings := PluginSettings.new()
+var decal_defaults: DecalPropsResource = null
 
 # TODO: move to decal settings
 var upper_fade = 0.3

addons/splasher/editor_viewport.gd

@@ -8,7 +8,7 @@ const Globals := preload("res://addons/splasher/globals.gd")
 
 @export_flags_3d_physics var temporary_layer: int
 
-var decal: Decal
+var decal_ref: Decal
 var decal_dupe: Decal
 var last_collider
 
@@ -20,24 +20,33 @@ var editor_manager
 
 func _ready():
 	if not Engine.is_editor_hint():
+		queue_free()
 		return
+
 	editor_manager = Globals.get_editor_manager()
-	decal = Decal.new()
+	decal_ref = Decal.new()
+
+	editor_manager.select_decal.connect(on_decal_selected)
 
-	editor_manager.select_decal.connect(_decal_selected)
+func on_decal_selected(path: String):
+	decal_ref.texture_albedo = ResourceLoader.load(path)
 
-func _decal_selected(path: String):
-	decal.texture_albedo = ResourceLoader.load(path)
+func create_decal_dupe():
+	if decal_dupe:
+		return
 
-func _create_decal():
-	if decal_dupe: return
 	var root := EditorInterface.get_edited_scene_root()
-	decal_dupe = decal.duplicate()
+	decal_dupe = decal_ref.duplicate()
 	decal_dupe.process_mode = Node.PROCESS_MODE_DISABLED
-	var upper_fade = editor_manager.upper_fade
-	var lower_fade = editor_manager.lower_fade
-	decal_dupe.upper_fade = upper_fade
-	decal_dupe.lower_fade = lower_fade
+
+	if editor_manager.decal_defaults:
+		editor_manager.decal_defaults.apply_to(decal_dupe)
+	else:
+		var upper_fade = editor_manager.upper_fade
+		var lower_fade = editor_manager.lower_fade
+		decal_dupe.upper_fade = upper_fade
+		decal_dupe.lower_fade = lower_fade
+
 	var pivot := root
 	var editor_selection := EditorInterface.get_selection()
 	if editor_selection.get_selected_nodes().size() == 1:
@@ -135,9 +144,9 @@ func on_ray_hit(hit) -> void:
 		Globals.get_debug_draw_3d().draw_line(hit_position, hit_position + hit_normal, Color.RED)
 
 	if not decal_dupe:
-		_create_decal()
+		create_decal_dupe()
 
-	if editor_manager.decal_settings.p_grid_snap:
+	if editor_manager.decal_placement_settings.p_grid_snap:
 		var snap_to := Vector3(
 			editor_manager.snap_step,
 			editor_manager.snap_step,
@@ -148,7 +157,7 @@ func on_ray_hit(hit) -> void:
 	decal_dupe.global_position = hit_position
 	decal_dupe.size = add_scale
 
-	if editor_manager.decal_settings.p_auto_thickness:
+	if editor_manager.decal_placement_settings.p_auto_thickness:
 		var hit_collider = hit.collider
 		var hit_collider_layer = hit_collider.collision_layer
 		var hit_collider_mask = hit_collider.collision_mask

addons/splasher/icons/copy.svg

@@ -0,0 +1,38 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://cf8x67lx8ukns"
+path="res://.godot/imported/copy.svg-e0fdfecfab9da15a225603325d35d437.ctex"
+metadata={
+"has_editor_variant": true,
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://addons/splasher/icons/copy.svg"
+dest_files=["res://.godot/imported/copy.svg-e0fdfecfab9da15a225603325d35d437.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1
+svg/scale=1.0
+editor/scale_with_editor_scale=true
+editor/convert_colors_with_editor_theme=true

addons/splasher/icons/copy.svg.import

@@ -35,6 +35,12 @@ func _exit_tree():
 	remove_autoload_singleton(Globals.EDITOR_VIEWPORT_NAME)
 	remove_autoload_singleton(Globals.EDITOR_MANAGER_NAME)
 
+func _handles(object: Object) -> bool:
+	return object is Decal
+
+func _make_visible(visible: bool) -> void:
+	viewport_panel.enable(visible)
+
 func _save_external_data() -> void:
 	if not save_timer.is_stopped():
 		save_timer.stop()
@@ -48,7 +54,7 @@ func watch_settings() -> void:
 	manager.plugin_settings.changed.connect(func (_p, _n, _o):
 		queue_settings_save()
 	)
-	manager.decal_settings.changed.connect(func (_p, _n, _o):
+	manager.decal_placement_settings.changed.connect(func (_p, _n, _o):
 		queue_settings_save()
 	)
 
@@ -64,7 +70,7 @@ func queue_settings_save() -> void:
 func save_settings() -> void:
 	var manager = Globals.get_editor_manager()
 	var res := StorageResource.new()
-	res.decal_settings = manager.decal_settings.storage
+	res.decal_placement_settings = manager.decal_placement_settings.storage
 	res.plugin_settings = manager.plugin_settings.storage
 
 	for decal in manager.decal_list.items:
@@ -82,7 +88,7 @@ func load_settings() -> void:
 		return
 
 	var manager = Globals.get_editor_manager()
-	manager.decal_settings.set_storage(res.decal_settings)
+	manager.decal_placement_settings.set_storage(res.decal_placement_settings)
 	manager.plugin_settings.set_storage(res.plugin_settings)
 
 	for stored_decal: StoredDecalResource in res.decal_registry:

addons/splasher/splasher.gd

@@ -5,6 +5,6 @@ enum StorageVersion {
 }
 
 @export var decal_registry: Array = []
-@export var decal_settings: Dictionary = {}
+@export var decal_placement_settings: Dictionary = {}
 @export var plugin_settings: Dictionary = {}
 @export var version: StorageVersion = StorageVersion.Version_Alpha

addons/splasher/storage.gd

@@ -2,28 +2,30 @@
 extends Control
 
 const Globals := preload("res://addons/splasher/globals.gd")
+const DecalPropsResource := preload("res://addons/splasher/decal_props.gd")
 
 @onready var toolbar: Control = $Toolbar
 @onready var info_label: Label = $Toolbar/HBoxContainer/InfoLabel
 
 @onready var auto_thickness_btn: Button = $Toolbar/HBoxContainer/AutoThickness
 @onready var grid_snap_btn: Button = $Toolbar/HBoxContainer/GridSnap
+@onready var copy_decal_props: Button = $Toolbar/HBoxContainer/CopyDecalProps
 
 func _ready() -> void:
-	# TODO: this
-	Globals.get_editor_manager().viewport_panel = self
+	var manager = Globals.get_editor_manager()
+	manager.viewport_panel = self
 
 	enable(false)
 
 	# Initialize based on settings
 
-	var settings = Globals.get_editor_manager().decal_settings
+	var settings = manager.decal_placement_settings
 	auto_thickness_btn.set_pressed_no_signal(settings.p_auto_thickness)
 	grid_snap_btn.set_pressed_no_signal(settings.p_grid_snap)
 
 	# Connect change signal
 
-	Globals.get_editor_manager().changed.connect(_editor_manager_changed)
+	manager.changed.connect(_editor_manager_changed)
 
 func _editor_manager_changed() -> void:
 	var manager = Globals.get_editor_manager()
@@ -35,13 +37,30 @@ func enable(value: bool) -> void:
 	if value:
 		info_label.text = get_info_label_text()
 
+	var manager = Globals.get_editor_manager()
+
+	var editor_selection := EditorInterface.get_selection()
+	copy_decal_props.visible = editor_selection.get_selected_nodes().size() == 1 and editor_selection.get_selected_nodes()[0] is Decal
+
+	auto_thickness_btn.visible = manager.enabled
+	grid_snap_btn.visible = manager.enabled
+
 func get_info_label_text() -> String:
-	return "decal placement"
+	return "Decal"
 
 # Events
 
 func _on_auto_thickness_toggled(toggled_on: bool) -> void:
-	Globals.get_editor_manager().decal_settings.p_auto_thickness = toggled_on
+	Globals.get_editor_manager().decal_placement_settings.p_auto_thickness = toggled_on
 
 func _on_grid_snap_toggled(toggled_on: bool) -> void:
-	Globals.get_editor_manager().decal_settings.p_grid_snap = toggled_on
+	Globals.get_editor_manager().decal_placement_settings.p_grid_snap = toggled_on
+
+func _on_copy_decal_props_pressed() -> void:
+	var editor_selection := EditorInterface.get_selection()
+
+	if editor_selection.get_selected_nodes().size() == 1 and editor_selection.get_selected_nodes()[0] is Decal:
+		var decal := editor_selection.get_selected_nodes()[0] as Decal
+		var defaults_res := DecalPropsResource.make_from(decal) as DecalPropsResource
+		var manager = Globals.get_editor_manager()
+		manager.decal_defaults = defaults_res