Add Particle System emission shapes gizmo #86902

paddy-exe · 2024-01-06T22:06:36Z

This Pull Request visualises the emission shapes from the GPU and CPU Particle Systems.

Closes godotengine/godot-proposals#7826

Showcase

Features

Handles for shapes manipulation
- Sphere
- Box
- Ring
Shapes drawing
- Box
- Sphere
- Ring
Emits a signal when either CPUParticles Node or the ParticleProcessMaterial resource of a GPUParticles Node properties are changed in any way so the changes can be synced and redrawn by the gizmo plugin

TODO

Creating a GPUParticles3D node in a blank scene results in the following error and no gizmo:

ERROR: Attempt to disconnect a nonexistent connection from '<ParticleProcessMaterial#-9223370086285254399>'. Signal: 'emission_shape_changed', callable: 'GPUParticles3D::update_gizmos'.
   at: _disconnect (./core/object/object.cpp:1492)
ERROR: Condition "material.is_null()" is true.
   at: _notification (./scene/3d/gpu_particles_3d.cpp:505)

Emission shape gizmos for unselected nodes should be hidden as to be less visually obstructive. (This is already done for the visibility AABB.)
Emission Shape Offset and Emission Shape Scale aren't taken into account by the handles
- Sphere handling
- Ring handling
- Box handling
Fix Ring Axis is not properly being properly handled by the editor gizmo drawing when using non-uniform values

Massive thanks to @Arnklit for helping me with this Pull Request.

scene/3d/gpu_particles_3d.cpp

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

paddy-exe · 2024-04-29T12:32:22Z

Thanks a lot for the style feedback @AThousandShips!

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

doc/classes/ParticleProcessMaterial.xml

akien-mga · 2024-08-20T13:48:10Z

@paddy-exe The 4.4 merge window is open, now would be a good time to finalize this PR.

Co-authored-by: Kasper Frandsen <kasper.arnklit@gmail.com>

paddy-exe · 2024-09-07T22:01:44Z

Alright, getting back into this PR again. Sorry for the waiting.
Here's an update:

Rebased on top of current master branch
figured out the error upon creating a new scene with GPUParticles3D Node and fixed it

Reworded the added documentation as requested
Emission Shape Offset and Emission Shape Scale aren't taken into account by the handles, even though the gizmo drawing is correct. This means the handles don't move to match the gizmo's actual position when these properties are set to non-default values. -> Still working on the handles as there are some discrepancies between the handles and the shape rendering for the ring shape
Emission shape gizmos for unselected nodes should be hidden as to be less visually obstructive. (This is already done for the visibility AABB.)

Mickeon

The description is very good, if there was any doubt.

akien-mga · 2024-09-24T10:08:40Z

You need to rebase the branch on latest master to fix the CI build, it's failing on some code not touched by this PR but which has been made invalid by #96532.

AThousandShips · 2024-12-07T16:10:42Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+
+#include "particles_3d_emission_shape_gizmo_plugin.h"
+
+#include "core/math/transform_3d.h"


Suggested change

#include "core/math/transform_3d.h"

Unnecessary

AThousandShips · 2024-12-07T16:11:35Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+		Vector3 s[2] = { gi.xform(ray_from), gi.xform(ray_from + ray_dir * 4096) };
+
+		Vector3 ra, rb;
+		float d;


Suggested change

float d;

float d = 0.0f;

AThousandShips · 2024-12-07T16:11:48Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+					d = Math::snapped(d, Node3DEditor::get_singleton()->get_translate_snap());
+				}
+				d = MAX(d, 0.001);
+				// Times 2 because of using the half_height for drawing


Suggested change

// Times 2 because of using the half_height for drawing

// Times 2 because of using the half_height for drawing.

