gizmo_3d_helper.cpp

/**************************************************************************/
/*  gizmo_3d_helper.cpp                                                   */
/**************************************************************************/
/*                         This file is part of:                          */
/*                             GODOT ENGINE                               */
/*                        https://godotengine.org                         */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
/*                                                                        */
/* Permission is hereby granted, free of charge, to any person obtaining  */
/* a copy of this software and associated documentation files (the        */
/* "Software"), to deal in the Software without restriction, including    */
/* without limitation the rights to use, copy, modify, merge, publish,    */
/* distribute, sublicense, and/or sell copies of the Software, and to     */
/* permit persons to whom the Software is furnished to do so, subject to  */
/* the following conditions:                                              */
/*                                                                        */
/* The above copyright notice and this permission notice shall be         */
/* included in all copies or substantial portions of the Software.        */
/*                                                                        */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
/**************************************************************************/

#include "gizmo_3d_helper.h"

#include "core/input/input.h"
#include "core/math/geometry_3d.h"
#include "editor/editor_undo_redo_manager.h"
#include "editor/scene/3d/node_3d_editor_plugin.h"
#include "scene/3d/camera_3d.h"

void Gizmo3DHelper::initialize_handle_action(const Variant &p_initial_value, const Transform3D &p_initial_transform) {
	initial_value = p_initial_value;
	initial_transform = p_initial_transform;
}

void Gizmo3DHelper::get_segment(Camera3D *p_camera, const Point2 &p_point, Vector3 *r_segment) {
	Transform3D gt = initial_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);

	r_segment[0] = gi.xform(ray_from);
	r_segment[1] = gi.xform(ray_from + ray_dir * 4096);
}

Vector<Vector3> Gizmo3DHelper::box_get_handles(const Vector3 &p_box_size) {
	Vector<Vector3> handles;
	for (int i = 0; i < 3; i++) {
		Vector3 ax;
		ax[i] = p_box_size[i] / 2;
		handles.push_back(ax);
		handles.push_back(-ax);
	}
	return handles;
}

String Gizmo3DHelper::box_get_handle_name(int p_id) const {
	switch (p_id) {
		case 0:
		case 1:
			return "Size X";
		case 2:
		case 3:
			return "Size Y";
		case 4:
		case 5:
			return "Size Z";
	}
	return "";
}

void Gizmo3DHelper::box_set_handle(const Vector3 p_segment[2], int p_id, Vector3 &r_box_size, Vector3 &r_box_position) {
	int axis = p_id / 2;
	int sign = p_id % 2 * -2 + 1;

	Vector3 initial_size = initial_value;
	float neg_end = initial_size[axis] * -0.5;
	float pos_end = initial_size[axis] * 0.5;

	Vector3 axis_segment[2] = { Vector3(), Vector3() };
	axis_segment[0][axis] = 4096.0;
	axis_segment[1][axis] = -4096.0;
	Vector3 ra, rb;
	Geometry3D::get_closest_points_between_segments(axis_segment[0], axis_segment[1], p_segment[0], p_segment[1], ra, rb);

	// Calculate new size.
	r_box_size = initial_size;
	if (Input::get_singleton()->is_key_pressed(Key::ALT)) {
		r_box_size[axis] = ra[axis] * sign * 2;
	} else {
		r_box_size[axis] = sign > 0 ? ra[axis] - neg_end : pos_end - ra[axis];
	}

	// Snap to grid.
	if (Node3DEditor::get_singleton()->is_snap_enabled()) {
		r_box_size[axis] = Math::snapped(r_box_size[axis], Node3DEditor::get_singleton()->get_translate_snap());
	}
	r_box_size[axis] = MAX(r_box_size[axis], 0.001);

	// Adjust position.
	if (Input::get_singleton()->is_key_pressed(Key::ALT)) {
		r_box_position = initial_transform.get_origin();
	} else {
		if (sign > 0) {
			pos_end = neg_end + r_box_size[axis];
		} else {
			neg_end = pos_end - r_box_size[axis];
		}

		Vector3 offset;
		offset[axis] = (pos_end + neg_end) * 0.5;
		r_box_position = initial_transform.xform(offset);
	}
}

