Merge pull request #89320 from Calinou/editor-fogvolume-use-gizmo-helper

Use 3D editor gizmo helper for FogVolume to allow dragging individual faces

editor/plugins/gizmos/fog_volume_gizmo_plugin.cpp

@@ -34,10 +34,12 @@
 #include "editor/editor_settings.h"
 #include "editor/editor_string_names.h"
 #include "editor/editor_undo_redo_manager.h"
+#include "editor/plugins/gizmos/gizmo_3d_helper.h"
 #include "editor/plugins/node_3d_editor_plugin.h"
 #include "scene/3d/fog_volume.h"
 
 FogVolumeGizmoPlugin::FogVolumeGizmoPlugin() {
+	helper.instantiate();
 	Color gizmo_color = EDITOR_DEF_RST("editors/3d_gizmos/gizmo_colors/fog_volume", Color(0.5, 0.7, 1));
 	create_material("shape_material", gizmo_color);
 	gizmo_color.a = 0.15;
@@ -48,6 +50,9 @@ FogVolumeGizmoPlugin::FogVolumeGizmoPlugin() {
 	create_handle_material("handles");
 }
 
+FogVolumeGizmoPlugin::~FogVolumeGizmoPlugin() {
+}
+
 bool FogVolumeGizmoPlugin::has_gizmo(Node3D *p_spatial) {
 	return (Object::cast_to<FogVolume>(p_spatial) != nullptr);
 }
@@ -61,63 +66,40 @@ int FogVolumeGizmoPlugin::get_priority() const {
 }
 
 String FogVolumeGizmoPlugin::get_handle_name(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary) const {
-	return "Size";
+	return helper->box_get_handle_name(p_id);
 }
 
 Variant FogVolumeGizmoPlugin::get_handle_value(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary) const {
 	return Vector3(p_gizmo->get_node_3d()->call("get_size"));
 }
 
-void FogVolumeGizmoPlugin::set_handle(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary, Camera3D *p_camera, const Point2 &p_point) {
-	Node3D *sn = p_gizmo->get_node_3d();
-
-	Transform3D gt = sn->get_global_transform();
-	Transform3D gi = gt.affine_inverse();
-
-	Vector3 ray_from = p_camera->project_ray_origin(p_point);
-	Vector3 ray_dir = p_camera->project_ray_normal(p_point);
-
-	Vector3 sg[2] = { gi.xform(ray_from), gi.xform(ray_from + ray_dir * 4096) };
+void FogVolumeGizmoPlugin::begin_handle_action(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary) {
+	helper->initialize_handle_action(get_handle_value(p_gizmo, p_id, p_secondary), p_gizmo->get_node_3d()->get_global_transform());
+}
 
-	Vector3 axis;
-	axis[p_id] = 1.0;
-	Vector3 ra, rb;
-	Geometry3D::get_closest_points_between_segments(Vector3(), axis * 4096, sg[0], sg[1], ra, rb);
-	float d = ra[p_id] * 2;
-	if (Node3DEditor::get_singleton()->is_snap_enabled()) {
-		d = Math::snapped(d, Node3DEditor::get_singleton()->get_translate_snap());
-	}
+void FogVolumeGizmoPlugin::set_handle(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary, Camera3D *p_camera, const Point2 &p_point) {
+	FogVolume *fog_volume = Object::cast_to<FogVolume>(p_gizmo->get_node_3d());
+	Vector3 size = fog_volume->get_size();
 
-	if (d < 0.001) {
-		d = 0.001;
-	}
+	Vector3 sg[2];
+	helper->get_segment(p_camera, p_point, sg);
 
-	Vector3 he = sn->call("get_size");
-	he[p_id] = d;
-	sn->call("set_size", he);
+	Vector3 position;
+	helper->box_set_handle(sg, p_id, size, position);
+	fog_volume->set_size(size);
+	fog_volume->set_global_position(position);
 }
 
 void FogVolumeGizmoPlugin::commit_handle(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary, const Variant &p_restore, bool p_cancel) {
-	Node3D *sn = p_gizmo->get_node_3d();
-
-	if (p_cancel) {
-		sn->call("set_size", p_restore);
-		return;
-	}
-
-	EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
-	ur->create_action(TTR("Change Fog Volume Size"));
-	ur->add_do_method(sn, "set_size", sn->call("get_size"));
-	ur->add_undo_method(sn, "set_size", p_restore);
-	ur->commit_action();
+	helper->box_commit_handle(TTR("Change FogVolume Size"), p_cancel, p_gizmo->get_node_3d());
 }
 
 void FogVolumeGizmoPlugin::redraw(EditorNode3DGizmo *p_gizmo) {
-	Node3D *cs = p_gizmo->get_node_3d();
+	FogVolume *fog_volume = Object::cast_to<FogVolume>(p_gizmo->get_node_3d());
 
 	p_gizmo->clear();
 
-	if (RS::FogVolumeShape(int(p_gizmo->get_node_3d()->call("get_shape"))) != RS::FOG_VOLUME_SHAPE_WORLD) {
+	if (fog_volume->get_shape() != RS::FOG_VOLUME_SHAPE_WORLD) {
 		const Ref<Material> material =
 				get_material("shape_material", p_gizmo);
 		const Ref<Material> material_internal =
@@ -127,7 +109,7 @@ void FogVolumeGizmoPlugin::redraw(EditorNode3DGizmo *p_gizmo) {
 
 		Vector<Vector3> lines;
 		AABB aabb;
-		aabb.size = cs->call("get_size").operator Vector3();
+		aabb.size = fog_volume->get_size();
 		aabb.position = aabb.size / -2;
 
 		for (int i = 0; i < 12; i++) {
@@ -137,13 +119,7 @@ void FogVolumeGizmoPlugin::redraw(EditorNode3DGizmo *p_gizmo) {
 			lines.push_back(b);
 		}
 
-		Vector<Vector3> handles;
-
-		for (int i = 0; i < 3; i++) {
-			Vector3 ax;
-			ax[i] = cs->call("get_size").operator Vector3()[i] / 2;
-			handles.push_back(ax);
-		}
+		Vector<Vector3> handles = helper->box_get_handles(fog_volume->get_size());
 
 		p_gizmo->add_lines(lines, material);
 		p_gizmo->add_collision_segments(lines);

editor/plugins/gizmos/fog_volume_gizmo_plugin.h

@@ -33,9 +33,13 @@
 
 #include "editor/plugins/node_3d_editor_gizmos.h"
 
+class Gizmo3DHelper;
+
 class FogVolumeGizmoPlugin : public EditorNode3DGizmoPlugin {
 	GDCLASS(FogVolumeGizmoPlugin, EditorNode3DGizmoPlugin);
 
+	Ref<Gizmo3DHelper> helper;
+
 public:
 	bool has_gizmo(Node3D *p_spatial) override;
 	String get_gizmo_name() const override;
@@ -44,10 +48,12 @@ public:
 
 	String get_handle_name(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary) const override;
 	Variant get_handle_value(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary) const override;
+	void begin_handle_action(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary) override;
 	void set_handle(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary, Camera3D *p_camera, const Point2 &p_point) override;
 	void commit_handle(const EditorNode3DGizmo *p_gizmo, int p_id, bool p_secondary, const Variant &p_restore, bool p_cancel = false) override;
 
 	FogVolumeGizmoPlugin();
+	~FogVolumeGizmoPlugin();
 };
 
 #endif // FOG_VOLUME_GIZMO_PLUGIN_H