Add a 3D soft body physics demo

Author: Calinou

3d/soft_body_physics/README.md

@@ -0,0 +1,35 @@
+# 3D Soft Body Physics
+
+An example of [soft body physics](https://docs.godotengine.org/en/latest/tutorials/physics/soft_body.html)
+(deformable objects) such as cloth, boxes and spheres.
+
+Soft bodies support pinning points as well as applying impulses/forces to specific points,
+which can be useful for effects such as wind.
+
+Soft bodies can interact with static, rigid and character bodies (and will be aware of rigid bodies'
+weight when doing so). However, soft bodies currently do **not** interact with other soft bodies,
+which means they will pass through each other.
+
+The per-point impulse timer example also showcases how to attach nodes to specific points of a SoftBody3D.
+This can be used to make particles, meshes or even rigid bodies follow specific points.
+
+The cloth soft bodies in this demo use a BaseMaterial3D with the **Grow** property enabled to prevent
+visible clipping into surfaces.
+
+Controls:
+
+- <kbd>R</kbd>: Reset soft body simulation and user-placed objects
+- <kbd>C</kbd>: Place cloth at cursor position
+- <kbd>V</kbd>: Place light box at cursor position
+- <kbd>B</kbd>: Place heavy box at cursor position
+
+For performance reasons, only 10 user-placed objects can be present at a time in this demo.
+The oldest objects will be removed when attempting to place more than 10 objects.
+
+Language: GDScript
+
+Renderer: Forward+
+
+## Screenshots
+
+![Screenshot](screenshots/soft_body_physics.webp)

3d/soft_body_physics/box.tscn

@@ -0,0 +1,36 @@
+[gd_scene load_steps=7 format=3 uid="uid://inwnbl1ufttq"]
+
+[ext_resource type="ArrayMesh" uid="uid://d2aecsqru2t1r" path="res://rounded_cube.obj" id="1_g2tbl"]
+
+[sub_resource type="Gradient" id="Gradient_cbx31"]
+colors = PackedColorArray(0.619608, 0.227451, 0, 1, 1, 0.564706, 0, 1)
+
+[sub_resource type="FastNoiseLite" id="FastNoiseLite_x8fbi"]
+fractal_lacunarity = 3.47
+fractal_gain = 1.105
+
+[sub_resource type="NoiseTexture2D" id="NoiseTexture2D_41u45"]
+noise = SubResource("FastNoiseLite_x8fbi")
+color_ramp = SubResource("Gradient_cbx31")
+seamless = true
+
+[sub_resource type="NoiseTexture2D" id="NoiseTexture2D_cbx31"]
+noise = SubResource("FastNoiseLite_x8fbi")
+color_ramp = SubResource("Gradient_cbx31")
+seamless = true
+as_normal_map = true
+bump_strength = 4.0
+
+[sub_resource type="StandardMaterial3D" id="StandardMaterial3D_cbx31"]
+albedo_texture = SubResource("NoiseTexture2D_41u45")
+normal_enabled = true
+normal_texture = SubResource("NoiseTexture2D_cbx31")
+uv1_scale = Vector3(2, 2, 2)
+texture_filter = 5
+
+[node name="SoftBody3D" type="SoftBody3D"]
+mesh = ExtResource("1_g2tbl")
+surface_material_override/0 = SubResource("StandardMaterial3D_cbx31")
+simulation_precision = 100
+total_mass = 10.01
+pressure_coefficient = 100.0

3d/soft_body_physics/cloth.tscn

@@ -0,0 +1,26 @@
+[gd_scene load_steps=6 format=3 uid="uid://ditdn410656"]
+
+[ext_resource type="Texture2D" uid="uid://csp3kbg6r4rwd" path="res://textures/polyhaven/fabric_pattern_07_col_1_1k.jpg" id="1_pir5u"]
+[ext_resource type="Texture2D" uid="uid://hh6i17naw1qx" path="res://textures/polyhaven/fabric_pattern_07_nor_gl_1k.jpg" id="2_q5utd"]
+[ext_resource type="Texture2D" uid="uid://clyte8pu0nwom" path="res://textures/polyhaven/fabric_pattern_07_arm_1k.jpg" id="3_eo47f"]
+
+[sub_resource type="ORMMaterial3D" id="ORMMaterial3D_g14j6"]
+cull_mode = 2
+albedo_texture = ExtResource("1_pir5u")
+orm_texture = ExtResource("3_eo47f")
+normal_enabled = true
+normal_texture = ExtResource("2_q5utd")
+uv1_scale = Vector3(4, 4, 4)
+texture_filter = 5
+grow = true
+grow_amount = 0.02
+
+[sub_resource type="PlaneMesh" id="PlaneMesh_6uqi0"]
+material = SubResource("ORMMaterial3D_g14j6")
+size = Vector2(1.6, 1.6)
+subdivide_width = 63
+subdivide_depth = 63
+
+[node name="Cloth" type="SoftBody3D"]
+mesh = SubResource("PlaneMesh_6uqi0")
+skeleton = NodePath("../..")

3d/soft_body_physics/icon.svg

@@ -0,0 +1,43 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://c5uks4gy25jah"
+path="res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://icon.svg"
+dest_files=["res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/uastc_level=0
+compress/rdo_quality_loss=0.0
+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/channel_remap/red=0
+process/channel_remap/green=1
+process/channel_remap/blue=2
+process/channel_remap/alpha=3
+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=false
+editor/convert_colors_with_editor_theme=false

3d/soft_body_physics/icon.svg.import

@@ -0,0 +1,85 @@
+[gd_scene load_steps=12 format=3 uid="uid://da7gfvk1e0p6i"]
+
+[sub_resource type="StandardMaterial3D" id="StandardMaterial3D_g14j6"]
+albedo_color = Color(1, 0.27, 0.27, 1)
+emission_enabled = true
+emission = Color(1, 0, 0, 1)
+
+[sub_resource type="SphereMesh" id="SphereMesh_g14j6"]
+material = SubResource("StandardMaterial3D_g14j6")
+radius = 0.02
+height = 0.04
+radial_segments = 16
+rings = 8
+
+[sub_resource type="Gradient" id="Gradient_c85u6"]
+colors = PackedColorArray(1, 1, 1, 1, 1, 1, 1, 0)
+
+[sub_resource type="GradientTexture1D" id="GradientTexture1D_nikp6"]
+gradient = SubResource("Gradient_c85u6")
+
+[sub_resource type="Curve" id="Curve_gflbs"]
+_data = [Vector2(0, 1), 0.0, 0.0, 0, 0, Vector2(1, 0), 0.0, 0.0, 0, 0]
+point_count = 2
+
+[sub_resource type="CurveTexture" id="CurveTexture_h4t62"]
+curve = SubResource("Curve_gflbs")
+
+[sub_resource type="ParticleProcessMaterial" id="ParticleProcessMaterial_sw3mb"]
+spread = 180.0
+initial_velocity_max = 0.25
+gravity = Vector3(0, 0, 0)
+scale_curve = SubResource("CurveTexture_h4t62")
+color_ramp = SubResource("GradientTexture1D_nikp6")
+
+[sub_resource type="Gradient" id="Gradient_jfmli"]
+interpolation_mode = 2
+colors = PackedColorArray(1, 1, 1, 1, 1, 1, 1, 0)
+
+[sub_resource type="GradientTexture2D" id="GradientTexture2D_reuqr"]
+gradient = SubResource("Gradient_jfmli")
+fill = 1
+fill_from = Vector2(0.5, 0.5)
+fill_to = Vector2(0.5, 0)
+
+[sub_resource type="StandardMaterial3D" id="StandardMaterial3D_c85u6"]
+transparency = 1
+blend_mode = 1
+shading_mode = 0
+vertex_color_use_as_albedo = true
+albedo_color = Color(1.8247963, 0.60199416, 0.49019507, 1)
+albedo_texture = SubResource("GradientTexture2D_reuqr")
+billboard_mode = 3
+billboard_keep_scale = true
+particles_anim_h_frames = 1
+particles_anim_v_frames = 1
+particles_anim_loop = false
+
+[sub_resource type="QuadMesh" id="QuadMesh_nikp6"]
+material = SubResource("StandardMaterial3D_c85u6")
+size = Vector2(0.05, 0.05)
+
+[node name="Pin" type="MeshInstance3D"]
+cast_shadow = 0
+visibility_range_end = 10.0
+visibility_range_end_margin = 5.0
+visibility_range_fade_mode = 1
+mesh = SubResource("SphereMesh_g14j6")
+
+[node name="GPUParticles3D" type="GPUParticles3D" parent="."]
+visibility_range_end = 10.0
+visibility_range_end_margin = 5.0
+visibility_range_fade_mode = 1
+amount = 100
+process_material = SubResource("ParticleProcessMaterial_sw3mb")
+draw_pass_1 = SubResource("QuadMesh_nikp6")
+
+[node name="OmniLight3D" type="OmniLight3D" parent="."]
+light_color = Color(1, 0.3137255, 0.2509804, 1)
+light_energy = 0.05
+light_size = 0.25
+distance_fade_enabled = true
+distance_fade_begin = 10.0
+distance_fade_length = 5.0
+omni_range = 0.25
+omni_attenuation = 2.0

3d/soft_body_physics/pin.tscn

@@ -0,0 +1,67 @@
+; Engine configuration file.
+; It's best edited using the editor UI and not directly,
+; since the parameters that go here are not all obvious.
+;
+; Format:
+;   [section] ; section goes between []
+;   param=value ; assign values to parameters
+
+config_version=5
+
+[application]
+
+config/name="Soft Body Physics"
+config/description="An example of soft body physics (deformable objects) such as cloth, boxes and spheres."
+config/tags=PackedStringArray("3d", "demo", "official", "rendering")
+run/main_scene="res://test.tscn"
+config/features=PackedStringArray("4.5")
+config/icon="uid://c5uks4gy25jah"
+
+[debug]
+
+settings/physics_interpolation/enable_warnings=false
+gdscript/warnings/untyped_declaration=1
+
+[display]
+
+window/stretch/mode="canvas_items"
+window/stretch/aspect="expand"
+
+[filesystem]
+
+import/blender/enabled=false
+
+[input]
+
+reset_physics_simulation={
+"deadzone": 0.2,
+"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":82,"physical_keycode":0,"key_label":0,"unicode":114,"location":0,"echo":false,"script":null)
+]
+}
+place_cloth={
+"deadzone": 0.2,
+"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":67,"physical_keycode":0,"key_label":0,"unicode":99,"location":0,"echo":false,"script":null)
+]
+}
+place_light_box={
+"deadzone": 0.2,
+"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":86,"physical_keycode":0,"key_label":0,"unicode":118,"location":0,"echo":false,"script":null)
+]
+}
+place_heavy_box={
+"deadzone": 0.2,
+"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":66,"physical_keycode":0,"key_label":0,"unicode":98,"location":0,"echo":false,"script":null)
+]
+}
+
+[physics]
+
+3d/physics_engine="Jolt Physics"
+common/physics_interpolation=true
+
+[rendering]
+
+lights_and_shadows/directional_shadow/soft_shadow_filter_quality=3
+textures/default_filters/anisotropic_filtering_level=4
+anti_aliasing/quality/msaa_3d=2
+textures/decals/filter=5