void Gizmo3DHelper::box_commit_handle(const String &p_action_name, bool p_cancel, Object *p_position_object, Object *p_size_object, const StringName &p_position_property, const StringName &p_size_property) {
	if (!p_size_object) {
		p_size_object = p_position_object;
	}

	if (p_cancel) {
		p_size_object->set(p_size_property, initial_value);
		p_position_object->set(p_position_property, initial_transform.get_origin());
		return;
	}

	EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
	ur->create_action(p_action_name);
	ur->add_do_property(p_size_object, p_size_property, p_size_object->get(p_size_property));
	ur->add_do_property(p_position_object, p_position_property, p_position_object->get(p_position_property));
	ur->add_undo_property(p_size_object, p_size_property, initial_value);
	ur->add_undo_property(p_position_object, p_position_property, initial_transform.get_origin());
	ur->commit_action();
}

Vector<Vector3> Gizmo3DHelper::cylinder_get_handles(real_t p_height, real_t p_radius) {
	Vector<Vector3> handles;
	handles.push_back(Vector3(0, p_height * 0.5, 0));
	handles.push_back(Vector3(0, p_height * -0.5, 0));
	handles.push_back(Vector3(p_radius, 0, 0));
	return handles;
}

String Gizmo3DHelper::_cylinder_or_capsule_or_cone_frustum_get_handle_name(int p_id) const {
	if (p_id < 2) {
		return "Height";
	} else {
		return "Radius";
	}
}

void Gizmo3DHelper::_cylinder_or_capsule_or_cone_frustum_set_handle(const Vector3 p_segment[2], int p_id, real_t &r_height, real_t &r_radius_top, real_t &r_radius_bottom, Vector3 &r_position, bool p_is_capsule, bool p_is_frustum) {
	ERR_FAIL_COND(p_is_capsule && p_is_frustum);

	real_t initial_radius_top, initial_radius_bottom, initial_height;
	if (p_is_frustum) {
		initial_radius_top = initial_value.operator Vector3().x;
		initial_radius_bottom = initial_value.operator Vector3().y;
		initial_height = initial_value.operator Vector3().z;
	} else {
		initial_radius_top = initial_value.operator Vector2().x;
		initial_radius_bottom = initial_radius_top;
		initial_height = initial_value.operator Vector2().y;
	}

	int sign = p_id == 1 ? -1 : 1;
	int axis = p_id >= 2 ? 0 : 1;

	Vector3 axis_vector;
	axis_vector[axis] = sign;
	Vector3 ra, rb;
	Geometry3D::get_closest_points_between_segments(axis_vector * -4096, axis_vector * 4096, p_segment[0], p_segment[1], ra, rb);
	float d = axis_vector.dot(ra);

	// Snap to grid.
	if (Node3DEditor::get_singleton()->is_snap_enabled()) {
		d = Math::snapped(d, Node3DEditor::get_singleton()->get_translate_snap());
	}

	if (p_id < 2) {
		// Adjust height.
		if (Input::get_singleton()->is_key_pressed(Key::ALT)) {
			r_height = d * 2.0;
		} else {
			r_height = (initial_height * 0.5) + d;
		}

		if (r_height < 0.001) {
			r_height = 0.001;
		}

		// Adjust position.
		if (Input::get_singleton()->is_key_pressed(Key::ALT)) {
			r_position = initial_transform.get_origin();
		} else {
			Vector3 offset;
			offset[axis] = (r_height - initial_height) * 0.5 * sign;
			r_position = initial_transform.xform(offset);
		}

		if (p_is_capsule) {
			r_radius_top = MIN(initial_radius_top, r_height / 2.0);
			r_radius_bottom = r_radius_top;
		} else {
			r_radius_top = initial_radius_top;
			r_radius_bottom = initial_radius_bottom;
		}
	} else {
		// Adjust radius.
		if (d < 0.001) {
			d = 0.001;
		}
		if (!p_is_frustum) {
			r_radius_top = d;
			r_radius_bottom = d;
		} else {
			real_t diff = d - (initial_radius_bottom + initial_radius_top) / 2.0;
			diff = MAX(MAX(-initial_radius_bottom + 0.001, -initial_radius_top + 0.001), diff);
			r_radius_top = initial_radius_top + diff;
			r_radius_bottom = initial_radius_bottom + diff;
		}

		r_position = initial_transform.get_origin();

		if (p_is_capsule) {
			r_height = MAX(initial_height, r_radius_top * 2.0);
		} else {
			r_height = initial_height;
		}
	}
}

