2023-04-05 15:14:46 +00:00
/**************************************************************************/
/* editor_interface.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 "editor_interface.h"
2024-09-01 23:18:54 +00:00
# include "editor_interface.compat.inc"
2023-04-05 15:14:46 +00:00
# include "editor/editor_command_palette.h"
2023-03-04 19:27:56 +00:00
# include "editor/editor_feature_profile.h"
2024-08-19 22:08:31 +00:00
# include "editor/editor_main_screen.h"
2023-04-05 15:14:46 +00:00
# include "editor/editor_node.h"
# include "editor/editor_paths.h"
# include "editor/editor_resource_preview.h"
# include "editor/editor_settings.h"
2023-06-07 11:44:37 +00:00
# include "editor/editor_undo_redo_manager.h"
2023-04-05 15:14:46 +00:00
# include "editor/filesystem_dock.h"
2024-09-30 03:48:08 +00:00
# include "editor/gui/editor_quick_open_dialog.h"
2023-04-12 19:02:28 +00:00
# include "editor/gui/editor_run_bar.h"
2024-04-02 14:17:14 +00:00
# include "editor/gui/editor_scene_tabs.h"
2024-10-30 19:33:40 +00:00
# include "editor/gui/editor_toaster.h"
2023-09-13 20:03:13 +00:00
# include "editor/gui/scene_tree_editor.h"
2023-04-05 15:14:46 +00:00
# include "editor/inspector_dock.h"
2023-08-13 18:57:23 +00:00
# include "editor/plugins/node_3d_editor_plugin.h"
2023-09-13 20:03:13 +00:00
# include "editor/property_selector.h"
2024-01-15 12:14:55 +00:00
# include "editor/themes/editor_scale.h"
2023-04-05 15:14:46 +00:00
# include "main/main.h"
# include "scene/gui/box_container.h"
# include "scene/gui/control.h"
2023-04-20 13:13:21 +00:00
# include "scene/main/window.h"
2023-09-13 11:14:07 +00:00
# include "scene/resources/theme.h"
2023-04-05 15:14:46 +00:00
EditorInterface * EditorInterface : : singleton = nullptr ;
void EditorInterface : : restart_editor ( bool p_save ) {
if ( p_save ) {
EditorNode : : get_singleton ( ) - > save_all_scenes ( ) ;
}
EditorNode : : get_singleton ( ) - > restart_editor ( ) ;
}
// Editor tools.
EditorCommandPalette * EditorInterface : : get_command_palette ( ) const {
return EditorCommandPalette : : get_singleton ( ) ;
}
EditorFileSystem * EditorInterface : : get_resource_file_system ( ) const {
return EditorFileSystem : : get_singleton ( ) ;
}
EditorPaths * EditorInterface : : get_editor_paths ( ) const {
return EditorPaths : : get_singleton ( ) ;
}
EditorResourcePreview * EditorInterface : : get_resource_previewer ( ) const {
return EditorResourcePreview : : get_singleton ( ) ;
}
EditorSelection * EditorInterface : : get_selection ( ) const {
return EditorNode : : get_singleton ( ) - > get_editor_selection ( ) ;
}
Ref < EditorSettings > EditorInterface : : get_editor_settings ( ) const {
return EditorSettings : : get_singleton ( ) ;
}
2024-10-30 19:33:40 +00:00
EditorToaster * EditorInterface : : get_editor_toaster ( ) const {
return EditorToaster : : get_singleton ( ) ;
}
2024-04-02 11:33:12 +00:00
EditorUndoRedoManager * EditorInterface : : get_editor_undo_redo ( ) const {
return EditorUndoRedoManager : : get_singleton ( ) ;
}
2023-04-05 15:14:46 +00:00
TypedArray < Texture2D > EditorInterface : : _make_mesh_previews ( const TypedArray < Mesh > & p_meshes , int p_preview_size ) {
Vector < Ref < Mesh > > meshes ;
for ( int i = 0 ; i < p_meshes . size ( ) ; i + + ) {
meshes . push_back ( p_meshes [ i ] ) ;
}
Vector < Ref < Texture2D > > textures = make_mesh_previews ( meshes , nullptr , p_preview_size ) ;
TypedArray < Texture2D > ret ;
for ( int i = 0 ; i < textures . size ( ) ; i + + ) {
ret . push_back ( textures [ i ] ) ;
}
return ret ;
}
Vector < Ref < Texture2D > > EditorInterface : : make_mesh_previews ( const Vector < Ref < Mesh > > & p_meshes , Vector < Transform3D > * p_transforms , int p_preview_size ) {
int size = p_preview_size ;
RID scenario = RS : : get_singleton ( ) - > scenario_create ( ) ;
RID viewport = RS : : get_singleton ( ) - > viewport_create ( ) ;
RS : : get_singleton ( ) - > viewport_set_update_mode ( viewport , RS : : VIEWPORT_UPDATE_ALWAYS ) ;
RS : : get_singleton ( ) - > viewport_set_scenario ( viewport , scenario ) ;
RS : : get_singleton ( ) - > viewport_set_size ( viewport , size , size ) ;
RS : : get_singleton ( ) - > viewport_set_transparent_background ( viewport , true ) ;
RS : : get_singleton ( ) - > viewport_set_active ( viewport , true ) ;
RID viewport_texture = RS : : get_singleton ( ) - > viewport_get_texture ( viewport ) ;
RID camera = RS : : get_singleton ( ) - > camera_create ( ) ;
RS : : get_singleton ( ) - > viewport_attach_camera ( viewport , camera ) ;
RID light = RS : : get_singleton ( ) - > directional_light_create ( ) ;
RID light_instance = RS : : get_singleton ( ) - > instance_create2 ( light , scenario ) ;
RID light2 = RS : : get_singleton ( ) - > directional_light_create ( ) ;
RS : : get_singleton ( ) - > light_set_color ( light2 , Color ( 0.7 , 0.7 , 0.7 ) ) ;
RID light_instance2 = RS : : get_singleton ( ) - > instance_create2 ( light2 , scenario ) ;
EditorProgress ep ( " mlib " , TTR ( " Creating Mesh Previews " ) , p_meshes . size ( ) ) ;
Vector < Ref < Texture2D > > textures ;
for ( int i = 0 ; i < p_meshes . size ( ) ; i + + ) {
2023-11-18 22:40:56 +00:00
const Ref < Mesh > & mesh = p_meshes [ i ] ;
2023-04-05 15:14:46 +00:00
if ( ! mesh . is_valid ( ) ) {
textures . push_back ( Ref < Texture2D > ( ) ) ;
continue ;
}
Transform3D mesh_xform ;
if ( p_transforms ! = nullptr ) {
mesh_xform = ( * p_transforms ) [ i ] ;
}
RID inst = RS : : get_singleton ( ) - > instance_create2 ( mesh - > get_rid ( ) , scenario ) ;
RS : : get_singleton ( ) - > instance_set_transform ( inst , mesh_xform ) ;
AABB aabb = mesh - > get_aabb ( ) ;
Vector3 ofs = aabb . get_center ( ) ;
aabb . position - = ofs ;
Transform3D xform ;
xform . basis = Basis ( ) . rotated ( Vector3 ( 0 , 1 , 0 ) , - Math_PI / 6 ) ;
xform . basis = Basis ( ) . rotated ( Vector3 ( 1 , 0 , 0 ) , Math_PI / 6 ) * xform . basis ;
AABB rot_aabb = xform . xform ( aabb ) ;
float m = MAX ( rot_aabb . size . x , rot_aabb . size . y ) * 0.5 ;
if ( m = = 0 ) {
textures . push_back ( Ref < Texture2D > ( ) ) ;
continue ;
}
xform . origin = - xform . basis . xform ( ofs ) ; //-ofs*m;
xform . origin . z - = rot_aabb . size . z * 2 ;
xform . invert ( ) ;
xform = mesh_xform * xform ;
RS : : get_singleton ( ) - > camera_set_transform ( camera , xform * Transform3D ( Basis ( ) , Vector3 ( 0 , 0 , 3 ) ) ) ;
RS : : get_singleton ( ) - > camera_set_orthogonal ( camera , m * 2 , 0.01 , 1000.0 ) ;
RS : : get_singleton ( ) - > instance_set_transform ( light_instance , xform * Transform3D ( ) . looking_at ( Vector3 ( - 2 , - 1 , - 1 ) , Vector3 ( 0 , 1 , 0 ) ) ) ;
RS : : get_singleton ( ) - > instance_set_transform ( light_instance2 , xform * Transform3D ( ) . looking_at ( Vector3 ( + 1 , - 1 , - 2 ) , Vector3 ( 0 , 1 , 0 ) ) ) ;
ep . step ( TTR ( " Thumbnail... " ) , i ) ;
DisplayServer : : get_singleton ( ) - > process_events ( ) ;
Main : : iteration ( ) ;
Main : : iteration ( ) ;
Ref < Image > img = RS : : get_singleton ( ) - > texture_2d_get ( viewport_texture ) ;
ERR_CONTINUE ( ! img . is_valid ( ) | | img - > is_empty ( ) ) ;
Ref < ImageTexture > it = ImageTexture : : create_from_image ( img ) ;
RS : : get_singleton ( ) - > free ( inst ) ;
textures . push_back ( it ) ;
}
RS : : get_singleton ( ) - > free ( viewport ) ;
RS : : get_singleton ( ) - > free ( light ) ;
RS : : get_singleton ( ) - > free ( light_instance ) ;
RS : : get_singleton ( ) - > free ( light2 ) ;
RS : : get_singleton ( ) - > free ( light_instance2 ) ;
RS : : get_singleton ( ) - > free ( camera ) ;
RS : : get_singleton ( ) - > free ( scenario ) ;
return textures ;
}
void EditorInterface : : set_plugin_enabled ( const String & p_plugin , bool p_enabled ) {
EditorNode : : get_singleton ( ) - > set_addon_plugin_enabled ( p_plugin , p_enabled , true ) ;
}
bool EditorInterface : : is_plugin_enabled ( const String & p_plugin ) const {
return EditorNode : : get_singleton ( ) - > is_addon_plugin_enabled ( p_plugin ) ;
}
// Editor GUI.
2023-09-13 11:14:07 +00:00
Ref < Theme > EditorInterface : : get_editor_theme ( ) const {
return EditorNode : : get_singleton ( ) - > get_editor_theme ( ) ;
}
2023-04-05 15:14:46 +00:00
Control * EditorInterface : : get_base_control ( ) const {
return EditorNode : : get_singleton ( ) - > get_gui_base ( ) ;
}
VBoxContainer * EditorInterface : : get_editor_main_screen ( ) const {
2024-08-19 22:08:31 +00:00
return EditorNode : : get_singleton ( ) - > get_editor_main_screen ( ) - > get_control ( ) ;
2023-04-05 15:14:46 +00:00
}
ScriptEditor * EditorInterface : : get_script_editor ( ) const {
return ScriptEditor : : get_singleton ( ) ;
}
2023-08-13 18:57:23 +00:00
SubViewport * EditorInterface : : get_editor_viewport_2d ( ) const {
return EditorNode : : get_singleton ( ) - > get_scene_root ( ) ;
}
SubViewport * EditorInterface : : get_editor_viewport_3d ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , static_cast < int > ( Node3DEditor : : VIEWPORTS_COUNT ) , nullptr ) ;
return Node3DEditor : : get_singleton ( ) - > get_editor_viewport ( p_idx ) - > get_viewport_node ( ) ;
}
2023-04-05 15:14:46 +00:00
void EditorInterface : : set_main_screen_editor ( const String & p_name ) {
2024-08-19 22:08:31 +00:00
EditorNode : : get_singleton ( ) - > get_editor_main_screen ( ) - > select_by_name ( p_name ) ;
2023-04-05 15:14:46 +00:00
}
void EditorInterface : : set_distraction_free_mode ( bool p_enter ) {
EditorNode : : get_singleton ( ) - > set_distraction_free_mode ( p_enter ) ;
}
bool EditorInterface : : is_distraction_free_mode_enabled ( ) const {
return EditorNode : : get_singleton ( ) - > is_distraction_free_mode_enabled ( ) ;
}
2023-11-06 11:41:08 +00:00
bool EditorInterface : : is_multi_window_enabled ( ) const {
return EditorNode : : get_singleton ( ) - > is_multi_window_enabled ( ) ;
}
2023-04-05 15:14:46 +00:00
float EditorInterface : : get_editor_scale ( ) const {
return EDSCALE ;
}
2023-04-20 13:13:21 +00:00
void EditorInterface : : popup_dialog ( Window * p_dialog , const Rect2i & p_screen_rect ) {
p_dialog - > popup_exclusive ( EditorNode : : get_singleton ( ) , p_screen_rect ) ;
}
void EditorInterface : : popup_dialog_centered ( Window * p_dialog , const Size2i & p_minsize ) {
p_dialog - > popup_exclusive_centered ( EditorNode : : get_singleton ( ) , p_minsize ) ;
}
void EditorInterface : : popup_dialog_centered_ratio ( Window * p_dialog , float p_ratio ) {
p_dialog - > popup_exclusive_centered_ratio ( EditorNode : : get_singleton ( ) , p_ratio ) ;
}
void EditorInterface : : popup_dialog_centered_clamped ( Window * p_dialog , const Size2i & p_size , float p_fallback_ratio ) {
p_dialog - > popup_exclusive_centered_clamped ( EditorNode : : get_singleton ( ) , p_size , p_fallback_ratio ) ;
}
2023-03-04 19:27:56 +00:00
String EditorInterface : : get_current_feature_profile ( ) const {
return EditorFeatureProfileManager : : get_singleton ( ) - > get_current_profile_name ( ) ;
}
void EditorInterface : : set_current_feature_profile ( const String & p_profile_name ) {
EditorFeatureProfileManager : : get_singleton ( ) - > set_current_profile ( p_profile_name , true ) ;
}
2023-09-13 20:03:13 +00:00
// Editor dialogs.
2024-09-01 23:18:54 +00:00
void EditorInterface : : popup_node_selector ( const Callable & p_callback , const TypedArray < StringName > & p_valid_types , Node * p_current_value ) {
2024-11-11 10:52:30 +00:00
if ( ! node_selector ) {
node_selector = memnew ( SceneTreeDialog ) ;
get_base_control ( ) - > add_child ( node_selector ) ;
2023-09-13 20:03:13 +00:00
}
Vector < StringName > valid_types ;
int length = p_valid_types . size ( ) ;
valid_types . resize ( length ) ;
for ( int i = 0 ; i < length ; i + + ) {
valid_types . write [ i ] = p_valid_types [ i ] ;
}
node_selector - > set_valid_types ( valid_types ) ;
2024-09-01 23:18:54 +00:00
node_selector - > popup_scenetree_dialog ( p_current_value ) ;
2023-09-13 20:03:13 +00:00
2024-11-11 10:52:30 +00:00
const Callable callback = callable_mp ( this , & EditorInterface : : _node_selected ) ;
node_selector - > connect ( SNAME ( " selected " ) , callback . bind ( p_callback ) , CONNECT_DEFERRED ) ;
node_selector - > connect ( SNAME ( " canceled " ) , callback . bind ( NodePath ( ) , p_callback ) , CONNECT_DEFERRED ) ;
2023-09-13 20:03:13 +00:00
}
2024-09-01 23:18:54 +00:00
void EditorInterface : : popup_property_selector ( Object * p_object , const Callable & p_callback , const PackedInt32Array & p_type_filter , const String & p_current_value ) {
2024-11-11 10:52:30 +00:00
if ( ! property_selector ) {
property_selector = memnew ( PropertySelector ) ;
get_base_control ( ) - > add_child ( property_selector ) ;
2023-09-13 20:03:13 +00:00
}
Vector < Variant : : Type > type_filter ;
int length = p_type_filter . size ( ) ;
type_filter . resize ( length ) ;
for ( int i = 0 ; i < length ; i + + ) {
type_filter . write [ i ] = ( Variant : : Type ) p_type_filter [ i ] ;
}
property_selector - > set_type_filter ( type_filter ) ;
2024-09-01 23:18:54 +00:00
property_selector - > select_property_from_instance ( p_object , p_current_value ) ;
2023-09-13 20:03:13 +00:00
2024-11-11 10:52:30 +00:00
const Callable callback = callable_mp ( this , & EditorInterface : : _property_selected ) ;
property_selector - > connect ( SNAME ( " selected " ) , callback . bind ( p_callback ) , CONNECT_DEFERRED ) ;
property_selector - > connect ( SNAME ( " canceled " ) , callback . bind ( String ( ) , p_callback ) , CONNECT_DEFERRED ) ;
2023-09-13 20:03:13 +00:00
}
2024-11-05 18:18:22 +00:00
void EditorInterface : : popup_method_selector ( Object * p_object , const Callable & p_callback , const String & p_current_value ) {
if ( ! method_selector ) {
method_selector = memnew ( PropertySelector ) ;
get_base_control ( ) - > add_child ( method_selector ) ;
}
method_selector - > select_method_from_instance ( p_object , p_current_value ) ;
const Callable callback = callable_mp ( this , & EditorInterface : : _method_selected ) ;
method_selector - > connect ( SNAME ( " selected " ) , callback . bind ( p_callback ) , CONNECT_DEFERRED ) ;
method_selector - > connect ( SNAME ( " canceled " ) , callback . bind ( String ( ) , p_callback ) , CONNECT_DEFERRED ) ;
}
2024-09-30 03:48:08 +00:00
void EditorInterface : : popup_quick_open ( const Callable & p_callback , const TypedArray < StringName > & p_base_types ) {
StringName required_type = SNAME ( " Resource " ) ;
Vector < StringName > base_types ;
if ( p_base_types . is_empty ( ) ) {
base_types . append ( required_type ) ;
} else {
for ( int i = 0 ; i < p_base_types . size ( ) ; i + + ) {
StringName type = p_base_types [ i ] ;
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. " ) ;
base_types . append ( type ) ;
}
}
EditorQuickOpenDialog * quick_open = EditorNode : : get_singleton ( ) - > get_quick_open_dialog ( ) ;
quick_open - > connect ( SNAME ( " canceled " ) , callable_mp ( this , & EditorInterface : : _quick_open ) . bind ( String ( ) , p_callback ) ) ;
quick_open - > popup_dialog ( base_types , callable_mp ( this , & EditorInterface : : _quick_open ) . bind ( p_callback ) ) ;
}
2023-09-13 20:03:13 +00:00
void EditorInterface : : _node_selected ( const NodePath & p_node_path , const Callable & p_callback ) {
2024-11-11 10:52:30 +00:00
const Callable callback = callable_mp ( this , & EditorInterface : : _node_selected ) ;
node_selector - > disconnect ( SNAME ( " selected " ) , callback ) ;
node_selector - > disconnect ( SNAME ( " canceled " ) , callback ) ;
2023-09-13 20:03:13 +00:00
2024-11-11 10:52:30 +00:00
if ( p_node_path . is_empty ( ) ) {
_call_dialog_callback ( p_callback , NodePath ( ) , " node selection canceled " ) ;
} else {
const NodePath path = get_edited_scene_root ( ) - > get_path ( ) . rel_path_to ( p_node_path ) ;
_call_dialog_callback ( p_callback , path , " node selected " ) ;
}
2023-09-13 20:03:13 +00:00
}
void EditorInterface : : _property_selected ( const String & p_property_name , const Callable & p_callback ) {
2024-11-11 10:52:30 +00:00
const Callable callback = callable_mp ( this , & EditorInterface : : _property_selected ) ;
property_selector - > disconnect ( SNAME ( " selected " ) , callback ) ;
property_selector - > disconnect ( SNAME ( " canceled " ) , callback ) ;
2023-09-13 20:03:13 +00:00
2024-11-11 10:52:30 +00:00
if ( p_property_name . is_empty ( ) ) {
_call_dialog_callback ( p_callback , NodePath ( p_property_name ) . get_as_property_path ( ) , " property selection canceled " ) ;
} else {
_call_dialog_callback ( p_callback , NodePath ( p_property_name ) . get_as_property_path ( ) , " property selected " ) ;
}
2023-09-13 20:03:13 +00:00
}
2024-11-05 18:18:22 +00:00
void EditorInterface : : _method_selected ( const String & p_method_name , const Callable & p_callback ) {
const Callable callback = callable_mp ( this , & EditorInterface : : _method_selected ) ;
method_selector - > disconnect ( SNAME ( " selected " ) , callback ) ;
method_selector - > disconnect ( SNAME ( " canceled " ) , callback ) ;
if ( p_method_name . is_empty ( ) ) {
_call_dialog_callback ( p_callback , p_method_name , " method selection canceled " ) ;
} else {
_call_dialog_callback ( p_callback , p_method_name , " method selected " ) ;
}
}
2024-09-30 03:48:08 +00:00
void EditorInterface : : _quick_open ( const String & p_file_path , const Callable & p_callback ) {
EditorQuickOpenDialog * quick_open = EditorNode : : get_singleton ( ) - > get_quick_open_dialog ( ) ;
quick_open - > disconnect ( SNAME ( " canceled " ) , callable_mp ( this , & EditorInterface : : _quick_open ) ) ;
_call_dialog_callback ( p_callback , p_file_path , " quick open " ) ;
}
2023-09-13 20:03:13 +00:00
void EditorInterface : : _call_dialog_callback ( const Callable & p_callback , const Variant & p_selected , const String & p_context ) {
Callable : : CallError ce ;
Variant ret ;
const Variant * args [ 1 ] = { & p_selected } ;
p_callback . callp ( args , 1 , ret , ce ) ;
if ( ce . error ! = Callable : : CallError : : CALL_OK ) {
ERR_PRINT ( vformat ( " Error calling %s callback: %s " , p_context , Variant : : get_callable_error_text ( p_callback , args , 1 , ce ) ) ) ;
}
}
2023-04-05 15:14:46 +00:00
// Editor docks.
FileSystemDock * EditorInterface : : get_file_system_dock ( ) const {
return FileSystemDock : : get_singleton ( ) ;
}
void EditorInterface : : select_file ( const String & p_file ) {
FileSystemDock : : get_singleton ( ) - > select_file ( p_file ) ;
}
Vector < String > EditorInterface : : get_selected_paths ( ) const {
return FileSystemDock : : get_singleton ( ) - > get_selected_paths ( ) ;
}
String EditorInterface : : get_current_path ( ) const {
return FileSystemDock : : get_singleton ( ) - > get_current_path ( ) ;
}
String EditorInterface : : get_current_directory ( ) const {
return FileSystemDock : : get_singleton ( ) - > get_current_directory ( ) ;
}
EditorInspector * EditorInterface : : get_inspector ( ) const {
return InspectorDock : : get_inspector_singleton ( ) ;
}
// Object/Resource/Node editing.
void EditorInterface : : inspect_object ( Object * p_obj , const String & p_for_property , bool p_inspector_only ) {
EditorNode : : get_singleton ( ) - > push_item ( p_obj , p_for_property , p_inspector_only ) ;
}
void EditorInterface : : edit_resource ( const Ref < Resource > & p_resource ) {
EditorNode : : get_singleton ( ) - > edit_resource ( p_resource ) ;
}
void EditorInterface : : edit_node ( Node * p_node ) {
EditorNode : : get_singleton ( ) - > edit_node ( p_node ) ;
}
void EditorInterface : : edit_script ( const Ref < Script > & p_script , int p_line , int p_col , bool p_grab_focus ) {
2023-07-13 00:52:09 +00:00
ScriptEditor : : get_singleton ( ) - > edit ( p_script , p_line - 1 , p_col - 1 , p_grab_focus ) ;
2023-04-05 15:14:46 +00:00
}
void EditorInterface : : open_scene_from_path ( const String & scene_path ) {
if ( EditorNode : : get_singleton ( ) - > is_changing_scene ( ) ) {
return ;
}
EditorNode : : get_singleton ( ) - > open_request ( scene_path ) ;
}
void EditorInterface : : reload_scene_from_path ( const String & scene_path ) {
if ( EditorNode : : get_singleton ( ) - > is_changing_scene ( ) ) {
return ;
}
EditorNode : : get_singleton ( ) - > reload_scene ( scene_path ) ;
}
Node * EditorInterface : : get_edited_scene_root ( ) const {
return EditorNode : : get_singleton ( ) - > get_edited_scene ( ) ;
}
PackedStringArray EditorInterface : : get_open_scenes ( ) const {
PackedStringArray ret ;
Vector < EditorData : : EditedScene > scenes = EditorNode : : get_editor_data ( ) . get_edited_scenes ( ) ;
int scns_amount = scenes . size ( ) ;
for ( int idx_scn = 0 ; idx_scn < scns_amount ; idx_scn + + ) {
if ( scenes [ idx_scn ] . root = = nullptr ) {
continue ;
}
ret . push_back ( scenes [ idx_scn ] . root - > get_scene_file_path ( ) ) ;
}
return ret ;
}
Error EditorInterface : : save_scene ( ) {
if ( ! get_edited_scene_root ( ) ) {
return ERR_CANT_CREATE ;
}
if ( get_edited_scene_root ( ) - > get_scene_file_path ( ) . is_empty ( ) ) {
return ERR_CANT_CREATE ;
}
save_scene_as ( get_edited_scene_root ( ) - > get_scene_file_path ( ) ) ;
return OK ;
}
void EditorInterface : : save_scene_as ( const String & p_scene , bool p_with_preview ) {
EditorNode : : get_singleton ( ) - > save_scene_to_path ( p_scene , p_with_preview ) ;
}
2023-06-07 11:44:37 +00:00
void EditorInterface : : mark_scene_as_unsaved ( ) {
EditorUndoRedoManager : : get_singleton ( ) - > set_history_as_unsaved ( EditorNode : : get_editor_data ( ) . get_current_edited_scene_history_id ( ) ) ;
2024-04-02 14:17:14 +00:00
EditorSceneTabs : : get_singleton ( ) - > update_scene_tabs ( ) ;
2023-06-07 11:44:37 +00:00
}
2023-05-27 02:23:06 +00:00
void EditorInterface : : save_all_scenes ( ) {
EditorNode : : get_singleton ( ) - > save_all_scenes ( ) ;
}
2023-04-05 15:14:46 +00:00
// Scene playback.
void EditorInterface : : play_main_scene ( ) {
2023-04-12 19:02:28 +00:00
EditorRunBar : : get_singleton ( ) - > play_main_scene ( ) ;
2023-04-05 15:14:46 +00:00
}
void EditorInterface : : play_current_scene ( ) {
2023-04-12 19:02:28 +00:00
EditorRunBar : : get_singleton ( ) - > play_current_scene ( ) ;
2023-04-05 15:14:46 +00:00
}
void EditorInterface : : play_custom_scene ( const String & scene_path ) {
2023-04-12 19:02:28 +00:00
EditorRunBar : : get_singleton ( ) - > play_custom_scene ( scene_path ) ;
2023-04-05 15:14:46 +00:00
}
void EditorInterface : : stop_playing_scene ( ) {
2023-04-12 19:02:28 +00:00
EditorRunBar : : get_singleton ( ) - > stop_playing ( ) ;
2023-04-05 15:14:46 +00:00
}
bool EditorInterface : : is_playing_scene ( ) const {
2023-04-12 19:02:28 +00:00
return EditorRunBar : : get_singleton ( ) - > is_playing ( ) ;
2023-04-05 15:14:46 +00:00
}
String EditorInterface : : get_playing_scene ( ) const {
2023-04-12 19:02:28 +00:00
return EditorRunBar : : get_singleton ( ) - > get_playing_scene ( ) ;
2023-04-05 15:14:46 +00:00
}
void EditorInterface : : set_movie_maker_enabled ( bool p_enabled ) {
2023-04-12 19:02:28 +00:00
EditorRunBar : : get_singleton ( ) - > set_movie_maker_enabled ( p_enabled ) ;
2023-04-05 15:14:46 +00:00
}
bool EditorInterface : : is_movie_maker_enabled ( ) const {
2023-04-12 19:02:28 +00:00
return EditorRunBar : : get_singleton ( ) - > is_movie_maker_enabled ( ) ;
2023-04-05 15:14:46 +00:00
}
2024-01-03 11:10:11 +00:00
# ifdef TOOLS_ENABLED
2024-01-06 17:06:41 +00:00
void EditorInterface : : get_argument_options ( const StringName & p_function , int p_idx , List < String > * r_options ) const {
2024-01-03 11:10:11 +00:00
const String pf = p_function ;
2024-01-06 17:06:41 +00:00
if ( p_idx = = 0 ) {
if ( pf = = " set_main_screen_editor " ) {
for ( String E : { " \" 2D \" " , " \" 3D \" " , " \" Script \" " , " \" AssetLib \" " } ) {
r_options - > push_back ( E ) ;
}
} else if ( pf = = " get_editor_viewport_3d " ) {
for ( uint32_t i = 0 ; i < Node3DEditor : : VIEWPORTS_COUNT ; i + + ) {
r_options - > push_back ( String : : num_int64 ( i ) ) ;
}
}
}
Object : : get_argument_options ( p_function , p_idx , r_options ) ;
}
2024-01-03 11:10:11 +00:00
# endif
// Base.
2023-04-05 15:14:46 +00:00
void EditorInterface : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " restart_editor " , " save " ) , & EditorInterface : : restart_editor , DEFVAL ( true ) ) ;
// Editor tools.
ClassDB : : bind_method ( D_METHOD ( " get_command_palette " ) , & EditorInterface : : get_command_palette ) ;
ClassDB : : bind_method ( D_METHOD ( " get_resource_filesystem " ) , & EditorInterface : : get_resource_file_system ) ;
ClassDB : : bind_method ( D_METHOD ( " get_editor_paths " ) , & EditorInterface : : get_editor_paths ) ;
ClassDB : : bind_method ( D_METHOD ( " get_resource_previewer " ) , & EditorInterface : : get_resource_previewer ) ;
ClassDB : : bind_method ( D_METHOD ( " get_selection " ) , & EditorInterface : : get_selection ) ;
ClassDB : : bind_method ( D_METHOD ( " get_editor_settings " ) , & EditorInterface : : get_editor_settings ) ;
2024-10-30 19:33:40 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_editor_toaster " ) , & EditorInterface : : get_editor_toaster ) ;
2024-04-02 11:33:12 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_editor_undo_redo " ) , & EditorInterface : : get_editor_undo_redo ) ;
2023-04-05 15:14:46 +00:00
ClassDB : : bind_method ( D_METHOD ( " make_mesh_previews " , " meshes " , " preview_size " ) , & EditorInterface : : _make_mesh_previews ) ;
ClassDB : : bind_method ( D_METHOD ( " set_plugin_enabled " , " plugin " , " enabled " ) , & EditorInterface : : set_plugin_enabled ) ;
ClassDB : : bind_method ( D_METHOD ( " is_plugin_enabled " , " plugin " ) , & EditorInterface : : is_plugin_enabled ) ;
// Editor GUI.
2023-09-13 11:14:07 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_editor_theme " ) , & EditorInterface : : get_editor_theme ) ;
2023-04-05 15:14:46 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_base_control " ) , & EditorInterface : : get_base_control ) ;
ClassDB : : bind_method ( D_METHOD ( " get_editor_main_screen " ) , & EditorInterface : : get_editor_main_screen ) ;
ClassDB : : bind_method ( D_METHOD ( " get_script_editor " ) , & EditorInterface : : get_script_editor ) ;
2023-08-13 18:57:23 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_editor_viewport_2d " ) , & EditorInterface : : get_editor_viewport_2d ) ;
ClassDB : : bind_method ( D_METHOD ( " get_editor_viewport_3d " , " idx " ) , & EditorInterface : : get_editor_viewport_3d , DEFVAL ( 0 ) ) ;
2023-04-05 15:14:46 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_main_screen_editor " , " name " ) , & EditorInterface : : set_main_screen_editor ) ;
ClassDB : : bind_method ( D_METHOD ( " set_distraction_free_mode " , " enter " ) , & EditorInterface : : set_distraction_free_mode ) ;
ClassDB : : bind_method ( D_METHOD ( " is_distraction_free_mode_enabled " ) , & EditorInterface : : is_distraction_free_mode_enabled ) ;
2023-11-06 11:41:08 +00:00
ClassDB : : bind_method ( D_METHOD ( " is_multi_window_enabled " ) , & EditorInterface : : is_multi_window_enabled ) ;
2023-04-05 15:14:46 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_editor_scale " ) , & EditorInterface : : get_editor_scale ) ;
2023-04-20 13:13:21 +00:00
ClassDB : : bind_method ( D_METHOD ( " popup_dialog " , " dialog " , " rect " ) , & EditorInterface : : popup_dialog , DEFVAL ( Rect2i ( ) ) ) ;
ClassDB : : bind_method ( D_METHOD ( " popup_dialog_centered " , " dialog " , " minsize " ) , & EditorInterface : : popup_dialog_centered , DEFVAL ( Size2i ( ) ) ) ;
ClassDB : : bind_method ( D_METHOD ( " popup_dialog_centered_ratio " , " dialog " , " ratio " ) , & EditorInterface : : popup_dialog_centered_ratio , DEFVAL ( 0.8 ) ) ;
ClassDB : : bind_method ( D_METHOD ( " popup_dialog_centered_clamped " , " dialog " , " minsize " , " fallback_ratio " ) , & EditorInterface : : popup_dialog_centered_clamped , DEFVAL ( Size2i ( ) ) , DEFVAL ( 0.75 ) ) ;
2023-03-04 19:27:56 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_current_feature_profile " ) , & EditorInterface : : get_current_feature_profile ) ;
ClassDB : : bind_method ( D_METHOD ( " set_current_feature_profile " , " profile_name " ) , & EditorInterface : : set_current_feature_profile ) ;
2023-04-05 15:14:46 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " distraction_free_mode " ) , " set_distraction_free_mode " , " is_distraction_free_mode_enabled " ) ;
2023-09-13 20:03:13 +00:00
// Editor dialogs.
2024-09-01 23:18:54 +00:00
ClassDB : : bind_method ( D_METHOD ( " popup_node_selector " , " callback " , " valid_types " , " current_value " ) , & EditorInterface : : popup_node_selector , DEFVAL ( TypedArray < StringName > ( ) ) , DEFVAL ( Variant ( ) ) ) ;
ClassDB : : bind_method ( D_METHOD ( " popup_property_selector " , " object " , " callback " , " type_filter " , " current_value " ) , & EditorInterface : : popup_property_selector , DEFVAL ( PackedInt32Array ( ) ) , DEFVAL ( String ( ) ) ) ;
2024-11-05 18:18:22 +00:00
ClassDB : : bind_method ( D_METHOD ( " popup_method_selector " , " object " , " callback " , " current_value " ) , & EditorInterface : : popup_method_selector , DEFVAL ( String ( ) ) ) ;
2024-09-30 03:48:08 +00:00
ClassDB : : bind_method ( D_METHOD ( " popup_quick_open " , " callback " , " base_types " ) , & EditorInterface : : popup_quick_open , DEFVAL ( TypedArray < StringName > ( ) ) ) ;
2023-09-13 20:03:13 +00:00
2023-04-05 15:14:46 +00:00
// Editor docks.
ClassDB : : bind_method ( D_METHOD ( " get_file_system_dock " ) , & EditorInterface : : get_file_system_dock ) ;
ClassDB : : bind_method ( D_METHOD ( " select_file " , " file " ) , & EditorInterface : : select_file ) ;
ClassDB : : bind_method ( D_METHOD ( " get_selected_paths " ) , & EditorInterface : : get_selected_paths ) ;
ClassDB : : bind_method ( D_METHOD ( " get_current_path " ) , & EditorInterface : : get_current_path ) ;
ClassDB : : bind_method ( D_METHOD ( " get_current_directory " ) , & EditorInterface : : get_current_directory ) ;
ClassDB : : bind_method ( D_METHOD ( " get_inspector " ) , & EditorInterface : : get_inspector ) ;
// Object/Resource/Node editing.
ClassDB : : bind_method ( D_METHOD ( " inspect_object " , " object " , " for_property " , " inspector_only " ) , & EditorInterface : : inspect_object , DEFVAL ( String ( ) ) , DEFVAL ( false ) ) ;
ClassDB : : bind_method ( D_METHOD ( " edit_resource " , " resource " ) , & EditorInterface : : edit_resource ) ;
ClassDB : : bind_method ( D_METHOD ( " edit_node " , " node " ) , & EditorInterface : : edit_node ) ;
ClassDB : : bind_method ( D_METHOD ( " edit_script " , " script " , " line " , " column " , " grab_focus " ) , & EditorInterface : : edit_script , DEFVAL ( - 1 ) , DEFVAL ( 0 ) , DEFVAL ( true ) ) ;
ClassDB : : bind_method ( D_METHOD ( " open_scene_from_path " , " scene_filepath " ) , & EditorInterface : : open_scene_from_path ) ;
ClassDB : : bind_method ( D_METHOD ( " reload_scene_from_path " , " scene_filepath " ) , & EditorInterface : : reload_scene_from_path ) ;
ClassDB : : bind_method ( D_METHOD ( " get_open_scenes " ) , & EditorInterface : : get_open_scenes ) ;
ClassDB : : bind_method ( D_METHOD ( " get_edited_scene_root " ) , & EditorInterface : : get_edited_scene_root ) ;
ClassDB : : bind_method ( D_METHOD ( " save_scene " ) , & EditorInterface : : save_scene ) ;
ClassDB : : bind_method ( D_METHOD ( " save_scene_as " , " path " , " with_preview " ) , & EditorInterface : : save_scene_as , DEFVAL ( true ) ) ;
2023-05-27 02:23:06 +00:00
ClassDB : : bind_method ( D_METHOD ( " save_all_scenes " ) , & EditorInterface : : save_all_scenes ) ;
2023-04-05 15:14:46 +00:00
2023-06-07 11:44:37 +00:00
ClassDB : : bind_method ( D_METHOD ( " mark_scene_as_unsaved " ) , & EditorInterface : : mark_scene_as_unsaved ) ;
2023-04-05 15:14:46 +00:00
// Scene playback.
ClassDB : : bind_method ( D_METHOD ( " play_main_scene " ) , & EditorInterface : : play_main_scene ) ;
ClassDB : : bind_method ( D_METHOD ( " play_current_scene " ) , & EditorInterface : : play_current_scene ) ;
ClassDB : : bind_method ( D_METHOD ( " play_custom_scene " , " scene_filepath " ) , & EditorInterface : : play_custom_scene ) ;
ClassDB : : bind_method ( D_METHOD ( " stop_playing_scene " ) , & EditorInterface : : stop_playing_scene ) ;
ClassDB : : bind_method ( D_METHOD ( " is_playing_scene " ) , & EditorInterface : : is_playing_scene ) ;
ClassDB : : bind_method ( D_METHOD ( " get_playing_scene " ) , & EditorInterface : : get_playing_scene ) ;
ClassDB : : bind_method ( D_METHOD ( " set_movie_maker_enabled " , " enabled " ) , & EditorInterface : : set_movie_maker_enabled ) ;
ClassDB : : bind_method ( D_METHOD ( " is_movie_maker_enabled " ) , & EditorInterface : : is_movie_maker_enabled ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " movie_maker_enabled " ) , " set_movie_maker_enabled " , " is_movie_maker_enabled " ) ;
}
void EditorInterface : : create ( ) {
memnew ( EditorInterface ) ;
}
void EditorInterface : : free ( ) {
2023-09-09 15:24:40 +00:00
ERR_FAIL_NULL ( singleton ) ;
2023-04-05 15:14:46 +00:00
memdelete ( singleton ) ;
}
EditorInterface : : EditorInterface ( ) {
ERR_FAIL_COND ( singleton ! = nullptr ) ;
singleton = this ;
}