Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/editor/editor_interface.cpp
20874 views
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
31
#include "editor_interface.h"
32
#include "editor_interface.compat.inc"
33
34
#include "core/config/project_settings.h"
35
#include "core/io/resource_loader.h"
36
#include "editor/docks/filesystem_dock.h"
37
#include "editor/docks/inspector_dock.h"
38
#include "editor/editor_main_screen.h"
39
#include "editor/editor_node.h"
40
#include "editor/editor_undo_redo_manager.h"
41
#include "editor/file_system/editor_paths.h"
42
#include "editor/gui/create_dialog.h"
43
#include "editor/gui/editor_quick_open_dialog.h"
44
#include "editor/gui/editor_toaster.h"
45
#include "editor/inspector/editor_preview_plugins.h"
46
#include "editor/inspector/editor_resource_preview.h"
47
#include "editor/inspector/property_selector.h"
48
#include "editor/run/editor_run_bar.h"
49
#include "editor/scene/3d/node_3d_editor_plugin.h"
50
#include "editor/scene/editor_scene_tabs.h"
51
#include "editor/scene/scene_tree_editor.h"
52
#include "editor/settings/editor_command_palette.h"
53
#include "editor/settings/editor_feature_profile.h"
54
#include "editor/settings/editor_settings.h"
55
#include "editor/themes/editor_scale.h"
56
#include "main/main.h"
57
#include "scene/3d/light_3d.h"
58
#include "scene/3d/mesh_instance_3d.h"
59
#include "scene/gui/box_container.h"
60
#include "scene/gui/control.h"
61
#include "scene/main/window.h"
62
#include "scene/resources/packed_scene.h"
63
#include "scene/resources/theme.h"
64
65
EditorInterface *EditorInterface::singleton = nullptr;
66
67
void EditorInterface::restart_editor(bool p_save) {
68
if (p_save) {
69
EditorNode::get_singleton()->save_all_scenes();
70
}
71
EditorNode::get_singleton()->restart_editor();
72
}
73
74
// Editor tools.
75
76
EditorCommandPalette *EditorInterface::get_command_palette() const {
77
return EditorCommandPalette::get_singleton();
78
}
79
80
EditorFileSystem *EditorInterface::get_resource_filesystem() const {
81
return EditorFileSystem::get_singleton();
82
}
83
84
EditorPaths *EditorInterface::get_editor_paths() const {
85
return EditorPaths::get_singleton();
86
}
87
88
EditorResourcePreview *EditorInterface::get_resource_previewer() const {
89
return EditorResourcePreview::get_singleton();
90
}
91
92
EditorSelection *EditorInterface::get_selection() const {
93
return EditorNode::get_singleton()->get_editor_selection();
94
}
95
96
Ref<EditorSettings> EditorInterface::get_editor_settings() const {
97
return EditorSettings::get_singleton();
98
}
99
100
EditorToaster *EditorInterface::get_editor_toaster() const {
101
return EditorToaster::get_singleton();
102
}
103
104
EditorUndoRedoManager *EditorInterface::get_editor_undo_redo() const {
105
return EditorUndoRedoManager::get_singleton();
106
}
107
108
AABB EditorInterface::_calculate_aabb_for_scene(Node *p_node, AABB &p_scene_aabb) {
109
MeshInstance3D *mesh_node = Object::cast_to<MeshInstance3D>(p_node);
110
if (mesh_node && mesh_node->get_mesh().is_valid()) {
111
Transform3D accum_xform;
112
Node3D *base = mesh_node;
113
while (base) {
114
accum_xform = base->get_transform() * accum_xform;
115
base = Object::cast_to<Node3D>(base->get_parent());
116
}
117
118
AABB aabb = accum_xform.xform(mesh_node->get_mesh()->get_aabb());
119
p_scene_aabb.merge_with(aabb);
120
}
121
122
for (int i = 0; i < p_node->get_child_count(); i++) {
123
p_scene_aabb = _calculate_aabb_for_scene(p_node->get_child(i), p_scene_aabb);
124
}
125
126
return p_scene_aabb;
127
}
128
129
TypedArray<Texture2D> EditorInterface::_make_mesh_previews(const TypedArray<Mesh> &p_meshes, int p_preview_size) {
130
Vector<Ref<Mesh>> meshes;
131
132
for (int i = 0; i < p_meshes.size(); i++) {
133
meshes.push_back(p_meshes[i]);
134
}
135
136
Vector<Ref<Texture2D>> textures = make_mesh_previews(meshes, nullptr, p_preview_size);
137
TypedArray<Texture2D> ret;
138
for (int i = 0; i < textures.size(); i++) {
139
ret.push_back(textures[i]);
140
}
141
142
return ret;
143
}
144
145
Vector<Ref<Texture2D>> EditorInterface::make_mesh_previews(const Vector<Ref<Mesh>> &p_meshes, Vector<Transform3D> *p_transforms, int p_preview_size) {
146
int size = p_preview_size;
147
148
RID scenario = RS::get_singleton()->scenario_create();
149
150
RID viewport = RS::get_singleton()->viewport_create();
151
RS::get_singleton()->viewport_set_update_mode(viewport, RS::VIEWPORT_UPDATE_ALWAYS);
152
RS::get_singleton()->viewport_set_scenario(viewport, scenario);
153
RS::get_singleton()->viewport_set_size(viewport, size, size);
154
RS::get_singleton()->viewport_set_transparent_background(viewport, true);
155
RS::get_singleton()->viewport_set_active(viewport, true);
156
RID viewport_texture = RS::get_singleton()->viewport_get_texture(viewport);
157
158
RID camera = RS::get_singleton()->camera_create();
159
RS::get_singleton()->viewport_attach_camera(viewport, camera);
160
161
RID light = RS::get_singleton()->directional_light_create();
162
RID light_instance = RS::get_singleton()->instance_create2(light, scenario);
163
164
RID light2 = RS::get_singleton()->directional_light_create();
165
RS::get_singleton()->light_set_color(light2, Color(0.7, 0.7, 0.7));
166
RID light_instance2 = RS::get_singleton()->instance_create2(light2, scenario);
167
168
EditorProgress ep("mlib", TTR("Creating Mesh Previews"), p_meshes.size());
169
170
Vector<Ref<Texture2D>> textures;
171
172
for (int i = 0; i < p_meshes.size(); i++) {
173
const Ref<Mesh> &mesh = p_meshes[i];
174
if (mesh.is_null()) {
175
textures.push_back(Ref<Texture2D>());
176
continue;
177
}
178
179
Transform3D mesh_xform;
180
if (p_transforms != nullptr) {
181
mesh_xform = (*p_transforms)[i];
182
}
183
184
RID inst = RS::get_singleton()->instance_create2(mesh->get_rid(), scenario);
185
RS::get_singleton()->instance_set_transform(inst, mesh_xform);
186
187
AABB aabb = mesh->get_aabb();
188
Vector3 ofs = aabb.get_center();
189
aabb.position -= ofs;
190
Transform3D xform;
191
xform.basis = Basis().rotated(Vector3(0, 1, 0), -Math::PI / 6);
192
xform.basis = Basis().rotated(Vector3(1, 0, 0), Math::PI / 6) * xform.basis;
193
AABB rot_aabb = xform.xform(aabb);
194
float m = MAX(rot_aabb.size.x, rot_aabb.size.y) * 0.5;
195
if (m == 0) {
196
textures.push_back(Ref<Texture2D>());
197
continue;
198
}
199
xform.origin = -xform.basis.xform(ofs); //-ofs*m;
200
xform.origin.z -= rot_aabb.size.z * 2;
201
xform.invert();
202
xform = mesh_xform * xform;
203
204
RS::get_singleton()->camera_set_transform(camera, xform * Transform3D(Basis(), Vector3(0, 0, 3)));
205
RS::get_singleton()->camera_set_orthogonal(camera, m * 2, 0.01, 1000.0);
206
207
RS::get_singleton()->instance_set_transform(light_instance, xform * Transform3D().looking_at(Vector3(-2, -1, -1), Vector3(0, 1, 0)));
208
RS::get_singleton()->instance_set_transform(light_instance2, xform * Transform3D().looking_at(Vector3(+1, -1, -2), Vector3(0, 1, 0)));
209
210
ep.step(TTR("Thumbnail..."), i);
211
DisplayServer::get_singleton()->process_events();
212
Main::iteration();
213
Main::iteration();
214
Ref<Image> img = RS::get_singleton()->texture_2d_get(viewport_texture);
215
ERR_CONTINUE(img.is_null() || img->is_empty());
216
Ref<ImageTexture> it = ImageTexture::create_from_image(img);
217
218
RS::get_singleton()->free_rid(inst);
219
220
textures.push_back(it);
221
}
222
223
RS::get_singleton()->free_rid(viewport);
224
RS::get_singleton()->free_rid(light);
225
RS::get_singleton()->free_rid(light_instance);
226
RS::get_singleton()->free_rid(light2);
227
RS::get_singleton()->free_rid(light_instance2);
228
RS::get_singleton()->free_rid(camera);
229
RS::get_singleton()->free_rid(scenario);
230
231
return textures;
232
}
233
234
void EditorInterface::make_scene_preview(const String &p_path, Node *p_scene, int p_preview_size) {
235
if (!Engine::get_singleton()->is_editor_hint() || !DisplayServer::get_singleton()->window_can_draw()) {
236
return;
237
}
238
ERR_FAIL_COND_MSG(p_path.is_empty(), "Path is empty, cannot generate preview.");
239
ERR_FAIL_NULL_MSG(p_scene, "The provided scene is null, cannot generate preview.");
240
ERR_FAIL_COND_MSG(p_scene->is_inside_tree(), "The scene must not be inside the tree.");
241
ERR_FAIL_NULL_MSG(EditorNode::get_singleton(), "EditorNode doesn't exist.");
242
243
SubViewport *sub_viewport_node = memnew(SubViewport);
244
AABB scene_aabb;
245
scene_aabb = _calculate_aabb_for_scene(p_scene, scene_aabb);
246
247
sub_viewport_node->set_update_mode(SubViewport::UPDATE_ALWAYS);
248
sub_viewport_node->set_size(Vector2i(p_preview_size, p_preview_size));
249
sub_viewport_node->set_transparent_background(false);
250
Ref<World3D> world;
251
world.instantiate();
252
sub_viewport_node->set_world_3d(world);
253
254
EditorNode::get_singleton()->add_child(sub_viewport_node);
255
Ref<Environment> env;
256
env.instantiate();
257
env->set_background(Environment::BG_CLEAR_COLOR);
258
259
Ref<CameraAttributesPractical> camera_attributes;
260
camera_attributes.instantiate();
261
262
Node3D *root = memnew(Node3D);
263
root->set_name("Root");
264
sub_viewport_node->add_child(root);
265
266
Camera3D *camera = memnew(Camera3D);
267
camera->set_environment(env);
268
camera->set_attributes(camera_attributes);
269
camera->set_name("Camera3D");
270
root->add_child(camera);
271
camera->set_current(true);
272
273
camera->set_position(Vector3(0.0, 0.0, 3.0));
274
275
DirectionalLight3D *light = memnew(DirectionalLight3D);
276
light->set_name("Light");
277
DirectionalLight3D *light2 = memnew(DirectionalLight3D);
278
light2->set_name("Light2");
279
light2->set_color(Color(0.7, 0.7, 0.7, 1.0));
280
281
root->add_child(light);
282
root->add_child(light2);
283
284
sub_viewport_node->add_child(p_scene);
285
286
// Calculate the camera and lighting position based on the size of the scene.
287
Vector3 center = scene_aabb.get_center();
288
float camera_size = scene_aabb.get_longest_axis_size();
289
290
const float cam_rot_x = -Math::PI / 4;
291
const float cam_rot_y = -Math::PI / 4;
292
293
camera->set_orthogonal(camera_size * 2.0, 0.0001, camera_size * 2.0);
294
295
Transform3D xf;
296
xf.basis = Basis(Vector3(0, 1, 0), cam_rot_y) * Basis(Vector3(1, 0, 0), cam_rot_x);
297
xf.origin = center;
298
xf.translate_local(0, 0, camera_size);
299
300
camera->set_transform(xf);
301
302
Transform3D xform;
303
xform.basis = Basis().rotated(Vector3(0, 1, 0), -Math::PI / 6);
304
xform.basis = Basis().rotated(Vector3(1, 0, 0), Math::PI / 6) * xform.basis;
305
306
light->set_transform(xform * Transform3D().looking_at(Vector3(-2, -1, -1), Vector3(0, 1, 0)));
307
light2->set_transform(xform * Transform3D().looking_at(Vector3(+1, -1, -2), Vector3(0, 1, 0)));
308
309
// Update the renderer to get the screenshot.
310
DisplayServer::get_singleton()->process_events();
311
Main::iteration();
312
Main::iteration();
313
314
// Get the texture.
315
Ref<Texture2D> texture = sub_viewport_node->get_texture();
316
ERR_FAIL_COND_MSG(texture.is_null(), "Failed to get texture from sub_viewport_node.");
317
318
// Remove the initial scene node.
319
sub_viewport_node->remove_child(p_scene);
320
321
// Cleanup the viewport.
322
if (sub_viewport_node) {
323
if (sub_viewport_node->get_parent()) {
324
sub_viewport_node->get_parent()->remove_child(sub_viewport_node);
325
}
326
sub_viewport_node->queue_free();
327
sub_viewport_node = nullptr;
328
}
329
330
// Now generate the cache image.
331
Ref<Image> img = texture->get_image();
332
if (img.is_valid() && img->get_width() > 0 && img->get_height() > 0) {
333
img = img->duplicate();
334
335
int preview_size = EDITOR_GET("filesystem/file_dialog/thumbnail_size");
336
preview_size *= EDSCALE;
337
338
int vp_size = MIN(img->get_width(), img->get_height());
339
int x = (img->get_width() - vp_size) / 2;
340
int y = (img->get_height() - vp_size) / 2;
341
342
if (vp_size < preview_size) {
343
img->crop_from_point(x, y, vp_size, vp_size);
344
} else {
345
int ratio = vp_size / preview_size;
346
int size = preview_size * MAX(1, ratio / 2);
347
348
x = (img->get_width() - size) / 2;
349
y = (img->get_height() - size) / 2;
350
351
img->crop_from_point(x, y, size, size);
352
img->resize(preview_size, preview_size, Image::INTERPOLATE_LANCZOS);
353
}
354
img->convert(Image::FORMAT_RGB8);
355
356
String temp_path = EditorPaths::get_singleton()->get_cache_dir();
357
String cache_base = ProjectSettings::get_singleton()->globalize_path(p_path).md5_text();
358
cache_base = temp_path.path_join("resthumb-" + cache_base);
359
360
post_process_preview(img);
361
img->save_png(cache_base + ".png");
362
}
363
364
EditorResourcePreview::get_singleton()->check_for_invalidation(p_path);
365
EditorFileSystem::get_singleton()->emit_signal(SNAME("filesystem_changed"));
366
}
367
368
void EditorInterface::add_root_node(Node *p_node) {
369
if (EditorNode::get_singleton()->get_edited_scene()) {
370
ERR_PRINT("EditorInterface::add_root_node: The current scene already has a root node.");
371
return;
372
}
373
374
const String &scene_path = p_node->get_scene_file_path();
375
if (!scene_path.is_empty()) {
376
Ref<PackedScene> scene = ResourceLoader::load(scene_path);
377
if (scene.is_valid()) {
378
memfree(scene->instantiate(PackedScene::GEN_EDIT_STATE_INSTANCE)); // Ensure node cache.
379
380
p_node->set_scene_inherited_state(scene->get_state());
381
p_node->set_scene_file_path(String());
382
}
383
}
384
385
EditorNode::get_singleton()->set_edited_scene(p_node);
386
EditorUndoRedoManager::get_singleton()->set_history_as_unsaved(EditorNode::get_editor_data().get_current_edited_scene_history_id());
387
EditorSceneTabs::get_singleton()->update_scene_tabs();
388
}
389
390
void EditorInterface::set_plugin_enabled(const String &p_plugin, bool p_enabled) {
391
EditorNode::get_singleton()->set_addon_plugin_enabled(p_plugin, p_enabled, true);
392
}
393
394
bool EditorInterface::is_plugin_enabled(const String &p_plugin) const {
395
return EditorNode::get_singleton()->is_addon_plugin_enabled(p_plugin);
396
}
397
398
// Editor GUI.
399
400
Ref<Theme> EditorInterface::get_editor_theme() const {
401
return EditorNode::get_singleton()->get_editor_theme();
402
}
403
404
Control *EditorInterface::get_base_control() const {
405
return EditorNode::get_singleton()->get_gui_base();
406
}
407
408
VBoxContainer *EditorInterface::get_editor_main_screen() const {
409
return EditorNode::get_singleton()->get_editor_main_screen()->get_control();
410
}
411
412
ScriptEditor *EditorInterface::get_script_editor() const {
413
return ScriptEditor::get_singleton();
414
}
415
416
SubViewport *EditorInterface::get_editor_viewport_2d() const {
417
return EditorNode::get_singleton()->get_scene_root();
418
}
419
420
SubViewport *EditorInterface::get_editor_viewport_3d(int p_idx) const {
421
ERR_FAIL_INDEX_V(p_idx, static_cast<int>(Node3DEditor::VIEWPORTS_COUNT), nullptr);
422
return Node3DEditor::get_singleton()->get_editor_viewport(p_idx)->get_viewport_node();
423
}
424
425
void EditorInterface::set_main_screen_editor(const String &p_name) {
426
EditorNode::get_singleton()->get_editor_main_screen()->select_by_name(p_name);
427
}
428
429
void EditorInterface::set_distraction_free_mode(bool p_enter) {
430
EditorNode::get_singleton()->set_distraction_free_mode(p_enter);
431
}
432
433
bool EditorInterface::is_distraction_free_mode_enabled() const {
434
return EditorNode::get_singleton()->is_distraction_free_mode_enabled();
435
}
436
437
bool EditorInterface::is_multi_window_enabled() const {
438
return EditorNode::get_singleton()->is_multi_window_enabled();
439
}
440
441
float EditorInterface::get_editor_scale() const {
442
return EDSCALE;
443
}
444
445
String EditorInterface::get_editor_language() const {
446
return EditorSettings::get_singleton()->get_language();
447
}
448
449
bool EditorInterface::is_node_3d_snap_enabled() const {
450
return Node3DEditor::get_singleton()->is_snap_enabled();
451
}
452
453
real_t EditorInterface::get_node_3d_translate_snap() const {
454
return Node3DEditor::get_singleton()->get_translate_snap();
455
}
456
457
real_t EditorInterface::get_node_3d_rotate_snap() const {
458
return Node3DEditor::get_singleton()->get_rotate_snap();
459
}
460
461
real_t EditorInterface::get_node_3d_scale_snap() const {
462
return Node3DEditor::get_singleton()->get_scale_snap();
463
}
464
465
void EditorInterface::popup_dialog(Window *p_dialog, const Rect2i &p_screen_rect) {
466
p_dialog->popup_exclusive(EditorNode::get_singleton(), p_screen_rect);
467
}
468
469
void EditorInterface::popup_dialog_centered(Window *p_dialog, const Size2i &p_minsize) {
470
p_dialog->popup_exclusive_centered(EditorNode::get_singleton(), p_minsize);
471
}
472
473
void EditorInterface::popup_dialog_centered_ratio(Window *p_dialog, float p_ratio) {
474
p_dialog->popup_exclusive_centered_ratio(EditorNode::get_singleton(), p_ratio);
475
}
476
477
void EditorInterface::popup_dialog_centered_clamped(Window *p_dialog, const Size2i &p_size, float p_fallback_ratio) {
478
p_dialog->popup_exclusive_centered_clamped(EditorNode::get_singleton(), p_size, p_fallback_ratio);
479
}
480
481
String EditorInterface::get_current_feature_profile() const {
482
return EditorFeatureProfileManager::get_singleton()->get_current_profile_name();
483
}
484
485
void EditorInterface::set_current_feature_profile(const String &p_profile_name) {
486
EditorFeatureProfileManager::get_singleton()->set_current_profile(p_profile_name, true);
487
}
488
489
// Editor dialogs.
490
491
void EditorInterface::popup_node_selector(const Callable &p_callback, const TypedArray<StringName> &p_valid_types, Node *p_current_value) {
492
if (!node_selector) {
493
node_selector = memnew(SceneTreeDialog);
494
get_base_control()->add_child(node_selector);
495
}
496
497
Vector<StringName> valid_types;
498
int length = p_valid_types.size();
499
valid_types.resize(length);
500
for (int i = 0; i < length; i++) {
501
valid_types.write[i] = p_valid_types[i];
502
}
503
node_selector->set_valid_types(valid_types);
504
node_selector->popup_scenetree_dialog(p_current_value);
505
506
const Callable callback = callable_mp(this, &EditorInterface::_node_selected);
507
node_selector->connect(SNAME("selected"), callback.bind(p_callback), CONNECT_DEFERRED);
508
node_selector->connect(SNAME("canceled"), callback.bind(NodePath(), p_callback), CONNECT_DEFERRED);
509
}
510
511
void EditorInterface::popup_property_selector(Object *p_object, const Callable &p_callback, const PackedInt32Array &p_type_filter, const String &p_current_value) {
512
if (!property_selector) {
513
property_selector = memnew(PropertySelector);
514
get_base_control()->add_child(property_selector);
515
}
516
517
Vector<Variant::Type> type_filter;
518
int length = p_type_filter.size();
519
type_filter.resize(length);
520
for (int i = 0; i < length; i++) {
521
type_filter.write[i] = (Variant::Type)p_type_filter[i];
522
}
523
property_selector->set_type_filter(type_filter);
524
property_selector->select_property_from_instance(p_object, p_current_value);
525
526
const Callable callback = callable_mp(this, &EditorInterface::_property_selected);
527
property_selector->connect(SNAME("selected"), callback.bind(p_callback), CONNECT_DEFERRED);
528
property_selector->connect(SNAME("canceled"), callback.bind(String(), p_callback), CONNECT_DEFERRED);
529
}
530
531
void EditorInterface::popup_method_selector(Object *p_object, const Callable &p_callback, const String &p_current_value) {
532
if (!method_selector) {
533
method_selector = memnew(PropertySelector);
534
get_base_control()->add_child(method_selector);
535
}
536
537
method_selector->select_method_from_instance(p_object, p_current_value);
538
539
const Callable callback = callable_mp(this, &EditorInterface::_method_selected);
540
method_selector->connect(SNAME("selected"), callback.bind(p_callback), CONNECT_DEFERRED);
541
method_selector->connect(SNAME("canceled"), callback.bind(String(), p_callback), CONNECT_DEFERRED);
542
}
543
544
void EditorInterface::popup_quick_open(const Callable &p_callback, const TypedArray<StringName> &p_base_types) {
545
StringName required_type = SNAME("Resource");
546
Vector<StringName> base_types;
547
if (p_base_types.is_empty()) {
548
base_types.append(required_type);
549
} else {
550
for (int i = 0; i < p_base_types.size(); i++) {
551
StringName type = p_base_types[i];
552
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.");
553
base_types.append(type);
554
}
555
}
556
557
EditorQuickOpenDialog *quick_open = EditorNode::get_singleton()->get_quick_open_dialog();
558
quick_open->connect(SNAME("canceled"), callable_mp(this, &EditorInterface::_quick_open).bind(String(), p_callback));
559
quick_open->popup_dialog(base_types, callable_mp(this, &EditorInterface::_quick_open).bind(p_callback));
560
}
561
562
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) {
563
if (!create_dialog) {
564
create_dialog = memnew(CreateDialog);
565
get_base_control()->add_child(create_dialog);
566
}
567
568
HashSet<StringName> blocklist;
569
for (const Variant &E : p_custom_type_blocklist) {
570
blocklist.insert(E);
571
}
572
create_dialog->set_type_blocklist(blocklist);
573
574
String safe_base_type = p_base_type;
575
if (p_base_type.is_empty() || (!ClassDB::class_exists(p_base_type) && !ScriptServer::is_global_class(p_base_type))) {
576
ERR_PRINT(vformat("Invalid base type '%s'. The base type has fallen back to 'Object'.", p_base_type));
577
safe_base_type = "Object";
578
}
579
580
create_dialog->set_base_type(safe_base_type);
581
create_dialog->popup_create(false, true, p_current_type, "");
582
create_dialog->set_title(p_dialog_title.is_empty() ? vformat(TTR("Create New %s"), p_base_type) : p_dialog_title);
583
584
const Callable callback = callable_mp(this, &EditorInterface::_create_dialog_item_selected);
585
create_dialog->connect(SNAME("create"), callback.bind(false, p_callback), CONNECT_DEFERRED);
586
create_dialog->connect(SNAME("canceled"), callback.bind(true, p_callback), CONNECT_DEFERRED);
587
}
588
589
void EditorInterface::_node_selected(const NodePath &p_node_path, const Callable &p_callback) {
590
const Callable callback = callable_mp(this, &EditorInterface::_node_selected);
591
node_selector->disconnect(SNAME("selected"), callback);
592
node_selector->disconnect(SNAME("canceled"), callback);
593
594
if (p_node_path.is_empty()) {
595
_call_dialog_callback(p_callback, NodePath(), "node selection canceled");
596
} else {
597
const NodePath path = get_edited_scene_root()->get_path().rel_path_to(p_node_path);
598
_call_dialog_callback(p_callback, path, "node selected");
599
}
600
}
601
602
void EditorInterface::_property_selected(const String &p_property_name, const Callable &p_callback) {
603
const Callable callback = callable_mp(this, &EditorInterface::_property_selected);
604
property_selector->disconnect(SNAME("selected"), callback);
605
property_selector->disconnect(SNAME("canceled"), callback);
606
607
if (p_property_name.is_empty()) {
608
_call_dialog_callback(p_callback, NodePath(p_property_name).get_as_property_path(), "property selection canceled");
609
} else {
610
_call_dialog_callback(p_callback, NodePath(p_property_name).get_as_property_path(), "property selected");
611
}
612
}
613
614
void EditorInterface::_method_selected(const String &p_method_name, const Callable &p_callback) {
615
const Callable callback = callable_mp(this, &EditorInterface::_method_selected);
616
method_selector->disconnect(SNAME("selected"), callback);
617
method_selector->disconnect(SNAME("canceled"), callback);
618
619
if (p_method_name.is_empty()) {
620
_call_dialog_callback(p_callback, p_method_name, "method selection canceled");
621
} else {
622
_call_dialog_callback(p_callback, p_method_name, "method selected");
623
}
624
}
625
626
void EditorInterface::_quick_open(const String &p_file_path, const Callable &p_callback) {
627
EditorQuickOpenDialog *quick_open = EditorNode::get_singleton()->get_quick_open_dialog();
628
quick_open->disconnect(SNAME("canceled"), callable_mp(this, &EditorInterface::_quick_open));
629
_call_dialog_callback(p_callback, p_file_path, "quick open");
630
}
631
632
void EditorInterface::_create_dialog_item_selected(bool p_is_canceled, const Callable &p_callback) {
633
const Callable callback = callable_mp(this, &EditorInterface::_create_dialog_item_selected);
634
create_dialog->disconnect(SNAME("create"), callback);
635
create_dialog->disconnect(SNAME("canceled"), callback);
636
_call_dialog_callback(p_callback, p_is_canceled ? "" : create_dialog->get_selected_type(), "create dialog");
637
}
638
639
void EditorInterface::_call_dialog_callback(const Callable &p_callback, const Variant &p_selected, const String &p_context) {
640
Callable::CallError ce;
641
Variant ret;
642
const Variant *args[1] = { &p_selected };
643
p_callback.callp(args, 1, ret, ce);
644
if (ce.error != Callable::CallError::CALL_OK) {
645
ERR_PRINT(vformat("Error calling %s callback: %s", p_context, Variant::get_callable_error_text(p_callback, args, 1, ce)));
646
}
647
}
648
649
// Editor docks.
650
651
FileSystemDock *EditorInterface::get_file_system_dock() const {
652
return FileSystemDock::get_singleton();
653
}
654
655
void EditorInterface::select_file(const String &p_file) {
656
FileSystemDock::get_singleton()->select_file(p_file);
657
}
658
659
Vector<String> EditorInterface::get_selected_paths() const {
660
return FileSystemDock::get_singleton()->get_selected_paths();
661
}
662
663
String EditorInterface::get_current_path() const {
664
return FileSystemDock::get_singleton()->get_current_path();
665
}
666
667
String EditorInterface::get_current_directory() const {
668
return FileSystemDock::get_singleton()->get_current_directory();
669
}
670
671
EditorInspector *EditorInterface::get_inspector() const {
672
return InspectorDock::get_inspector_singleton();
673
}
674
675
// Object/Resource/Node editing.
676
677
void EditorInterface::inspect_object(Object *p_obj, const String &p_for_property, bool p_inspector_only) {
678
EditorNode::get_singleton()->push_item(p_obj, p_for_property, p_inspector_only);
679
}
680
681
void EditorInterface::edit_resource(const Ref<Resource> &p_resource) {
682
EditorNode::get_singleton()->edit_resource(p_resource);
683
}
684
685
void EditorInterface::edit_node(Node *p_node) {
686
EditorNode::get_singleton()->edit_node(p_node);
687
}
688
689
void EditorInterface::edit_script(const Ref<Script> &p_script, int p_line, int p_col, bool p_grab_focus) {
690
ScriptEditor::get_singleton()->edit(p_script, p_line - 1, p_col - 1, p_grab_focus);
691
}
692
693
void EditorInterface::open_scene_from_path(const String &scene_path, bool p_set_inherited) {
694
if (EditorNode::get_singleton()->is_changing_scene()) {
695
return;
696
}
697
EditorNode::get_singleton()->load_scene(scene_path, false, p_set_inherited);
698
}
699
700
void EditorInterface::reload_scene_from_path(const String &scene_path) {
701
if (EditorNode::get_singleton()->is_changing_scene()) {
702
return;
703
}
704
705
EditorNode::get_singleton()->reload_scene(scene_path);
706
}
707
708
void EditorInterface::set_object_edited(Object *p_object, bool p_edited) {
709
ERR_FAIL_NULL_MSG(p_object, "Cannot change edited status on a null object.");
710
p_object->set_edited(p_edited);
711
}
712
713
bool EditorInterface::is_object_edited(Object *p_object) const {
714
ERR_FAIL_NULL_V_MSG(p_object, false, "Cannot check edit status on a null object.");
715
return p_object->is_edited();
716
}
717
718
Node *EditorInterface::get_edited_scene_root() const {
719
return EditorNode::get_singleton()->get_edited_scene();
720
}
721
722
PackedStringArray EditorInterface::get_open_scenes() const {
723
PackedStringArray ret;
724
Vector<EditorData::EditedScene> scenes = EditorNode::get_editor_data().get_edited_scenes();
725
726
for (EditorData::EditedScene &edited_scene : scenes) {
727
if (edited_scene.root == nullptr) {
728
continue;
729
}
730
ret.push_back(edited_scene.root->get_scene_file_path());
731
}
732
return ret;
733
}
734
735
TypedArray<Node> EditorInterface::get_open_scene_roots() const {
736
TypedArray<Node> ret;
737
Vector<EditorData::EditedScene> scenes = EditorNode::get_editor_data().get_edited_scenes();
738
739
for (EditorData::EditedScene &edited_scene : scenes) {
740
if (edited_scene.root == nullptr) {
741
continue;
742
}
743
ret.push_back(edited_scene.root);
744
}
745
return ret;
746
}
747
748
Error EditorInterface::save_scene() {
749
if (!get_edited_scene_root()) {
750
return ERR_CANT_CREATE;
751
}
752
if (get_edited_scene_root()->get_scene_file_path().is_empty()) {
753
return ERR_CANT_CREATE;
754
}
755
756
save_scene_as(get_edited_scene_root()->get_scene_file_path());
757
return OK;
758
}
759
760
void EditorInterface::save_scene_as(const String &p_scene, bool p_with_preview) {
761
EditorNode::get_singleton()->save_scene_to_path(p_scene, p_with_preview);
762
}
763
764
void EditorInterface::mark_scene_as_unsaved() {
765
EditorUndoRedoManager::get_singleton()->set_history_as_unsaved(EditorNode::get_editor_data().get_current_edited_scene_history_id());
766
EditorSceneTabs::get_singleton()->update_scene_tabs();
767
}
768
769
void EditorInterface::save_all_scenes() {
770
EditorNode::get_singleton()->save_all_scenes();
771
}
772
773
Error EditorInterface::close_scene() {
774
return EditorNode::get_singleton()->close_scene() ? OK : ERR_DOES_NOT_EXIST;
775
}
776
777
// Scene playback.
778
779
void EditorInterface::play_main_scene() {
780
EditorRunBar::get_singleton()->play_main_scene();
781
}
782
783
void EditorInterface::play_current_scene() {
784
EditorRunBar::get_singleton()->play_current_scene();
785
}
786
787
void EditorInterface::play_custom_scene(const String &scene_path) {
788
EditorRunBar::get_singleton()->play_custom_scene(scene_path);
789
}
790
791
void EditorInterface::stop_playing_scene() {
792
EditorRunBar::get_singleton()->stop_playing();
793
}
794
795
bool EditorInterface::is_playing_scene() const {
796
return EditorRunBar::get_singleton()->is_playing();
797
}
798
799
String EditorInterface::get_playing_scene() const {
800
return EditorRunBar::get_singleton()->get_playing_scene();
801
}
802
803
void EditorInterface::set_movie_maker_enabled(bool p_enabled) {
804
EditorRunBar::get_singleton()->set_movie_maker_enabled(p_enabled);
805
}
806
807
bool EditorInterface::is_movie_maker_enabled() const {
808
return EditorRunBar::get_singleton()->is_movie_maker_enabled();
809
}
810
811
void EditorInterface::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
812
const String pf = p_function;
813
if (p_idx == 0) {
814
if (pf == "set_main_screen_editor") {
815
for (String E : { "\"2D\"", "\"3D\"", "\"Script\"", "\"Game\"", "\"AssetLib\"" }) {
816
r_options->push_back(E);
817
}
818
} else if (pf == "get_editor_viewport_3d") {
819
for (uint32_t i = 0; i < Node3DEditor::VIEWPORTS_COUNT; i++) {
820
r_options->push_back(String::num_int64(i));
821
}
822
}
823
}
824
Object::get_argument_options(p_function, p_idx, r_options);
825
}
826
827
// Base.
828
829
void EditorInterface::_bind_methods() {
830
ClassDB::bind_method(D_METHOD("restart_editor", "save"), &EditorInterface::restart_editor, DEFVAL(true));
831
832
// Editor tools.
833
834
ClassDB::bind_method(D_METHOD("get_command_palette"), &EditorInterface::get_command_palette);
835
ClassDB::bind_method(D_METHOD("get_resource_filesystem"), &EditorInterface::get_resource_filesystem);
836
ClassDB::bind_method(D_METHOD("get_editor_paths"), &EditorInterface::get_editor_paths);
837
ClassDB::bind_method(D_METHOD("get_resource_previewer"), &EditorInterface::get_resource_previewer);
838
ClassDB::bind_method(D_METHOD("get_selection"), &EditorInterface::get_selection);
839
ClassDB::bind_method(D_METHOD("get_editor_settings"), &EditorInterface::get_editor_settings);
840
ClassDB::bind_method(D_METHOD("get_editor_toaster"), &EditorInterface::get_editor_toaster);
841
ClassDB::bind_method(D_METHOD("get_editor_undo_redo"), &EditorInterface::get_editor_undo_redo);
842
843
ClassDB::bind_method(D_METHOD("make_mesh_previews", "meshes", "preview_size"), &EditorInterface::_make_mesh_previews);
844
845
ClassDB::bind_method(D_METHOD("set_plugin_enabled", "plugin", "enabled"), &EditorInterface::set_plugin_enabled);
846
ClassDB::bind_method(D_METHOD("is_plugin_enabled", "plugin"), &EditorInterface::is_plugin_enabled);
847
848
// Editor GUI.
849
850
ClassDB::bind_method(D_METHOD("get_editor_theme"), &EditorInterface::get_editor_theme);
851
ClassDB::bind_method(D_METHOD("get_base_control"), &EditorInterface::get_base_control);
852
ClassDB::bind_method(D_METHOD("get_editor_main_screen"), &EditorInterface::get_editor_main_screen);
853
ClassDB::bind_method(D_METHOD("get_script_editor"), &EditorInterface::get_script_editor);
854
ClassDB::bind_method(D_METHOD("get_editor_viewport_2d"), &EditorInterface::get_editor_viewport_2d);
855
ClassDB::bind_method(D_METHOD("get_editor_viewport_3d", "idx"), &EditorInterface::get_editor_viewport_3d, DEFVAL(0));
856
857
ClassDB::bind_method(D_METHOD("set_main_screen_editor", "name"), &EditorInterface::set_main_screen_editor);
858
ClassDB::bind_method(D_METHOD("set_distraction_free_mode", "enter"), &EditorInterface::set_distraction_free_mode);
859
ClassDB::bind_method(D_METHOD("is_distraction_free_mode_enabled"), &EditorInterface::is_distraction_free_mode_enabled);
860
ClassDB::bind_method(D_METHOD("is_multi_window_enabled"), &EditorInterface::is_multi_window_enabled);
861
862
ClassDB::bind_method(D_METHOD("get_editor_scale"), &EditorInterface::get_editor_scale);
863
ClassDB::bind_method(D_METHOD("get_editor_language"), &EditorInterface::get_editor_language);
864
865
ClassDB::bind_method(D_METHOD("is_node_3d_snap_enabled"), &EditorInterface::is_node_3d_snap_enabled);
866
ClassDB::bind_method(D_METHOD("get_node_3d_translate_snap"), &EditorInterface::get_node_3d_translate_snap);
867
ClassDB::bind_method(D_METHOD("get_node_3d_rotate_snap"), &EditorInterface::get_node_3d_rotate_snap);
868
ClassDB::bind_method(D_METHOD("get_node_3d_scale_snap"), &EditorInterface::get_node_3d_scale_snap);
869
870
ClassDB::bind_method(D_METHOD("popup_dialog", "dialog", "rect"), &EditorInterface::popup_dialog, DEFVAL(Rect2i()));
871
ClassDB::bind_method(D_METHOD("popup_dialog_centered", "dialog", "minsize"), &EditorInterface::popup_dialog_centered, DEFVAL(Size2i()));
872
ClassDB::bind_method(D_METHOD("popup_dialog_centered_ratio", "dialog", "ratio"), &EditorInterface::popup_dialog_centered_ratio, DEFVAL(0.8));
873
ClassDB::bind_method(D_METHOD("popup_dialog_centered_clamped", "dialog", "minsize", "fallback_ratio"), &EditorInterface::popup_dialog_centered_clamped, DEFVAL(Size2i()), DEFVAL(0.75));
874
875
ClassDB::bind_method(D_METHOD("get_current_feature_profile"), &EditorInterface::get_current_feature_profile);
876
ClassDB::bind_method(D_METHOD("set_current_feature_profile", "profile_name"), &EditorInterface::set_current_feature_profile);
877
878
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "distraction_free_mode"), "set_distraction_free_mode", "is_distraction_free_mode_enabled");
879
880
// Editor dialogs.
881
882
ClassDB::bind_method(D_METHOD("popup_node_selector", "callback", "valid_types", "current_value"), &EditorInterface::popup_node_selector, DEFVAL(TypedArray<StringName>()), DEFVAL(Variant()));
883
ClassDB::bind_method(D_METHOD("popup_property_selector", "object", "callback", "type_filter", "current_value"), &EditorInterface::popup_property_selector, DEFVAL(PackedInt32Array()), DEFVAL(String()));
884
ClassDB::bind_method(D_METHOD("popup_method_selector", "object", "callback", "current_value"), &EditorInterface::popup_method_selector, DEFVAL(String()));
885
ClassDB::bind_method(D_METHOD("popup_quick_open", "callback", "base_types"), &EditorInterface::popup_quick_open, DEFVAL(TypedArray<StringName>()));
886
ClassDB::bind_method(D_METHOD("popup_create_dialog", "callback", "base_type", "current_type", "dialog_title", "type_blocklist"), &EditorInterface::popup_create_dialog, DEFVAL(""), DEFVAL(""), DEFVAL(""), DEFVAL(TypedArray<StringName>()));
887
888
// Editor docks.
889
890
ClassDB::bind_method(D_METHOD("get_file_system_dock"), &EditorInterface::get_file_system_dock);
891
ClassDB::bind_method(D_METHOD("select_file", "file"), &EditorInterface::select_file);
892
ClassDB::bind_method(D_METHOD("get_selected_paths"), &EditorInterface::get_selected_paths);
893
ClassDB::bind_method(D_METHOD("get_current_path"), &EditorInterface::get_current_path);
894
ClassDB::bind_method(D_METHOD("get_current_directory"), &EditorInterface::get_current_directory);
895
896
ClassDB::bind_method(D_METHOD("get_inspector"), &EditorInterface::get_inspector);
897
898
// Object/Resource/Node editing.
899
900
ClassDB::bind_method(D_METHOD("inspect_object", "object", "for_property", "inspector_only"), &EditorInterface::inspect_object, DEFVAL(String()), DEFVAL(false));
901
902
ClassDB::bind_method(D_METHOD("edit_resource", "resource"), &EditorInterface::edit_resource);
903
ClassDB::bind_method(D_METHOD("edit_node", "node"), &EditorInterface::edit_node);
904
ClassDB::bind_method(D_METHOD("edit_script", "script", "line", "column", "grab_focus"), &EditorInterface::edit_script, DEFVAL(-1), DEFVAL(0), DEFVAL(true));
905
ClassDB::bind_method(D_METHOD("open_scene_from_path", "scene_filepath", "set_inherited"), &EditorInterface::open_scene_from_path, DEFVAL(false));
906
ClassDB::bind_method(D_METHOD("reload_scene_from_path", "scene_filepath"), &EditorInterface::reload_scene_from_path);
907
908
ClassDB::bind_method(D_METHOD("set_object_edited", "object", "edited"), &EditorInterface::set_object_edited);
909
ClassDB::bind_method(D_METHOD("is_object_edited", "object"), &EditorInterface::is_object_edited);
910
911
ClassDB::bind_method(D_METHOD("get_open_scenes"), &EditorInterface::get_open_scenes);
912
ClassDB::bind_method(D_METHOD("get_open_scene_roots"), &EditorInterface::get_open_scene_roots);
913
ClassDB::bind_method(D_METHOD("get_edited_scene_root"), &EditorInterface::get_edited_scene_root);
914
915
ClassDB::bind_method(D_METHOD("add_root_node", "node"), &EditorInterface::add_root_node);
916
917
ClassDB::bind_method(D_METHOD("save_scene"), &EditorInterface::save_scene);
918
ClassDB::bind_method(D_METHOD("save_scene_as", "path", "with_preview"), &EditorInterface::save_scene_as, DEFVAL(true));
919
ClassDB::bind_method(D_METHOD("save_all_scenes"), &EditorInterface::save_all_scenes);
920
ClassDB::bind_method(D_METHOD("close_scene"), &EditorInterface::close_scene);
921
922
ClassDB::bind_method(D_METHOD("mark_scene_as_unsaved"), &EditorInterface::mark_scene_as_unsaved);
923
924
// Scene playback.
925
926
ClassDB::bind_method(D_METHOD("play_main_scene"), &EditorInterface::play_main_scene);
927
ClassDB::bind_method(D_METHOD("play_current_scene"), &EditorInterface::play_current_scene);
928
ClassDB::bind_method(D_METHOD("play_custom_scene", "scene_filepath"), &EditorInterface::play_custom_scene);
929
ClassDB::bind_method(D_METHOD("stop_playing_scene"), &EditorInterface::stop_playing_scene);
930
ClassDB::bind_method(D_METHOD("is_playing_scene"), &EditorInterface::is_playing_scene);
931
ClassDB::bind_method(D_METHOD("get_playing_scene"), &EditorInterface::get_playing_scene);
932
933
ClassDB::bind_method(D_METHOD("set_movie_maker_enabled", "enabled"), &EditorInterface::set_movie_maker_enabled);
934
ClassDB::bind_method(D_METHOD("is_movie_maker_enabled"), &EditorInterface::is_movie_maker_enabled);
935
936
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "movie_maker_enabled"), "set_movie_maker_enabled", "is_movie_maker_enabled");
937
}
938
939
void EditorInterface::create() {
940
memnew(EditorInterface);
941
}
942
943
void EditorInterface::free() {
944
ERR_FAIL_NULL(singleton);
945
memdelete(singleton);
946
}
947
948
EditorInterface::EditorInterface() {
949
ERR_FAIL_COND(singleton != nullptr);
950
singleton = this;
951
}
952
953