3d/soft_body_physics/project.godot

@@ -0,0 +1,38 @@
+[gd_scene load_steps=7 format=3 uid="uid://hlyf6l5pbqgu"]
+
+[sub_resource type="PhysicsMaterial" id="PhysicsMaterial_ppyta"]
+friction = 0.75
+bounce = 0.4
+
+[sub_resource type="Gradient" id="Gradient_jgx4i"]
+interpolation_mode = 2
+colors = PackedColorArray(1, 1, 1, 1, 0.5, 0.5, 0.5, 1)
+
+[sub_resource type="GradientTexture2D" id="GradientTexture2D_jypa8"]
+gradient = SubResource("Gradient_jgx4i")
+fill = 2
+fill_from = Vector2(0.5, 0.5)
+
+[sub_resource type="StandardMaterial3D" id="StandardMaterial3D_ppyta"]
+albedo_color = Color(1, 0.298039, 0.74902, 1)
+albedo_texture = SubResource("GradientTexture2D_jypa8")
+uv1_scale = Vector3(3, 2, 1)
+texture_filter = 5
+
+[sub_resource type="BoxMesh" id="BoxMesh_ykrsh"]
+material = SubResource("StandardMaterial3D_ppyta")
+size = Vector3(0.25, 0.25, 0.25)
+
+[sub_resource type="BoxShape3D" id="BoxShape3D_ppyta"]
+size = Vector3(0.25, 0.25, 0.25)
+
+[node name="RigidBoxHeavy" type="RigidBody3D"]
+collision_mask = 3
+mass = 1000.0
+physics_material_override = SubResource("PhysicsMaterial_ppyta")
+
+[node name="MeshInstance3D" type="MeshInstance3D" parent="."]
+mesh = SubResource("BoxMesh_ykrsh")
+
+[node name="CollisionShape3D" type="CollisionShape3D" parent="."]
+shape = SubResource("BoxShape3D_ppyta")

