Add ruler mode to 3D #100162

ryevdokimov · 2024-12-08T02:36:48Z

Implements and closes: godotengine/godot-proposals#8839

Starts on mouse down and is cleared on mouse up. Uses collision detection functionality from #96740 to snap to objects.

2024-12-11.19-08-37.mp4

Calinou

Tested locally, it works as expected. This is a great start 🙂

Some feedback:

I suggest renaming the Measure tool to Ruler (also with its internal enum name), so that it matches the name in the 2D editor. This should also be done for the shortcut name.
Draw the distance text with a black outline, and use the bold editor font with a slightly increased font size. Doing this will help a lot with visibility on mixed-color backgrounds, which can be an issue right now:

See the 2D editor for reference:

Display a the unique with a m suffix for "meters" (e.g. 123.456 m), as 3D units are meters in Godot.
Round the display to 3 decimals using String.pad_decimals(), so there's always 3 decimals displayed (even if technically not needed in some cases). This prevents the text from jumping around as the ruler moves.
The ruler line occasionally disappears depending on which direction it's going towards:

ruler_disappear.mp4

This issue depends on the camera angle. It never occurs if the camera is looking straight down by pressing KP 7.

You could look into replicating the rectangle and angle measurements from the 2D ruler in the 3D ruler, but this can be left for a future PR.

ryevdokimov · 2024-12-09T15:29:15Z

I suggest renaming the Measure tool to Ruler (also with its internal enum name), so that it matches the name in the 2D editor. This should also be done for the shortcut name.

Done.

Draw the distance text with a black outline and use the bold editor font with a slightly increased font size. Doing this will help a lot with visibility on mixed-color backgrounds, which can be an issue right now:sin
itor for reference:

Done.

Display a the unique with a m suffix for "meters" (e.g. 123.456 m), as 3D units are meters in Godot.

Done.

Round the display to 3 decimals using String.pad_decimals(), so there's always 3 decimals displayed (even if technically not needed in some cases). This prevents the text from jumping around as the ruler moves.

Done.

The ruler line occasionally disappears depending on which direction it's going towards:

I can't reproduce this. Does the target mesh have a collision node associated with it? At the moment the end points snap to only collisions, since snapping to geometry is a different animal.

You could look into replicating the rectangle and angle measurements from the 2D ruler in the 3D ruler, but this can be left for a future PR.

Will probably save this for another PR since there is a lot of different avenues this kind of functionality can take. Persisting measurements, more than one measurement on the screen, measuring volume, angles, etc. I think it makes sense to wait for feedback from the public on this initial step.

ryevdokimov · 2024-12-09T15:34:44Z

See video below:

In one instance the line does go behind the mesh and extends depth-wise in the viewport, but this is expected.

2024-12-09.10-32-03.mp4

Calinou · 2024-12-09T16:23:43Z

In one instance the line does go behind the mesh and extends depth-wise in the viewport, but this is expected.

I see, that makes sense. In this case, I'd do what the 3D selection box does:

Draw a solid line without the No Depth Test flag (as is done now).
Draw a transparent line at the same coordinates with No Depth Test flag, with the same color but lower opacity.

This way, you can see the line going through objects at reduced opacity, giving it a x-ray look.

ryevdokimov · 2024-12-09T20:59:04Z

Done.

2024-12-09.15-55-54.mp4

Calinou

Works great now 🙂

Code looks good to me.

Calinou · 2024-12-10T15:18:13Z

editor/plugins/node_3d_editor_plugin.cpp

+	ruler_label = memnew(Label);
+	ruler_label->add_theme_color_override(SceneStringName(font_color), Color(1.0, 0.9, 0.0, 1.0));
+	ruler_label->add_theme_color_override("font_outline_color", Color(0.0, 0.0, 0.0, 1.0));
+	ruler_label->add_theme_constant_override("outline_size", 4);


Scale the outline for hiDPI displays (otherwise, the outline looks thinner relative to the font size):

Suggested change

ruler_label->add_theme_constant_override("outline_size", 4);

ruler_label->add_theme_constant_override("outline_size", 4 * EDSCALE);

AThousandShips · 2024-12-09T15:22:14Z

editor/plugins/node_3d_editor_plugin.cpp

