Done Example Scenes

Author: erayzesen

.sconsign.dblite

@@ -1,21 +1,29 @@
-![](./project_logo.png)
+![](./images/project_logo.png)
 
-The godot-quarkphysics project is a native plugin that integrates QuarkPhysics into Godot Engine versions 4.3 and above.
+The project is a native plugin that integrates QuarkPhysics into Godot Engine versions 4.3 and above.
 QuarkPhysics is a physics engine for 2D games, capable of simulating Rigid Body, Soft Body, and various dynamics. You can find detailed information on the [project page](https://github.com/erayzesen/QuarkPhysics).
 
-Note: This project is currently in the alpha stage. You can test it and contribute by reporting bugs.
+[![Watch Examples](./images/examples_play.png)()](https://www.youtube.com/watch?v=KxsLLHMrB-Q)
 
 ## Features of the Extension:
 
 * Covers the entire API of the physics engine and can be easily used with the engine's up-to-date [documentation](https://erayzesen.github.io/QuarkPhysics/documentation/).
 * Can render QMeshNode objects with various advanced settings.
-* Includes tools for editing QMeshNode objects.
+* Includes `QMeshEditor` plugin for editing QMeshAdvancedNode objects.
 * Supports all platforms provided by Godot's GDExtension.
 * Includes example projects created with QuarkPhysics.
 
 ## How to Use? 
+You can use it like other Godot 4 native extension and plugins. Simply download the latest version from the Releases section and add the `addons` folder to your project as is. If you want to use the `QMeshEditor` plugin, make sure it is activated in Godot's project settings.
+
+Additionally, you can check out the example scenes and applications in the `examples` folder. If you don't need them, there's no need to add anything other than the addon folder to your project.
+
+## How to Contribute?
+You can contribute to the project in many ways. At this stage, the most valuable contribution is to test the project and report any bugs you encounter. You can also share your experiences. Additionally, you can help by working on documentation, creating tutorials, or promoting the project.
+
+If you use QuarkPhysics in one of your game projects, please don’t forget to let me know at erayzesen@gmail.com. This would be a significant contribution to the showcase we plan to present soon.
+
 
-Until a stable release is published, no precompiled builds or initial releases are available. You can fork the project and compile it using Godot's official GDExtension compilation tutorials. The builds are placed in the `/project/addons/quarkphysics/bin` directory. You can copy the `addons` folder under the `project` directory to your project and start using it. Alternatively, you can check out the example Godot project available in the `/project` directory of this repository.
 
 
 

README.md

@@ -0,0 +1,110 @@
+class_name QMeshSnapHelper extends RefCounted
+
+#These Helper Functions were taken from: @bitwes - https://github.com/godotengine/godot-proposals/issues/10529#issuecomment-2501936526 
+var found_all_editor_controls = false
+var snap_enabled: bool = false
+var snap_step : Vector2 = Vector2.ZERO
+var snap_offset: Vector2 = Vector2.ZERO
+
+var editor_controls = {
+	dialog = null,
+	grid_offset_x = null,
+	grid_offset_y = null,
+	grid_snap_x = null,
+	grid_snap_y = null,
+	snap_toggle = null
+}
+
+
+func _init():
+	if(Engine.is_editor_hint()):
+		setup_controls()
+		update_values_from_editor()
+
+
+func setup_controls():
+	var main_screen = EditorInterface.get_editor_main_screen()
+	editor_controls.snap_toggle = safe_get_descendant(main_screen, ["HBoxContainer", 12], Button)
+
+	var snap_dia_grid_container = safe_get_descendant(main_screen, ["SnapDialog", "GridContainer"], GridContainer)
+	editor_controls.grid_offset_x = safe_get_child(snap_dia_grid_container, 1, SpinBox)
+	editor_controls.grid_offset_y = safe_get_child(snap_dia_grid_container, 2, SpinBox)
+	editor_controls.grid_snap_x = safe_get_child(snap_dia_grid_container, 4, SpinBox)
+	editor_controls.grid_snap_y = safe_get_child(snap_dia_grid_container, 5, SpinBox)
+	editor_controls.dialog = find_child_with_name_containing(main_screen, "SnapDialog", ConfirmationDialog)
+
+	if(null in editor_controls.values()):
+		push_error("One or more Editor Controls could not be found.")
+		return
+	else:
+		found_all_editor_controls = true
+
+	editor_controls.snap_toggle.toggled.connect(func(tog: bool) -> void: snap_enabled = tog)
+	editor_controls.dialog.get_ok_button().pressed.connect(update_values_from_editor)
+
+
+func update_values_from_editor():
+	if(!found_all_editor_controls):
+		return
+	snap_enabled = editor_controls.snap_toggle.button_pressed
+	snap_offset.x = editor_controls.grid_offset_x.value
+	snap_offset.y = editor_controls.grid_offset_y.value
+	snap_step.x = editor_controls.grid_snap_x.value
+	snap_step.y = editor_controls.grid_snap_y.value
+
+func find_child_with_name_containing(parent, child_name, expected_type = null):
+	var to_return = parent.find_child("*%s*" % child_name, true, false)
+
+	if(to_return == null):
+		push_error("Could not find child named ", child_name, " in ", parent)
+	elif(expected_type != null and not is_instance_of(to_return, expected_type)):
+		push_error("Expected ", to_return, ' to be an instance of ', expected_type)
+		to_return = null
+
+	return to_return
+	
+func safe_get_child(parent, index, expected_type = null):
+	if(parent != null and index < parent.get_child_count()):
+		var found = parent.get_child(index)
+		if(expected_type != null and not is_instance_of(found, expected_type)):
+			push_error("Expected ", found, ' to be an instance of ', expected_type)
+			found = null
+		return found
+	else:
+		push_error(str("Could not get child index ", index, " on ", parent, '.  ', parent, ' has ', parent.get_child_count(), ' children.'))
+		return null
+		
+func safe_get_descendant(parent, names_and_or_indexes, expected_type = null):
+	var here = parent
+	var index = 0
+
+	while(here != null and index < names_and_or_indexes.size()):
+		var entry = names_and_or_indexes[index]
+		if(typeof(entry) == TYPE_STRING):
+			here = find_child_with_name_containing(here, entry)
+		elif(typeof(entry) == TYPE_INT):
+			here = safe_get_child(here, entry)
+		index += 1
+
+	if(here != null and expected_type != null and not is_instance_of(here, expected_type)):
+		push_error("Expected ", here, ' to be an instance of ', expected_type)
+		here = null
+
+	return here
+	
+var descendant_props_to_print = ['text', 'value']
+
+func print_descendants(parent, indent='', child_index = -1):
+	var text = ""
+	if(child_index != -1):
+		text = str(indent, '[', child_index, '] ', parent)
+	else:
+		text = str(indent, parent)
+
+	for ptp in descendant_props_to_print:
+		if(parent.get(ptp) != null):
+			text += str(' ', ptp, ' = ', parent.get(ptp))
+	print(indent, text)
+
+	for i in range(parent.get_child_count()):
+		print_descendants(parent.get_child(i), indent + '  ', i)

images/examples_play.png

@@ -11,8 +11,12 @@ var last_mouse_motion_position=Vector2.ZERO
 #Plugin References
 var radiusSpinBox:SpinBox
 var internalCheckBox:CheckBox
+var operationOptionButton:OptionButton
 var plugin:EditorPlugin
 
+#Helpers
+var snapHelper:QMeshSnapHelper=QMeshSnapHelper.new()
+
 func _reset_tool() :
 	mouse_drag_mode=false
 	last_mouse_pressed_position=Vector2.ZERO
@@ -32,6 +36,7 @@ func _internal_checkbox_toggled(toggled_on:bool) :
 func _radius_bar_changed(value:float) :
 	pass
 
+	
 func toScreen(point:Vector2) ->Vector2 :
 	var viewport_transform=EditorInterface.get_editor_viewport_2d().get_final_transform()*EditorInterface.get_base_control().get_canvas_transform()
 	return viewport_transform*point
@@ -48,12 +53,77 @@ func get_nearest_particle_index(targetMeshNode:QMeshNode,position:Vector2) ->int
 			return i
 	return -1;
 
+func get_nearest_spring_index(targetMeshNode:QMeshNode, position:Vector2, internal:bool)->int :
+	var min_distance:float=INF
+	var search_range=3.0
+	var spring_index=-1
+	var springs=targetMeshNode.data_internal_springs if internal else targetMeshNode.data_springs  
+	for i in range(springs.size()) :
+		var spring=springs[i]
+		var pA=targetMeshNode.data_particle_positions[ spring[0] ]+meshNode.global_position
+		var pB=targetMeshNode.data_particle_positions[ spring[1] ]++meshNode.global_position
+		var a_vec=(pB-pA)
+		var unit=a_vec.normalized()
+		var normal=unit.orthogonal()
+		var b_vec=position-pA
+		var proj=b_vec.dot(unit)
+		if proj>=0 && proj<=a_vec.length() :
+			var distance=abs( b_vec.dot(normal) )
+			if  distance<search_range :
+				if distance<min_distance :
+					spring_index=i
+					min_distance=distance
+				
+	
+	return spring_index
+	
+func snap_to_grid(point:Vector2) ->Vector2:
+	var snapped_x = roundf(point.x / snapHelper.snap_step.x) * snapHelper.snap_step.x
+	var snapped_y = roundf(point.y / snapHelper.snap_step.y) * snapHelper.snap_step.y
+	var res = Vector2(snapped_x, snapped_y) + snapHelper.snap_offset
+	return res
+		
+	
+func get_uv_map_index_at_position(targetMeshNode:QMeshNode, position:Vector2) -> int:
+	for i in range(targetMeshNode.data_uv_maps.size()) :
+		var map=targetMeshNode.data_uv_maps[i]
+		var uv_poly:PackedVector2Array
+		for j in range(map.size()):
+			uv_poly.push_back( targetMeshNode.data_particle_positions[ map[j] ]+targetMeshNode.global_position )
+		if Geometry2D.is_point_in_polygon(position,uv_poly) :
+			return i
+	return -1
+		
+	pass
+	
+	
 func search_spring(targetMeshNode:QMeshNode,first_index:int,second_index:int,internal_springs:bool)->int:
 	var spring_list=targetMeshNode.data_springs if internal_springs==false else targetMeshNode.data_internal_springs
 	for i in range(spring_list.size()) :
-		if targetMeshNode.data_springs[i][0]==first_index && targetMeshNode.data_springs[i][1]==second_index :
+		if spring_list[i][0]==first_index && spring_list[i][1]==second_index :
 			return i
 
-		if targetMeshNode.data_springs[i][1]==first_index && targetMeshNode.data_springs[i][0]==second_index :
+		if spring_list[i][1]==first_index && spring_list[i][0]==second_index :
 			return i
 	return -1
+
+func is_particle_exist_in_springs(targetMeshNode:QMeshNode,particleIndex:int, internal:bool)->bool:
+	var springs=targetMeshNode.data_springs if internal==false else targetMeshNode.data_internal_springs
+	for i in range(springs.size()):
+		var spring=springs[i]
+		if spring[0]==particleIndex || spring[1]==particleIndex :
+			return true
+	return false
+	
+func is_particle_exist_in_polygon(targetMeshNode:QMeshNode,particleIndex:int)->bool:
+	for i in range(targetMeshNode.data_polygon.size() ):
+		if targetMeshNode.data_polygon[i]==particleIndex :
+			return true
+	return false
+func is_particle_exist_in_uv(targetMeshNode:QMeshNode,particleIndex:int)->bool:
+	for i in range(targetMeshNode.data_uv_maps.size() ):
+		var map=targetMeshNode.data_uv_maps[i]
+		for j in range(map.size()) :
+			if map[j]==particleIndex :
+				return true
+	return false

project_logo.png renamed to images/project_logo.png

@@ -1,11 +1,16 @@
-[gd_scene load_steps=3 format=3 uid="uid://1iyw5k4em234"]
+[gd_scene load_steps=8 format=3 uid="uid://1iyw5k4em234"]
 
 [ext_resource type="Script" path="res://addons/quarkphysics/qmesh_editor/qmesh_editor_tool_bar.gd" id="1_8n687"]
+[ext_resource type="Texture2D" uid="uid://dp3nkgnpb61vc" path="res://addons/quarkphysics/src/icon_select_tool.svg" id="2_7b1ko"]
+[ext_resource type="Texture2D" uid="uid://dxqm8s0qwcci" path="res://addons/quarkphysics/src/icon_particle_tool.svg" id="3_ujk4v"]
+[ext_resource type="Texture2D" uid="uid://4flsqjsp3hwi" path="res://addons/quarkphysics/src/icon_spring_tool.svg" id="4_m4cpb"]
+[ext_resource type="Texture2D" uid="uid://cq6tapejdqkxs" path="res://addons/quarkphysics/src/icon_polygon_tool.svg" id="5_parlp"]
+[ext_resource type="Texture2D" uid="uid://24koqbn2wrt6" path="res://addons/quarkphysics/src/icon_uv_tool.svg" id="6_0a26w"]
 
 [sub_resource type="ButtonGroup" id="ButtonGroup_l0uhj"]
 
 [node name="Control" type="HBoxContainer"]
-custom_minimum_size = Vector2(605, 0)
+custom_minimum_size = Vector2(500, 0)
 anchors_preset = 15
 anchor_right = 1.0
 anchor_bottom = 1.0
@@ -16,49 +21,75 @@ script = ExtResource("1_8n687")
 [node name="EditButton" type="Button" parent="."]
 layout_mode = 2
 size_flags_vertical = 4
+tooltip_text = "Edit QMesh"
 toggle_mode = true
 text = "Edit QMesh"
 
 [node name="SelectButton" type="Button" parent="."]
 visible = false
+custom_minimum_size = Vector2(32, 32)
 layout_mode = 2
 size_flags_vertical = 4
+tooltip_text = "Select And Edit Particles"
 toggle_mode = true
 button_pressed = true
 button_group = SubResource("ButtonGroup_l0uhj")
-text = "Select"
+icon = ExtResource("2_7b1ko")
+icon_alignment = 1
 
 [node name="ParticleButton" type="Button" parent="."]
 visible = false
+custom_minimum_size = Vector2(32, 32)
 layout_mode = 2
 size_flags_vertical = 4
+tooltip_text = "Add/Remove Particle"
 toggle_mode = true
 button_group = SubResource("ButtonGroup_l0uhj")
-text = "Particle"
+icon = ExtResource("3_ujk4v")
+icon_alignment = 1
 
 [node name="SpringButton" type="Button" parent="."]
 visible = false
+custom_minimum_size = Vector2(32, 32)
 layout_mode = 2
 size_flags_vertical = 4
+tooltip_text = "Add/Remove Spring"
 toggle_mode = true
 button_group = SubResource("ButtonGroup_l0uhj")
-text = "Spring"
+icon = ExtResource("4_m4cpb")
+icon_alignment = 1
 
 [node name="PolygonButton" type="Button" parent="."]
 visible = false
+custom_minimum_size = Vector2(32, 32)
 layout_mode = 2
 size_flags_vertical = 4
+tooltip_text = "Edit Polygon"
 toggle_mode = true
 button_group = SubResource("ButtonGroup_l0uhj")
-text = "Polygon"
+icon = ExtResource("5_parlp")
+icon_alignment = 1
 
 [node name="UVButton" type="Button" parent="."]
 visible = false
+custom_minimum_size = Vector2(32, 32)
 layout_mode = 2
 size_flags_vertical = 4
+tooltip_text = "Add/Remove UV Map"
 toggle_mode = true
 button_group = SubResource("ButtonGroup_l0uhj")
-text = "UV"
+icon = ExtResource("6_0a26w")
+icon_alignment = 1
+
+[node name="OperationOptionButton" type="OptionButton" parent="."]
+visible = false
+layout_mode = 2
+size_flags_vertical = 4
+selected = 0
+item_count = 2
+popup/item_0/text = "ADD"
+popup/item_1/text = "REMOVE"
+popup/item_1/id = 1
 
 [node name="InternalCheckBox" type="CheckBox" parent="."]
 visible = false