void Gizmo3DHelper::cylinder_commit_handle(int p_id, const String &p_radius_action_name, const String &p_height_action_name, bool p_cancel, Object *p_position_object, Object *p_height_object, Object *p_radius_object, const StringName &p_position_property, const StringName &p_height_property, const StringName &p_radius_property) {
	if (!p_height_object) {
		p_height_object = p_position_object;
	}
	if (!p_radius_object) {
		p_radius_object = p_position_object;
	}

	if (p_cancel) {
		p_radius_object->set(p_radius_property, initial_value.operator Vector2().x);
		p_height_object->set(p_height_property, initial_value.operator Vector2().y);
		p_position_object->set(p_position_property, initial_transform.get_origin());
		return;
	}

	EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
	ur->create_action(p_id < 2 ? p_height_action_name : p_radius_action_name);
	ur->add_do_property(p_radius_object, p_radius_property, p_radius_object->get(p_radius_property));
	ur->add_undo_property(p_radius_object, p_radius_property, initial_value.operator Vector2().x);
	ur->add_do_property(p_height_object, p_height_property, p_height_object->get(p_height_property));
	ur->add_undo_property(p_height_object, p_height_property, initial_value.operator Vector2().y);
	ur->add_do_property(p_position_object, p_position_property, p_position_object->get(p_position_property));
	ur->add_undo_property(p_position_object, p_position_property, initial_transform.get_origin());
	ur->commit_action();
}

Vector<Vector3> Gizmo3DHelper::cone_frustum_get_handles(real_t p_height, real_t p_radius_top, real_t p_radius_bottom) {
	Vector<Vector3> handles;
	handles.push_back(Vector3(0, p_height * 0.5, 0));
	handles.push_back(Vector3(0, p_height * -0.5, 0));
	handles.push_back(Vector3((p_radius_top + p_radius_bottom) / 2.0, 0, 0));
	return handles;
}

void Gizmo3DHelper::cone_frustum_commit_handle(int p_id, const String &p_radius_action_name, const String &p_height_action_name, bool p_cancel, Object *p_position_object, Object *p_height_object, Object *p_radius_top_object, Object *p_radius_bottom_object, const StringName &p_position_property, const StringName &p_height_property, const StringName &p_radius_top_property, const StringName &p_radius_bottom_property) {
	if (!p_height_object) {
		p_height_object = p_position_object;
	}
	if (!p_radius_top_object) {
		p_radius_top_object = p_position_object;
	}
	if (!p_radius_bottom_object) {
		p_radius_bottom_object = p_position_object;
	}

	if (p_cancel) {
		p_radius_top_object->set(p_radius_top_property, initial_value.operator Vector3().x);
		p_radius_bottom_object->set(p_radius_bottom_property, initial_value.operator Vector3().y);
		p_height_object->set(p_height_property, initial_value.operator Vector3().z);
		p_position_object->set(p_position_property, initial_transform.get_origin());
		return;
	}

	EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
	ur->create_action(p_id < 2 ? p_height_action_name : p_radius_action_name);
	ur->add_do_property(p_radius_top_object, p_radius_top_property, p_radius_top_object->get(p_radius_top_property));
	ur->add_do_property(p_radius_bottom_object, p_radius_bottom_property, p_radius_bottom_object->get(p_radius_bottom_property));
	ur->add_undo_property(p_radius_top_object, p_radius_top_property, initial_value.operator Vector3().x);
	ur->add_undo_property(p_radius_bottom_object, p_radius_bottom_property, initial_value.operator Vector3().y);
	ur->add_do_property(p_height_object, p_height_property, p_height_object->get(p_height_property));
	ur->add_undo_property(p_height_object, p_height_property, initial_value.operator Vector3().z);
	ur->add_do_property(p_position_object, p_position_property, p_position_object->get(p_position_property));
	ur->add_undo_property(p_position_object, p_position_property, initial_transform.get_origin());
	ur->commit_action();
}