+					if (ruler->is_inside_tree()) {
+						if (!ruler_start_point->is_visible()) {
+							ruler_end_point->set_global_position(ruler_start_point->get_global_position());
+							ruler_start_point->set_visible(true);
+							ruler_end_point->set_visible(true);
+							ruler_label->set_visible(true);
+						}


Suggested change

if (ruler->is_inside_tree()) {

if (!ruler_start_point->is_visible()) {

ruler_end_point->set_global_position(ruler_start_point->get_global_position());

ruler_start_point->set_visible(true);

ruler_end_point->set_visible(true);

ruler_label->set_visible(true);

}

if (ruler->is_inside_tree() && !ruler_start_point->is_visible()) {

ruler_end_point->set_global_position(ruler_start_point->get_global_position());

ruler_start_point->set_visible(true);

ruler_end_point->set_visible(true);

ruler_label->set_visible(true);

AThousandShips · 2024-12-09T16:37:07Z

editor/plugins/node_3d_editor_plugin.h

@@ -35,9 +35,11 @@
 #include "editor/plugins/editor_plugin.h"
 #include "editor/plugins/node_3d_editor_gizmos.h"
 #include "editor/themes/editor_scale.h"
+#include "scene/3d/mesh_instance_3d.h"


Forward declare this

ryevdokimov · 2024-12-10T16:00:01Z

Suggestions applied.

Repiteo · 2024-12-11T23:41:33Z

Thanks!

ryevdokimov · 2024-12-14T22:47:09Z

Does the target mesh have a collision node associated with it? At the moment the end points snap to only collisions, since snapping to geometry is a different animal.

This PR is a way to solve this: #100415

ryevdokimov requested a review from a team as a code owner December 8, 2024 02:36

ryevdokimov force-pushed the measure-mode-3d branch 5 times, most recently from cb57993 to 500ab10 Compare December 8, 2024 05:39

Chaosus added enhancement topic:editor topic:3d labels Dec 8, 2024

Chaosus added this to the 4.4 milestone Dec 8, 2024

ryevdokimov force-pushed the measure-mode-3d branch from 500ab10 to 6e79f3f Compare December 8, 2024 18:48

ryevdokimov mentioned this pull request Dec 8, 2024

Add Ruler Mode for 3D godotengine/godot-proposals#8839

Closed

Calinou reviewed Dec 9, 2024

View reviewed changes

ryevdokimov force-pushed the measure-mode-3d branch from 6e79f3f to 57b2c3d Compare December 9, 2024 15:21

ryevdokimov changed the title ~~Add measure mode to 3D~~ Add ruler mode to 3D Dec 9, 2024

ryevdokimov force-pushed the measure-mode-3d branch from 57b2c3d to 3cf4c98 Compare December 9, 2024 20:57

ryevdokimov force-pushed the measure-mode-3d branch from 3cf4c98 to d1299fd Compare December 10, 2024 14:12

Calinou approved these changes Dec 10, 2024

View reviewed changes

Calinou reviewed Dec 10, 2024

View reviewed changes

AThousandShips reviewed Dec 10, 2024

View reviewed changes

Add measure mode to 3D

e2ed286

ryevdokimov force-pushed the measure-mode-3d branch from d1299fd to e2ed286 Compare December 10, 2024 15:31

Repiteo merged commit a5cf24c into godotengine:master Dec 11, 2024
20 checks passed

ryevdokimov deleted the measure-mode-3d branch December 11, 2024 23:42

ryevdokimov mentioned this pull request Dec 11, 2024

Fix crash due to collision reposition functionality #99943

Closed

KoBeWi mentioned this pull request Dec 12, 2024

Fix 3D ruler theme overrides #100312

Merged

ryevdokimov mentioned this pull request Dec 16, 2024

Add measuring functionality Open-Industry-Project/Open-Industry-Project#63

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ruler mode to 3D #100162

Add ruler mode to 3D #100162

ryevdokimov commented Dec 8, 2024 •

edited by akien-mga

Loading

Calinou left a comment •

edited

Loading

ryevdokimov commented Dec 9, 2024

ryevdokimov commented Dec 9, 2024

Calinou commented Dec 9, 2024 •

edited

Loading

ryevdokimov commented Dec 9, 2024

Calinou left a comment

Calinou Dec 10, 2024 •

edited

Loading

AThousandShips Dec 9, 2024

AThousandShips Dec 9, 2024

ryevdokimov commented Dec 10, 2024

Repiteo commented Dec 11, 2024

ryevdokimov commented Dec 14, 2024

	ruler_label->add_theme_constant_override("outline_size", 4);
	ruler_label->add_theme_constant_override("outline_size", 4 * EDSCALE);

Add ruler mode to 3D #100162

Add ruler mode to 3D #100162

Conversation

ryevdokimov commented Dec 8, 2024 • edited by akien-mga Loading

Calinou left a comment • edited Loading

Choose a reason for hiding this comment

ryevdokimov commented Dec 9, 2024

ryevdokimov commented Dec 9, 2024

Calinou commented Dec 9, 2024 • edited Loading

ryevdokimov commented Dec 9, 2024

Calinou left a comment

Choose a reason for hiding this comment

Calinou Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

AThousandShips Dec 9, 2024

Choose a reason for hiding this comment

AThousandShips Dec 9, 2024

Choose a reason for hiding this comment

ryevdokimov commented Dec 10, 2024

Repiteo commented Dec 11, 2024

ryevdokimov commented Dec 14, 2024

ryevdokimov commented Dec 8, 2024 •

edited by akien-mga

Loading

Calinou left a comment •

edited

Loading

Calinou commented Dec 9, 2024 •

edited

Loading

Calinou Dec 10, 2024 •

edited

Loading