AThousandShips · 2024-12-07T16:12:20Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+	if (Object::cast_to<GPUParticles3D>(p_gizmo->get_node_3d())) {
+		GPUParticles3D *particles = Object::cast_to<GPUParticles3D>(p_gizmo->get_node_3d());
+
+		if (particles->get_process_material() != nullptr) {


Suggested change

if (particles->get_process_material() != nullptr) {

if (particles->get_process_material().is_valid()) {

AThousandShips · 2024-12-07T16:12:32Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+				for (int i = 0; i < 12; i++) {
+					Vector3 a, b;
+					box_aabb.get_edge(i, a, b);
+					// Multiplication by 2 due to the extents being only half of the box size


Suggested change

// Multiplication by 2 due to the extents being only half of the box size

// Multiplication by 2 due to the extents being only half of the box size.

AThousandShips · 2024-12-07T16:14:24Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+				// inner top ring cap
+				points.push_back(basis.xform(Vector3(inner_a.x, half_ring_height, inner_a.y)));
+				points.push_back(basis.xform(Vector3(inner_b.x, half_ring_height, inner_b.y)));
+				// inner bottom ring cap


Suggested change

// inner bottom ring cap

// Inner bottom ring cap.

AThousandShips · 2024-12-07T16:14:36Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+				Point2 a = Vector2(Math::sin(ra), Math::cos(ra)) * ring_radius;
+				Point2 inner_a = Vector2(Math::sin(ra), Math::cos(ra)) * ring_inner_radius;
+
+				// outer 90 degrees vertical lines


Suggested change

// outer 90 degrees vertical lines

// Outer 90 degrees vertical lines.

AThousandShips · 2024-12-07T16:14:43Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+				points.push_back(basis.xform(Vector3(a.x, half_ring_height, a.y)));
+				points.push_back(basis.xform(Vector3(a.x, -half_ring_height, a.y)));
+
+				// inner 90 degrees vertical lines


Suggested change

// inner 90 degrees vertical lines

// Inner 90 degrees vertical lines.

AThousandShips · 2024-12-07T16:15:44Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+		Vector3 s_scale = mat->get_emission_shape_scale();
+
+		Vector3 ra, rb;
+		float d;


Suggested change

float d;

float d = 0.0f;

AThousandShips · 2024-12-07T16:15:55Z

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp

+					d = Math::snapped(d, Node3DEditor::get_singleton()->get_translate_snap());
+				}
+				d = MAX(d, 0.001);
+				// Times 2 because of using the half_height for drawing


Suggested change

// Times 2 because of using the half_height for drawing

// Times 2 because of using the half_height for drawing.

KoBeWi · 2025-02-06T21:48:03Z

Looks like #102249 will supersede this?
The 3D part was already implemented in #100113

paddy-exe · 2025-02-06T21:57:01Z

Looks like #102249 will supersede this?

The 3D part was already implemented in #100113

No, the gizmo handles are still missing for 3d shapes. Will need to rebase this PR here but haven't gotten to it yet due to time constraints.

paddy-exe added topic:3d topic:particles labels Jan 6, 2024

paddy-exe force-pushed the particle-emission-shapes branch 2 times, most recently from 94e1901 to 4363ca4 Compare January 6, 2024 22:48

AThousandShips added the enhancement label Jan 6, 2024

AThousandShips added this to the 4.x milestone Jan 6, 2024

paddy-exe force-pushed the particle-emission-shapes branch 4 times, most recently from c9a3e02 to e659548 Compare January 9, 2024 20:01

paddy-exe force-pushed the particle-emission-shapes branch from e659548 to cb39d7a Compare January 14, 2024 22:49

paddy-exe force-pushed the particle-emission-shapes branch 2 times, most recently from 715a117 to 970796b Compare February 8, 2024 00:44

paddy-exe force-pushed the particle-emission-shapes branch 3 times, most recently from 7cbb484 to abffa04 Compare April 16, 2024 14:04

paddy-exe force-pushed the particle-emission-shapes branch from 5615a63 to b5d6302 Compare April 21, 2024 10:50

Arnklit mentioned this pull request Apr 24, 2024

Hide the GPUParticles3D Visibility AABB gizmo by default godotengine/godot-proposals#9591

Open

paddy-exe marked this pull request as ready for review April 25, 2024 20:09

paddy-exe requested review from a team as code owners April 25, 2024 20:09

Calinou mentioned this pull request Apr 26, 2024

Simplify the GPUParticles3D editor gizmo to improve readability #91226

Merged

paddy-exe changed the title ~~WIP: Add Particle System emission shapes gizmo~~ Add Particle System emission shapes gizmo Apr 27, 2024

paddy-exe force-pushed the particle-emission-shapes branch 3 times, most recently from cb575de to e3daec7 Compare April 29, 2024 12:13

AThousandShips reviewed Apr 29, 2024

View reviewed changes

paddy-exe force-pushed the particle-emission-shapes branch from d2bc5e0 to 0afe343 Compare April 29, 2024 12:31

paddy-exe force-pushed the particle-emission-shapes branch from 0afe343 to 1afc432 Compare April 29, 2024 12:36

Calinou reviewed May 2, 2024

View reviewed changes

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp Outdated Show resolved Hide resolved

Calinou reviewed May 2, 2024

View reviewed changes

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp Outdated Show resolved Hide resolved

Calinou reviewed May 2, 2024

View reviewed changes

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp Outdated Show resolved Hide resolved

Calinou reviewed May 2, 2024

View reviewed changes

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp Outdated Show resolved Hide resolved

Calinou reviewed May 2, 2024

View reviewed changes

editor/plugins/gizmos/particles_3d_emission_shape_gizmo_plugin.cpp Outdated Show resolved Hide resolved

Arnklit mentioned this pull request May 15, 2024

Add cone angle control to particle emission ring shape #91973

Merged

Mickeon reviewed Jul 9, 2024

View reviewed changes

doc/classes/ParticleProcessMaterial.xml Outdated Show resolved Hide resolved

paddy-exe force-pushed the particle-emission-shapes branch 3 times, most recently from c19cb27 to c71e2c4 Compare September 2, 2024 13:05

paddy-exe force-pushed the particle-emission-shapes branch 2 times, most recently from c8ca5dc to 2f1391c Compare September 7, 2024 20:27

Add emission shape gizmo plugin for CPU and GPU 3D Particles

c3df21e

Co-authored-by: Kasper Frandsen <kasper.arnklit@gmail.com>

paddy-exe force-pushed the particle-emission-shapes branch from 2f1391c to 46b896d Compare September 7, 2024 21:56

Mickeon approved these changes Sep 8, 2024

View reviewed changes

paddy-exe force-pushed the particle-emission-shapes branch from 46b896d to 5749512 Compare September 9, 2024 13:47

akien-mga requested a review from QbieShay September 10, 2024 07:47

QbieShay self-assigned this Sep 10, 2024

Disable gizmos when node is unselected and fix shape gizmos

a6d6e33

paddy-exe force-pushed the particle-emission-shapes branch from 5749512 to a6d6e33 Compare September 23, 2024 12:29

paddy-exe mentioned this pull request Dec 6, 2024

Add visualization of 3D particle emission shapes #100113

Merged

1 task

AThousandShips approved these changes Dec 7, 2024

View reviewed changes

akien-mga added the needs work label Dec 12, 2024

Repiteo modified the milestones: 4.4, 4.x Jan 20, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Particle System emission shapes gizmo #86902

Add Particle System emission shapes gizmo #86902

paddy-exe commented Jan 6, 2024 •

edited

Loading

paddy-exe commented Apr 29, 2024

akien-mga commented Aug 20, 2024

paddy-exe commented Sep 7, 2024 •

edited

Loading

Mickeon left a comment •

edited

Loading

akien-mga commented Sep 24, 2024

AThousandShips Dec 7, 2024

AThousandShips Dec 7, 2024

AThousandShips Dec 7, 2024

AThousandShips Dec 7, 2024

AThousandShips Dec 7, 2024

AThousandShips Dec 7, 2024

AThousandShips Dec 7, 2024

AThousandShips Dec 7, 2024

AThousandShips Dec 7, 2024

AThousandShips Dec 7, 2024

KoBeWi commented Feb 6, 2025

paddy-exe commented Feb 6, 2025 •

edited

Loading


		#include "particles_3d_emission_shape_gizmo_plugin.h"

		#include "core/math/transform_3d.h"

	// Times 2 because of using the half_height for drawing
	// Times 2 because of using the half_height for drawing.

	if (particles->get_process_material() != nullptr) {
	if (particles->get_process_material().is_valid()) {

	// Multiplication by 2 due to the extents being only half of the box size
	// Multiplication by 2 due to the extents being only half of the box size.

	// outer 90 degrees vertical lines
	// Outer 90 degrees vertical lines.

	// inner 90 degrees vertical lines
	// Inner 90 degrees vertical lines.

Add Particle System emission shapes gizmo #86902

Are you sure you want to change the base?

Add Particle System emission shapes gizmo #86902

Conversation

paddy-exe commented Jan 6, 2024 • edited Loading

Showcase

Features

TODO

paddy-exe commented Apr 29, 2024

akien-mga commented Aug 20, 2024

paddy-exe commented Sep 7, 2024 • edited Loading

Mickeon left a comment • edited Loading

Choose a reason for hiding this comment

akien-mga commented Sep 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KoBeWi commented Feb 6, 2025

paddy-exe commented Feb 6, 2025 • edited Loading

paddy-exe commented Jan 6, 2024 •

edited

Loading

paddy-exe commented Sep 7, 2024 •

edited

Loading

Mickeon left a comment •

edited

Loading

paddy-exe commented Feb 6, 2025 •

edited

Loading