2018-05-16 17:19:33 +00:00
/*************************************************************************/
/* editor_inspector.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
2019-01-01 11:53:14 +00:00
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
2018-05-16 17:19:33 +00:00
/* */
/* 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. */
/*************************************************************************/
2018-05-15 20:12:35 +00:00
# include "editor_inspector.h"
# include "array_property_edit.h"
# include "dictionary_property_edit.h"
# include "editor_node.h"
# include "editor_scale.h"
# include "multi_node_edit.h"
# include "scene/resources/packed_scene.h"
Size2 EditorProperty : : get_minimum_size ( ) const {
Size2 ms ;
2018-08-07 15:19:19 +00:00
Ref < Font > font = get_font ( " font " , " Tree " ) ;
ms . height = font - > get_height ( ) ;
2018-05-15 20:12:35 +00:00
for ( int i = 0 ; i < get_child_count ( ) ; i + + ) {
Control * c = Object : : cast_to < Control > ( get_child ( i ) ) ;
if ( ! c )
continue ;
if ( c - > is_set_as_toplevel ( ) )
continue ;
if ( ! c - > is_visible ( ) )
continue ;
2018-05-17 21:02:16 +00:00
if ( c = = bottom_editor )
continue ;
2018-05-15 20:12:35 +00:00
Size2 minsize = c - > get_combined_minimum_size ( ) ;
ms . width = MAX ( ms . width , minsize . width ) ;
ms . height = MAX ( ms . height , minsize . height ) ;
}
if ( keying ) {
Ref < Texture > key = get_icon ( " Key " , " EditorIcons " ) ;
ms . width + = key - > get_width ( ) + get_constant ( " hseparator " , " Tree " ) ;
}
if ( checkable ) {
Ref < Texture > check = get_icon ( " checked " , " CheckBox " ) ;
ms . width + = check - > get_width ( ) + get_constant ( " hseparator " , " Tree " ) ;
}
2018-08-07 15:19:19 +00:00
if ( bottom_editor ! = NULL & & bottom_editor - > is_visible ( ) ) {
2018-05-15 20:12:35 +00:00
ms . height + = get_constant ( " vseparation " , " Tree " ) ;
2018-05-17 21:02:16 +00:00
Size2 bems = bottom_editor - > get_combined_minimum_size ( ) ;
2018-08-07 15:19:19 +00:00
//bems.width += get_constant("item_margin", "Tree");
2018-05-17 21:02:16 +00:00
ms . height + = bems . height ;
ms . width = MAX ( ms . width , bems . width ) ;
2018-05-15 20:12:35 +00:00
}
return ms ;
}
2019-01-18 16:01:24 +00:00
void EditorProperty : : emit_changed ( const StringName & p_property , const Variant & p_value , const StringName & p_field , bool p_changing ) {
emit_signal ( " property_changed " , p_property , p_value , p_field , p_changing ) ;
}
2018-05-15 20:12:35 +00:00
void EditorProperty : : _notification ( int p_what ) {
if ( p_what = = NOTIFICATION_SORT_CHILDREN ) {
Size2 size = get_size ( ) ;
Rect2 rect ;
2018-05-17 21:02:16 +00:00
Rect2 bottom_rect ;
2018-05-15 20:12:35 +00:00
2018-07-18 22:37:17 +00:00
right_child_rect = Rect2 ( ) ;
bottom_child_rect = Rect2 ( ) ;
2018-05-17 21:02:16 +00:00
{
2018-07-14 21:15:42 +00:00
int child_room = size . width * ( 1.0 - split_ratio ) ;
2018-05-17 21:02:16 +00:00
Ref < Font > font = get_font ( " font " , " Tree " ) ;
int height = font - > get_height ( ) ;
2018-08-07 15:19:19 +00:00
bool no_children = true ;
2018-05-15 20:12:35 +00:00
//compute room needed
for ( int i = 0 ; i < get_child_count ( ) ; i + + ) {
Control * c = Object : : cast_to < Control > ( get_child ( i ) ) ;
if ( ! c )
continue ;
if ( c - > is_set_as_toplevel ( ) )
continue ;
2018-05-17 21:02:16 +00:00
if ( c = = bottom_editor )
continue ;
2018-05-15 20:12:35 +00:00
Size2 minsize = c - > get_combined_minimum_size ( ) ;
child_room = MAX ( child_room , minsize . width ) ;
2018-05-17 21:02:16 +00:00
height = MAX ( height , minsize . height ) ;
2018-08-07 15:19:19 +00:00
no_children = false ;
2018-05-15 20:12:35 +00:00
}
2018-08-07 15:19:19 +00:00
if ( no_children ) {
text_size = size . width ;
rect = Rect2 ( size . width - 1 , 0 , 1 , height ) ;
} else {
text_size = MAX ( 0 , size . width - ( child_room + 4 * EDSCALE ) ) ;
rect = Rect2 ( size . width - child_room , 0 , child_room , height ) ;
}
2018-05-17 21:02:16 +00:00
if ( bottom_editor ) {
2018-05-15 20:12:35 +00:00
2018-07-18 22:37:17 +00:00
int m = 0 ; //get_constant("item_margin", "Tree");
2018-05-17 21:02:16 +00:00
bottom_rect = Rect2 ( m , rect . size . height + get_constant ( " vseparation " , " Tree " ) , size . width - m , bottom_editor - > get_combined_minimum_size ( ) . height ) ;
}
2018-05-15 20:12:35 +00:00
2018-11-30 16:00:04 +00:00
if ( keying ) {
Ref < Texture > key ;
2018-05-15 20:12:35 +00:00
2018-11-30 16:00:04 +00:00
if ( use_keying_next ( ) ) {
key = get_icon ( " KeyNext " , " EditorIcons " ) ;
} else {
key = get_icon ( " Key " , " EditorIcons " ) ;
}
2018-05-15 20:12:35 +00:00
2018-11-30 16:00:04 +00:00
rect . size . x - = key - > get_width ( ) + get_constant ( " hseparator " , " Tree " ) ;
if ( no_children ) {
text_size - = key - > get_width ( ) + 4 * EDSCALE ;
}
}
2018-05-15 20:12:35 +00:00
}
//set children
for ( int i = 0 ; i < get_child_count ( ) ; i + + ) {
Control * c = Object : : cast_to < Control > ( get_child ( i ) ) ;
if ( ! c )
continue ;
if ( c - > is_set_as_toplevel ( ) )
continue ;
2018-05-17 21:02:16 +00:00
if ( c = = bottom_editor )
continue ;
2018-05-15 20:12:35 +00:00
fit_child_in_rect ( c , rect ) ;
2018-07-18 22:37:17 +00:00
right_child_rect = rect ;
2018-05-15 20:12:35 +00:00
}
2018-05-17 21:02:16 +00:00
if ( bottom_editor ) {
fit_child_in_rect ( bottom_editor , bottom_rect ) ;
2018-07-18 22:37:17 +00:00
bottom_child_rect = bottom_rect ;
2018-05-17 21:02:16 +00:00
}
2018-05-15 20:12:35 +00:00
update ( ) ; //need to redraw text
}
if ( p_what = = NOTIFICATION_DRAW ) {
Ref < Font > font = get_font ( " font " , " Tree " ) ;
2018-07-18 22:37:17 +00:00
Color dark_color = get_color ( " dark_color_2 " , " Editor " ) ;
2018-05-15 20:12:35 +00:00
Size2 size = get_size ( ) ;
2018-05-17 21:02:16 +00:00
if ( bottom_editor ) {
size . height = bottom_editor - > get_margin ( MARGIN_TOP ) ;
2018-05-15 20:12:35 +00:00
} else if ( label_reference ) {
size . height = label_reference - > get_size ( ) . height ;
}
if ( selected ) {
Ref < StyleBox > sb = get_stylebox ( " selected " , " Tree " ) ;
draw_style_box ( sb , Rect2 ( Vector2 ( ) , size ) ) ;
}
2018-08-07 15:19:19 +00:00
if ( draw_top_bg & & right_child_rect ! = Rect2 ( ) ) {
2018-07-18 22:37:17 +00:00
draw_rect ( right_child_rect , dark_color ) ;
}
if ( bottom_child_rect ! = Rect2 ( ) ) {
draw_rect ( bottom_child_rect , dark_color ) ;
}
2018-05-15 20:12:35 +00:00
Color color ;
if ( draw_red ) {
color = get_color ( " error_color " , " Editor " ) ;
} else {
2018-08-07 15:19:19 +00:00
color = get_color ( " property_color " , " Editor " ) ;
2018-05-15 20:12:35 +00:00
}
if ( label . find ( " . " ) ! = - 1 ) {
color . a = 0.5 ; //this should be un-hacked honestly, as it's used for editor overrides
}
int ofs = 0 ;
if ( checkable ) {
Ref < Texture > checkbox ;
if ( checked )
checkbox = get_icon ( " checked " , " CheckBox " ) ;
else
checkbox = get_icon ( " unchecked " , " CheckBox " ) ;
Color color ( 1 , 1 , 1 ) ;
if ( check_hover ) {
color . r * = 1.2 ;
color . g * = 1.2 ;
color . b * = 1.2 ;
}
check_rect = Rect2 ( ofs , ( ( size . height - checkbox - > get_height ( ) ) / 2 ) , checkbox - > get_width ( ) , checkbox - > get_height ( ) ) ;
draw_texture ( checkbox , check_rect . position , color ) ;
ofs + = get_constant ( " hseparator " , " Tree " ) ;
ofs + = checkbox - > get_width ( ) ;
} else {
check_rect = Rect2 ( ) ;
}
int text_limit = text_size ;
if ( can_revert ) {
Ref < Texture > reload_icon = get_icon ( " ReloadSmall " , " EditorIcons " ) ;
text_limit - = reload_icon - > get_width ( ) + get_constant ( " hseparator " , " Tree " ) * 2 ;
revert_rect = Rect2 ( text_limit + get_constant ( " hseparator " , " Tree " ) , ( size . height - reload_icon - > get_height ( ) ) / 2 , reload_icon - > get_width ( ) , reload_icon - > get_height ( ) ) ;
Color color ( 1 , 1 , 1 ) ;
if ( revert_hover ) {
color . r * = 1.2 ;
color . g * = 1.2 ;
color . b * = 1.2 ;
}
draw_texture ( reload_icon , revert_rect . position , color ) ;
} else {
revert_rect = Rect2 ( ) ;
}
int v_ofs = ( size . height - font - > get_height ( ) ) / 2 ;
draw_string ( font , Point2 ( ofs , v_ofs + font - > get_ascent ( ) ) , label , color , text_limit ) ;
if ( keying ) {
Ref < Texture > key ;
if ( use_keying_next ( ) ) {
key = get_icon ( " KeyNext " , " EditorIcons " ) ;
} else {
key = get_icon ( " Key " , " EditorIcons " ) ;
}
ofs = size . width - key - > get_width ( ) - get_constant ( " hseparator " , " Tree " ) ;
Color color ( 1 , 1 , 1 ) ;
if ( keying_hover ) {
color . r * = 1.2 ;
color . g * = 1.2 ;
color . b * = 1.2 ;
}
keying_rect = Rect2 ( ofs , ( ( size . height - key - > get_height ( ) ) / 2 ) , key - > get_width ( ) , key - > get_height ( ) ) ;
draw_texture ( key , keying_rect . position , color ) ;
} else {
keying_rect = Rect2 ( ) ;
}
}
}
void EditorProperty : : set_label ( const String & p_label ) {
label = p_label ;
update ( ) ;
}
String EditorProperty : : get_label ( ) const {
return label ;
}
Object * EditorProperty : : get_edited_object ( ) {
return object ;
}
StringName EditorProperty : : get_edited_property ( ) {
return property ;
}
void EditorProperty : : update_property ( ) {
if ( get_script_instance ( ) )
get_script_instance ( ) - > call ( " update_property " ) ;
}
void EditorProperty : : set_read_only ( bool p_read_only ) {
read_only = p_read_only ;
}
bool EditorProperty : : is_read_only ( ) const {
return read_only ;
}
2018-11-25 13:46:26 +00:00
bool EditorPropertyRevert : : may_node_be_in_instance ( Node * p_node ) {
2018-05-15 20:12:35 +00:00
Node * edited_scene = EditorNode : : get_singleton ( ) - > get_edited_scene ( ) ;
bool might_be = false ;
2018-11-25 13:46:26 +00:00
Node * node = p_node ;
2018-05-15 20:12:35 +00:00
while ( node ) {
if ( node - > get_scene_instance_state ( ) . is_valid ( ) ) {
might_be = true ;
break ;
}
if ( node = = edited_scene ) {
if ( node - > get_scene_inherited_state ( ) . is_valid ( ) ) {
might_be = true ;
break ;
}
might_be = false ;
break ;
}
node = node - > get_owner ( ) ;
}
return might_be ; // or might not be
}
2018-11-25 13:46:26 +00:00
bool EditorPropertyRevert : : get_instanced_node_original_property ( Node * p_node , const StringName & p_prop , Variant & value ) {
2018-05-15 20:12:35 +00:00
2018-11-25 13:46:26 +00:00
Node * node = p_node ;
2018-05-15 20:12:35 +00:00
Node * orig = node ;
Node * edited_scene = EditorNode : : get_singleton ( ) - > get_edited_scene ( ) ;
bool found = false ;
while ( node ) {
Ref < SceneState > ss ;
if ( node = = edited_scene ) {
ss = node - > get_scene_inherited_state ( ) ;
} else {
ss = node - > get_scene_instance_state ( ) ;
}
if ( ss . is_valid ( ) ) {
NodePath np = node - > get_path_to ( orig ) ;
int node_idx = ss - > find_node_by_path ( np ) ;
if ( node_idx > = 0 ) {
bool lfound = false ;
Variant lvar ;
lvar = ss - > get_property_value ( node_idx , p_prop , lfound ) ;
if ( lfound ) {
found = true ;
value = lvar ;
}
}
}
if ( node = = edited_scene ) {
//just in case
break ;
}
node = node - > get_owner ( ) ;
}
2018-11-08 14:30:02 +00:00
if ( ! found ) {
//if not found, try default class value
2018-11-25 13:46:26 +00:00
Variant attempt = ClassDB : : class_get_default_property_value ( node - > get_class_name ( ) , p_prop ) ;
2018-11-08 14:30:02 +00:00
if ( attempt . get_type ( ) ! = Variant : : NIL ) {
found = true ;
value = attempt ;
}
}
2018-05-15 20:12:35 +00:00
return found ;
}
2018-11-25 13:46:26 +00:00
bool EditorPropertyRevert : : is_node_property_different ( Node * p_node , const Variant & p_current , const Variant & p_orig ) {
2018-05-15 20:12:35 +00:00
// this is a pretty difficult function, because a property may not be saved but may have
// the flag to not save if one or if zero
2018-11-08 14:30:02 +00:00
//make sure there is an actual state
2018-05-15 20:12:35 +00:00
{
2018-11-25 13:46:26 +00:00
Node * node = p_node ;
2018-05-15 20:12:35 +00:00
if ( ! node )
return false ;
Node * edited_scene = EditorNode : : get_singleton ( ) - > get_edited_scene ( ) ;
bool found_state = false ;
while ( node ) {
Ref < SceneState > ss ;
if ( node = = edited_scene ) {
ss = node - > get_scene_inherited_state ( ) ;
} else {
ss = node - > get_scene_instance_state ( ) ;
}
if ( ss . is_valid ( ) ) {
found_state = true ;
}
if ( node = = edited_scene ) {
//just in case
break ;
}
node = node - > get_owner ( ) ;
}
if ( ! found_state )
return false ; //pointless to check if we are not comparing against anything.
}
if ( p_current . get_type ( ) = = Variant : : REAL & & p_orig . get_type ( ) = = Variant : : REAL ) {
float a = p_current ;
float b = p_orig ;
return Math : : abs ( a - b ) > CMP_EPSILON ; //this must be done because, as some scenes save as text, there might be a tiny difference in floats due to numerical error
}
return bool ( Variant : : evaluate ( Variant : : OP_NOT_EQUAL , p_current , p_orig ) ) ;
}
2018-11-25 13:46:26 +00:00
bool EditorPropertyRevert : : can_property_revert ( Object * p_object , const StringName & p_property ) {
2018-05-15 20:12:35 +00:00
2018-11-25 13:46:26 +00:00
bool has_revert = false ;
2018-05-15 20:12:35 +00:00
2018-11-25 13:46:26 +00:00
Node * node = Object : : cast_to < Node > ( p_object ) ;
2018-05-15 20:12:35 +00:00
2018-11-25 13:46:26 +00:00
if ( node & & EditorPropertyRevert : : may_node_be_in_instance ( node ) ) {
2018-11-08 14:30:02 +00:00
//check for difference including instantiation
Variant vorig ;
2018-11-25 13:46:26 +00:00
if ( EditorPropertyRevert : : get_instanced_node_original_property ( node , p_property , vorig ) ) {
Variant v = p_object - > get ( p_property ) ;
2018-11-08 14:30:02 +00:00
2018-11-25 13:46:26 +00:00
if ( EditorPropertyRevert : : is_node_property_different ( node , v , vorig ) ) {
has_revert = true ;
2018-11-08 14:30:02 +00:00
}
}
} else {
//check for difference against default class value instead
2018-11-25 13:46:26 +00:00
Variant default_value = ClassDB : : class_get_default_property_value ( p_object - > get_class_name ( ) , p_property ) ;
if ( default_value ! = Variant ( ) & & default_value ! = p_object - > get ( p_property ) ) {
has_revert = true ;
2018-10-29 15:25:31 +00:00
}
}
2018-05-15 20:12:35 +00:00
2018-11-25 13:46:26 +00:00
if ( p_object - > call ( " property_can_revert " , p_property ) . operator bool ( ) ) {
2018-05-15 20:12:35 +00:00
2018-11-25 13:46:26 +00:00
has_revert = true ;
2018-05-15 20:12:35 +00:00
}
2018-11-25 13:46:26 +00:00
if ( ! has_revert & & ! p_object - > get_script ( ) . is_null ( ) ) {
Ref < Script > scr = p_object - > get_script ( ) ;
2018-05-15 20:12:35 +00:00
Variant orig_value ;
2018-11-25 13:46:26 +00:00
if ( scr - > get_property_default_value ( p_property , orig_value ) ) {
if ( orig_value ! = p_object - > get ( p_property ) ) {
has_revert = true ;
2018-05-15 20:12:35 +00:00
}
}
}
2018-11-25 13:46:26 +00:00
return has_revert ;
}
void EditorProperty : : update_reload_status ( ) {
if ( property = = StringName ( ) )
return ; //no property, so nothing to do
bool has_reload = EditorPropertyRevert : : can_property_revert ( object , property ) ;
2018-05-15 20:12:35 +00:00
if ( has_reload ! = can_revert ) {
can_revert = has_reload ;
update ( ) ;
}
}
bool EditorProperty : : use_keying_next ( ) const {
2018-10-01 19:44:57 +00:00
List < PropertyInfo > plist ;
object - > get_property_list ( & plist , true ) ;
for ( List < PropertyInfo > : : Element * I = plist . front ( ) ; I ; I = I - > next ( ) ) {
PropertyInfo & p = I - > get ( ) ;
if ( p . name = = property ) {
return p . hint = = PROPERTY_HINT_SPRITE_FRAME ;
}
}
2018-05-15 20:12:35 +00:00
return false ;
}
void EditorProperty : : set_checkable ( bool p_checkable ) {
checkable = p_checkable ;
update ( ) ;
queue_sort ( ) ;
}
bool EditorProperty : : is_checkable ( ) const {
return checkable ;
}
void EditorProperty : : set_checked ( bool p_checked ) {
checked = p_checked ;
update ( ) ;
}
bool EditorProperty : : is_checked ( ) const {
return checked ;
}
void EditorProperty : : set_draw_red ( bool p_draw_red ) {
draw_red = p_draw_red ;
update ( ) ;
}
void EditorProperty : : set_keying ( bool p_keying ) {
keying = p_keying ;
update ( ) ;
queue_sort ( ) ;
}
bool EditorProperty : : is_keying ( ) const {
return keying ;
}
bool EditorProperty : : is_draw_red ( ) const {
return draw_red ;
}
void EditorProperty : : _focusable_focused ( int p_index ) {
2018-05-19 19:09:38 +00:00
if ( ! selectable )
return ;
2018-05-15 20:12:35 +00:00
bool already_selected = selected ;
selected = true ;
selected_focusable = p_index ;
update ( ) ;
if ( ! already_selected & & selected ) {
emit_signal ( " selected " , property , selected_focusable ) ;
}
}
void EditorProperty : : add_focusable ( Control * p_control ) {
p_control - > connect ( " focus_entered " , this , " _focusable_focused " , varray ( focusables . size ( ) ) ) ;
focusables . push_back ( p_control ) ;
}
void EditorProperty : : select ( int p_focusable ) {
bool already_selected = selected ;
if ( p_focusable > = 0 ) {
ERR_FAIL_INDEX ( p_focusable , focusables . size ( ) ) ;
focusables [ p_focusable ] - > grab_focus ( ) ;
} else {
selected = true ;
update ( ) ;
}
if ( ! already_selected & & selected ) {
emit_signal ( " selected " , property , selected_focusable ) ;
}
}
void EditorProperty : : deselect ( ) {
selected = false ;
selected_focusable = - 1 ;
update ( ) ;
}
bool EditorProperty : : is_selected ( ) const {
return selected ;
}
void EditorProperty : : _gui_input ( const Ref < InputEvent > & p_event ) {
if ( property = = StringName ( ) )
return ;
Ref < InputEventMouse > me = p_event ;
if ( me . is_valid ( ) ) {
bool button_left = me - > get_button_mask ( ) & BUTTON_MASK_LEFT ;
bool new_keying_hover = keying_rect . has_point ( me - > get_position ( ) ) & & ! button_left ;
if ( new_keying_hover ! = keying_hover ) {
keying_hover = new_keying_hover ;
update ( ) ;
}
bool new_revert_hover = revert_rect . has_point ( me - > get_position ( ) ) & & ! button_left ;
if ( new_revert_hover ! = revert_hover ) {
revert_hover = new_revert_hover ;
update ( ) ;
}
bool new_check_hover = check_rect . has_point ( me - > get_position ( ) ) & & ! button_left ;
if ( new_check_hover ! = check_hover ) {
check_hover = new_check_hover ;
update ( ) ;
}
}
Ref < InputEventMouseButton > mb = p_event ;
if ( mb . is_valid ( ) & & mb - > is_pressed ( ) & & mb - > get_button_index ( ) = = BUTTON_LEFT ) {
2018-05-19 19:09:38 +00:00
if ( ! selected & & selectable ) {
2018-05-15 20:12:35 +00:00
selected = true ;
emit_signal ( " selected " , property , - 1 ) ;
update ( ) ;
}
if ( keying_rect . has_point ( mb - > get_position ( ) ) ) {
2018-11-08 20:46:34 +00:00
emit_signal ( " property_keyed " , property , use_keying_next ( ) ) ;
2018-10-01 19:44:57 +00:00
if ( use_keying_next ( ) ) {
2019-01-18 16:01:24 +00:00
call_deferred ( " emit_changed " , property , object - > get ( property ) . operator int64_t ( ) + 1 , " " , false ) ;
2018-10-01 19:44:57 +00:00
call_deferred ( " update_property " ) ;
}
2018-05-15 20:12:35 +00:00
}
if ( revert_rect . has_point ( mb - > get_position ( ) ) ) {
Variant vorig ;
2018-11-25 13:46:26 +00:00
Node * node = Object : : cast_to < Node > ( object ) ;
if ( node & & EditorPropertyRevert : : may_node_be_in_instance ( node ) & & EditorPropertyRevert : : get_instanced_node_original_property ( node , property , vorig ) ) {
2018-05-15 20:12:35 +00:00
2019-01-18 16:01:24 +00:00
emit_changed ( property , vorig . duplicate ( true ) ) ;
2018-05-15 20:12:35 +00:00
update_property ( ) ;
return ;
}
if ( object - > call ( " property_can_revert " , property ) . operator bool ( ) ) {
Variant rev = object - > call ( " property_get_revert " , property ) ;
2019-01-18 16:01:24 +00:00
emit_changed ( property , rev ) ;
2018-05-15 20:12:35 +00:00
update_property ( ) ;
2018-10-29 15:25:31 +00:00
return ;
2018-05-15 20:12:35 +00:00
}
if ( ! object - > get_script ( ) . is_null ( ) ) {
Ref < Script > scr = object - > get_script ( ) ;
Variant orig_value ;
if ( scr - > get_property_default_value ( property , orig_value ) ) {
2019-01-18 16:01:24 +00:00
emit_changed ( property , orig_value ) ;
2018-05-15 20:12:35 +00:00
update_property ( ) ;
2018-10-29 15:25:31 +00:00
return ;
}
}
2018-11-08 14:30:02 +00:00
Variant default_value = ClassDB : : class_get_default_property_value ( object - > get_class_name ( ) , property ) ;
if ( default_value ! = Variant ( ) ) {
2019-01-18 16:01:24 +00:00
emit_changed ( property , default_value ) ;
2018-11-08 14:30:02 +00:00
update_property ( ) ;
return ;
2018-05-15 20:12:35 +00:00
}
}
if ( check_rect . has_point ( mb - > get_position ( ) ) ) {
checked = ! checked ;
update ( ) ;
emit_signal ( " property_checked " , property , checked ) ;
}
}
}
void EditorProperty : : set_label_reference ( Control * p_control ) {
label_reference = p_control ;
}
2018-05-17 21:02:16 +00:00
void EditorProperty : : set_bottom_editor ( Control * p_control ) {
2018-05-15 20:12:35 +00:00
2018-05-17 21:02:16 +00:00
bottom_editor = p_control ;
}
2018-05-15 20:12:35 +00:00
Variant EditorProperty : : get_drag_data ( const Point2 & p_point ) {
if ( property = = StringName ( ) )
return Variant ( ) ;
Dictionary dp ;
dp [ " type " ] = " obj_property " ;
dp [ " object " ] = object ;
dp [ " property " ] = property ;
dp [ " value " ] = object - > get ( property ) ;
Label * label = memnew ( Label ) ;
label - > set_text ( property ) ;
set_drag_preview ( label ) ;
return dp ;
}
2018-05-17 21:02:16 +00:00
void EditorProperty : : set_use_folding ( bool p_use_folding ) {
use_folding = p_use_folding ;
}
bool EditorProperty : : is_using_folding ( ) const {
return use_folding ;
}
void EditorProperty : : expand_all_folding ( ) {
}
void EditorProperty : : collapse_all_folding ( ) {
2018-05-15 20:12:35 +00:00
}
2018-05-19 19:09:38 +00:00
void EditorProperty : : set_selectable ( bool p_selectable ) {
selectable = p_selectable ;
}
bool EditorProperty : : is_selectable ( ) const {
return selectable ;
}
2018-07-14 21:15:42 +00:00
void EditorProperty : : set_name_split_ratio ( float p_ratio ) {
split_ratio = p_ratio ;
}
float EditorProperty : : get_name_split_ratio ( ) const {
return split_ratio ;
}
2018-05-19 19:09:38 +00:00
void EditorProperty : : set_object_and_property ( Object * p_object , const StringName & p_property ) {
object = p_object ;
property = p_property ;
}
2018-07-20 21:14:33 +00:00
Control * EditorProperty : : make_custom_tooltip ( const String & p_text ) const {
tooltip_text = p_text ;
EditorHelpBit * help_bit = memnew ( EditorHelpBit ) ;
help_bit - > add_style_override ( " panel " , get_stylebox ( " panel " , " TooltipPanel " ) ) ;
2018-10-24 18:00:22 +00:00
help_bit - > get_rich_text ( ) - > set_fixed_size_to_width ( 360 * EDSCALE ) ;
2018-07-20 21:14:33 +00:00
2018-10-24 18:00:22 +00:00
String text = TTR ( " Property: " ) + " [u][b] " + p_text . get_slice ( " :: " , 0 ) + " [/b][/u] \n " ;
2018-07-20 21:14:33 +00:00
text + = p_text . get_slice ( " :: " , 1 ) . strip_edges ( ) ;
help_bit - > set_text ( text ) ;
help_bit - > call_deferred ( " set_text " , text ) ; //hack so it uses proper theme once inside scene
return help_bit ;
}
String EditorProperty : : get_tooltip_text ( ) const {
return tooltip_text ;
}
2018-05-15 20:12:35 +00:00
void EditorProperty : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " set_label " , " text " ) , & EditorProperty : : set_label ) ;
ClassDB : : bind_method ( D_METHOD ( " get_label " ) , & EditorProperty : : get_label ) ;
ClassDB : : bind_method ( D_METHOD ( " set_read_only " , " read_only " ) , & EditorProperty : : set_read_only ) ;
ClassDB : : bind_method ( D_METHOD ( " is_read_only " ) , & EditorProperty : : is_read_only ) ;
ClassDB : : bind_method ( D_METHOD ( " set_checkable " , " checkable " ) , & EditorProperty : : set_checkable ) ;
ClassDB : : bind_method ( D_METHOD ( " is_checkable " ) , & EditorProperty : : is_checkable ) ;
ClassDB : : bind_method ( D_METHOD ( " set_checked " , " checked " ) , & EditorProperty : : set_checked ) ;
ClassDB : : bind_method ( D_METHOD ( " is_checked " ) , & EditorProperty : : is_checked ) ;
ClassDB : : bind_method ( D_METHOD ( " set_draw_red " , " draw_red " ) , & EditorProperty : : set_draw_red ) ;
ClassDB : : bind_method ( D_METHOD ( " is_draw_red " ) , & EditorProperty : : is_draw_red ) ;
ClassDB : : bind_method ( D_METHOD ( " set_keying " , " keying " ) , & EditorProperty : : set_keying ) ;
ClassDB : : bind_method ( D_METHOD ( " is_keying " ) , & EditorProperty : : is_keying ) ;
ClassDB : : bind_method ( D_METHOD ( " get_edited_property " ) , & EditorProperty : : get_edited_property ) ;
ClassDB : : bind_method ( D_METHOD ( " get_edited_object " ) , & EditorProperty : : get_edited_object ) ;
ClassDB : : bind_method ( D_METHOD ( " _gui_input " ) , & EditorProperty : : _gui_input ) ;
ClassDB : : bind_method ( D_METHOD ( " _focusable_focused " ) , & EditorProperty : : _focusable_focused ) ;
2018-07-20 21:14:33 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_tooltip_text " ) , & EditorProperty : : get_tooltip_text ) ;
2019-01-18 16:01:24 +00:00
ClassDB : : bind_method ( D_METHOD ( " emit_changed " , " property " , " value " , " field " , " changing " ) , & EditorProperty : : emit_changed , DEFVAL ( StringName ( ) ) , DEFVAL ( false ) ) ;
2018-05-15 20:12:35 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : STRING , " label " ) , " set_label " , " get_label " ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " read_only " ) , " set_read_only " , " is_read_only " ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " checkable " ) , " set_checkable " , " is_checkable " ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " checked " ) , " set_checked " , " is_checked " ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " draw_red " ) , " set_draw_red " , " is_draw_red " ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " keying " ) , " set_keying " , " is_keying " ) ;
ADD_SIGNAL ( MethodInfo ( " property_changed " , PropertyInfo ( Variant : : STRING , " property " ) , PropertyInfo ( Variant : : NIL , " value " , PROPERTY_HINT_NONE , " " , PROPERTY_USAGE_NIL_IS_VARIANT ) ) ) ;
ADD_SIGNAL ( MethodInfo ( " multiple_properties_changed " , PropertyInfo ( Variant : : POOL_STRING_ARRAY , " properties " ) , PropertyInfo ( Variant : : ARRAY , " value " ) ) ) ;
ADD_SIGNAL ( MethodInfo ( " property_keyed " , PropertyInfo ( Variant : : STRING , " property " ) ) ) ;
2018-05-17 21:02:16 +00:00
ADD_SIGNAL ( MethodInfo ( " property_keyed_with_value " , PropertyInfo ( Variant : : STRING , " property " ) , PropertyInfo ( Variant : : NIL , " value " , PROPERTY_HINT_NONE , " " , PROPERTY_USAGE_NIL_IS_VARIANT ) ) ) ;
2018-05-15 20:12:35 +00:00
ADD_SIGNAL ( MethodInfo ( " property_checked " , PropertyInfo ( Variant : : STRING , " property " ) , PropertyInfo ( Variant : : STRING , " bool " ) ) ) ;
ADD_SIGNAL ( MethodInfo ( " resource_selected " , PropertyInfo ( Variant : : STRING , " path " ) , PropertyInfo ( Variant : : OBJECT , " resource " , PROPERTY_HINT_RESOURCE_TYPE , " Resource " ) ) ) ;
ADD_SIGNAL ( MethodInfo ( " object_id_selected " , PropertyInfo ( Variant : : STRING , " property " ) , PropertyInfo ( Variant : : INT , " id " ) ) ) ;
ADD_SIGNAL ( MethodInfo ( " selected " , PropertyInfo ( Variant : : STRING , " path " ) , PropertyInfo ( Variant : : INT , " focusable_idx " ) ) ) ;
MethodInfo vm ;
vm . name = " update_property " ;
BIND_VMETHOD ( vm ) ;
}
EditorProperty : : EditorProperty ( ) {
2018-08-07 15:19:19 +00:00
draw_top_bg = true ;
object = NULL ;
2018-07-14 21:15:42 +00:00
split_ratio = 0.5 ;
2018-05-19 19:09:38 +00:00
selectable = true ;
2018-05-15 20:12:35 +00:00
text_size = 0 ;
read_only = false ;
checkable = false ;
checked = false ;
draw_red = false ;
keying = false ;
keying_hover = false ;
revert_hover = false ;
check_hover = false ;
can_revert = false ;
2018-05-17 21:02:16 +00:00
use_folding = false ;
2018-05-15 20:12:35 +00:00
property_usage = 0 ;
selected = false ;
selected_focusable = - 1 ;
label_reference = NULL ;
2018-05-17 21:02:16 +00:00
bottom_editor = NULL ;
2018-05-15 20:12:35 +00:00
}
////////////////////////////////////////////////
////////////////////////////////////////////////
void EditorInspectorPlugin : : add_custom_control ( Control * control ) {
AddedEditor ae ;
ae . property_editor = control ;
added_editors . push_back ( ae ) ;
}
void EditorInspectorPlugin : : add_property_editor ( const String & p_for_property , Control * p_prop ) {
ERR_FAIL_COND ( Object : : cast_to < EditorProperty > ( p_prop ) = = NULL ) ;
AddedEditor ae ;
ae . properties . push_back ( p_for_property ) ;
ae . property_editor = p_prop ;
added_editors . push_back ( ae ) ;
}
void EditorInspectorPlugin : : add_property_editor_for_multiple_properties ( const String & p_label , const Vector < String > & p_properties , Control * p_prop ) {
AddedEditor ae ;
ae . properties = p_properties ;
ae . property_editor = p_prop ;
ae . label = p_label ;
added_editors . push_back ( ae ) ;
}
bool EditorInspectorPlugin : : can_handle ( Object * p_object ) {
if ( get_script_instance ( ) ) {
return get_script_instance ( ) - > call ( " can_handle " , p_object ) ;
}
return false ;
}
void EditorInspectorPlugin : : parse_begin ( Object * p_object ) {
if ( get_script_instance ( ) ) {
get_script_instance ( ) - > call ( " parse_begin " , p_object ) ;
}
}
2018-05-17 21:02:16 +00:00
void EditorInspectorPlugin : : parse_category ( Object * p_object , const String & p_parse_category ) {
if ( get_script_instance ( ) ) {
get_script_instance ( ) - > call ( " parse_category " , p_object , p_parse_category ) ;
}
}
2018-05-15 20:12:35 +00:00
bool EditorInspectorPlugin : : parse_property ( Object * p_object , Variant : : Type p_type , const String & p_path , PropertyHint p_hint , const String & p_hint_text , int p_usage ) {
if ( get_script_instance ( ) ) {
Variant arg [ 6 ] = {
p_object , p_type , p_path , p_hint , p_hint_text , p_usage
} ;
const Variant * argptr [ 6 ] = {
& arg [ 0 ] , & arg [ 1 ] , & arg [ 2 ] , & arg [ 3 ] , & arg [ 4 ] , & arg [ 5 ]
} ;
Variant : : CallError err ;
return get_script_instance ( ) - > call ( " parse_property " , ( const Variant * * ) & argptr , 6 , err ) ;
}
return false ;
}
void EditorInspectorPlugin : : parse_end ( ) {
if ( get_script_instance ( ) ) {
get_script_instance ( ) - > call ( " parse_end " ) ;
}
}
void EditorInspectorPlugin : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " add_custom_control " , " control " ) , & EditorInspectorPlugin : : add_custom_control ) ;
ClassDB : : bind_method ( D_METHOD ( " add_property_editor " , " property " , " editor " ) , & EditorInspectorPlugin : : add_property_editor ) ;
ClassDB : : bind_method ( D_METHOD ( " add_property_editor_for_multiple_properties " , " label " , " properties " , " editor " ) , & EditorInspectorPlugin : : add_property_editor_for_multiple_properties ) ;
MethodInfo vm ;
vm . name = " can_handle " ;
2018-05-28 14:28:09 +00:00
vm . return_val . type = Variant : : BOOL ;
2018-05-15 20:12:35 +00:00
vm . arguments . push_back ( PropertyInfo ( Variant : : OBJECT , " object " ) ) ;
BIND_VMETHOD ( vm ) ;
vm . name = " parse_begin " ;
2018-05-28 14:28:09 +00:00
vm . return_val . type = Variant : : NIL ;
2018-05-15 20:12:35 +00:00
BIND_VMETHOD ( vm ) ;
2018-05-17 21:02:16 +00:00
vm . name = " parse_category " ;
vm . arguments . push_back ( PropertyInfo ( Variant : : STRING , " category " ) ) ;
BIND_VMETHOD ( vm ) ;
vm . arguments . pop_back ( ) ;
2018-05-15 20:12:35 +00:00
vm . name = " parse_property " ;
vm . return_val . type = Variant : : BOOL ;
vm . arguments . push_back ( PropertyInfo ( Variant : : INT , " type " ) ) ;
vm . arguments . push_back ( PropertyInfo ( Variant : : STRING , " path " ) ) ;
vm . arguments . push_back ( PropertyInfo ( Variant : : INT , " hint " ) ) ;
vm . arguments . push_back ( PropertyInfo ( Variant : : STRING , " hint_text " ) ) ;
vm . arguments . push_back ( PropertyInfo ( Variant : : INT , " usage " ) ) ;
BIND_VMETHOD ( vm ) ;
vm . arguments . clear ( ) ;
vm . name = " parse_end " ;
2018-05-28 14:28:09 +00:00
vm . return_val . type = Variant : : NIL ;
2018-05-15 20:12:35 +00:00
BIND_VMETHOD ( vm ) ;
}
////////////////////////////////////////////////
////////////////////////////////////////////////
void EditorInspectorCategory : : _notification ( int p_what ) {
if ( p_what = = NOTIFICATION_DRAW ) {
draw_rect ( Rect2 ( Vector2 ( ) , get_size ( ) ) , bg_color ) ;
Ref < Font > font = get_font ( " font " , " Tree " ) ;
int hs = get_constant ( " hseparation " , " Tree " ) ;
int w = font - > get_string_size ( label ) . width ;
if ( icon . is_valid ( ) ) {
w + = hs + icon - > get_width ( ) ;
}
int ofs = ( get_size ( ) . width - w ) / 2 ;
if ( icon . is_valid ( ) ) {
draw_texture ( icon , Point2 ( ofs , ( get_size ( ) . height - icon - > get_height ( ) ) / 2 ) . floor ( ) ) ;
ofs + = hs + icon - > get_width ( ) ;
}
Color color = get_color ( " font_color " , " Tree " ) ;
draw_string ( font , Point2 ( ofs , font - > get_ascent ( ) + ( get_size ( ) . height - font - > get_height ( ) ) / 2 ) . floor ( ) , label , color , get_size ( ) . width ) ;
}
}
2018-07-20 21:14:33 +00:00
Control * EditorInspectorCategory : : make_custom_tooltip ( const String & p_text ) const {
tooltip_text = p_text ;
EditorHelpBit * help_bit = memnew ( EditorHelpBit ) ;
help_bit - > add_style_override ( " panel " , get_stylebox ( " panel " , " TooltipPanel " ) ) ;
2018-10-24 18:00:22 +00:00
help_bit - > get_rich_text ( ) - > set_fixed_size_to_width ( 360 * EDSCALE ) ;
2018-07-20 21:14:33 +00:00
String text = " [u][b] " + p_text . get_slice ( " :: " , 0 ) + " [/b][/u] \n " ;
text + = p_text . get_slice ( " :: " , 1 ) . strip_edges ( ) ;
help_bit - > set_text ( text ) ;
help_bit - > call_deferred ( " set_text " , text ) ; //hack so it uses proper theme once inside scene
return help_bit ;
}
2018-05-15 20:12:35 +00:00
Size2 EditorInspectorCategory : : get_minimum_size ( ) const {
Ref < Font > font = get_font ( " font " , " Tree " ) ;
Size2 ms ;
ms . width = 1 ;
ms . height = font - > get_height ( ) ;
if ( icon . is_valid ( ) ) {
ms . height = MAX ( icon - > get_height ( ) , ms . height ) ;
}
ms . height + = get_constant ( " vseparation " , " Tree " ) ;
return ms ;
}
2018-07-20 21:14:33 +00:00
void EditorInspectorCategory : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " get_tooltip_text " ) , & EditorInspectorCategory : : get_tooltip_text ) ;
}
String EditorInspectorCategory : : get_tooltip_text ( ) const {
return tooltip_text ;
}
2018-05-15 20:12:35 +00:00
EditorInspectorCategory : : EditorInspectorCategory ( ) {
}
////////////////////////////////////////////////
////////////////////////////////////////////////
2018-07-18 22:37:17 +00:00
void EditorInspectorSection : : _test_unfold ( ) {
if ( ! vbox_added ) {
add_child ( vbox ) ;
vbox_added = true ;
}
}
2018-05-15 20:12:35 +00:00
void EditorInspectorSection : : _notification ( int p_what ) {
if ( p_what = = NOTIFICATION_SORT_CHILDREN ) {
Ref < Font > font = get_font ( " font " , " Tree " ) ;
Ref < Texture > arrow ;
# ifdef TOOLS_ENABLED
if ( foldable ) {
if ( object - > editor_is_section_unfolded ( section ) ) {
2018-07-18 22:37:17 +00:00
arrow = get_icon ( " arrow_up " , " Tree " ) ;
2018-05-15 20:12:35 +00:00
} else {
2018-07-18 22:37:17 +00:00
arrow = get_icon ( " arrow " , " Tree " ) ;
2018-05-15 20:12:35 +00:00
}
}
# endif
Size2 size = get_size ( ) ;
Point2 offset ;
offset . y = font - > get_height ( ) ;
if ( arrow . is_valid ( ) ) {
offset . y = MAX ( offset . y , arrow - > get_height ( ) ) ;
}
offset . y + = get_constant ( " vseparation " , " Tree " ) ;
2018-07-18 22:37:17 +00:00
offset . x + = get_constant ( " inspector_margin " , " Editor " ) ;
2018-05-15 20:12:35 +00:00
Rect2 rect ( offset , size - offset ) ;
//set children
for ( int i = 0 ; i < get_child_count ( ) ; i + + ) {
Control * c = Object : : cast_to < Control > ( get_child ( i ) ) ;
if ( ! c )
continue ;
if ( c - > is_set_as_toplevel ( ) )
continue ;
if ( ! c - > is_visible_in_tree ( ) )
continue ;
fit_child_in_rect ( c , rect ) ;
}
update ( ) ; //need to redraw text
}
if ( p_what = = NOTIFICATION_DRAW ) {
Ref < Texture > arrow ;
# ifdef TOOLS_ENABLED
if ( foldable ) {
if ( object - > editor_is_section_unfolded ( section ) ) {
2018-07-18 22:37:17 +00:00
arrow = get_icon ( " arrow_up " , " Tree " ) ;
2018-05-15 20:12:35 +00:00
} else {
2018-07-18 22:37:17 +00:00
arrow = get_icon ( " arrow " , " Tree " ) ;
2018-05-15 20:12:35 +00:00
}
}
# endif
Ref < Font > font = get_font ( " font " , " Tree " ) ;
int h = font - > get_height ( ) ;
if ( arrow . is_valid ( ) ) {
h = MAX ( h , arrow - > get_height ( ) ) ;
}
h + = get_constant ( " vseparation " , " Tree " ) ;
draw_rect ( Rect2 ( Vector2 ( ) , Vector2 ( get_size ( ) . width , h ) ) , bg_color ) ;
int hs = get_constant ( " hseparation " , " Tree " ) ;
2018-07-18 22:37:17 +00:00
Color color = get_color ( " font_color " , " Tree " ) ;
draw_string ( font , Point2 ( hs , font - > get_ascent ( ) + ( h - font - > get_height ( ) ) / 2 ) . floor ( ) , label , color , get_size ( ) . width ) ;
2018-05-15 20:12:35 +00:00
if ( arrow . is_valid ( ) ) {
2018-07-18 22:37:17 +00:00
draw_texture ( arrow , Point2 ( get_size ( ) . width - arrow - > get_width ( ) , ( h - arrow - > get_height ( ) ) / 2 ) . floor ( ) ) ;
2018-05-15 20:12:35 +00:00
}
}
}
Size2 EditorInspectorSection : : get_minimum_size ( ) const {
Size2 ms ;
for ( int i = 0 ; i < get_child_count ( ) ; i + + ) {
Control * c = Object : : cast_to < Control > ( get_child ( i ) ) ;
if ( ! c )
continue ;
if ( c - > is_set_as_toplevel ( ) )
continue ;
if ( ! c - > is_visible ( ) )
continue ;
Size2 minsize = c - > get_combined_minimum_size ( ) ;
ms . width = MAX ( ms . width , minsize . width ) ;
ms . height = MAX ( ms . height , minsize . height ) ;
}
Ref < Font > font = get_font ( " font " , " Tree " ) ;
2018-07-18 22:37:17 +00:00
ms . height + = font - > get_height ( ) + get_constant ( " vseparation " , " Tree " ) ;
ms . width + = get_constant ( " inspector_margin " , " Editor " ) ;
2018-05-15 20:12:35 +00:00
return ms ;
}
void EditorInspectorSection : : setup ( const String & p_section , const String & p_label , Object * p_object , const Color & p_bg_color , bool p_foldable ) {
section = p_section ;
label = p_label ;
object = p_object ;
bg_color = p_bg_color ;
foldable = p_foldable ;
2018-07-18 22:37:17 +00:00
if ( ! foldable & & ! vbox_added ) {
add_child ( vbox ) ;
vbox_added = true ;
}
2018-05-15 20:12:35 +00:00
# ifdef TOOLS_ENABLED
if ( foldable ) {
2018-07-18 22:37:17 +00:00
_test_unfold ( ) ;
2018-05-15 20:12:35 +00:00
if ( object - > editor_is_section_unfolded ( section ) ) {
vbox - > show ( ) ;
} else {
vbox - > hide ( ) ;
}
}
# endif
}
void EditorInspectorSection : : _gui_input ( const Ref < InputEvent > & p_event ) {
if ( ! foldable )
return ;
# ifdef TOOLS_ENABLED
Ref < InputEventMouseButton > mb = p_event ;
if ( mb . is_valid ( ) & & mb - > is_pressed ( ) & & mb - > get_button_index ( ) = = BUTTON_LEFT ) {
2018-07-18 22:37:17 +00:00
2018-11-19 00:52:01 +00:00
Ref < Font > font = get_font ( " font " , " Tree " ) ;
if ( mb - > get_position ( ) . y > font - > get_height ( ) ) { //clicked outside
return ;
}
2018-07-18 22:37:17 +00:00
_test_unfold ( ) ;
2018-05-15 20:12:35 +00:00
bool unfold = ! object - > editor_is_section_unfolded ( section ) ;
object - > editor_set_section_unfold ( section , unfold ) ;
if ( unfold ) {
vbox - > show ( ) ;
} else {
vbox - > hide ( ) ;
}
}
# endif
}
VBoxContainer * EditorInspectorSection : : get_vbox ( ) {
return vbox ;
}
void EditorInspectorSection : : unfold ( ) {
if ( ! foldable )
return ;
2018-07-18 22:37:17 +00:00
_test_unfold ( ) ;
2018-05-15 20:12:35 +00:00
# ifdef TOOLS_ENABLED
object - > editor_set_section_unfold ( section , true ) ;
vbox - > show ( ) ;
update ( ) ;
# endif
}
void EditorInspectorSection : : fold ( ) {
if ( ! foldable )
return ;
2018-07-18 22:37:17 +00:00
if ( ! vbox_added )
return ; //kinda pointless
2018-05-15 20:12:35 +00:00
2018-09-11 13:53:50 +00:00
# ifdef TOOLS_ENABLED
2018-05-15 20:12:35 +00:00
object - > editor_set_section_unfold ( section , false ) ;
vbox - > hide ( ) ;
update ( ) ;
# endif
}
void EditorInspectorSection : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " setup " , " section " , " label " , " object " , " bg_color " , " foldable " ) , & EditorInspectorSection : : setup ) ;
ClassDB : : bind_method ( D_METHOD ( " get_vbox " ) , & EditorInspectorSection : : get_vbox ) ;
ClassDB : : bind_method ( D_METHOD ( " unfold " ) , & EditorInspectorSection : : unfold ) ;
ClassDB : : bind_method ( D_METHOD ( " fold " ) , & EditorInspectorSection : : fold ) ;
ClassDB : : bind_method ( D_METHOD ( " _gui_input " ) , & EditorInspectorSection : : _gui_input ) ;
}
EditorInspectorSection : : EditorInspectorSection ( ) {
object = NULL ;
foldable = false ;
vbox = memnew ( VBoxContainer ) ;
2018-07-18 22:37:17 +00:00
vbox_added = false ;
}
EditorInspectorSection : : ~ EditorInspectorSection ( ) {
if ( ! vbox_added ) {
memdelete ( vbox ) ;
}
2018-05-15 20:12:35 +00:00
}
////////////////////////////////////////////////
////////////////////////////////////////////////
Ref < EditorInspectorPlugin > EditorInspector : : inspector_plugins [ MAX_PLUGINS ] ;
int EditorInspector : : inspector_plugin_count = 0 ;
2018-07-14 21:15:42 +00:00
EditorProperty * EditorInspector : : instantiate_property_editor ( Object * p_object , Variant : : Type p_type , const String & p_path , PropertyHint p_hint , const String & p_hint_text , int p_usage ) {
for ( int i = inspector_plugin_count - 1 ; i > = 0 ; i - - ) {
inspector_plugins [ i ] - > parse_property ( p_object , p_type , p_path , p_hint , p_hint_text , p_usage ) ;
if ( inspector_plugins [ i ] - > added_editors . size ( ) ) {
for ( int j = 1 ; j < inspector_plugins [ i ] - > added_editors . size ( ) ; j + + ) { //only keep first one
memdelete ( inspector_plugins [ i ] - > added_editors [ j ] . property_editor ) ;
}
EditorProperty * prop = Object : : cast_to < EditorProperty > ( inspector_plugins [ i ] - > added_editors [ 0 ] . property_editor ) ;
if ( prop ) {
inspector_plugins [ i ] - > added_editors . clear ( ) ;
return prop ;
} else {
memdelete ( inspector_plugins [ i ] - > added_editors [ 0 ] . property_editor ) ;
inspector_plugins [ i ] - > added_editors . clear ( ) ;
}
}
}
return NULL ;
}
2018-05-15 20:12:35 +00:00
void EditorInspector : : add_inspector_plugin ( const Ref < EditorInspectorPlugin > & p_plugin ) {
ERR_FAIL_COND ( inspector_plugin_count = = MAX_PLUGINS ) ;
for ( int i = 0 ; i < inspector_plugin_count ; i + + ) {
if ( inspector_plugins [ i ] = = p_plugin )
return ; //already exists
}
inspector_plugins [ inspector_plugin_count + + ] = p_plugin ;
}
void EditorInspector : : remove_inspector_plugin ( const Ref < EditorInspectorPlugin > & p_plugin ) {
ERR_FAIL_COND ( inspector_plugin_count = = MAX_PLUGINS ) ;
int idx = - 1 ;
for ( int i = 0 ; i < inspector_plugin_count ; i + + ) {
if ( inspector_plugins [ i ] = = p_plugin ) {
idx = i ;
break ;
}
}
for ( int i = idx ; i < inspector_plugin_count - 1 ; i + + ) {
inspector_plugins [ i ] = inspector_plugins [ i + 1 ] ;
}
inspector_plugin_count - - ;
}
void EditorInspector : : cleanup_plugins ( ) {
for ( int i = 0 ; i < inspector_plugin_count ; i + + ) {
inspector_plugins [ i ] . unref ( ) ;
}
inspector_plugin_count = 0 ;
}
void EditorInspector : : set_undo_redo ( UndoRedo * p_undo_redo ) {
undo_redo = p_undo_redo ;
}
String EditorInspector : : get_selected_path ( ) const {
return property_selected ;
}
2018-05-17 21:02:16 +00:00
void EditorInspector : : _parse_added_editors ( VBoxContainer * current_vbox , Ref < EditorInspectorPlugin > ped ) {
for ( List < EditorInspectorPlugin : : AddedEditor > : : Element * F = ped - > added_editors . front ( ) ; F ; F = F - > next ( ) ) {
EditorProperty * ep = Object : : cast_to < EditorProperty > ( F - > get ( ) . property_editor ) ;
current_vbox - > add_child ( F - > get ( ) . property_editor ) ;
if ( ep ) {
ep - > object = object ;
ep - > connect ( " property_changed " , this , " _property_changed " ) ;
ep - > connect ( " property_keyed " , this , " _property_keyed " ) ;
ep - > connect ( " property_keyed_with_value " , this , " _property_keyed_with_value " ) ;
ep - > connect ( " property_checked " , this , " _property_checked " ) ;
ep - > connect ( " selected " , this , " _property_selected " ) ;
ep - > connect ( " multiple_properties_changed " , this , " _multiple_properties_changed " ) ;
ep - > connect ( " resource_selected " , this , " _resource_selected " , varray ( ) , CONNECT_DEFERRED ) ;
ep - > connect ( " object_id_selected " , this , " _object_id_selected " , varray ( ) , CONNECT_DEFERRED ) ;
if ( F - > get ( ) . properties . size ( ) ) {
if ( F - > get ( ) . properties . size ( ) = = 1 ) {
//since it's one, associate:
ep - > property = F - > get ( ) . properties [ 0 ] ;
ep - > property_usage = 0 ;
}
if ( F - > get ( ) . label ! = String ( ) ) {
ep - > set_label ( F - > get ( ) . label ) ;
}
for ( int i = 0 ; i < F - > get ( ) . properties . size ( ) ; i + + ) {
String prop = F - > get ( ) . properties [ i ] ;
if ( ! editor_property_map . has ( prop ) ) {
editor_property_map [ prop ] = List < EditorProperty * > ( ) ;
}
editor_property_map [ prop ] . push_back ( ep ) ;
}
}
ep - > set_read_only ( read_only ) ;
ep - > update_property ( ) ;
ep - > update_reload_status ( ) ;
}
}
ped - > added_editors . clear ( ) ;
}
2018-05-15 20:12:35 +00:00
void EditorInspector : : update_tree ( ) {
//to update properly if all is refreshed
StringName current_selected = property_selected ;
2019-01-22 15:29:26 +00:00
int current_focusable = - 1 ;
if ( property_focusable ! = - 1 ) {
//check focusable is really focusable
bool restore_focus = false ;
Control * focused = get_focus_owner ( ) ;
if ( focused ) {
Node * parent = focused - > get_parent ( ) ;
while ( parent ) {
EditorInspector * inspector = Object : : cast_to < EditorInspector > ( parent ) ;
if ( inspector ) {
restore_focus = inspector = = this ; //may be owned by another inspector
break ; //exit after the first inspector is found, since there may be nested ones
}
parent = parent - > get_parent ( ) ;
}
}
if ( restore_focus ) {
current_focusable = property_focusable ;
}
}
2018-05-15 20:12:35 +00:00
_clear ( ) ;
if ( ! object )
return ;
List < Ref < EditorInspectorPlugin > > valid_plugins ;
for ( int i = inspector_plugin_count - 1 ; i > = 0 ; i - - ) { //start by last, so lastly added can override newly added
if ( ! inspector_plugins [ i ] - > can_handle ( object ) )
continue ;
valid_plugins . push_back ( inspector_plugins [ i ] ) ;
}
bool draw_red = false ;
{
Node * nod = Object : : cast_to < Node > ( object ) ;
Node * es = EditorNode : : get_singleton ( ) - > get_edited_scene ( ) ;
if ( nod & & es ! = nod & & nod - > get_owner ( ) ! = es ) {
draw_red = true ;
}
}
// TreeItem *current_category = NULL;
String filter = search_box ? search_box - > get_text ( ) : " " ;
String group ;
String group_base ;
2018-07-18 22:37:17 +00:00
VBoxContainer * category_vbox = NULL ;
2018-05-15 20:12:35 +00:00
2018-07-18 22:37:17 +00:00
List < PropertyInfo >
plist ;
2018-05-15 20:12:35 +00:00
object - > get_property_list ( & plist , true ) ;
HashMap < String , VBoxContainer * > item_path ;
2018-10-29 20:38:51 +00:00
Map < VBoxContainer * , EditorInspectorSection * > section_map ;
2018-05-15 20:12:35 +00:00
item_path [ " " ] = main_vbox ;
Color sscolor = get_color ( " prop_subsection " , " Editor " ) ;
2018-05-17 21:02:16 +00:00
for ( List < Ref < EditorInspectorPlugin > > : : Element * E = valid_plugins . front ( ) ; E ; E = E - > next ( ) ) {
Ref < EditorInspectorPlugin > ped = E - > get ( ) ;
ped - > parse_begin ( object ) ;
_parse_added_editors ( main_vbox , ped ) ;
}
2018-05-15 20:12:35 +00:00
for ( List < PropertyInfo > : : Element * I = plist . front ( ) ; I ; I = I - > next ( ) ) {
PropertyInfo & p = I - > get ( ) ;
//make sure the property can be edited
if ( p . usage & PROPERTY_USAGE_GROUP ) {
group = p . name ;
group_base = p . hint_string ;
continue ;
} else if ( p . usage & PROPERTY_USAGE_CATEGORY ) {
group = " " ;
group_base = " " ;
if ( ! show_categories )
continue ;
List < PropertyInfo > : : Element * N = I - > next ( ) ;
bool valid = true ;
//if no properties in category, skip
while ( N ) {
if ( N - > get ( ) . usage & PROPERTY_USAGE_EDITOR )
break ;
if ( N - > get ( ) . usage & PROPERTY_USAGE_CATEGORY ) {
valid = false ;
break ;
}
N = N - > next ( ) ;
}
if ( ! valid )
continue ; //empty, ignore
EditorInspectorCategory * category = memnew ( EditorInspectorCategory ) ;
main_vbox - > add_child ( category ) ;
2018-07-18 22:37:17 +00:00
category_vbox = NULL ; //reset
2018-05-15 20:12:35 +00:00
String type = p . name ;
2018-09-02 21:40:51 +00:00
category - > icon = EditorNode : : get_singleton ( ) - > get_class_icon ( type , " Object " ) ;
2018-05-15 20:12:35 +00:00
category - > label = type ;
category - > bg_color = get_color ( " prop_category " , " Editor " ) ;
if ( use_doc_hints ) {
StringName type = p . name ;
if ( ! class_descr_cache . has ( type ) ) {
String descr ;
DocData * dd = EditorHelp : : get_doc_data ( ) ;
Map < String , DocData : : ClassDoc > : : Element * E = dd - > class_list . find ( type ) ;
if ( E ) {
descr = E - > get ( ) . brief_description ;
}
class_descr_cache [ type ] = descr . word_wrap ( 80 ) ;
}
2018-07-20 21:14:33 +00:00
category - > set_tooltip ( p . name + " :: " + ( class_descr_cache [ type ] = = " " ? " " : class_descr_cache [ type ] ) ) ;
2018-05-15 20:12:35 +00:00
}
2018-05-17 21:02:16 +00:00
for ( List < Ref < EditorInspectorPlugin > > : : Element * E = valid_plugins . front ( ) ; E ; E = E - > next ( ) ) {
Ref < EditorInspectorPlugin > ped = E - > get ( ) ;
ped - > parse_category ( object , p . name ) ;
_parse_added_editors ( main_vbox , ped ) ;
}
2018-05-15 20:12:35 +00:00
continue ;
} else if ( ! ( p . usage & PROPERTY_USAGE_EDITOR ) )
continue ;
2018-09-28 23:32:40 +00:00
if ( p . usage & PROPERTY_USAGE_HIGH_END_GFX & & VS : : get_singleton ( ) - > is_low_end ( ) )
continue ; //do not show this property in low end gfx
2018-06-07 15:46:14 +00:00
if ( p . name = = " script " & & ( hide_script | | bool ( object - > call ( " _hide_script_from_inspector " ) ) ) ) {
2018-05-15 20:12:35 +00:00
continue ;
2018-06-07 15:46:14 +00:00
}
2018-05-15 20:12:35 +00:00
String basename = p . name ;
if ( group ! = " " ) {
if ( group_base ! = " " ) {
if ( basename . begins_with ( group_base ) ) {
basename = basename . replace_first ( group_base , " " ) ;
} else if ( group_base . begins_with ( basename ) ) {
//keep it, this is used pretty often
} else {
group = " " ; //no longer using group base, clear
}
}
}
if ( group ! = " " ) {
basename = group + " / " + basename ;
}
String name = ( basename . find ( " / " ) ! = - 1 ) ? basename . right ( basename . find_last ( " / " ) + 1 ) : basename ;
if ( capitalize_paths ) {
int dot = name . find ( " . " ) ;
if ( dot ! = - 1 ) {
String ov = name . right ( dot ) ;
name = name . substr ( 0 , dot ) ;
name = name . camelcase_to_underscore ( ) . capitalize ( ) ;
name + = ov ;
} else {
name = name . camelcase_to_underscore ( ) . capitalize ( ) ;
}
}
String path = basename . left ( basename . find_last ( " / " ) ) ;
if ( use_filter & & filter ! = " " ) {
String cat = path ;
if ( capitalize_paths )
cat = cat . capitalize ( ) ;
if ( ! filter . is_subsequence_ofi ( cat ) & & ! filter . is_subsequence_ofi ( name ) )
continue ;
}
2018-07-18 22:37:17 +00:00
if ( category_vbox = = NULL ) {
category_vbox = memnew ( VBoxContainer ) ;
main_vbox - > add_child ( category_vbox ) ;
}
2018-05-15 20:12:35 +00:00
VBoxContainer * current_vbox = main_vbox ;
{
String acc_path = " " ;
int level = 1 ;
for ( int i = 0 ; i < path . get_slice_count ( " / " ) ; i + + ) {
String path_name = path . get_slice ( " / " , i ) ;
if ( i > 0 )
acc_path + = " / " ;
acc_path + = path_name ;
if ( ! item_path . has ( acc_path ) ) {
EditorInspectorSection * section = memnew ( EditorInspectorSection ) ;
current_vbox - > add_child ( section ) ;
sections . push_back ( section ) ;
if ( capitalize_paths )
path_name = path_name . capitalize ( ) ;
2018-08-20 16:38:18 +00:00
2018-05-15 20:12:35 +00:00
Color c = sscolor ;
c . a / = level ;
2018-08-20 20:07:02 +00:00
section - > setup ( acc_path , path_name , object , c , use_folding ) ;
2018-05-15 20:12:35 +00:00
2018-10-29 20:38:51 +00:00
VBoxContainer * vb = section - > get_vbox ( ) ;
item_path [ acc_path ] = vb ;
section_map [ vb ] = section ;
2018-05-15 20:12:35 +00:00
}
current_vbox = item_path [ acc_path ] ;
level = ( MIN ( level + 1 , 4 ) ) ;
}
2018-07-18 22:37:17 +00:00
if ( current_vbox = = main_vbox ) {
//do not add directly to the main vbox, given it has no spacing
if ( category_vbox = = NULL ) {
category_vbox = memnew ( VBoxContainer ) ;
}
current_vbox = category_vbox ;
}
2018-05-15 20:12:35 +00:00
}
bool checkable = false ;
bool checked = false ;
if ( p . usage & PROPERTY_USAGE_CHECKABLE ) {
checkable = true ;
checked = p . usage & PROPERTY_USAGE_CHECKED ;
}
2018-07-19 21:58:15 +00:00
if ( p . usage & PROPERTY_USAGE_RESTART_IF_CHANGED ) {
restart_request_props . insert ( p . name ) ;
}
2018-05-15 20:12:35 +00:00
String doc_hint ;
if ( use_doc_hints ) {
StringName classname = object - > get_class_name ( ) ;
2018-07-19 21:58:15 +00:00
if ( object_class ! = String ( ) ) {
classname = object_class ;
}
StringName propname = property_prefix + p . name ;
2018-05-15 20:12:35 +00:00
String descr ;
bool found = false ;
Map < StringName , Map < StringName , String > > : : Element * E = descr_cache . find ( classname ) ;
if ( E ) {
Map < StringName , String > : : Element * F = E - > get ( ) . find ( propname ) ;
if ( F ) {
found = true ;
descr = F - > get ( ) ;
}
}
if ( ! found ) {
DocData * dd = EditorHelp : : get_doc_data ( ) ;
Map < String , DocData : : ClassDoc > : : Element * E = dd - > class_list . find ( classname ) ;
while ( E & & descr = = String ( ) ) {
for ( int i = 0 ; i < E - > get ( ) . properties . size ( ) ; i + + ) {
if ( E - > get ( ) . properties [ i ] . name = = propname . operator String ( ) ) {
descr = E - > get ( ) . properties [ i ] . description . strip_edges ( ) . word_wrap ( 80 ) ;
break ;
}
}
if ( ! E - > get ( ) . inherits . empty ( ) ) {
E = dd - > class_list . find ( E - > get ( ) . inherits ) ;
} else {
break ;
}
}
descr_cache [ classname ] [ propname ] = descr ;
}
doc_hint = descr ;
}
for ( List < Ref < EditorInspectorPlugin > > : : Element * E = valid_plugins . front ( ) ; E ; E = E - > next ( ) ) {
Ref < EditorInspectorPlugin > ped = E - > get ( ) ;
2018-06-26 22:05:11 +00:00
bool exclusive = ped - > parse_property ( object , p . type , p . name , p . hint , p . hint_string , p . usage ) ;
2018-05-17 21:02:16 +00:00
List < EditorInspectorPlugin : : AddedEditor > editors = ped - > added_editors ; //make a copy, since plugins may be used again in a sub-inspector
ped - > added_editors . clear ( ) ;
for ( List < EditorInspectorPlugin : : AddedEditor > : : Element * F = editors . front ( ) ; F ; F = F - > next ( ) ) {
2018-05-15 20:12:35 +00:00
EditorProperty * ep = Object : : cast_to < EditorProperty > ( F - > get ( ) . property_editor ) ;
if ( ep ) {
2018-08-07 15:19:19 +00:00
//set all this before the control gets the ENTER_TREE notification
2018-05-15 20:12:35 +00:00
ep - > object = object ;
if ( F - > get ( ) . properties . size ( ) ) {
if ( F - > get ( ) . properties . size ( ) = = 1 ) {
//since it's one, associate:
ep - > property = F - > get ( ) . properties [ 0 ] ;
ep - > property_usage = p . usage ;
//and set label?
}
if ( F - > get ( ) . label ! = String ( ) ) {
ep - > set_label ( F - > get ( ) . label ) ;
} else {
//use existin one
ep - > set_label ( name ) ;
}
for ( int i = 0 ; i < F - > get ( ) . properties . size ( ) ; i + + ) {
String prop = F - > get ( ) . properties [ i ] ;
if ( ! editor_property_map . has ( prop ) ) {
editor_property_map [ prop ] = List < EditorProperty * > ( ) ;
}
editor_property_map [ prop ] . push_back ( ep ) ;
}
}
2018-08-07 15:19:19 +00:00
ep - > set_draw_red ( draw_red ) ;
ep - > set_use_folding ( use_folding ) ;
ep - > set_checkable ( checkable ) ;
ep - > set_checked ( checked ) ;
ep - > set_keying ( keying ) ;
2018-05-15 20:12:35 +00:00
ep - > set_read_only ( read_only ) ;
2018-08-07 15:19:19 +00:00
}
current_vbox - > add_child ( F - > get ( ) . property_editor ) ;
if ( ep ) {
ep - > connect ( " property_changed " , this , " _property_changed " ) ;
if ( p . usage & PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED ) {
ep - > connect ( " property_changed " , this , " _property_changed_update_all " , varray ( ) , CONNECT_DEFERRED ) ;
}
ep - > connect ( " property_keyed " , this , " _property_keyed " ) ;
ep - > connect ( " property_keyed_with_value " , this , " _property_keyed_with_value " ) ;
ep - > connect ( " property_checked " , this , " _property_checked " ) ;
ep - > connect ( " selected " , this , " _property_selected " ) ;
ep - > connect ( " multiple_properties_changed " , this , " _multiple_properties_changed " ) ;
ep - > connect ( " resource_selected " , this , " _resource_selected " , varray ( ) , CONNECT_DEFERRED ) ;
ep - > connect ( " object_id_selected " , this , " _object_id_selected " , varray ( ) , CONNECT_DEFERRED ) ;
if ( doc_hint ! = String ( ) ) {
ep - > set_tooltip ( property_prefix + p . name + " :: " + doc_hint ) ;
} else {
ep - > set_tooltip ( property_prefix + p . name ) ;
}
2018-05-15 20:12:35 +00:00
ep - > update_property ( ) ;
ep - > update_reload_status ( ) ;
if ( current_selected & & ep - > property = = current_selected ) {
ep - > select ( current_focusable ) ;
}
}
}
2018-06-26 22:05:11 +00:00
if ( exclusive ) {
break ;
}
2018-05-15 20:12:35 +00:00
}
}
2018-05-17 21:02:16 +00:00
for ( List < Ref < EditorInspectorPlugin > > : : Element * E = valid_plugins . front ( ) ; E ; E = E - > next ( ) ) {
Ref < EditorInspectorPlugin > ped = E - > get ( ) ;
ped - > parse_end ( ) ;
_parse_added_editors ( main_vbox , ped ) ;
}
2018-05-15 20:12:35 +00:00
//see if this property exists and should be kept
}
void EditorInspector : : update_property ( const String & p_prop ) {
if ( ! editor_property_map . has ( p_prop ) )
return ;
for ( List < EditorProperty * > : : Element * E = editor_property_map [ p_prop ] . front ( ) ; E ; E = E - > next ( ) ) {
E - > get ( ) - > update_property ( ) ;
E - > get ( ) - > update_reload_status ( ) ;
}
}
void EditorInspector : : _clear ( ) {
while ( main_vbox - > get_child_count ( ) ) {
memdelete ( main_vbox - > get_child ( 0 ) ) ;
}
2018-05-17 21:02:16 +00:00
property_selected = StringName ( ) ;
property_focusable = - 1 ;
editor_property_map . clear ( ) ;
sections . clear ( ) ;
pending . clear ( ) ;
2018-07-19 21:58:15 +00:00
restart_request_props . clear ( ) ;
2018-05-15 20:12:35 +00:00
}
void EditorInspector : : refresh ( ) {
2018-07-04 23:08:45 +00:00
if ( refresh_countdown > 0 | | changing )
2018-05-15 20:12:35 +00:00
return ;
refresh_countdown = EditorSettings : : get_singleton ( ) - > get ( " docks/property_editor/auto_refresh_interval " ) ;
}
2018-05-17 21:02:16 +00:00
Object * EditorInspector : : get_edited_object ( ) {
return object ;
}
2018-05-15 20:12:35 +00:00
2018-05-17 21:02:16 +00:00
void EditorInspector : : edit ( Object * p_object ) {
if ( object = = p_object )
return ;
2018-05-15 20:12:35 +00:00
if ( object ) {
2018-05-17 21:02:16 +00:00
_clear ( ) ;
2018-05-15 20:12:35 +00:00
object - > remove_change_receptor ( this ) ;
}
object = p_object ;
2018-05-17 21:02:16 +00:00
2018-05-15 20:12:35 +00:00
if ( object ) {
2018-07-18 22:37:17 +00:00
update_scroll_request = 0 ; //reset
if ( scroll_cache . has ( object - > get_instance_id ( ) ) ) { //if exists, set something else
2018-09-13 01:38:39 +00:00
update_scroll_request = scroll_cache [ object - > get_instance_id ( ) ] ; //done this way because wait until full size is accommodated
2018-07-18 22:37:17 +00:00
}
2018-05-15 20:12:35 +00:00
object - > add_change_receptor ( this ) ;
update_tree ( ) ;
}
}
void EditorInspector : : set_keying ( bool p_active ) {
if ( keying = = p_active )
return ;
keying = p_active ;
update_tree ( ) ;
}
void EditorInspector : : set_read_only ( bool p_read_only ) {
read_only = p_read_only ;
update_tree ( ) ;
}
bool EditorInspector : : is_capitalize_paths_enabled ( ) const {
return capitalize_paths ;
}
void EditorInspector : : set_enable_capitalize_paths ( bool p_capitalize ) {
capitalize_paths = p_capitalize ;
update_tree ( ) ;
}
void EditorInspector : : set_autoclear ( bool p_enable ) {
autoclear = p_enable ;
}
void EditorInspector : : set_show_categories ( bool p_show ) {
show_categories = p_show ;
update_tree ( ) ;
}
void EditorInspector : : set_use_doc_hints ( bool p_enable ) {
use_doc_hints = p_enable ;
update_tree ( ) ;
}
void EditorInspector : : set_hide_script ( bool p_hide ) {
hide_script = p_hide ;
update_tree ( ) ;
}
void EditorInspector : : set_use_filter ( bool p_use ) {
use_filter = p_use ;
update_tree ( ) ;
}
void EditorInspector : : register_text_enter ( Node * p_line_edit ) {
search_box = Object : : cast_to < LineEdit > ( p_line_edit ) ;
if ( search_box )
search_box - > connect ( " text_changed " , this , " _filter_changed " ) ;
}
void EditorInspector : : _filter_changed ( const String & p_text ) {
2018-06-05 17:12:01 +00:00
_clear ( ) ;
2018-05-15 20:12:35 +00:00
update_tree ( ) ;
}
void EditorInspector : : set_use_folding ( bool p_enable ) {
use_folding = p_enable ;
update_tree ( ) ;
}
2018-06-14 18:36:38 +00:00
bool EditorInspector : : is_using_folding ( ) {
return use_folding ;
}
2018-05-15 20:12:35 +00:00
void EditorInspector : : collapse_all_folding ( ) {
for ( List < EditorInspectorSection * > : : Element * E = sections . front ( ) ; E ; E = E - > next ( ) ) {
E - > get ( ) - > fold ( ) ;
}
2018-05-17 21:02:16 +00:00
for ( Map < StringName , List < EditorProperty * > > : : Element * F = editor_property_map . front ( ) ; F ; F = F - > next ( ) ) {
for ( List < EditorProperty * > : : Element * E = F - > get ( ) . front ( ) ; E ; E = E - > next ( ) ) {
E - > get ( ) - > collapse_all_folding ( ) ;
}
}
2018-05-15 20:12:35 +00:00
}
void EditorInspector : : expand_all_folding ( ) {
for ( List < EditorInspectorSection * > : : Element * E = sections . front ( ) ; E ; E = E - > next ( ) ) {
E - > get ( ) - > unfold ( ) ;
}
2018-05-17 21:02:16 +00:00
for ( Map < StringName , List < EditorProperty * > > : : Element * F = editor_property_map . front ( ) ; F ; F = F - > next ( ) ) {
for ( List < EditorProperty * > : : Element * E = F - > get ( ) . front ( ) ; E ; E = E - > next ( ) ) {
E - > get ( ) - > expand_all_folding ( ) ;
}
}
2018-05-15 20:12:35 +00:00
}
void EditorInspector : : set_scroll_offset ( int p_offset ) {
set_v_scroll ( p_offset ) ;
}
int EditorInspector : : get_scroll_offset ( ) const {
return get_v_scroll ( ) ;
}
2019-01-25 18:14:56 +00:00
void EditorInspector : : set_sub_inspector ( bool p_enable ) {
2018-07-18 22:37:17 +00:00
2019-01-25 18:14:56 +00:00
sub_inspector = p_enable ;
2018-07-18 22:37:17 +00:00
if ( ! is_inside_tree ( ) )
return ;
2019-01-25 18:14:56 +00:00
if ( sub_inspector ) {
2018-07-18 22:37:17 +00:00
add_style_override ( " bg " , get_stylebox ( " sub_inspector_bg " , " Editor " ) ) ;
} else {
add_style_override ( " bg " , get_stylebox ( " bg " , " Tree " ) ) ;
}
}
2018-05-15 20:12:35 +00:00
void EditorInspector : : _edit_request_change ( Object * p_object , const String & p_property ) {
if ( object ! = p_object ) //may be undoing/redoing for a non edited object, so ignore
return ;
if ( changing )
return ;
if ( p_property = = String ( ) )
update_tree_pending = true ;
else {
pending . insert ( p_property ) ;
}
}
void EditorInspector : : _edit_set ( const String & p_name , const Variant & p_value , bool p_refresh_all , const String & p_changed_field ) {
if ( autoclear & & editor_property_map . has ( p_name ) ) {
for ( List < EditorProperty * > : : Element * E = editor_property_map [ p_name ] . front ( ) ; E ; E = E - > next ( ) ) {
if ( E - > get ( ) - > is_checkable ( ) ) {
E - > get ( ) - > set_checked ( true ) ;
}
}
}
if ( ! undo_redo | | Object : : cast_to < ArrayPropertyEdit > ( object ) | | Object : : cast_to < DictionaryPropertyEdit > ( object ) ) { //kind of hacky
object - > set ( p_name , p_value ) ;
if ( p_refresh_all )
_edit_request_change ( object , " " ) ;
else
_edit_request_change ( object , p_name ) ;
emit_signal ( _prop_edited , p_name ) ;
} else if ( Object : : cast_to < MultiNodeEdit > ( object ) ) {
Object : : cast_to < MultiNodeEdit > ( object ) - > set_property_field ( p_name , p_value , p_changed_field ) ;
_edit_request_change ( object , p_name ) ;
emit_signal ( _prop_edited , p_name ) ;
} else {
undo_redo - > create_action ( TTR ( " Set " ) + " " + p_name , UndoRedo : : MERGE_ENDS ) ;
undo_redo - > add_do_property ( object , p_name , p_value ) ;
undo_redo - > add_undo_property ( object , p_name , object - > get ( p_name ) ) ;
if ( p_refresh_all ) {
undo_redo - > add_do_method ( this , " _edit_request_change " , object , " " ) ;
undo_redo - > add_undo_method ( this , " _edit_request_change " , object , " " ) ;
} else {
undo_redo - > add_do_method ( this , " _edit_request_change " , object , p_name ) ;
undo_redo - > add_undo_method ( this , " _edit_request_change " , object , p_name ) ;
}
Resource * r = Object : : cast_to < Resource > ( object ) ;
if ( r ) {
if ( String ( p_name ) = = " resource_local_to_scene " ) {
bool prev = object - > get ( p_name ) ;
bool next = p_value ;
if ( next ) {
undo_redo - > add_do_method ( r , " setup_local_to_scene " ) ;
}
if ( prev ) {
undo_redo - > add_undo_method ( r , " setup_local_to_scene " ) ;
}
}
}
undo_redo - > add_do_method ( this , " emit_signal " , _prop_edited , p_name ) ;
undo_redo - > add_undo_method ( this , " emit_signal " , _prop_edited , p_name ) ;
undo_redo - > commit_action ( ) ;
}
if ( editor_property_map . has ( p_name ) ) {
for ( List < EditorProperty * > : : Element * E = editor_property_map [ p_name ] . front ( ) ; E ; E = E - > next ( ) ) {
E - > get ( ) - > update_reload_status ( ) ;
}
}
}
2018-09-02 17:16:33 +00:00
void EditorInspector : : _property_changed ( const String & p_path , const Variant & p_value , const String & p_name , bool changing ) {
2018-07-04 23:08:45 +00:00
// The "changing" variable must be true for properties that trigger events as typing occurs,
// like "text_changed" signal. eg: Text property of Label, Button, RichTextLabel, etc.
if ( changing )
this - > changing + + ;
2018-05-15 20:12:35 +00:00
2018-09-02 17:16:33 +00:00
_edit_set ( p_path , p_value , false , p_name ) ;
2018-07-04 23:08:45 +00:00
if ( changing )
this - > changing - - ;
2018-07-19 21:58:15 +00:00
if ( restart_request_props . has ( p_path ) ) {
emit_signal ( " restart_requested " ) ;
}
2018-05-15 20:12:35 +00:00
}
2019-01-27 16:37:24 +00:00
void EditorInspector : : _property_changed_update_all ( const String & p_path , const Variant & p_value , const String & p_name , bool p_changing ) {
2018-06-19 01:10:48 +00:00
update_tree ( ) ;
}
2018-05-15 20:12:35 +00:00
void EditorInspector : : _multiple_properties_changed ( Vector < String > p_paths , Array p_values ) {
ERR_FAIL_COND ( p_paths . size ( ) = = 0 | | p_values . size ( ) = = 0 ) ;
ERR_FAIL_COND ( p_paths . size ( ) ! = p_values . size ( ) ) ;
String names ;
for ( int i = 0 ; i < p_paths . size ( ) ; i + + ) {
if ( i > 0 )
names + = " , " ;
names + = p_paths [ i ] ;
}
undo_redo - > create_action ( TTR ( " Set Multiple: " ) + " " + names , UndoRedo : : MERGE_ENDS ) ;
for ( int i = 0 ; i < p_paths . size ( ) ; i + + ) {
_edit_set ( p_paths [ i ] , p_values [ i ] , false , " " ) ;
2018-07-19 21:58:15 +00:00
if ( restart_request_props . has ( p_paths [ i ] ) ) {
emit_signal ( " restart_requested " ) ;
}
2018-05-15 20:12:35 +00:00
}
changing + + ;
undo_redo - > commit_action ( ) ;
changing - - ;
}
2018-11-08 20:46:34 +00:00
void EditorInspector : : _property_keyed ( const String & p_path , bool p_advance ) {
2018-05-15 20:12:35 +00:00
if ( ! object )
return ;
2018-11-08 20:46:34 +00:00
emit_signal ( " property_keyed " , p_path , object - > get ( p_path ) , p_advance ) ; //second param is deprecated
2018-05-15 20:12:35 +00:00
}
2018-11-08 20:46:34 +00:00
void EditorInspector : : _property_keyed_with_value ( const String & p_path , const Variant & p_value , bool p_advance ) {
2018-05-17 21:02:16 +00:00
if ( ! object )
return ;
2018-11-08 20:46:34 +00:00
emit_signal ( " property_keyed " , p_path , p_value , p_advance ) ; //second param is deprecated
2018-05-17 21:02:16 +00:00
}
2018-05-15 20:12:35 +00:00
void EditorInspector : : _property_checked ( const String & p_path , bool p_checked ) {
if ( ! object )
return ;
//property checked
if ( autoclear ) {
if ( ! p_checked ) {
object - > set ( p_path , Variant ( ) ) ;
} else {
Variant to_create ;
List < PropertyInfo > pinfo ;
object - > get_property_list ( & pinfo ) ;
for ( List < PropertyInfo > : : Element * E = pinfo . front ( ) ; E ; E = E - > next ( ) ) {
if ( E - > get ( ) . name = = p_path ) {
Variant : : CallError ce ;
to_create = Variant : : construct ( E - > get ( ) . type , NULL , 0 , ce ) ;
break ;
}
}
object - > set ( p_path , to_create ) ;
}
if ( editor_property_map . has ( p_path ) ) {
for ( List < EditorProperty * > : : Element * E = editor_property_map [ p_path ] . front ( ) ; E ; E = E - > next ( ) ) {
E - > get ( ) - > update_property ( ) ;
E - > get ( ) - > update_reload_status ( ) ;
}
}
} else {
emit_signal ( " property_toggled " , p_path , p_checked ) ;
}
}
void EditorInspector : : _property_selected ( const String & p_path , int p_focusable ) {
property_selected = p_path ;
property_focusable = p_focusable ;
//deselect the others
for ( Map < StringName , List < EditorProperty * > > : : Element * F = editor_property_map . front ( ) ; F ; F = F - > next ( ) ) {
if ( F - > key ( ) = = property_selected )
continue ;
for ( List < EditorProperty * > : : Element * E = F - > get ( ) . front ( ) ; E ; E = E - > next ( ) ) {
if ( E - > get ( ) - > is_selected ( ) )
E - > get ( ) - > deselect ( ) ;
}
}
2018-07-19 21:58:15 +00:00
emit_signal ( " property_selected " , p_path ) ;
2018-05-15 20:12:35 +00:00
}
void EditorInspector : : _object_id_selected ( const String & p_path , ObjectID p_id ) {
emit_signal ( " object_id_selected " , p_id ) ;
}
void EditorInspector : : _resource_selected ( const String & p_path , RES p_resource ) {
emit_signal ( " resource_selected " , p_resource , p_path ) ;
}
void EditorInspector : : _node_removed ( Node * p_node ) {
if ( p_node = = object ) {
edit ( NULL ) ;
}
}
void EditorInspector : : _notification ( int p_what ) {
if ( p_what = = NOTIFICATION_ENTER_TREE ) {
2019-01-25 18:14:56 +00:00
if ( sub_inspector ) {
2018-07-18 22:37:17 +00:00
add_style_override ( " bg " , get_stylebox ( " sub_inspector_bg " , " Editor " ) ) ;
2019-01-25 18:14:56 +00:00
} else {
2018-07-18 22:37:17 +00:00
add_style_override ( " bg " , get_stylebox ( " bg " , " Tree " ) ) ;
2019-01-25 18:14:56 +00:00
get_tree ( ) - > connect ( " node_removed " , this , " _node_removed " ) ;
2018-07-18 22:37:17 +00:00
}
2018-05-15 20:12:35 +00:00
}
if ( p_what = = NOTIFICATION_EXIT_TREE ) {
2019-01-25 18:14:56 +00:00
if ( ! sub_inspector ) {
get_tree ( ) - > disconnect ( " node_removed " , this , " _node_removed " ) ;
}
2018-05-15 20:12:35 +00:00
edit ( NULL ) ;
}
if ( p_what = = NOTIFICATION_PROCESS ) {
2018-07-18 22:37:17 +00:00
if ( update_scroll_request > = 0 ) {
get_v_scrollbar ( ) - > call_deferred ( " set_value " , update_scroll_request ) ;
update_scroll_request = - 1 ;
}
2018-05-15 20:12:35 +00:00
if ( refresh_countdown > 0 ) {
refresh_countdown - = get_process_delta_time ( ) ;
if ( refresh_countdown < = 0 ) {
for ( Map < StringName , List < EditorProperty * > > : : Element * F = editor_property_map . front ( ) ; F ; F = F - > next ( ) ) {
for ( List < EditorProperty * > : : Element * E = F - > get ( ) . front ( ) ; E ; E = E - > next ( ) ) {
E - > get ( ) - > update_property ( ) ;
E - > get ( ) - > update_reload_status ( ) ;
}
}
}
}
changing + + ;
if ( update_tree_pending ) {
update_tree ( ) ;
update_tree_pending = false ;
pending . clear ( ) ;
} else {
while ( pending . size ( ) ) {
StringName prop = pending . front ( ) - > get ( ) ;
if ( editor_property_map . has ( prop ) ) {
for ( List < EditorProperty * > : : Element * E = editor_property_map [ prop ] . front ( ) ; E ; E = E - > next ( ) ) {
E - > get ( ) - > update_property ( ) ;
E - > get ( ) - > update_reload_status ( ) ;
}
}
pending . erase ( pending . front ( ) ) ;
}
}
changing - - ;
}
if ( p_what = = EditorSettings : : NOTIFICATION_EDITOR_SETTINGS_CHANGED ) {
2018-10-05 18:37:26 +00:00
2019-01-25 18:14:56 +00:00
if ( sub_inspector ) {
2018-10-05 18:37:26 +00:00
add_style_override ( " bg " , get_stylebox ( " sub_inspector_bg " , " Editor " ) ) ;
} else if ( is_inside_tree ( ) ) {
add_style_override ( " bg " , get_stylebox ( " bg " , " Tree " ) ) ;
}
2018-05-15 20:12:35 +00:00
update_tree ( ) ;
}
}
void EditorInspector : : _changed_callback ( Object * p_changed , const char * p_prop ) {
//this is called when property change is notified via _change_notify()
_edit_request_change ( p_changed , p_prop ) ;
}
2018-07-18 22:37:17 +00:00
void EditorInspector : : _vscroll_changed ( double p_offset ) {
if ( update_scroll_request > = 0 ) //waiting, do nothing
return ;
if ( object ) {
scroll_cache [ object - > get_instance_id ( ) ] = p_offset ;
}
}
2018-07-20 06:37:10 +00:00
2018-07-19 21:58:15 +00:00
void EditorInspector : : set_property_prefix ( const String & p_prefix ) {
property_prefix = p_prefix ;
}
String EditorInspector : : get_property_prefix ( ) const {
return property_prefix ;
}
void EditorInspector : : set_object_class ( const String & p_class ) {
object_class = p_class ;
}
String EditorInspector : : get_object_class ( ) const {
return object_class ;
}
2018-07-18 22:37:17 +00:00
2018-05-15 20:12:35 +00:00
void EditorInspector : : _bind_methods ( ) {
2018-09-02 17:16:33 +00:00
ClassDB : : bind_method ( " _property_changed " , & EditorInspector : : _property_changed , DEFVAL ( " " ) , DEFVAL ( false ) ) ;
2018-05-15 20:12:35 +00:00
ClassDB : : bind_method ( " _multiple_properties_changed " , & EditorInspector : : _multiple_properties_changed ) ;
2018-06-19 01:10:48 +00:00
ClassDB : : bind_method ( " _property_changed_update_all " , & EditorInspector : : _property_changed_update_all ) ;
2018-05-15 20:12:35 +00:00
ClassDB : : bind_method ( " _edit_request_change " , & EditorInspector : : _edit_request_change ) ;
ClassDB : : bind_method ( " _node_removed " , & EditorInspector : : _node_removed ) ;
ClassDB : : bind_method ( " _filter_changed " , & EditorInspector : : _filter_changed ) ;
ClassDB : : bind_method ( " _property_keyed " , & EditorInspector : : _property_keyed ) ;
2018-05-17 21:02:16 +00:00
ClassDB : : bind_method ( " _property_keyed_with_value " , & EditorInspector : : _property_keyed_with_value ) ;
2018-05-15 20:12:35 +00:00
ClassDB : : bind_method ( " _property_checked " , & EditorInspector : : _property_checked ) ;
ClassDB : : bind_method ( " _property_selected " , & EditorInspector : : _property_selected ) ;
ClassDB : : bind_method ( " _resource_selected " , & EditorInspector : : _resource_selected ) ;
ClassDB : : bind_method ( " _object_id_selected " , & EditorInspector : : _object_id_selected ) ;
2018-07-18 22:37:17 +00:00
ClassDB : : bind_method ( " _vscroll_changed " , & EditorInspector : : _vscroll_changed ) ;
2018-07-04 23:08:45 +00:00
ClassDB : : bind_method ( " refresh " , & EditorInspector : : refresh ) ;
2018-05-15 20:12:35 +00:00
2018-07-19 21:58:15 +00:00
ADD_SIGNAL ( MethodInfo ( " property_selected " , PropertyInfo ( Variant : : STRING , " property " ) ) ) ;
2018-05-15 20:12:35 +00:00
ADD_SIGNAL ( MethodInfo ( " property_keyed " , PropertyInfo ( Variant : : STRING , " property " ) ) ) ;
ADD_SIGNAL ( MethodInfo ( " resource_selected " , PropertyInfo ( Variant : : OBJECT , " res " ) , PropertyInfo ( Variant : : STRING , " prop " ) ) ) ;
ADD_SIGNAL ( MethodInfo ( " object_id_selected " , PropertyInfo ( Variant : : INT , " id " ) ) ) ;
2018-07-19 21:58:15 +00:00
ADD_SIGNAL ( MethodInfo ( " property_edited " , PropertyInfo ( Variant : : STRING , " property " ) ) ) ;
2018-10-30 16:11:54 +00:00
ADD_SIGNAL ( MethodInfo ( " property_toggled " , PropertyInfo ( Variant : : STRING , " property " ) , PropertyInfo ( Variant : : BOOL , " checked " ) ) ) ;
2018-07-19 21:58:15 +00:00
ADD_SIGNAL ( MethodInfo ( " restart_requested " ) ) ;
2018-05-15 20:12:35 +00:00
}
EditorInspector : : EditorInspector ( ) {
object = NULL ;
undo_redo = NULL ;
main_vbox = memnew ( VBoxContainer ) ;
main_vbox - > set_h_size_flags ( SIZE_EXPAND_FILL ) ;
2018-07-18 22:37:17 +00:00
main_vbox - > add_constant_override ( " separation " , 0 ) ;
2018-05-15 20:12:35 +00:00
add_child ( main_vbox ) ;
2018-05-17 21:02:16 +00:00
set_enable_h_scroll ( false ) ;
set_enable_v_scroll ( true ) ;
2018-05-15 20:12:35 +00:00
show_categories = false ;
hide_script = true ;
use_doc_hints = false ;
2018-08-20 20:07:02 +00:00
capitalize_paths = true ;
2018-05-15 20:12:35 +00:00
use_filter = false ;
autoclear = false ;
changing = 0 ;
use_folding = false ;
update_all_pending = false ;
update_tree_pending = false ;
refresh_countdown = 0 ;
read_only = false ;
search_box = NULL ;
keying = false ;
_prop_edited = " property_edited " ;
set_process ( true ) ;
property_focusable = - 1 ;
2019-01-25 18:14:56 +00:00
sub_inspector = false ;
2018-07-18 22:37:17 +00:00
get_v_scrollbar ( ) - > connect ( " value_changed " , this , " _vscroll_changed " ) ;
update_scroll_request = - 1 ;
2018-05-15 20:12:35 +00:00
}