editor_interface.cpp 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881
  1. /**************************************************************************/
  2. /* editor_interface.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "editor_interface.h"
  31. #include "editor_interface.compat.inc"
  32. #include "core/config/project_settings.h"
  33. #include "editor/create_dialog.h"
  34. #include "editor/editor_command_palette.h"
  35. #include "editor/editor_feature_profile.h"
  36. #include "editor/editor_main_screen.h"
  37. #include "editor/editor_node.h"
  38. #include "editor/editor_paths.h"
  39. #include "editor/editor_resource_preview.h"
  40. #include "editor/editor_settings.h"
  41. #include "editor/editor_undo_redo_manager.h"
  42. #include "editor/filesystem_dock.h"
  43. #include "editor/gui/editor_quick_open_dialog.h"
  44. #include "editor/gui/editor_run_bar.h"
  45. #include "editor/gui/editor_scene_tabs.h"
  46. #include "editor/gui/editor_toaster.h"
  47. #include "editor/gui/scene_tree_editor.h"
  48. #include "editor/inspector_dock.h"
  49. #include "editor/plugins/node_3d_editor_plugin.h"
  50. #include "editor/property_selector.h"
  51. #include "editor/themes/editor_scale.h"
  52. #include "main/main.h"
  53. #include "plugins/editor_preview_plugins.h"
  54. #include "scene/3d/light_3d.h"
  55. #include "scene/3d/mesh_instance_3d.h"
  56. #include "scene/gui/box_container.h"
  57. #include "scene/gui/control.h"
  58. #include "scene/main/window.h"
  59. #include "scene/resources/theme.h"
  60. EditorInterface *EditorInterface::singleton = nullptr;
  61. void EditorInterface::restart_editor(bool p_save) {
  62. if (p_save) {
  63. EditorNode::get_singleton()->save_all_scenes();
  64. }
  65. EditorNode::get_singleton()->restart_editor();
  66. }
  67. // Editor tools.
  68. EditorCommandPalette *EditorInterface::get_command_palette() const {
  69. return EditorCommandPalette::get_singleton();
  70. }
  71. EditorFileSystem *EditorInterface::get_resource_file_system() const {
  72. return EditorFileSystem::get_singleton();
  73. }
  74. EditorPaths *EditorInterface::get_editor_paths() const {
  75. return EditorPaths::get_singleton();
  76. }
  77. EditorResourcePreview *EditorInterface::get_resource_previewer() const {
  78. return EditorResourcePreview::get_singleton();
  79. }
  80. EditorSelection *EditorInterface::get_selection() const {
  81. return EditorNode::get_singleton()->get_editor_selection();
  82. }
  83. Ref<EditorSettings> EditorInterface::get_editor_settings() const {
  84. return EditorSettings::get_singleton();
  85. }
  86. EditorToaster *EditorInterface::get_editor_toaster() const {
  87. return EditorToaster::get_singleton();
  88. }
  89. EditorUndoRedoManager *EditorInterface::get_editor_undo_redo() const {
  90. return EditorUndoRedoManager::get_singleton();
  91. }
  92. AABB EditorInterface::_calculate_aabb_for_scene(Node *p_node, AABB &p_scene_aabb) {
  93. MeshInstance3D *mesh_node = Object::cast_to<MeshInstance3D>(p_node);
  94. if (mesh_node && mesh_node->get_mesh().is_valid()) {
  95. Transform3D accum_xform;
  96. Node3D *base = mesh_node;
  97. while (base) {
  98. accum_xform = base->get_transform() * accum_xform;
  99. base = Object::cast_to<Node3D>(base->get_parent());
  100. }
  101. AABB aabb = accum_xform.xform(mesh_node->get_mesh()->get_aabb());
  102. p_scene_aabb.merge_with(aabb);
  103. }
  104. for (int i = 0; i < p_node->get_child_count(); i++) {
  105. p_scene_aabb = _calculate_aabb_for_scene(p_node->get_child(i), p_scene_aabb);
  106. }
  107. return p_scene_aabb;
  108. }
  109. TypedArray<Texture2D> EditorInterface::_make_mesh_previews(const TypedArray<Mesh> &p_meshes, int p_preview_size) {
  110. Vector<Ref<Mesh>> meshes;
  111. for (int i = 0; i < p_meshes.size(); i++) {
  112. meshes.push_back(p_meshes[i]);
  113. }
  114. Vector<Ref<Texture2D>> textures = make_mesh_previews(meshes, nullptr, p_preview_size);
  115. TypedArray<Texture2D> ret;
  116. for (int i = 0; i < textures.size(); i++) {
  117. ret.push_back(textures[i]);
  118. }
  119. return ret;
  120. }
  121. Vector<Ref<Texture2D>> EditorInterface::make_mesh_previews(const Vector<Ref<Mesh>> &p_meshes, Vector<Transform3D> *p_transforms, int p_preview_size) {
  122. int size = p_preview_size;
  123. RID scenario = RS::get_singleton()->scenario_create();
  124. RID viewport = RS::get_singleton()->viewport_create();
  125. RS::get_singleton()->viewport_set_update_mode(viewport, RS::VIEWPORT_UPDATE_ALWAYS);
  126. RS::get_singleton()->viewport_set_scenario(viewport, scenario);
  127. RS::get_singleton()->viewport_set_size(viewport, size, size);
  128. RS::get_singleton()->viewport_set_transparent_background(viewport, true);
  129. RS::get_singleton()->viewport_set_active(viewport, true);
  130. RID viewport_texture = RS::get_singleton()->viewport_get_texture(viewport);
  131. RID camera = RS::get_singleton()->camera_create();
  132. RS::get_singleton()->viewport_attach_camera(viewport, camera);
  133. RID light = RS::get_singleton()->directional_light_create();
  134. RID light_instance = RS::get_singleton()->instance_create2(light, scenario);
  135. RID light2 = RS::get_singleton()->directional_light_create();
  136. RS::get_singleton()->light_set_color(light2, Color(0.7, 0.7, 0.7));
  137. RID light_instance2 = RS::get_singleton()->instance_create2(light2, scenario);
  138. EditorProgress ep("mlib", TTR("Creating Mesh Previews"), p_meshes.size());
  139. Vector<Ref<Texture2D>> textures;
  140. for (int i = 0; i < p_meshes.size(); i++) {
  141. const Ref<Mesh> &mesh = p_meshes[i];
  142. if (!mesh.is_valid()) {
  143. textures.push_back(Ref<Texture2D>());
  144. continue;
  145. }
  146. Transform3D mesh_xform;
  147. if (p_transforms != nullptr) {
  148. mesh_xform = (*p_transforms)[i];
  149. }
  150. RID inst = RS::get_singleton()->instance_create2(mesh->get_rid(), scenario);
  151. RS::get_singleton()->instance_set_transform(inst, mesh_xform);
  152. AABB aabb = mesh->get_aabb();
  153. Vector3 ofs = aabb.get_center();
  154. aabb.position -= ofs;
  155. Transform3D xform;
  156. xform.basis = Basis().rotated(Vector3(0, 1, 0), -Math_PI / 6);
  157. xform.basis = Basis().rotated(Vector3(1, 0, 0), Math_PI / 6) * xform.basis;
  158. AABB rot_aabb = xform.xform(aabb);
  159. float m = MAX(rot_aabb.size.x, rot_aabb.size.y) * 0.5;
  160. if (m == 0) {
  161. textures.push_back(Ref<Texture2D>());
  162. continue;
  163. }
  164. xform.origin = -xform.basis.xform(ofs); //-ofs*m;
  165. xform.origin.z -= rot_aabb.size.z * 2;
  166. xform.invert();
  167. xform = mesh_xform * xform;
  168. RS::get_singleton()->camera_set_transform(camera, xform * Transform3D(Basis(), Vector3(0, 0, 3)));
  169. RS::get_singleton()->camera_set_orthogonal(camera, m * 2, 0.01, 1000.0);
  170. RS::get_singleton()->instance_set_transform(light_instance, xform * Transform3D().looking_at(Vector3(-2, -1, -1), Vector3(0, 1, 0)));
  171. RS::get_singleton()->instance_set_transform(light_instance2, xform * Transform3D().looking_at(Vector3(+1, -1, -2), Vector3(0, 1, 0)));
  172. ep.step(TTR("Thumbnail..."), i);
  173. DisplayServer::get_singleton()->process_events();
  174. Main::iteration();
  175. Main::iteration();
  176. Ref<Image> img = RS::get_singleton()->texture_2d_get(viewport_texture);
  177. ERR_CONTINUE(!img.is_valid() || img->is_empty());
  178. Ref<ImageTexture> it = ImageTexture::create_from_image(img);
  179. RS::get_singleton()->free(inst);
  180. textures.push_back(it);
  181. }
  182. RS::get_singleton()->free(viewport);
  183. RS::get_singleton()->free(light);
  184. RS::get_singleton()->free(light_instance);
  185. RS::get_singleton()->free(light2);
  186. RS::get_singleton()->free(light_instance2);
  187. RS::get_singleton()->free(camera);
  188. RS::get_singleton()->free(scenario);
  189. return textures;
  190. }
  191. void EditorInterface::make_scene_preview(const String &p_path, Node *p_scene, int p_preview_size) {
  192. ERR_FAIL_NULL_MSG(p_scene, "The provided scene is null.");
  193. ERR_FAIL_COND_MSG(p_scene->is_inside_tree(), "The scene must not be inside the tree.");
  194. ERR_FAIL_COND_MSG(!Engine::get_singleton()->is_editor_hint(), "This function can only be called from the editor.");
  195. ERR_FAIL_NULL_MSG(EditorNode::get_singleton(), "EditorNode doesn't exist.");
  196. SubViewport *sub_viewport_node = memnew(SubViewport);
  197. AABB scene_aabb;
  198. scene_aabb = _calculate_aabb_for_scene(p_scene, scene_aabb);
  199. sub_viewport_node->set_update_mode(SubViewport::UPDATE_ALWAYS);
  200. sub_viewport_node->set_size(Vector2i(p_preview_size, p_preview_size));
  201. sub_viewport_node->set_transparent_background(false);
  202. Ref<World3D> world;
  203. world.instantiate();
  204. sub_viewport_node->set_world_3d(world);
  205. EditorNode::get_singleton()->add_child(sub_viewport_node);
  206. Ref<Environment> env;
  207. env.instantiate();
  208. env->set_background(Environment::BG_CLEAR_COLOR);
  209. Ref<CameraAttributesPractical> camera_attributes;
  210. camera_attributes.instantiate();
  211. Node3D *root = memnew(Node3D);
  212. root->set_name("Root");
  213. sub_viewport_node->add_child(root);
  214. Camera3D *camera = memnew(Camera3D);
  215. camera->set_environment(env);
  216. camera->set_attributes(camera_attributes);
  217. camera->set_name("Camera3D");
  218. root->add_child(camera);
  219. camera->set_current(true);
  220. camera->set_position(Vector3(0.0, 0.0, 3.0));
  221. DirectionalLight3D *light = memnew(DirectionalLight3D);
  222. light->set_name("Light");
  223. DirectionalLight3D *light2 = memnew(DirectionalLight3D);
  224. light2->set_name("Light2");
  225. light2->set_color(Color(0.7, 0.7, 0.7, 1.0));
  226. root->add_child(light);
  227. root->add_child(light2);
  228. sub_viewport_node->add_child(p_scene);
  229. // Calculate the camera and lighting position based on the size of the scene.
  230. Vector3 center = scene_aabb.get_center();
  231. float camera_size = scene_aabb.get_longest_axis_size();
  232. const float cam_rot_x = -Math_PI / 4;
  233. const float cam_rot_y = -Math_PI / 4;
  234. camera->set_orthogonal(camera_size * 2.0, 0.0001, camera_size * 2.0);
  235. Transform3D xf;
  236. xf.basis = Basis(Vector3(0, 1, 0), cam_rot_y) * Basis(Vector3(1, 0, 0), cam_rot_x);
  237. xf.origin = center;
  238. xf.translate_local(0, 0, camera_size);
  239. camera->set_transform(xf);
  240. Transform3D xform;
  241. xform.basis = Basis().rotated(Vector3(0, 1, 0), -Math_PI / 6);
  242. xform.basis = Basis().rotated(Vector3(1, 0, 0), Math_PI / 6) * xform.basis;
  243. light->set_transform(xform * Transform3D().looking_at(Vector3(-2, -1, -1), Vector3(0, 1, 0)));
  244. light2->set_transform(xform * Transform3D().looking_at(Vector3(+1, -1, -2), Vector3(0, 1, 0)));
  245. // Update the renderer to get the screenshot.
  246. DisplayServer::get_singleton()->process_events();
  247. Main::iteration();
  248. Main::iteration();
  249. // Get the texture.
  250. Ref<Texture2D> texture = sub_viewport_node->get_texture();
  251. ERR_FAIL_COND_MSG(texture.is_null(), "Failed to get texture from sub_viewport_node.");
  252. // Remove the initial scene node.
  253. sub_viewport_node->remove_child(p_scene);
  254. // Cleanup the viewport.
  255. if (sub_viewport_node) {
  256. if (sub_viewport_node->get_parent()) {
  257. sub_viewport_node->get_parent()->remove_child(sub_viewport_node);
  258. }
  259. sub_viewport_node->queue_free();
  260. sub_viewport_node = nullptr;
  261. }
  262. // Now generate the cache image.
  263. Ref<Image> img = texture->get_image();
  264. if (img.is_valid() && img->get_width() > 0 && img->get_height() > 0) {
  265. img = img->duplicate();
  266. int preview_size = EDITOR_GET("filesystem/file_dialog/thumbnail_size");
  267. preview_size *= EDSCALE;
  268. int vp_size = MIN(img->get_width(), img->get_height());
  269. int x = (img->get_width() - vp_size) / 2;
  270. int y = (img->get_height() - vp_size) / 2;
  271. if (vp_size < preview_size) {
  272. img->crop_from_point(x, y, vp_size, vp_size);
  273. } else {
  274. int ratio = vp_size / preview_size;
  275. int size = preview_size * MAX(1, ratio / 2);
  276. x = (img->get_width() - size) / 2;
  277. y = (img->get_height() - size) / 2;
  278. img->crop_from_point(x, y, size, size);
  279. img->resize(preview_size, preview_size, Image::INTERPOLATE_LANCZOS);
  280. }
  281. img->convert(Image::FORMAT_RGB8);
  282. String temp_path = EditorPaths::get_singleton()->get_cache_dir();
  283. String cache_base = ProjectSettings::get_singleton()->globalize_path(p_path).md5_text();
  284. cache_base = temp_path.path_join("resthumb-" + cache_base);
  285. post_process_preview(img);
  286. img->save_png(cache_base + ".png");
  287. }
  288. EditorResourcePreview::get_singleton()->check_for_invalidation(p_path);
  289. EditorFileSystem::get_singleton()->emit_signal(SNAME("filesystem_changed"));
  290. }
  291. void EditorInterface::set_plugin_enabled(const String &p_plugin, bool p_enabled) {
  292. EditorNode::get_singleton()->set_addon_plugin_enabled(p_plugin, p_enabled, true);
  293. }
  294. bool EditorInterface::is_plugin_enabled(const String &p_plugin) const {
  295. return EditorNode::get_singleton()->is_addon_plugin_enabled(p_plugin);
  296. }
  297. // Editor GUI.
  298. Ref<Theme> EditorInterface::get_editor_theme() const {
  299. return EditorNode::get_singleton()->get_editor_theme();
  300. }
  301. Control *EditorInterface::get_base_control() const {
  302. return EditorNode::get_singleton()->get_gui_base();
  303. }
  304. VBoxContainer *EditorInterface::get_editor_main_screen() const {
  305. return EditorNode::get_singleton()->get_editor_main_screen()->get_control();
  306. }
  307. ScriptEditor *EditorInterface::get_script_editor() const {
  308. return ScriptEditor::get_singleton();
  309. }
  310. SubViewport *EditorInterface::get_editor_viewport_2d() const {
  311. return EditorNode::get_singleton()->get_scene_root();
  312. }
  313. SubViewport *EditorInterface::get_editor_viewport_3d(int p_idx) const {
  314. ERR_FAIL_INDEX_V(p_idx, static_cast<int>(Node3DEditor::VIEWPORTS_COUNT), nullptr);
  315. return Node3DEditor::get_singleton()->get_editor_viewport(p_idx)->get_viewport_node();
  316. }
  317. void EditorInterface::set_main_screen_editor(const String &p_name) {
  318. EditorNode::get_singleton()->get_editor_main_screen()->select_by_name(p_name);
  319. }
  320. void EditorInterface::set_distraction_free_mode(bool p_enter) {
  321. EditorNode::get_singleton()->set_distraction_free_mode(p_enter);
  322. }
  323. bool EditorInterface::is_distraction_free_mode_enabled() const {
  324. return EditorNode::get_singleton()->is_distraction_free_mode_enabled();
  325. }
  326. bool EditorInterface::is_multi_window_enabled() const {
  327. return EditorNode::get_singleton()->is_multi_window_enabled();
  328. }
  329. float EditorInterface::get_editor_scale() const {
  330. return EDSCALE;
  331. }
  332. void EditorInterface::popup_dialog(Window *p_dialog, const Rect2i &p_screen_rect) {
  333. p_dialog->popup_exclusive(EditorNode::get_singleton(), p_screen_rect);
  334. }
  335. void EditorInterface::popup_dialog_centered(Window *p_dialog, const Size2i &p_minsize) {
  336. p_dialog->popup_exclusive_centered(EditorNode::get_singleton(), p_minsize);
  337. }
  338. void EditorInterface::popup_dialog_centered_ratio(Window *p_dialog, float p_ratio) {
  339. p_dialog->popup_exclusive_centered_ratio(EditorNode::get_singleton(), p_ratio);
  340. }
  341. void EditorInterface::popup_dialog_centered_clamped(Window *p_dialog, const Size2i &p_size, float p_fallback_ratio) {
  342. p_dialog->popup_exclusive_centered_clamped(EditorNode::get_singleton(), p_size, p_fallback_ratio);
  343. }
  344. String EditorInterface::get_current_feature_profile() const {
  345. return EditorFeatureProfileManager::get_singleton()->get_current_profile_name();
  346. }
  347. void EditorInterface::set_current_feature_profile(const String &p_profile_name) {
  348. EditorFeatureProfileManager::get_singleton()->set_current_profile(p_profile_name, true);
  349. }
  350. // Editor dialogs.
  351. void EditorInterface::popup_node_selector(const Callable &p_callback, const TypedArray<StringName> &p_valid_types, Node *p_current_value) {
  352. if (!node_selector) {
  353. node_selector = memnew(SceneTreeDialog);
  354. get_base_control()->add_child(node_selector);
  355. }
  356. Vector<StringName> valid_types;
  357. int length = p_valid_types.size();
  358. valid_types.resize(length);
  359. for (int i = 0; i < length; i++) {
  360. valid_types.write[i] = p_valid_types[i];
  361. }
  362. node_selector->set_valid_types(valid_types);
  363. node_selector->popup_scenetree_dialog(p_current_value);
  364. const Callable callback = callable_mp(this, &EditorInterface::_node_selected);
  365. node_selector->connect(SNAME("selected"), callback.bind(p_callback), CONNECT_DEFERRED);
  366. node_selector->connect(SNAME("canceled"), callback.bind(NodePath(), p_callback), CONNECT_DEFERRED);
  367. }
  368. void EditorInterface::popup_property_selector(Object *p_object, const Callable &p_callback, const PackedInt32Array &p_type_filter, const String &p_current_value) {
  369. if (!property_selector) {
  370. property_selector = memnew(PropertySelector);
  371. get_base_control()->add_child(property_selector);
  372. }
  373. Vector<Variant::Type> type_filter;
  374. int length = p_type_filter.size();
  375. type_filter.resize(length);
  376. for (int i = 0; i < length; i++) {
  377. type_filter.write[i] = (Variant::Type)p_type_filter[i];
  378. }
  379. property_selector->set_type_filter(type_filter);
  380. property_selector->select_property_from_instance(p_object, p_current_value);
  381. const Callable callback = callable_mp(this, &EditorInterface::_property_selected);
  382. property_selector->connect(SNAME("selected"), callback.bind(p_callback), CONNECT_DEFERRED);
  383. property_selector->connect(SNAME("canceled"), callback.bind(String(), p_callback), CONNECT_DEFERRED);
  384. }
  385. void EditorInterface::popup_method_selector(Object *p_object, const Callable &p_callback, const String &p_current_value) {
  386. if (!method_selector) {
  387. method_selector = memnew(PropertySelector);
  388. get_base_control()->add_child(method_selector);
  389. }
  390. method_selector->select_method_from_instance(p_object, p_current_value);
  391. const Callable callback = callable_mp(this, &EditorInterface::_method_selected);
  392. method_selector->connect(SNAME("selected"), callback.bind(p_callback), CONNECT_DEFERRED);
  393. method_selector->connect(SNAME("canceled"), callback.bind(String(), p_callback), CONNECT_DEFERRED);
  394. }
  395. void EditorInterface::popup_quick_open(const Callable &p_callback, const TypedArray<StringName> &p_base_types) {
  396. StringName required_type = SNAME("Resource");
  397. Vector<StringName> base_types;
  398. if (p_base_types.is_empty()) {
  399. base_types.append(required_type);
  400. } else {
  401. for (int i = 0; i < p_base_types.size(); i++) {
  402. StringName type = p_base_types[i];
  403. ERR_FAIL_COND_MSG(!(ClassDB::is_parent_class(type, required_type) || EditorNode::get_editor_data().script_class_is_parent(type, required_type)), "Only types deriving from Resource are supported in the quick open dialog.");
  404. base_types.append(type);
  405. }
  406. }
  407. EditorQuickOpenDialog *quick_open = EditorNode::get_singleton()->get_quick_open_dialog();
  408. quick_open->connect(SNAME("canceled"), callable_mp(this, &EditorInterface::_quick_open).bind(String(), p_callback));
  409. quick_open->popup_dialog(base_types, callable_mp(this, &EditorInterface::_quick_open).bind(p_callback));
  410. }
  411. void EditorInterface::popup_create_dialog(const Callable &p_callback, const StringName &p_base_type, const String &p_current_type, const String &p_dialog_title, const TypedArray<StringName> &p_custom_type_blocklist, const Dictionary &p_custom_suffix) {
  412. if (!create_dialog) {
  413. create_dialog = memnew(CreateDialog);
  414. get_base_control()->add_child(create_dialog);
  415. }
  416. HashSet<StringName> blocklist;
  417. for (const Variant &E : p_custom_type_blocklist) {
  418. blocklist.insert(E);
  419. }
  420. create_dialog->set_type_blocklist(blocklist);
  421. HashMap<StringName, String> suffix_map;
  422. List<Variant> keys;
  423. p_custom_suffix.get_key_list(&keys);
  424. for (Variant &k : keys) {
  425. const StringName key = k;
  426. if (key.is_empty()) {
  427. continue;
  428. }
  429. suffix_map.insert(key, p_custom_suffix[key]);
  430. }
  431. create_dialog->set_type_suffixes(suffix_map);
  432. String safe_base_type = p_base_type;
  433. if (p_base_type.is_empty() || (!ClassDB::class_exists(p_base_type) && !ScriptServer::is_global_class(p_base_type))) {
  434. ERR_PRINT(vformat("Invalid base type '%s'. The base type has fallen back to 'Object'.", p_base_type));
  435. safe_base_type = "Object";
  436. }
  437. create_dialog->set_base_type(safe_base_type);
  438. create_dialog->popup_create(false, true, p_current_type, "");
  439. create_dialog->set_title(p_dialog_title.is_empty() ? vformat(TTR("Create New %s"), p_base_type) : p_dialog_title);
  440. const Callable callback = callable_mp(this, &EditorInterface::_create_dialog_item_selected);
  441. create_dialog->connect(SNAME("create"), callback.bind(false, p_callback), CONNECT_DEFERRED);
  442. create_dialog->connect(SNAME("canceled"), callback.bind(true, p_callback), CONNECT_DEFERRED);
  443. }
  444. void EditorInterface::_node_selected(const NodePath &p_node_path, const Callable &p_callback) {
  445. const Callable callback = callable_mp(this, &EditorInterface::_node_selected);
  446. node_selector->disconnect(SNAME("selected"), callback);
  447. node_selector->disconnect(SNAME("canceled"), callback);
  448. if (p_node_path.is_empty()) {
  449. _call_dialog_callback(p_callback, NodePath(), "node selection canceled");
  450. } else {
  451. const NodePath path = get_edited_scene_root()->get_path().rel_path_to(p_node_path);
  452. _call_dialog_callback(p_callback, path, "node selected");
  453. }
  454. }
  455. void EditorInterface::_property_selected(const String &p_property_name, const Callable &p_callback) {
  456. const Callable callback = callable_mp(this, &EditorInterface::_property_selected);
  457. property_selector->disconnect(SNAME("selected"), callback);
  458. property_selector->disconnect(SNAME("canceled"), callback);
  459. if (p_property_name.is_empty()) {
  460. _call_dialog_callback(p_callback, NodePath(p_property_name).get_as_property_path(), "property selection canceled");
  461. } else {
  462. _call_dialog_callback(p_callback, NodePath(p_property_name).get_as_property_path(), "property selected");
  463. }
  464. }
  465. void EditorInterface::_method_selected(const String &p_method_name, const Callable &p_callback) {
  466. const Callable callback = callable_mp(this, &EditorInterface::_method_selected);
  467. method_selector->disconnect(SNAME("selected"), callback);
  468. method_selector->disconnect(SNAME("canceled"), callback);
  469. if (p_method_name.is_empty()) {
  470. _call_dialog_callback(p_callback, p_method_name, "method selection canceled");
  471. } else {
  472. _call_dialog_callback(p_callback, p_method_name, "method selected");
  473. }
  474. }
  475. void EditorInterface::_quick_open(const String &p_file_path, const Callable &p_callback) {
  476. EditorQuickOpenDialog *quick_open = EditorNode::get_singleton()->get_quick_open_dialog();
  477. quick_open->disconnect(SNAME("canceled"), callable_mp(this, &EditorInterface::_quick_open));
  478. _call_dialog_callback(p_callback, p_file_path, "quick open");
  479. }
  480. void EditorInterface::_create_dialog_item_selected(bool p_is_canceled, const Callable &p_callback) {
  481. const Callable callback = callable_mp(this, &EditorInterface::_create_dialog_item_selected);
  482. create_dialog->disconnect(SNAME("create"), callback);
  483. create_dialog->disconnect(SNAME("canceled"), callback);
  484. _call_dialog_callback(p_callback, p_is_canceled ? "" : create_dialog->get_selected_type(), "create dialog");
  485. }
  486. void EditorInterface::_call_dialog_callback(const Callable &p_callback, const Variant &p_selected, const String &p_context) {
  487. Callable::CallError ce;
  488. Variant ret;
  489. const Variant *args[1] = { &p_selected };
  490. p_callback.callp(args, 1, ret, ce);
  491. if (ce.error != Callable::CallError::CALL_OK) {
  492. ERR_PRINT(vformat("Error calling %s callback: %s", p_context, Variant::get_callable_error_text(p_callback, args, 1, ce)));
  493. }
  494. }
  495. // Editor docks.
  496. FileSystemDock *EditorInterface::get_file_system_dock() const {
  497. return FileSystemDock::get_singleton();
  498. }
  499. void EditorInterface::select_file(const String &p_file) {
  500. FileSystemDock::get_singleton()->select_file(p_file);
  501. }
  502. Vector<String> EditorInterface::get_selected_paths() const {
  503. return FileSystemDock::get_singleton()->get_selected_paths();
  504. }
  505. String EditorInterface::get_current_path() const {
  506. return FileSystemDock::get_singleton()->get_current_path();
  507. }
  508. String EditorInterface::get_current_directory() const {
  509. return FileSystemDock::get_singleton()->get_current_directory();
  510. }
  511. EditorInspector *EditorInterface::get_inspector() const {
  512. return InspectorDock::get_inspector_singleton();
  513. }
  514. // Object/Resource/Node editing.
  515. void EditorInterface::inspect_object(Object *p_obj, const String &p_for_property, bool p_inspector_only) {
  516. EditorNode::get_singleton()->push_item(p_obj, p_for_property, p_inspector_only);
  517. }
  518. void EditorInterface::edit_resource(const Ref<Resource> &p_resource) {
  519. EditorNode::get_singleton()->edit_resource(p_resource);
  520. }
  521. void EditorInterface::edit_node(Node *p_node) {
  522. EditorNode::get_singleton()->edit_node(p_node);
  523. }
  524. void EditorInterface::edit_script(const Ref<Script> &p_script, int p_line, int p_col, bool p_grab_focus) {
  525. ScriptEditor::get_singleton()->edit(p_script, p_line - 1, p_col - 1, p_grab_focus);
  526. }
  527. void EditorInterface::open_scene_from_path(const String &scene_path, bool p_set_inherited) {
  528. if (EditorNode::get_singleton()->is_changing_scene()) {
  529. return;
  530. }
  531. EditorNode::get_singleton()->open_request(scene_path, p_set_inherited);
  532. }
  533. void EditorInterface::reload_scene_from_path(const String &scene_path) {
  534. if (EditorNode::get_singleton()->is_changing_scene()) {
  535. return;
  536. }
  537. EditorNode::get_singleton()->reload_scene(scene_path);
  538. }
  539. Node *EditorInterface::get_edited_scene_root() const {
  540. return EditorNode::get_singleton()->get_edited_scene();
  541. }
  542. PackedStringArray EditorInterface::get_open_scenes() const {
  543. PackedStringArray ret;
  544. Vector<EditorData::EditedScene> scenes = EditorNode::get_editor_data().get_edited_scenes();
  545. int scns_amount = scenes.size();
  546. for (int idx_scn = 0; idx_scn < scns_amount; idx_scn++) {
  547. if (scenes[idx_scn].root == nullptr) {
  548. continue;
  549. }
  550. ret.push_back(scenes[idx_scn].root->get_scene_file_path());
  551. }
  552. return ret;
  553. }
  554. Error EditorInterface::save_scene() {
  555. if (!get_edited_scene_root()) {
  556. return ERR_CANT_CREATE;
  557. }
  558. if (get_edited_scene_root()->get_scene_file_path().is_empty()) {
  559. return ERR_CANT_CREATE;
  560. }
  561. save_scene_as(get_edited_scene_root()->get_scene_file_path());
  562. return OK;
  563. }
  564. void EditorInterface::save_scene_as(const String &p_scene, bool p_with_preview) {
  565. EditorNode::get_singleton()->save_scene_to_path(p_scene, p_with_preview);
  566. }
  567. void EditorInterface::mark_scene_as_unsaved() {
  568. EditorUndoRedoManager::get_singleton()->set_history_as_unsaved(EditorNode::get_editor_data().get_current_edited_scene_history_id());
  569. EditorSceneTabs::get_singleton()->update_scene_tabs();
  570. }
  571. void EditorInterface::save_all_scenes() {
  572. EditorNode::get_singleton()->save_all_scenes();
  573. }
  574. // Scene playback.
  575. void EditorInterface::play_main_scene() {
  576. EditorRunBar::get_singleton()->play_main_scene();
  577. }
  578. void EditorInterface::play_current_scene() {
  579. EditorRunBar::get_singleton()->play_current_scene();
  580. }
  581. void EditorInterface::play_custom_scene(const String &scene_path) {
  582. EditorRunBar::get_singleton()->play_custom_scene(scene_path);
  583. }
  584. void EditorInterface::stop_playing_scene() {
  585. EditorRunBar::get_singleton()->stop_playing();
  586. }
  587. bool EditorInterface::is_playing_scene() const {
  588. return EditorRunBar::get_singleton()->is_playing();
  589. }
  590. String EditorInterface::get_playing_scene() const {
  591. return EditorRunBar::get_singleton()->get_playing_scene();
  592. }
  593. void EditorInterface::set_movie_maker_enabled(bool p_enabled) {
  594. EditorRunBar::get_singleton()->set_movie_maker_enabled(p_enabled);
  595. }
  596. bool EditorInterface::is_movie_maker_enabled() const {
  597. return EditorRunBar::get_singleton()->is_movie_maker_enabled();
  598. }
  599. #ifdef TOOLS_ENABLED
  600. void EditorInterface::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
  601. const String pf = p_function;
  602. if (p_idx == 0) {
  603. if (pf == "set_main_screen_editor") {
  604. for (String E : { "\"2D\"", "\"3D\"", "\"Script\"", "\"AssetLib\"" }) {
  605. r_options->push_back(E);
  606. }
  607. } else if (pf == "get_editor_viewport_3d") {
  608. for (uint32_t i = 0; i < Node3DEditor::VIEWPORTS_COUNT; i++) {
  609. r_options->push_back(String::num_int64(i));
  610. }
  611. }
  612. }
  613. Object::get_argument_options(p_function, p_idx, r_options);
  614. }
  615. #endif
  616. // Base.
  617. void EditorInterface::_bind_methods() {
  618. ClassDB::bind_method(D_METHOD("restart_editor", "save"), &EditorInterface::restart_editor, DEFVAL(true));
  619. // Editor tools.
  620. ClassDB::bind_method(D_METHOD("get_command_palette"), &EditorInterface::get_command_palette);
  621. ClassDB::bind_method(D_METHOD("get_resource_filesystem"), &EditorInterface::get_resource_file_system);
  622. ClassDB::bind_method(D_METHOD("get_editor_paths"), &EditorInterface::get_editor_paths);
  623. ClassDB::bind_method(D_METHOD("get_resource_previewer"), &EditorInterface::get_resource_previewer);
  624. ClassDB::bind_method(D_METHOD("get_selection"), &EditorInterface::get_selection);
  625. ClassDB::bind_method(D_METHOD("get_editor_settings"), &EditorInterface::get_editor_settings);
  626. ClassDB::bind_method(D_METHOD("get_editor_toaster"), &EditorInterface::get_editor_toaster);
  627. ClassDB::bind_method(D_METHOD("get_editor_undo_redo"), &EditorInterface::get_editor_undo_redo);
  628. ClassDB::bind_method(D_METHOD("make_mesh_previews", "meshes", "preview_size"), &EditorInterface::_make_mesh_previews);
  629. ClassDB::bind_method(D_METHOD("set_plugin_enabled", "plugin", "enabled"), &EditorInterface::set_plugin_enabled);
  630. ClassDB::bind_method(D_METHOD("is_plugin_enabled", "plugin"), &EditorInterface::is_plugin_enabled);
  631. // Editor GUI.
  632. ClassDB::bind_method(D_METHOD("get_editor_theme"), &EditorInterface::get_editor_theme);
  633. ClassDB::bind_method(D_METHOD("get_base_control"), &EditorInterface::get_base_control);
  634. ClassDB::bind_method(D_METHOD("get_editor_main_screen"), &EditorInterface::get_editor_main_screen);
  635. ClassDB::bind_method(D_METHOD("get_script_editor"), &EditorInterface::get_script_editor);
  636. ClassDB::bind_method(D_METHOD("get_editor_viewport_2d"), &EditorInterface::get_editor_viewport_2d);
  637. ClassDB::bind_method(D_METHOD("get_editor_viewport_3d", "idx"), &EditorInterface::get_editor_viewport_3d, DEFVAL(0));
  638. ClassDB::bind_method(D_METHOD("set_main_screen_editor", "name"), &EditorInterface::set_main_screen_editor);
  639. ClassDB::bind_method(D_METHOD("set_distraction_free_mode", "enter"), &EditorInterface::set_distraction_free_mode);
  640. ClassDB::bind_method(D_METHOD("is_distraction_free_mode_enabled"), &EditorInterface::is_distraction_free_mode_enabled);
  641. ClassDB::bind_method(D_METHOD("is_multi_window_enabled"), &EditorInterface::is_multi_window_enabled);
  642. ClassDB::bind_method(D_METHOD("get_editor_scale"), &EditorInterface::get_editor_scale);
  643. ClassDB::bind_method(D_METHOD("popup_dialog", "dialog", "rect"), &EditorInterface::popup_dialog, DEFVAL(Rect2i()));
  644. ClassDB::bind_method(D_METHOD("popup_dialog_centered", "dialog", "minsize"), &EditorInterface::popup_dialog_centered, DEFVAL(Size2i()));
  645. ClassDB::bind_method(D_METHOD("popup_dialog_centered_ratio", "dialog", "ratio"), &EditorInterface::popup_dialog_centered_ratio, DEFVAL(0.8));
  646. ClassDB::bind_method(D_METHOD("popup_dialog_centered_clamped", "dialog", "minsize", "fallback_ratio"), &EditorInterface::popup_dialog_centered_clamped, DEFVAL(Size2i()), DEFVAL(0.75));
  647. ClassDB::bind_method(D_METHOD("get_current_feature_profile"), &EditorInterface::get_current_feature_profile);
  648. ClassDB::bind_method(D_METHOD("set_current_feature_profile", "profile_name"), &EditorInterface::set_current_feature_profile);
  649. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "distraction_free_mode"), "set_distraction_free_mode", "is_distraction_free_mode_enabled");
  650. // Editor dialogs.
  651. ClassDB::bind_method(D_METHOD("popup_node_selector", "callback", "valid_types", "current_value"), &EditorInterface::popup_node_selector, DEFVAL(TypedArray<StringName>()), DEFVAL(Variant()));
  652. ClassDB::bind_method(D_METHOD("popup_property_selector", "object", "callback", "type_filter", "current_value"), &EditorInterface::popup_property_selector, DEFVAL(PackedInt32Array()), DEFVAL(String()));
  653. ClassDB::bind_method(D_METHOD("popup_method_selector", "object", "callback", "current_value"), &EditorInterface::popup_method_selector, DEFVAL(String()));
  654. ClassDB::bind_method(D_METHOD("popup_quick_open", "callback", "base_types"), &EditorInterface::popup_quick_open, DEFVAL(TypedArray<StringName>()));
  655. ClassDB::bind_method(D_METHOD("popup_create_dialog", "callback", "base_type", "current_type", "dialog_title", "type_blocklist", "type_suffixes"), &EditorInterface::popup_create_dialog, DEFVAL(""), DEFVAL(""), DEFVAL(""), DEFVAL(TypedArray<StringName>()), DEFVAL(Dictionary()));
  656. // Editor docks.
  657. ClassDB::bind_method(D_METHOD("get_file_system_dock"), &EditorInterface::get_file_system_dock);
  658. ClassDB::bind_method(D_METHOD("select_file", "file"), &EditorInterface::select_file);
  659. ClassDB::bind_method(D_METHOD("get_selected_paths"), &EditorInterface::get_selected_paths);
  660. ClassDB::bind_method(D_METHOD("get_current_path"), &EditorInterface::get_current_path);
  661. ClassDB::bind_method(D_METHOD("get_current_directory"), &EditorInterface::get_current_directory);
  662. ClassDB::bind_method(D_METHOD("get_inspector"), &EditorInterface::get_inspector);
  663. // Object/Resource/Node editing.
  664. ClassDB::bind_method(D_METHOD("inspect_object", "object", "for_property", "inspector_only"), &EditorInterface::inspect_object, DEFVAL(String()), DEFVAL(false));
  665. ClassDB::bind_method(D_METHOD("edit_resource", "resource"), &EditorInterface::edit_resource);
  666. ClassDB::bind_method(D_METHOD("edit_node", "node"), &EditorInterface::edit_node);
  667. ClassDB::bind_method(D_METHOD("edit_script", "script", "line", "column", "grab_focus"), &EditorInterface::edit_script, DEFVAL(-1), DEFVAL(0), DEFVAL(true));
  668. ClassDB::bind_method(D_METHOD("open_scene_from_path", "scene_filepath", "set_inherited"), &EditorInterface::open_scene_from_path, DEFVAL(false));
  669. ClassDB::bind_method(D_METHOD("reload_scene_from_path", "scene_filepath"), &EditorInterface::reload_scene_from_path);
  670. ClassDB::bind_method(D_METHOD("get_open_scenes"), &EditorInterface::get_open_scenes);
  671. ClassDB::bind_method(D_METHOD("get_edited_scene_root"), &EditorInterface::get_edited_scene_root);
  672. ClassDB::bind_method(D_METHOD("save_scene"), &EditorInterface::save_scene);
  673. ClassDB::bind_method(D_METHOD("save_scene_as", "path", "with_preview"), &EditorInterface::save_scene_as, DEFVAL(true));
  674. ClassDB::bind_method(D_METHOD("save_all_scenes"), &EditorInterface::save_all_scenes);
  675. ClassDB::bind_method(D_METHOD("mark_scene_as_unsaved"), &EditorInterface::mark_scene_as_unsaved);
  676. // Scene playback.
  677. ClassDB::bind_method(D_METHOD("play_main_scene"), &EditorInterface::play_main_scene);
  678. ClassDB::bind_method(D_METHOD("play_current_scene"), &EditorInterface::play_current_scene);
  679. ClassDB::bind_method(D_METHOD("play_custom_scene", "scene_filepath"), &EditorInterface::play_custom_scene);
  680. ClassDB::bind_method(D_METHOD("stop_playing_scene"), &EditorInterface::stop_playing_scene);
  681. ClassDB::bind_method(D_METHOD("is_playing_scene"), &EditorInterface::is_playing_scene);
  682. ClassDB::bind_method(D_METHOD("get_playing_scene"), &EditorInterface::get_playing_scene);
  683. ClassDB::bind_method(D_METHOD("set_movie_maker_enabled", "enabled"), &EditorInterface::set_movie_maker_enabled);
  684. ClassDB::bind_method(D_METHOD("is_movie_maker_enabled"), &EditorInterface::is_movie_maker_enabled);
  685. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "movie_maker_enabled"), "set_movie_maker_enabled", "is_movie_maker_enabled");
  686. }
  687. void EditorInterface::create() {
  688. memnew(EditorInterface);
  689. }
  690. void EditorInterface::free() {
  691. ERR_FAIL_NULL(singleton);
  692. memdelete(singleton);
  693. }
  694. EditorInterface::EditorInterface() {
  695. ERR_FAIL_COND(singleton != nullptr);
  696. singleton = this;
  697. }