3d/soft_body_physics/rigid_box_heavy.tscn

@@ -0,0 +1,38 @@
+[gd_scene load_steps=7 format=3 uid="uid://b6uelvj3b82bf"]
+
+[sub_resource type="PhysicsMaterial" id="PhysicsMaterial_ppyta"]
+friction = 0.75
+bounce = 0.4
+
+[sub_resource type="Gradient" id="Gradient_jgx4i"]
+interpolation_mode = 2
+colors = PackedColorArray(1, 1, 1, 1, 0.5, 0.5, 0.5, 1)
+
+[sub_resource type="GradientTexture2D" id="GradientTexture2D_nmss4"]
+gradient = SubResource("Gradient_jgx4i")
+fill = 2
+fill_from = Vector2(0.5, 0.5)
+
+[sub_resource type="StandardMaterial3D" id="StandardMaterial3D_ppyta"]
+albedo_color = Color(1.8771e-06, 0.751954, 0.25936, 1)
+albedo_texture = SubResource("GradientTexture2D_nmss4")
+uv1_scale = Vector3(3, 2, 1)
+texture_filter = 5
+
+[sub_resource type="BoxMesh" id="BoxMesh_ykrsh"]
+material = SubResource("StandardMaterial3D_ppyta")
+size = Vector3(0.25, 0.25, 0.25)
+
+[sub_resource type="BoxShape3D" id="BoxShape3D_ppyta"]
+size = Vector3(0.25, 0.25, 0.25)
+
+[node name="RigidBoxLight" type="RigidBody3D"]
+collision_mask = 3
+mass = 10.0
+physics_material_override = SubResource("PhysicsMaterial_ppyta")
+
+[node name="MeshInstance3D" type="MeshInstance3D" parent="."]
+mesh = SubResource("BoxMesh_ykrsh")
+
+[node name="CollisionShape3D" type="CollisionShape3D" parent="."]
+shape = SubResource("BoxShape3D_ppyta")