editor_inspector.cpp 147 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327
  1. /**************************************************************************/
  2. /* editor_inspector.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "editor_inspector.h"
  31. #include "editor_inspector.compat.inc"
  32. #include "core/os/keyboard.h"
  33. #include "editor/add_metadata_dialog.h"
  34. #include "editor/doc_tools.h"
  35. #include "editor/editor_feature_profile.h"
  36. #include "editor/editor_main_screen.h"
  37. #include "editor/editor_node.h"
  38. #include "editor/editor_property_name_processor.h"
  39. #include "editor/editor_settings.h"
  40. #include "editor/editor_string_names.h"
  41. #include "editor/editor_undo_redo_manager.h"
  42. #include "editor/gui/editor_validation_panel.h"
  43. #include "editor/inspector_dock.h"
  44. #include "editor/multi_node_edit.h"
  45. #include "editor/plugins/script_editor_plugin.h"
  46. #include "editor/themes/editor_scale.h"
  47. #include "editor/themes/editor_theme_manager.h"
  48. #include "scene/gui/margin_container.h"
  49. #include "scene/gui/spin_box.h"
  50. #include "scene/gui/texture_rect.h"
  51. #include "scene/property_utils.h"
  52. #include "scene/resources/packed_scene.h"
  53. #include "scene/resources/style_box_flat.h"
  54. #include "scene/scene_string_names.h"
  55. bool EditorInspector::_property_path_matches(const String &p_property_path, const String &p_filter, EditorPropertyNameProcessor::Style p_style) {
  56. if (p_property_path.containsn(p_filter)) {
  57. return true;
  58. }
  59. const Vector<String> prop_sections = p_property_path.split("/");
  60. for (int i = 0; i < prop_sections.size(); i++) {
  61. if (p_filter.is_subsequence_ofn(EditorPropertyNameProcessor::get_singleton()->process_name(prop_sections[i], p_style, p_property_path))) {
  62. return true;
  63. }
  64. }
  65. return false;
  66. }
  67. Size2 EditorProperty::get_minimum_size() const {
  68. Size2 ms;
  69. Ref<Font> font = get_theme_font(SceneStringName(font), SNAME("Tree"));
  70. int font_size = get_theme_font_size(SceneStringName(font_size), SNAME("Tree"));
  71. ms.height = label.is_empty() ? 0 : font->get_height(font_size) + 4 * EDSCALE;
  72. for (int i = 0; i < get_child_count(); i++) {
  73. Control *c = as_sortable_control(get_child(i));
  74. if (!c) {
  75. continue;
  76. }
  77. if (c == bottom_editor) {
  78. continue;
  79. }
  80. Size2 minsize = c->get_combined_minimum_size();
  81. ms = ms.max(minsize);
  82. }
  83. if (keying) {
  84. Ref<Texture2D> key = get_editor_theme_icon(SNAME("Key"));
  85. ms.width += key->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  86. }
  87. if (deletable) {
  88. Ref<Texture2D> key = get_editor_theme_icon(SNAME("Close"));
  89. ms.width += key->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  90. }
  91. if (checkable) {
  92. Ref<Texture2D> check = get_theme_icon(SNAME("checked"), SNAME("CheckBox"));
  93. ms.width += check->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  94. }
  95. if (bottom_editor != nullptr && bottom_editor->is_visible()) {
  96. ms.height += label.is_empty() ? 0 : get_theme_constant(SNAME("v_separation"));
  97. Size2 bems = bottom_editor->get_combined_minimum_size();
  98. //bems.width += get_constant("item_margin", "Tree");
  99. ms.height += bems.height;
  100. ms.width = MAX(ms.width, bems.width);
  101. }
  102. return ms;
  103. }
  104. void EditorProperty::emit_changed(const StringName &p_property, const Variant &p_value, const StringName &p_field, bool p_changing) {
  105. Variant args[4] = { p_property, p_value, p_field, p_changing };
  106. const Variant *argptrs[4] = { &args[0], &args[1], &args[2], &args[3] };
  107. cache[p_property] = p_value;
  108. emit_signalp(SNAME("property_changed"), (const Variant **)argptrs, 4);
  109. }
  110. void EditorProperty::_notification(int p_what) {
  111. switch (p_what) {
  112. case NOTIFICATION_SORT_CHILDREN: {
  113. Size2 size = get_size();
  114. Rect2 rect;
  115. Rect2 bottom_rect;
  116. right_child_rect = Rect2();
  117. bottom_child_rect = Rect2();
  118. {
  119. int child_room = size.width * (1.0 - split_ratio);
  120. Ref<Font> font = get_theme_font(SceneStringName(font), SNAME("Tree"));
  121. int font_size = get_theme_font_size(SceneStringName(font_size), SNAME("Tree"));
  122. int height = label.is_empty() ? 0 : font->get_height(font_size) + 4 * EDSCALE;
  123. bool no_children = true;
  124. //compute room needed
  125. for (int i = 0; i < get_child_count(); i++) {
  126. Control *c = as_sortable_control(get_child(i));
  127. if (!c) {
  128. continue;
  129. }
  130. if (c == bottom_editor) {
  131. continue;
  132. }
  133. Size2 minsize = c->get_combined_minimum_size();
  134. child_room = MAX(child_room, minsize.width);
  135. height = MAX(height, minsize.height);
  136. no_children = false;
  137. }
  138. if (no_children) {
  139. text_size = size.width;
  140. rect = Rect2(size.width - 1, 0, 1, height);
  141. } else {
  142. text_size = MAX(0, size.width - (child_room + 4 * EDSCALE));
  143. if (is_layout_rtl()) {
  144. rect = Rect2(1, 0, child_room, height);
  145. } else {
  146. rect = Rect2(size.width - child_room, 0, child_room, height);
  147. }
  148. }
  149. if (bottom_editor) {
  150. int v_offset = label.is_empty() ? 0 : get_theme_constant(SNAME("v_separation"));
  151. bottom_rect = Rect2(0, rect.size.height + v_offset, size.width, bottom_editor->get_combined_minimum_size().height);
  152. }
  153. if (keying) {
  154. Ref<Texture2D> key;
  155. if (use_keying_next()) {
  156. key = get_editor_theme_icon(SNAME("KeyNext"));
  157. } else {
  158. key = get_editor_theme_icon(SNAME("Key"));
  159. }
  160. rect.size.x -= key->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  161. if (is_layout_rtl()) {
  162. rect.position.x += key->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  163. }
  164. if (no_children) {
  165. text_size -= key->get_width() + 4 * EDSCALE;
  166. }
  167. }
  168. if (deletable) {
  169. Ref<Texture2D> close;
  170. close = get_editor_theme_icon(SNAME("Close"));
  171. rect.size.x -= close->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  172. if (is_layout_rtl()) {
  173. rect.position.x += close->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  174. }
  175. if (no_children) {
  176. text_size -= close->get_width() + 4 * EDSCALE;
  177. }
  178. }
  179. // Account for the space needed on the outer side
  180. // when any of the icons are visible.
  181. if (keying || deletable) {
  182. int separation = get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  183. rect.size.x -= separation;
  184. if (is_layout_rtl()) {
  185. rect.position.x += separation;
  186. }
  187. }
  188. }
  189. //set children
  190. for (int i = 0; i < get_child_count(); i++) {
  191. Control *c = as_sortable_control(get_child(i));
  192. if (!c) {
  193. continue;
  194. }
  195. if (c == bottom_editor) {
  196. continue;
  197. }
  198. fit_child_in_rect(c, rect);
  199. right_child_rect = rect;
  200. }
  201. if (bottom_editor) {
  202. fit_child_in_rect(bottom_editor, bottom_rect);
  203. bottom_child_rect = bottom_rect;
  204. }
  205. queue_redraw(); //need to redraw text
  206. } break;
  207. case NOTIFICATION_DRAW: {
  208. Ref<Font> font = get_theme_font(SceneStringName(font), SNAME("Tree"));
  209. int font_size = get_theme_font_size(SceneStringName(font_size), SNAME("Tree"));
  210. bool rtl = is_layout_rtl();
  211. Size2 size = get_size();
  212. if (bottom_editor) {
  213. size.height = bottom_editor->get_offset(SIDE_TOP) - get_theme_constant(SNAME("v_separation"));
  214. } else if (label_reference) {
  215. size.height = label_reference->get_size().height;
  216. }
  217. // Only draw the label if it's not empty.
  218. if (label.is_empty()) {
  219. size.height = 0;
  220. } else {
  221. Ref<StyleBox> sb = get_theme_stylebox(selected ? SNAME("bg_selected") : SNAME("bg"));
  222. draw_style_box(sb, Rect2(Vector2(), size));
  223. }
  224. Ref<StyleBox> bg_stylebox = get_theme_stylebox(SNAME("child_bg"));
  225. if (draw_top_bg && right_child_rect != Rect2()) {
  226. draw_style_box(bg_stylebox, right_child_rect);
  227. }
  228. if (bottom_child_rect != Rect2()) {
  229. draw_style_box(bg_stylebox, bottom_child_rect);
  230. }
  231. Color color;
  232. if (draw_warning || draw_prop_warning) {
  233. color = get_theme_color(is_read_only() ? SNAME("readonly_warning_color") : SNAME("warning_color"));
  234. } else {
  235. color = get_theme_color(is_read_only() ? SNAME("readonly_color") : SNAME("property_color"));
  236. }
  237. if (label.contains(".")) {
  238. // FIXME: Move this to the project settings editor, as this is only used
  239. // for project settings feature tag overrides.
  240. color.a = 0.5;
  241. }
  242. int ofs = get_theme_constant(SNAME("font_offset"));
  243. int text_limit = text_size - ofs;
  244. if (checkable) {
  245. Ref<Texture2D> checkbox;
  246. if (checked) {
  247. checkbox = get_editor_theme_icon(SNAME("GuiChecked"));
  248. } else {
  249. checkbox = get_editor_theme_icon(SNAME("GuiUnchecked"));
  250. }
  251. Color color2(1, 1, 1);
  252. if (check_hover) {
  253. color2.r *= 1.2;
  254. color2.g *= 1.2;
  255. color2.b *= 1.2;
  256. }
  257. check_rect = Rect2(ofs, ((size.height - checkbox->get_height()) / 2), checkbox->get_width(), checkbox->get_height());
  258. if (rtl) {
  259. draw_texture(checkbox, Vector2(size.width - check_rect.position.x - checkbox->get_width(), check_rect.position.y), color2);
  260. } else {
  261. draw_texture(checkbox, check_rect.position, color2);
  262. }
  263. int check_ofs = checkbox->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  264. ofs += check_ofs;
  265. text_limit -= check_ofs;
  266. } else {
  267. check_rect = Rect2();
  268. }
  269. if (can_revert && !is_read_only()) {
  270. Ref<Texture2D> reload_icon = get_editor_theme_icon(SNAME("ReloadSmall"));
  271. text_limit -= reload_icon->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  272. revert_rect = Rect2(ofs + text_limit, (size.height - reload_icon->get_height()) / 2, reload_icon->get_width(), reload_icon->get_height());
  273. Color color2(1, 1, 1);
  274. if (revert_hover) {
  275. color2.r *= 1.2;
  276. color2.g *= 1.2;
  277. color2.b *= 1.2;
  278. }
  279. if (rtl) {
  280. draw_texture(reload_icon, Vector2(size.width - revert_rect.position.x - reload_icon->get_width(), revert_rect.position.y), color2);
  281. } else {
  282. draw_texture(reload_icon, revert_rect.position, color2);
  283. }
  284. } else {
  285. revert_rect = Rect2();
  286. }
  287. if (!pin_hidden && pinned) {
  288. Ref<Texture2D> pinned_icon = get_editor_theme_icon(SNAME("Pin"));
  289. int margin_w = get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  290. int total_icon_w = margin_w + pinned_icon->get_width();
  291. int text_w = font->get_string_size(label, rtl ? HORIZONTAL_ALIGNMENT_RIGHT : HORIZONTAL_ALIGNMENT_LEFT, text_limit - total_icon_w, font_size).x;
  292. int y = (size.height - pinned_icon->get_height()) / 2;
  293. if (rtl) {
  294. draw_texture(pinned_icon, Vector2(size.width - ofs - text_w - total_icon_w, y), color);
  295. } else {
  296. draw_texture(pinned_icon, Vector2(ofs + text_w + margin_w, y), color);
  297. }
  298. text_limit -= total_icon_w;
  299. }
  300. int v_ofs = (size.height - font->get_height(font_size)) / 2;
  301. if (rtl) {
  302. draw_string(font, Point2(size.width - ofs - text_limit, v_ofs + font->get_ascent(font_size)), label, HORIZONTAL_ALIGNMENT_RIGHT, text_limit, font_size, color);
  303. } else {
  304. draw_string(font, Point2(ofs, v_ofs + font->get_ascent(font_size)), label, HORIZONTAL_ALIGNMENT_LEFT, text_limit, font_size, color);
  305. }
  306. ofs = size.width;
  307. if (keying) {
  308. Ref<Texture2D> key;
  309. if (use_keying_next()) {
  310. key = get_editor_theme_icon(SNAME("KeyNext"));
  311. } else {
  312. key = get_editor_theme_icon(SNAME("Key"));
  313. }
  314. ofs -= key->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  315. Color color2(1, 1, 1);
  316. if (keying_hover) {
  317. color2.r *= 1.2;
  318. color2.g *= 1.2;
  319. color2.b *= 1.2;
  320. }
  321. keying_rect = Rect2(ofs, ((size.height - key->get_height()) / 2), key->get_width(), key->get_height());
  322. if (rtl) {
  323. draw_texture(key, Vector2(size.width - keying_rect.position.x - key->get_width(), keying_rect.position.y), color2);
  324. } else {
  325. draw_texture(key, keying_rect.position, color2);
  326. }
  327. } else {
  328. keying_rect = Rect2();
  329. }
  330. if (deletable) {
  331. Ref<Texture2D> close;
  332. close = get_editor_theme_icon(SNAME("Close"));
  333. ofs -= close->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  334. Color color2(1, 1, 1);
  335. if (delete_hover) {
  336. color2.r *= 1.2;
  337. color2.g *= 1.2;
  338. color2.b *= 1.2;
  339. }
  340. delete_rect = Rect2(ofs, ((size.height - close->get_height()) / 2), close->get_width(), close->get_height());
  341. if (rtl) {
  342. draw_texture(close, Vector2(size.width - delete_rect.position.x - close->get_width(), delete_rect.position.y), color2);
  343. } else {
  344. draw_texture(close, delete_rect.position, color2);
  345. }
  346. } else {
  347. delete_rect = Rect2();
  348. }
  349. } break;
  350. case NOTIFICATION_ENTER_TREE: {
  351. if (has_borders) {
  352. get_parent()->connect(SceneStringName(theme_changed), callable_mp(this, &EditorProperty::_update_property_bg));
  353. _update_property_bg();
  354. }
  355. } break;
  356. case NOTIFICATION_EXIT_TREE: {
  357. if (has_borders) {
  358. get_parent()->disconnect(SceneStringName(theme_changed), callable_mp(this, &EditorProperty::_update_property_bg));
  359. }
  360. } break;
  361. }
  362. }
  363. void EditorProperty::set_label(const String &p_label) {
  364. label = p_label;
  365. queue_redraw();
  366. }
  367. String EditorProperty::get_label() const {
  368. return label;
  369. }
  370. Object *EditorProperty::get_edited_object() {
  371. return object;
  372. }
  373. StringName EditorProperty::get_edited_property() const {
  374. return property;
  375. }
  376. EditorInspector *EditorProperty::get_parent_inspector() const {
  377. Node *parent = get_parent();
  378. while (parent) {
  379. EditorInspector *ei = Object::cast_to<EditorInspector>(parent);
  380. if (ei) {
  381. return ei;
  382. }
  383. parent = parent->get_parent();
  384. }
  385. return nullptr;
  386. }
  387. void EditorProperty::set_doc_path(const String &p_doc_path) {
  388. doc_path = p_doc_path;
  389. }
  390. void EditorProperty::set_internal(bool p_internal) {
  391. internal = p_internal;
  392. }
  393. void EditorProperty::update_property() {
  394. GDVIRTUAL_CALL(_update_property);
  395. }
  396. void EditorProperty::_set_read_only(bool p_read_only) {
  397. }
  398. void EditorProperty::set_read_only(bool p_read_only) {
  399. read_only = p_read_only;
  400. if (GDVIRTUAL_CALL(_set_read_only, p_read_only)) {
  401. return;
  402. }
  403. _set_read_only(p_read_only);
  404. }
  405. bool EditorProperty::is_read_only() const {
  406. return read_only;
  407. }
  408. Variant EditorPropertyRevert::get_property_revert_value(Object *p_object, const StringName &p_property, bool *r_is_valid) {
  409. if (p_object->property_can_revert(p_property)) {
  410. if (r_is_valid) {
  411. *r_is_valid = true;
  412. }
  413. return p_object->property_get_revert(p_property);
  414. }
  415. return PropertyUtils::get_property_default_value(p_object, p_property, r_is_valid);
  416. }
  417. bool EditorPropertyRevert::can_property_revert(Object *p_object, const StringName &p_property, const Variant *p_custom_current_value) {
  418. bool is_valid_revert = false;
  419. Variant revert_value = EditorPropertyRevert::get_property_revert_value(p_object, p_property, &is_valid_revert);
  420. if (!is_valid_revert) {
  421. return false;
  422. }
  423. Variant current_value = p_custom_current_value ? *p_custom_current_value : p_object->get(p_property);
  424. return PropertyUtils::is_property_value_different(p_object, current_value, revert_value);
  425. }
  426. StringName EditorProperty::_get_revert_property() const {
  427. return property;
  428. }
  429. void EditorProperty::_update_property_bg() {
  430. // This function is to be called on EditorPropertyResource, EditorPropertyArray, and EditorPropertyDictionary.
  431. // Behavior is undetermined on any other EditorProperty.
  432. if (!is_inside_tree()) {
  433. return;
  434. }
  435. begin_bulk_theme_override();
  436. if (bottom_editor) {
  437. ColorationMode nested_color_mode = (ColorationMode)(int)EDITOR_GET("interface/inspector/nested_color_mode");
  438. bool delimitate_all_container_and_resources = EDITOR_GET("interface/inspector/delimitate_all_container_and_resources");
  439. int count_subinspectors = 0;
  440. if (is_colored(nested_color_mode)) {
  441. Node *n = this;
  442. while (n) {
  443. EditorProperty *ep = Object::cast_to<EditorProperty>(n);
  444. if (ep && ep->is_colored(nested_color_mode)) {
  445. count_subinspectors++;
  446. }
  447. n = n->get_parent();
  448. }
  449. count_subinspectors = MIN(16, count_subinspectors);
  450. }
  451. add_theme_style_override(SNAME("DictionaryAddItem"), get_theme_stylebox("DictionaryAddItem" + itos(count_subinspectors), EditorStringName(EditorStyles)));
  452. add_theme_constant_override("v_separation", 0);
  453. if (delimitate_all_container_and_resources || is_colored(nested_color_mode)) {
  454. add_theme_style_override("bg_selected", get_theme_stylebox("sub_inspector_property_bg" + itos(count_subinspectors), EditorStringName(EditorStyles)));
  455. add_theme_style_override("bg", get_theme_stylebox("sub_inspector_property_bg" + itos(count_subinspectors), EditorStringName(EditorStyles)));
  456. add_theme_color_override("property_color", get_theme_color(SNAME("sub_inspector_property_color"), EditorStringName(EditorStyles)));
  457. bottom_editor->add_theme_style_override(SceneStringName(panel), get_theme_stylebox("sub_inspector_bg" + itos(count_subinspectors), EditorStringName(EditorStyles)));
  458. } else {
  459. bottom_editor->add_theme_style_override(SceneStringName(panel), get_theme_stylebox("sub_inspector_bg_no_border", EditorStringName(EditorStyles)));
  460. }
  461. } else {
  462. remove_theme_style_override("bg_selected");
  463. remove_theme_style_override("bg");
  464. remove_theme_color_override("property_color");
  465. }
  466. end_bulk_theme_override();
  467. queue_redraw();
  468. }
  469. void EditorProperty::update_editor_property_status() {
  470. if (property == StringName()) {
  471. return; //no property, so nothing to do
  472. }
  473. bool new_pinned = false;
  474. if (can_pin) {
  475. Node *node = Object::cast_to<Node>(object);
  476. CRASH_COND(!node);
  477. new_pinned = node->is_property_pinned(property);
  478. }
  479. bool new_warning = false;
  480. if (object->has_method("_get_property_warning")) {
  481. new_warning = !String(object->call("_get_property_warning", property)).is_empty();
  482. }
  483. Variant current = object->get(_get_revert_property());
  484. bool new_can_revert = EditorPropertyRevert::can_property_revert(object, property, &current) && !is_read_only();
  485. bool new_checked = checked;
  486. if (checkable) { // for properties like theme overrides.
  487. bool valid = false;
  488. Variant value = object->get(property, &valid);
  489. if (valid) {
  490. new_checked = value.get_type() != Variant::NIL;
  491. }
  492. }
  493. if (new_can_revert != can_revert || new_pinned != pinned || new_checked != checked || new_warning != draw_prop_warning) {
  494. if (new_can_revert != can_revert) {
  495. emit_signal(SNAME("property_can_revert_changed"), property, new_can_revert);
  496. }
  497. draw_prop_warning = new_warning;
  498. can_revert = new_can_revert;
  499. pinned = new_pinned;
  500. checked = new_checked;
  501. queue_redraw();
  502. }
  503. }
  504. bool EditorProperty::use_keying_next() const {
  505. List<PropertyInfo> plist;
  506. object->get_property_list(&plist, true);
  507. for (List<PropertyInfo>::Element *I = plist.front(); I; I = I->next()) {
  508. PropertyInfo &p = I->get();
  509. if (p.name == property) {
  510. return (p.usage & PROPERTY_USAGE_KEYING_INCREMENTS);
  511. }
  512. }
  513. return false;
  514. }
  515. void EditorProperty::set_checkable(bool p_checkable) {
  516. checkable = p_checkable;
  517. queue_redraw();
  518. queue_sort();
  519. }
  520. bool EditorProperty::is_checkable() const {
  521. return checkable;
  522. }
  523. void EditorProperty::set_checked(bool p_checked) {
  524. checked = p_checked;
  525. queue_redraw();
  526. }
  527. bool EditorProperty::is_checked() const {
  528. return checked;
  529. }
  530. void EditorProperty::set_draw_warning(bool p_draw_warning) {
  531. draw_warning = p_draw_warning;
  532. queue_redraw();
  533. }
  534. void EditorProperty::set_keying(bool p_keying) {
  535. keying = p_keying;
  536. queue_redraw();
  537. queue_sort();
  538. }
  539. void EditorProperty::set_deletable(bool p_deletable) {
  540. deletable = p_deletable;
  541. queue_redraw();
  542. queue_sort();
  543. }
  544. bool EditorProperty::is_deletable() const {
  545. return deletable;
  546. }
  547. bool EditorProperty::is_keying() const {
  548. return keying;
  549. }
  550. bool EditorProperty::is_draw_warning() const {
  551. return draw_warning;
  552. }
  553. void EditorProperty::_focusable_focused(int p_index) {
  554. if (!selectable) {
  555. return;
  556. }
  557. bool already_selected = selected;
  558. selected = true;
  559. selected_focusable = p_index;
  560. queue_redraw();
  561. if (!already_selected && selected) {
  562. emit_signal(SNAME("selected"), property, selected_focusable);
  563. }
  564. }
  565. void EditorProperty::add_focusable(Control *p_control) {
  566. p_control->connect(SceneStringName(focus_entered), callable_mp(this, &EditorProperty::_focusable_focused).bind(focusables.size()));
  567. focusables.push_back(p_control);
  568. }
  569. void EditorProperty::grab_focus(int p_focusable) {
  570. if (focusables.is_empty()) {
  571. return;
  572. }
  573. if (p_focusable >= 0) {
  574. ERR_FAIL_INDEX(p_focusable, focusables.size());
  575. focusables[p_focusable]->grab_focus();
  576. } else {
  577. focusables[0]->grab_focus();
  578. }
  579. }
  580. void EditorProperty::select(int p_focusable) {
  581. bool already_selected = selected;
  582. if (!selectable) {
  583. return;
  584. }
  585. if (p_focusable >= 0) {
  586. ERR_FAIL_INDEX(p_focusable, focusables.size());
  587. focusables[p_focusable]->grab_focus();
  588. } else {
  589. selected = true;
  590. queue_redraw();
  591. }
  592. if (!already_selected && selected) {
  593. emit_signal(SNAME("selected"), property, selected_focusable);
  594. }
  595. }
  596. void EditorProperty::deselect() {
  597. selected = false;
  598. selected_focusable = -1;
  599. queue_redraw();
  600. }
  601. bool EditorProperty::is_selected() const {
  602. return selected;
  603. }
  604. void EditorProperty::gui_input(const Ref<InputEvent> &p_event) {
  605. ERR_FAIL_COND(p_event.is_null());
  606. if (property == StringName()) {
  607. return;
  608. }
  609. Ref<InputEventMouse> me = p_event;
  610. if (me.is_valid()) {
  611. Vector2 mpos = me->get_position();
  612. if (is_layout_rtl()) {
  613. mpos.x = get_size().x - mpos.x;
  614. }
  615. bool button_left = me->get_button_mask().has_flag(MouseButtonMask::LEFT);
  616. bool new_keying_hover = keying_rect.has_point(mpos) && !button_left;
  617. if (new_keying_hover != keying_hover) {
  618. keying_hover = new_keying_hover;
  619. queue_redraw();
  620. }
  621. bool new_delete_hover = delete_rect.has_point(mpos) && !button_left;
  622. if (new_delete_hover != delete_hover) {
  623. delete_hover = new_delete_hover;
  624. queue_redraw();
  625. }
  626. bool new_revert_hover = revert_rect.has_point(mpos) && !button_left;
  627. if (new_revert_hover != revert_hover) {
  628. revert_hover = new_revert_hover;
  629. queue_redraw();
  630. }
  631. bool new_check_hover = check_rect.has_point(mpos) && !button_left;
  632. if (new_check_hover != check_hover) {
  633. check_hover = new_check_hover;
  634. queue_redraw();
  635. }
  636. }
  637. Ref<InputEventMouseButton> mb = p_event;
  638. if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == MouseButton::LEFT) {
  639. Vector2 mpos = mb->get_position();
  640. if (is_layout_rtl()) {
  641. mpos.x = get_size().x - mpos.x;
  642. }
  643. select();
  644. if (keying_rect.has_point(mpos)) {
  645. accept_event();
  646. emit_signal(SNAME("property_keyed"), property, use_keying_next());
  647. if (use_keying_next()) {
  648. if (property == "frame_coords" && (object->is_class("Sprite2D") || object->is_class("Sprite3D"))) {
  649. Vector2i new_coords = object->get(property);
  650. new_coords.x++;
  651. if (new_coords.x >= int64_t(object->get("hframes"))) {
  652. new_coords.x = 0;
  653. new_coords.y++;
  654. }
  655. if (new_coords.x < int64_t(object->get("hframes")) && new_coords.y < int64_t(object->get("vframes"))) {
  656. callable_mp(this, &EditorProperty::emit_changed).call_deferred(property, new_coords, "", false);
  657. }
  658. } else {
  659. if (int64_t(object->get(property)) + 1 < (int64_t(object->get("hframes")) * int64_t(object->get("vframes")))) {
  660. callable_mp(this, &EditorProperty::emit_changed).call_deferred(property, object->get(property).operator int64_t() + 1, "", false);
  661. }
  662. }
  663. callable_mp(this, &EditorProperty::update_property).call_deferred();
  664. }
  665. }
  666. if (delete_rect.has_point(mpos)) {
  667. accept_event();
  668. emit_signal(SNAME("property_deleted"), property);
  669. }
  670. if (revert_rect.has_point(mpos)) {
  671. accept_event();
  672. get_viewport()->gui_release_focus();
  673. bool is_valid_revert = false;
  674. Variant revert_value = EditorPropertyRevert::get_property_revert_value(object, property, &is_valid_revert);
  675. ERR_FAIL_COND(!is_valid_revert);
  676. emit_changed(_get_revert_property(), revert_value);
  677. update_property();
  678. }
  679. if (check_rect.has_point(mpos)) {
  680. accept_event();
  681. checked = !checked;
  682. queue_redraw();
  683. emit_signal(SNAME("property_checked"), property, checked);
  684. }
  685. } else if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == MouseButton::RIGHT) {
  686. accept_event();
  687. _update_popup();
  688. menu->set_position(get_screen_position() + get_local_mouse_position());
  689. menu->reset_size();
  690. menu->popup();
  691. select();
  692. return;
  693. }
  694. }
  695. void EditorProperty::shortcut_input(const Ref<InputEvent> &p_event) {
  696. if (!selected || !p_event->is_pressed()) {
  697. return;
  698. }
  699. const Ref<InputEventKey> k = p_event;
  700. if (k.is_valid() && k->is_pressed()) {
  701. if (ED_IS_SHORTCUT("property_editor/copy_value", p_event)) {
  702. menu_option(MENU_COPY_VALUE);
  703. accept_event();
  704. } else if (!is_read_only() && ED_IS_SHORTCUT("property_editor/paste_value", p_event)) {
  705. menu_option(MENU_PASTE_VALUE);
  706. accept_event();
  707. } else if (!internal && ED_IS_SHORTCUT("property_editor/copy_property_path", p_event)) {
  708. menu_option(MENU_COPY_PROPERTY_PATH);
  709. accept_event();
  710. }
  711. }
  712. }
  713. const Color *EditorProperty::_get_property_colors() {
  714. static Color c[4];
  715. c[0] = get_theme_color(SNAME("property_color_x"), EditorStringName(Editor));
  716. c[1] = get_theme_color(SNAME("property_color_y"), EditorStringName(Editor));
  717. c[2] = get_theme_color(SNAME("property_color_z"), EditorStringName(Editor));
  718. c[3] = get_theme_color(SNAME("property_color_w"), EditorStringName(Editor));
  719. return c;
  720. }
  721. void EditorProperty::set_label_reference(Control *p_control) {
  722. label_reference = p_control;
  723. }
  724. void EditorProperty::set_bottom_editor(Control *p_control) {
  725. bottom_editor = p_control;
  726. if (has_borders) {
  727. _update_property_bg();
  728. }
  729. }
  730. Variant EditorProperty::_get_cache_value(const StringName &p_prop, bool &r_valid) const {
  731. return object->get(p_prop, &r_valid);
  732. }
  733. bool EditorProperty::is_cache_valid() const {
  734. if (object) {
  735. for (const KeyValue<StringName, Variant> &E : cache) {
  736. bool valid;
  737. Variant value = _get_cache_value(E.key, valid);
  738. if (!valid || value != E.value) {
  739. return false;
  740. }
  741. }
  742. }
  743. return true;
  744. }
  745. void EditorProperty::update_cache() {
  746. cache.clear();
  747. if (object && property != StringName()) {
  748. bool valid;
  749. Variant value = _get_cache_value(property, valid);
  750. if (valid) {
  751. cache[property] = value;
  752. }
  753. }
  754. }
  755. Variant EditorProperty::get_drag_data(const Point2 &p_point) {
  756. if (property == StringName()) {
  757. return Variant();
  758. }
  759. Dictionary dp;
  760. dp["type"] = "obj_property";
  761. dp["object"] = object;
  762. dp["property"] = property;
  763. dp["value"] = object->get(property);
  764. Label *drag_label = memnew(Label);
  765. drag_label->set_text(property);
  766. drag_label->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED); // Don't translate raw property name.
  767. set_drag_preview(drag_label);
  768. return dp;
  769. }
  770. void EditorProperty::set_use_folding(bool p_use_folding) {
  771. use_folding = p_use_folding;
  772. }
  773. bool EditorProperty::is_using_folding() const {
  774. return use_folding;
  775. }
  776. void EditorProperty::expand_all_folding() {
  777. }
  778. void EditorProperty::collapse_all_folding() {
  779. }
  780. void EditorProperty::expand_revertable() {
  781. }
  782. void EditorProperty::set_selectable(bool p_selectable) {
  783. selectable = p_selectable;
  784. }
  785. bool EditorProperty::is_selectable() const {
  786. return selectable;
  787. }
  788. void EditorProperty::set_name_split_ratio(float p_ratio) {
  789. split_ratio = p_ratio;
  790. }
  791. float EditorProperty::get_name_split_ratio() const {
  792. return split_ratio;
  793. }
  794. void EditorProperty::set_object_and_property(Object *p_object, const StringName &p_property) {
  795. object = p_object;
  796. property = p_property;
  797. _update_pin_flags();
  798. }
  799. static bool _is_value_potential_override(Node *p_node, const String &p_property) {
  800. // Consider a value is potentially overriding another if either of the following is true:
  801. // a) The node is foreign (inheriting or an instance), so the original value may come from another scene.
  802. // b) The node belongs to the scene, but the original value comes from somewhere but the builtin class (i.e., a script).
  803. Node *edited_scene = EditorNode::get_singleton()->get_edited_scene();
  804. Vector<SceneState::PackState> states_stack = PropertyUtils::get_node_states_stack(p_node, edited_scene);
  805. if (states_stack.size()) {
  806. return true;
  807. } else {
  808. bool is_valid_default = false;
  809. bool is_class_default = false;
  810. PropertyUtils::get_property_default_value(p_node, p_property, &is_valid_default, &states_stack, false, nullptr, &is_class_default);
  811. return !is_class_default;
  812. }
  813. }
  814. void EditorProperty::_update_pin_flags() {
  815. can_pin = false;
  816. pin_hidden = true;
  817. if (read_only) {
  818. return;
  819. }
  820. if (Node *node = Object::cast_to<Node>(object)) {
  821. // Avoid errors down the road by ignoring nodes which are not part of a scene
  822. if (!node->get_owner()) {
  823. bool is_scene_root = false;
  824. for (int i = 0; i < EditorNode::get_editor_data().get_edited_scene_count(); ++i) {
  825. if (EditorNode::get_editor_data().get_edited_scene_root(i) == node) {
  826. is_scene_root = true;
  827. break;
  828. }
  829. }
  830. if (!is_scene_root) {
  831. return;
  832. }
  833. }
  834. if (!_is_value_potential_override(node, property)) {
  835. return;
  836. }
  837. pin_hidden = false;
  838. {
  839. HashSet<StringName> storable_properties;
  840. node->get_storable_properties(storable_properties);
  841. if (storable_properties.has(node->get_property_store_alias(property))) {
  842. can_pin = true;
  843. }
  844. }
  845. }
  846. }
  847. Control *EditorProperty::make_custom_tooltip(const String &p_text) const {
  848. String custom_warning;
  849. if (object->has_method("_get_property_warning")) {
  850. custom_warning = object->call("_get_property_warning", property);
  851. }
  852. if (has_doc_tooltip || !custom_warning.is_empty()) {
  853. EditorHelpBit *help_bit = memnew(EditorHelpBit);
  854. if (has_doc_tooltip) {
  855. help_bit->parse_symbol(p_text);
  856. const EditorInspector *inspector = get_parent_inspector();
  857. if (inspector) {
  858. const String custom_description = inspector->get_custom_property_description(p_text);
  859. if (!custom_description.is_empty()) {
  860. help_bit->set_description(custom_description);
  861. }
  862. }
  863. }
  864. if (!custom_warning.is_empty()) {
  865. String description = "[b][color=" + get_theme_color(SNAME("warning_color")).to_html(false) + "]" + custom_warning + "[/color][/b]";
  866. if (!help_bit->get_description().is_empty()) {
  867. description += "\n" + help_bit->get_description();
  868. }
  869. help_bit->set_description(description);
  870. }
  871. EditorHelpBitTooltip::show_tooltip(help_bit, const_cast<EditorProperty *>(this));
  872. return memnew(Control); // Make the standard tooltip invisible.
  873. }
  874. return nullptr;
  875. }
  876. void EditorProperty::menu_option(int p_option) {
  877. switch (p_option) {
  878. case MENU_COPY_VALUE: {
  879. InspectorDock::get_inspector_singleton()->set_property_clipboard(object->get(property));
  880. } break;
  881. case MENU_PASTE_VALUE: {
  882. emit_changed(property, InspectorDock::get_inspector_singleton()->get_property_clipboard());
  883. } break;
  884. case MENU_COPY_PROPERTY_PATH: {
  885. DisplayServer::get_singleton()->clipboard_set(property_path);
  886. } break;
  887. case MENU_PIN_VALUE: {
  888. emit_signal(SNAME("property_pinned"), property, !pinned);
  889. queue_redraw();
  890. } break;
  891. case MENU_OPEN_DOCUMENTATION: {
  892. ScriptEditor::get_singleton()->goto_help(doc_path);
  893. EditorNode::get_singleton()->get_editor_main_screen()->select(EditorMainScreen::EDITOR_SCRIPT);
  894. } break;
  895. }
  896. }
  897. void EditorProperty::_bind_methods() {
  898. ClassDB::bind_method(D_METHOD("set_label", "text"), &EditorProperty::set_label);
  899. ClassDB::bind_method(D_METHOD("get_label"), &EditorProperty::get_label);
  900. ClassDB::bind_method(D_METHOD("set_read_only", "read_only"), &EditorProperty::set_read_only);
  901. ClassDB::bind_method(D_METHOD("is_read_only"), &EditorProperty::is_read_only);
  902. ClassDB::bind_method(D_METHOD("set_checkable", "checkable"), &EditorProperty::set_checkable);
  903. ClassDB::bind_method(D_METHOD("is_checkable"), &EditorProperty::is_checkable);
  904. ClassDB::bind_method(D_METHOD("set_checked", "checked"), &EditorProperty::set_checked);
  905. ClassDB::bind_method(D_METHOD("is_checked"), &EditorProperty::is_checked);
  906. ClassDB::bind_method(D_METHOD("set_draw_warning", "draw_warning"), &EditorProperty::set_draw_warning);
  907. ClassDB::bind_method(D_METHOD("is_draw_warning"), &EditorProperty::is_draw_warning);
  908. ClassDB::bind_method(D_METHOD("set_keying", "keying"), &EditorProperty::set_keying);
  909. ClassDB::bind_method(D_METHOD("is_keying"), &EditorProperty::is_keying);
  910. ClassDB::bind_method(D_METHOD("set_deletable", "deletable"), &EditorProperty::set_deletable);
  911. ClassDB::bind_method(D_METHOD("is_deletable"), &EditorProperty::is_deletable);
  912. ClassDB::bind_method(D_METHOD("get_edited_property"), &EditorProperty::get_edited_property);
  913. ClassDB::bind_method(D_METHOD("get_edited_object"), &EditorProperty::get_edited_object);
  914. ClassDB::bind_method(D_METHOD("update_property"), &EditorProperty::update_property);
  915. ClassDB::bind_method(D_METHOD("add_focusable", "control"), &EditorProperty::add_focusable);
  916. ClassDB::bind_method(D_METHOD("set_bottom_editor", "editor"), &EditorProperty::set_bottom_editor);
  917. ClassDB::bind_method(D_METHOD("emit_changed", "property", "value", "field", "changing"), &EditorProperty::emit_changed, DEFVAL(StringName()), DEFVAL(false));
  918. ADD_PROPERTY(PropertyInfo(Variant::STRING, "label"), "set_label", "get_label");
  919. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "read_only"), "set_read_only", "is_read_only");
  920. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "checkable"), "set_checkable", "is_checkable");
  921. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "checked"), "set_checked", "is_checked");
  922. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_warning"), "set_draw_warning", "is_draw_warning");
  923. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "keying"), "set_keying", "is_keying");
  924. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "deletable"), "set_deletable", "is_deletable");
  925. ADD_SIGNAL(MethodInfo("property_changed", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::NIL, "value", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NIL_IS_VARIANT), PropertyInfo(Variant::STRING_NAME, "field"), PropertyInfo(Variant::BOOL, "changing")));
  926. ADD_SIGNAL(MethodInfo("multiple_properties_changed", PropertyInfo(Variant::PACKED_STRING_ARRAY, "properties"), PropertyInfo(Variant::ARRAY, "value")));
  927. ADD_SIGNAL(MethodInfo("property_keyed", PropertyInfo(Variant::STRING_NAME, "property")));
  928. ADD_SIGNAL(MethodInfo("property_deleted", PropertyInfo(Variant::STRING_NAME, "property")));
  929. ADD_SIGNAL(MethodInfo("property_keyed_with_value", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::NIL, "value", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NIL_IS_VARIANT)));
  930. ADD_SIGNAL(MethodInfo("property_checked", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::BOOL, "checked")));
  931. ADD_SIGNAL(MethodInfo("property_pinned", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::BOOL, "pinned")));
  932. ADD_SIGNAL(MethodInfo("property_can_revert_changed", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::BOOL, "can_revert")));
  933. ADD_SIGNAL(MethodInfo("resource_selected", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::OBJECT, "resource", PROPERTY_HINT_RESOURCE_TYPE, "Resource")));
  934. ADD_SIGNAL(MethodInfo("object_id_selected", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::INT, "id")));
  935. ADD_SIGNAL(MethodInfo("selected", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::INT, "focusable_idx")));
  936. GDVIRTUAL_BIND(_update_property)
  937. GDVIRTUAL_BIND(_set_read_only, "read_only")
  938. ClassDB::bind_method(D_METHOD("_update_editor_property_status"), &EditorProperty::update_editor_property_status);
  939. }
  940. EditorProperty::EditorProperty() {
  941. object = nullptr;
  942. split_ratio = 0.5;
  943. text_size = 0;
  944. property_usage = 0;
  945. selected_focusable = -1;
  946. label_reference = nullptr;
  947. bottom_editor = nullptr;
  948. menu = nullptr;
  949. set_process_shortcut_input(true);
  950. }
  951. void EditorProperty::_update_popup() {
  952. if (menu) {
  953. menu->clear();
  954. } else {
  955. menu = memnew(PopupMenu);
  956. add_child(menu);
  957. menu->connect(SceneStringName(id_pressed), callable_mp(this, &EditorProperty::menu_option));
  958. }
  959. menu->add_icon_shortcut(get_editor_theme_icon(SNAME("ActionCopy")), ED_GET_SHORTCUT("property_editor/copy_value"), MENU_COPY_VALUE);
  960. menu->add_icon_shortcut(get_editor_theme_icon(SNAME("ActionPaste")), ED_GET_SHORTCUT("property_editor/paste_value"), MENU_PASTE_VALUE);
  961. menu->add_icon_shortcut(get_editor_theme_icon(SNAME("CopyNodePath")), ED_GET_SHORTCUT("property_editor/copy_property_path"), MENU_COPY_PROPERTY_PATH);
  962. menu->set_item_disabled(MENU_PASTE_VALUE, is_read_only());
  963. menu->set_item_disabled(MENU_COPY_PROPERTY_PATH, internal);
  964. if (!pin_hidden) {
  965. menu->add_separator();
  966. if (can_pin) {
  967. menu->add_icon_check_item(get_editor_theme_icon(SNAME("Pin")), TTR("Pin Value"), MENU_PIN_VALUE);
  968. menu->set_item_checked(menu->get_item_index(MENU_PIN_VALUE), pinned);
  969. } else {
  970. menu->add_icon_check_item(get_editor_theme_icon(SNAME("Pin")), vformat(TTR("Pin Value [Disabled because '%s' is editor-only]"), property), MENU_PIN_VALUE);
  971. menu->set_item_disabled(menu->get_item_index(MENU_PIN_VALUE), true);
  972. }
  973. menu->set_item_tooltip(menu->get_item_index(MENU_PIN_VALUE), TTR("Pinning a value forces it to be saved even if it's equal to the default."));
  974. }
  975. if (!doc_path.is_empty()) {
  976. menu->add_separator();
  977. menu->add_icon_item(get_editor_theme_icon(SNAME("Help")), TTR("Open Documentation"), MENU_OPEN_DOCUMENTATION);
  978. }
  979. }
  980. ////////////////////////////////////////////////
  981. ////////////////////////////////////////////////
  982. void EditorInspectorPlugin::add_custom_control(Control *control) {
  983. AddedEditor ae;
  984. ae.property_editor = control;
  985. added_editors.push_back(ae);
  986. }
  987. void EditorInspectorPlugin::add_property_editor(const String &p_for_property, Control *p_prop, bool p_add_to_end, const String &p_label) {
  988. AddedEditor ae;
  989. ae.properties.push_back(p_for_property);
  990. ae.property_editor = p_prop;
  991. ae.add_to_end = p_add_to_end;
  992. ae.label = p_label;
  993. added_editors.push_back(ae);
  994. }
  995. void EditorInspectorPlugin::add_property_editor_for_multiple_properties(const String &p_label, const Vector<String> &p_properties, Control *p_prop) {
  996. AddedEditor ae;
  997. ae.properties = p_properties;
  998. ae.property_editor = p_prop;
  999. ae.label = p_label;
  1000. added_editors.push_back(ae);
  1001. }
  1002. bool EditorInspectorPlugin::can_handle(Object *p_object) {
  1003. bool success = false;
  1004. GDVIRTUAL_CALL(_can_handle, p_object, success);
  1005. return success;
  1006. }
  1007. void EditorInspectorPlugin::parse_begin(Object *p_object) {
  1008. GDVIRTUAL_CALL(_parse_begin, p_object);
  1009. }
  1010. void EditorInspectorPlugin::parse_category(Object *p_object, const String &p_category) {
  1011. GDVIRTUAL_CALL(_parse_category, p_object, p_category);
  1012. }
  1013. void EditorInspectorPlugin::parse_group(Object *p_object, const String &p_group) {
  1014. GDVIRTUAL_CALL(_parse_group, p_object, p_group);
  1015. }
  1016. bool EditorInspectorPlugin::parse_property(Object *p_object, const Variant::Type p_type, const String &p_path, const PropertyHint p_hint, const String &p_hint_text, const BitField<PropertyUsageFlags> p_usage, const bool p_wide) {
  1017. bool ret = false;
  1018. GDVIRTUAL_CALL(_parse_property, p_object, p_type, p_path, p_hint, p_hint_text, p_usage, p_wide, ret);
  1019. return ret;
  1020. }
  1021. void EditorInspectorPlugin::parse_end(Object *p_object) {
  1022. GDVIRTUAL_CALL(_parse_end, p_object);
  1023. }
  1024. void EditorInspectorPlugin::_bind_methods() {
  1025. ClassDB::bind_method(D_METHOD("add_custom_control", "control"), &EditorInspectorPlugin::add_custom_control);
  1026. ClassDB::bind_method(D_METHOD("add_property_editor", "property", "editor", "add_to_end", "label"), &EditorInspectorPlugin::add_property_editor, DEFVAL(false), DEFVAL(String()));
  1027. ClassDB::bind_method(D_METHOD("add_property_editor_for_multiple_properties", "label", "properties", "editor"), &EditorInspectorPlugin::add_property_editor_for_multiple_properties);
  1028. GDVIRTUAL_BIND(_can_handle, "object")
  1029. GDVIRTUAL_BIND(_parse_begin, "object")
  1030. GDVIRTUAL_BIND(_parse_category, "object", "category")
  1031. GDVIRTUAL_BIND(_parse_group, "object", "group")
  1032. GDVIRTUAL_BIND(_parse_property, "object", "type", "name", "hint_type", "hint_string", "usage_flags", "wide");
  1033. GDVIRTUAL_BIND(_parse_end, "object")
  1034. }
  1035. ////////////////////////////////////////////////
  1036. ////////////////////////////////////////////////
  1037. void EditorInspectorCategory::_notification(int p_what) {
  1038. switch (p_what) {
  1039. case NOTIFICATION_ENTER_TREE:
  1040. case NOTIFICATION_THEME_CHANGED: {
  1041. menu->set_item_icon(menu->get_item_index(MENU_OPEN_DOCS), get_editor_theme_icon(SNAME("Help")));
  1042. } break;
  1043. case NOTIFICATION_DRAW: {
  1044. Ref<StyleBox> sb = get_theme_stylebox(SNAME("bg"));
  1045. draw_style_box(sb, Rect2(Vector2(), get_size()));
  1046. Ref<Font> font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
  1047. int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts));
  1048. int hs = get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
  1049. int icon_size = get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor));
  1050. int w = font->get_string_size(label, HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width;
  1051. if (icon.is_valid()) {
  1052. w += hs + icon_size;
  1053. }
  1054. w = MIN(w, get_size().width - sb->get_minimum_size().width);
  1055. int ofs = (get_size().width - w) / 2;
  1056. float v_margin_offset = sb->get_content_margin(SIDE_TOP) - sb->get_content_margin(SIDE_BOTTOM);
  1057. if (icon.is_valid()) {
  1058. Size2 rect_size = Size2(icon_size, icon_size);
  1059. Point2 rect_pos = Point2(ofs, (get_size().height - icon_size) / 2 + v_margin_offset).round();
  1060. if (is_layout_rtl()) {
  1061. rect_pos.x = get_size().width - rect_pos.x - icon_size;
  1062. }
  1063. draw_texture_rect(icon, Rect2(rect_pos, rect_size));
  1064. ofs += hs + icon_size;
  1065. w -= hs + icon_size;
  1066. }
  1067. Color color = get_theme_color(SceneStringName(font_color), SNAME("Tree"));
  1068. if (is_layout_rtl()) {
  1069. ofs = get_size().width - ofs - w;
  1070. }
  1071. float text_pos_y = font->get_ascent(font_size) + (get_size().height - font->get_height(font_size)) / 2 + v_margin_offset;
  1072. Point2 text_pos = Point2(ofs, text_pos_y).round();
  1073. draw_string(font, text_pos, label, HORIZONTAL_ALIGNMENT_LEFT, w, font_size, color);
  1074. } break;
  1075. }
  1076. }
  1077. Control *EditorInspectorCategory::make_custom_tooltip(const String &p_text) const {
  1078. // If it's not a doc tooltip, fallback to the default one.
  1079. if (doc_class_name.is_empty()) {
  1080. return nullptr;
  1081. }
  1082. EditorHelpBit *help_bit = memnew(EditorHelpBit(p_text));
  1083. EditorHelpBitTooltip::show_tooltip(help_bit, const_cast<EditorInspectorCategory *>(this));
  1084. return memnew(Control); // Make the standard tooltip invisible.
  1085. }
  1086. Size2 EditorInspectorCategory::get_minimum_size() const {
  1087. Ref<Font> font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
  1088. int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts));
  1089. Size2 ms;
  1090. ms.height = font->get_height(font_size);
  1091. if (icon.is_valid()) {
  1092. int icon_size = get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor));
  1093. ms.height = MAX(icon_size, ms.height);
  1094. }
  1095. ms.height += get_theme_constant(SNAME("v_separation"), SNAME("Tree"));
  1096. const Ref<StyleBox> &bg_style = get_theme_stylebox(SNAME("bg"));
  1097. ms.height += bg_style->get_content_margin(SIDE_TOP) + bg_style->get_content_margin(SIDE_BOTTOM);
  1098. return ms;
  1099. }
  1100. void EditorInspectorCategory::_handle_menu_option(int p_option) {
  1101. switch (p_option) {
  1102. case MENU_OPEN_DOCS:
  1103. ScriptEditor::get_singleton()->goto_help("class:" + doc_class_name);
  1104. EditorNode::get_singleton()->get_editor_main_screen()->select(EditorMainScreen::EDITOR_SCRIPT);
  1105. break;
  1106. }
  1107. }
  1108. void EditorInspectorCategory::gui_input(const Ref<InputEvent> &p_event) {
  1109. if (doc_class_name.is_empty()) {
  1110. return;
  1111. }
  1112. const Ref<InputEventMouseButton> &mb_event = p_event;
  1113. if (mb_event.is_null() || !mb_event->is_pressed() || mb_event->get_button_index() != MouseButton::RIGHT) {
  1114. return;
  1115. }
  1116. menu->set_item_disabled(menu->get_item_index(MENU_OPEN_DOCS), !EditorHelp::get_doc_data()->class_list.has(doc_class_name));
  1117. menu->set_position(get_screen_position() + mb_event->get_position());
  1118. menu->reset_size();
  1119. menu->popup();
  1120. }
  1121. EditorInspectorCategory::EditorInspectorCategory() {
  1122. menu = memnew(PopupMenu);
  1123. menu->connect(SceneStringName(id_pressed), callable_mp(this, &EditorInspectorCategory::_handle_menu_option));
  1124. menu->add_item(TTR("Open Documentation"), MENU_OPEN_DOCS);
  1125. add_child(menu);
  1126. }
  1127. ////////////////////////////////////////////////
  1128. ////////////////////////////////////////////////
  1129. void EditorInspectorSection::_test_unfold() {
  1130. if (!vbox_added) {
  1131. add_child(vbox);
  1132. move_child(vbox, 0);
  1133. vbox_added = true;
  1134. }
  1135. }
  1136. Ref<Texture2D> EditorInspectorSection::_get_arrow() {
  1137. Ref<Texture2D> arrow;
  1138. if (foldable) {
  1139. if (object->editor_is_section_unfolded(section)) {
  1140. arrow = get_theme_icon(SNAME("arrow"), SNAME("Tree"));
  1141. } else {
  1142. if (is_layout_rtl()) {
  1143. arrow = get_theme_icon(SNAME("arrow_collapsed_mirrored"), SNAME("Tree"));
  1144. } else {
  1145. arrow = get_theme_icon(SNAME("arrow_collapsed"), SNAME("Tree"));
  1146. }
  1147. }
  1148. }
  1149. return arrow;
  1150. }
  1151. int EditorInspectorSection::_get_header_height() {
  1152. Ref<Font> font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
  1153. int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts));
  1154. int header_height = font->get_height(font_size);
  1155. Ref<Texture2D> arrow = _get_arrow();
  1156. if (arrow.is_valid()) {
  1157. header_height = MAX(header_height, arrow->get_height());
  1158. }
  1159. header_height += get_theme_constant(SNAME("v_separation"), SNAME("Tree"));
  1160. return header_height;
  1161. }
  1162. void EditorInspectorSection::_notification(int p_what) {
  1163. switch (p_what) {
  1164. case NOTIFICATION_THEME_CHANGED: {
  1165. update_minimum_size();
  1166. bg_color = get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor));
  1167. bg_color.a /= level;
  1168. } break;
  1169. case NOTIFICATION_SORT_CHILDREN: {
  1170. if (!vbox_added) {
  1171. return;
  1172. }
  1173. int inspector_margin = get_theme_constant(SNAME("inspector_margin"), EditorStringName(Editor));
  1174. int section_indent_size = get_theme_constant(SNAME("indent_size"), SNAME("EditorInspectorSection"));
  1175. if (indent_depth > 0 && section_indent_size > 0) {
  1176. inspector_margin += indent_depth * section_indent_size;
  1177. }
  1178. Ref<StyleBoxFlat> section_indent_style = get_theme_stylebox(SNAME("indent_box"), SNAME("EditorInspectorSection"));
  1179. if (indent_depth > 0 && section_indent_style.is_valid()) {
  1180. inspector_margin += section_indent_style->get_margin(SIDE_LEFT) + section_indent_style->get_margin(SIDE_RIGHT);
  1181. }
  1182. Size2 size = get_size() - Vector2(inspector_margin, 0);
  1183. int header_height = _get_header_height();
  1184. Vector2 offset = Vector2(is_layout_rtl() ? 0 : inspector_margin, header_height);
  1185. for (int i = 0; i < get_child_count(); i++) {
  1186. Control *c = as_sortable_control(get_child(i));
  1187. if (!c) {
  1188. continue;
  1189. }
  1190. fit_child_in_rect(c, Rect2(offset, size));
  1191. }
  1192. } break;
  1193. case NOTIFICATION_DRAW: {
  1194. int section_indent = 0;
  1195. int section_indent_size = get_theme_constant(SNAME("indent_size"), SNAME("EditorInspectorSection"));
  1196. if (indent_depth > 0 && section_indent_size > 0) {
  1197. section_indent = indent_depth * section_indent_size;
  1198. }
  1199. Ref<StyleBoxFlat> section_indent_style = get_theme_stylebox(SNAME("indent_box"), SNAME("EditorInspectorSection"));
  1200. if (indent_depth > 0 && section_indent_style.is_valid()) {
  1201. section_indent += section_indent_style->get_margin(SIDE_LEFT) + section_indent_style->get_margin(SIDE_RIGHT);
  1202. }
  1203. int header_width = get_size().width - section_indent;
  1204. int header_offset_x = 0.0;
  1205. bool rtl = is_layout_rtl();
  1206. if (!rtl) {
  1207. header_offset_x += section_indent;
  1208. }
  1209. // Draw header area.
  1210. int header_height = _get_header_height();
  1211. Rect2 header_rect = Rect2(Vector2(header_offset_x, 0.0), Vector2(header_width, header_height));
  1212. Color c = bg_color;
  1213. c.a *= 0.4;
  1214. if (foldable && header_rect.has_point(get_local_mouse_position())) {
  1215. c = c.lightened(Input::get_singleton()->is_mouse_button_pressed(MouseButton::LEFT) ? -0.05 : 0.2);
  1216. }
  1217. draw_rect(header_rect, c);
  1218. // Draw header title, folding arrow and count of revertable properties.
  1219. {
  1220. int outer_margin = Math::round(2 * EDSCALE);
  1221. int separation = get_theme_constant(SNAME("h_separation"), SNAME("EditorInspectorSection"));
  1222. int margin_start = section_indent + outer_margin;
  1223. int margin_end = outer_margin;
  1224. // - Arrow.
  1225. Ref<Texture2D> arrow = _get_arrow();
  1226. if (arrow.is_valid()) {
  1227. Point2 arrow_position;
  1228. if (rtl) {
  1229. arrow_position.x = get_size().width - (margin_start + arrow->get_width());
  1230. } else {
  1231. arrow_position.x = margin_start;
  1232. }
  1233. arrow_position.y = (header_height - arrow->get_height()) / 2;
  1234. draw_texture(arrow, arrow_position);
  1235. margin_start += arrow->get_width() + separation;
  1236. }
  1237. int available = get_size().width - (margin_start + margin_end);
  1238. // - Count of revertable properties.
  1239. String num_revertable_str;
  1240. int num_revertable_width = 0;
  1241. bool folded = foldable && !object->editor_is_section_unfolded(section);
  1242. Ref<Font> font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
  1243. int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts));
  1244. Color font_color = get_theme_color(SceneStringName(font_color), EditorStringName(Editor));
  1245. if (folded && revertable_properties.size()) {
  1246. int label_width = font->get_string_size(label, HORIZONTAL_ALIGNMENT_LEFT, available, font_size, TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_CONSTRAIN_ELLIPSIS).x;
  1247. Ref<Font> light_font = get_theme_font(SNAME("main"), EditorStringName(EditorFonts));
  1248. int light_font_size = get_theme_font_size(SNAME("main_size"), EditorStringName(EditorFonts));
  1249. Color light_font_color = get_theme_color(SNAME("font_disabled_color"), EditorStringName(Editor));
  1250. // Can we fit the long version of the revertable count text?
  1251. num_revertable_str = vformat(TTRN("(%d change)", "(%d changes)", revertable_properties.size()), revertable_properties.size());
  1252. num_revertable_width = light_font->get_string_size(num_revertable_str, HORIZONTAL_ALIGNMENT_LEFT, -1.0f, light_font_size, TextServer::JUSTIFICATION_NONE).x;
  1253. if (label_width + outer_margin + num_revertable_width > available) {
  1254. // We'll have to use the short version.
  1255. num_revertable_str = vformat("(%d)", revertable_properties.size());
  1256. num_revertable_width = light_font->get_string_size(num_revertable_str, HORIZONTAL_ALIGNMENT_LEFT, -1.0f, light_font_size, TextServer::JUSTIFICATION_NONE).x;
  1257. }
  1258. float text_offset_y = light_font->get_ascent(light_font_size) + (header_height - light_font->get_height(light_font_size)) / 2;
  1259. Point2 text_offset = Point2(margin_end, text_offset_y).round();
  1260. if (!rtl) {
  1261. text_offset.x = get_size().width - (text_offset.x + num_revertable_width);
  1262. }
  1263. draw_string(light_font, text_offset, num_revertable_str, HORIZONTAL_ALIGNMENT_LEFT, -1.0f, light_font_size, light_font_color, TextServer::JUSTIFICATION_NONE);
  1264. margin_end += num_revertable_width + outer_margin;
  1265. available -= num_revertable_width + outer_margin;
  1266. }
  1267. // - Label.
  1268. float text_offset_y = font->get_ascent(font_size) + (header_height - font->get_height(font_size)) / 2;
  1269. Point2 text_offset = Point2(margin_start, text_offset_y).round();
  1270. if (rtl) {
  1271. text_offset.x = margin_end;
  1272. }
  1273. HorizontalAlignment text_align = rtl ? HORIZONTAL_ALIGNMENT_RIGHT : HORIZONTAL_ALIGNMENT_LEFT;
  1274. draw_string(font, text_offset, label, text_align, available, font_size, font_color, TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_CONSTRAIN_ELLIPSIS);
  1275. }
  1276. // Draw section indentation.
  1277. if (section_indent_style.is_valid() && section_indent > 0) {
  1278. Rect2 indent_rect = Rect2(Vector2(), Vector2(indent_depth * section_indent_size, get_size().height));
  1279. if (rtl) {
  1280. indent_rect.position.x = get_size().width - section_indent + section_indent_style->get_margin(SIDE_RIGHT);
  1281. } else {
  1282. indent_rect.position.x = section_indent_style->get_margin(SIDE_LEFT);
  1283. }
  1284. draw_style_box(section_indent_style, indent_rect);
  1285. }
  1286. } break;
  1287. case NOTIFICATION_DRAG_BEGIN: {
  1288. dropping_for_unfold = true;
  1289. } break;
  1290. case NOTIFICATION_DRAG_END: {
  1291. dropping_for_unfold = false;
  1292. } break;
  1293. case NOTIFICATION_MOUSE_ENTER: {
  1294. if (dropping_for_unfold) {
  1295. dropping_unfold_timer->start();
  1296. }
  1297. queue_redraw();
  1298. } break;
  1299. case NOTIFICATION_MOUSE_EXIT: {
  1300. if (dropping_for_unfold) {
  1301. dropping_unfold_timer->stop();
  1302. }
  1303. queue_redraw();
  1304. } break;
  1305. }
  1306. }
  1307. Size2 EditorInspectorSection::get_minimum_size() const {
  1308. Size2 ms;
  1309. for (int i = 0; i < get_child_count(); i++) {
  1310. Control *c = as_sortable_control(get_child(i));
  1311. if (!c) {
  1312. continue;
  1313. }
  1314. Size2 minsize = c->get_combined_minimum_size();
  1315. ms = ms.max(minsize);
  1316. }
  1317. Ref<Font> font = get_theme_font(SceneStringName(font), SNAME("Tree"));
  1318. int font_size = get_theme_font_size(SceneStringName(font_size), SNAME("Tree"));
  1319. ms.height += font->get_height(font_size) + get_theme_constant(SNAME("v_separation"), SNAME("Tree"));
  1320. ms.width += get_theme_constant(SNAME("inspector_margin"), EditorStringName(Editor));
  1321. int section_indent_size = get_theme_constant(SNAME("indent_size"), SNAME("EditorInspectorSection"));
  1322. if (indent_depth > 0 && section_indent_size > 0) {
  1323. ms.width += indent_depth * section_indent_size;
  1324. }
  1325. Ref<StyleBoxFlat> section_indent_style = get_theme_stylebox(SNAME("indent_box"), SNAME("EditorInspectorSection"));
  1326. if (indent_depth > 0 && section_indent_style.is_valid()) {
  1327. ms.width += section_indent_style->get_margin(SIDE_LEFT) + section_indent_style->get_margin(SIDE_RIGHT);
  1328. }
  1329. return ms;
  1330. }
  1331. void EditorInspectorSection::setup(const String &p_section, const String &p_label, Object *p_object, const Color &p_bg_color, bool p_foldable, int p_indent_depth, int p_level) {
  1332. section = p_section;
  1333. label = p_label;
  1334. object = p_object;
  1335. bg_color = p_bg_color;
  1336. foldable = p_foldable;
  1337. indent_depth = p_indent_depth;
  1338. level = p_level;
  1339. if (!foldable && !vbox_added) {
  1340. add_child(vbox);
  1341. move_child(vbox, 0);
  1342. vbox_added = true;
  1343. }
  1344. if (foldable) {
  1345. _test_unfold();
  1346. if (object->editor_is_section_unfolded(section)) {
  1347. vbox->show();
  1348. } else {
  1349. vbox->hide();
  1350. }
  1351. }
  1352. }
  1353. void EditorInspectorSection::gui_input(const Ref<InputEvent> &p_event) {
  1354. ERR_FAIL_COND(p_event.is_null());
  1355. if (!foldable) {
  1356. return;
  1357. }
  1358. Ref<InputEventMouseButton> mb = p_event;
  1359. if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == MouseButton::LEFT) {
  1360. if (object->editor_is_section_unfolded(section)) {
  1361. int header_height = _get_header_height();
  1362. if (mb->get_position().y >= header_height) {
  1363. return;
  1364. }
  1365. }
  1366. accept_event();
  1367. bool should_unfold = !object->editor_is_section_unfolded(section);
  1368. if (should_unfold) {
  1369. unfold();
  1370. } else {
  1371. fold();
  1372. }
  1373. } else if (mb.is_valid() && !mb->is_pressed()) {
  1374. queue_redraw();
  1375. }
  1376. }
  1377. VBoxContainer *EditorInspectorSection::get_vbox() {
  1378. return vbox;
  1379. }
  1380. void EditorInspectorSection::unfold() {
  1381. if (!foldable) {
  1382. return;
  1383. }
  1384. _test_unfold();
  1385. object->editor_set_section_unfold(section, true);
  1386. vbox->show();
  1387. queue_redraw();
  1388. }
  1389. void EditorInspectorSection::fold() {
  1390. if (!foldable) {
  1391. return;
  1392. }
  1393. if (!vbox_added) {
  1394. return;
  1395. }
  1396. object->editor_set_section_unfold(section, false);
  1397. vbox->hide();
  1398. queue_redraw();
  1399. }
  1400. void EditorInspectorSection::set_bg_color(const Color &p_bg_color) {
  1401. bg_color = p_bg_color;
  1402. queue_redraw();
  1403. }
  1404. bool EditorInspectorSection::has_revertable_properties() const {
  1405. return !revertable_properties.is_empty();
  1406. }
  1407. void EditorInspectorSection::property_can_revert_changed(const String &p_path, bool p_can_revert) {
  1408. bool had_revertable_properties = has_revertable_properties();
  1409. if (p_can_revert) {
  1410. revertable_properties.insert(p_path);
  1411. } else {
  1412. revertable_properties.erase(p_path);
  1413. }
  1414. if (has_revertable_properties() != had_revertable_properties) {
  1415. queue_redraw();
  1416. }
  1417. }
  1418. void EditorInspectorSection::_bind_methods() {
  1419. ClassDB::bind_method(D_METHOD("setup", "section", "label", "object", "bg_color", "foldable", "indent_depth", "level"), &EditorInspectorSection::setup, DEFVAL(0), DEFVAL(1));
  1420. ClassDB::bind_method(D_METHOD("get_vbox"), &EditorInspectorSection::get_vbox);
  1421. ClassDB::bind_method(D_METHOD("unfold"), &EditorInspectorSection::unfold);
  1422. ClassDB::bind_method(D_METHOD("fold"), &EditorInspectorSection::fold);
  1423. }
  1424. EditorInspectorSection::EditorInspectorSection() {
  1425. vbox = memnew(VBoxContainer);
  1426. dropping_unfold_timer = memnew(Timer);
  1427. dropping_unfold_timer->set_wait_time(0.6);
  1428. dropping_unfold_timer->set_one_shot(true);
  1429. add_child(dropping_unfold_timer);
  1430. dropping_unfold_timer->connect("timeout", callable_mp(this, &EditorInspectorSection::unfold));
  1431. }
  1432. EditorInspectorSection::~EditorInspectorSection() {
  1433. if (!vbox_added) {
  1434. memdelete(vbox);
  1435. }
  1436. }
  1437. ////////////////////////////////////////////////
  1438. ////////////////////////////////////////////////
  1439. int EditorInspectorArray::_get_array_count() {
  1440. if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
  1441. List<PropertyInfo> object_property_list;
  1442. object->get_property_list(&object_property_list);
  1443. return _extract_properties_as_array(object_property_list).size();
  1444. } else if (mode == MODE_USE_COUNT_PROPERTY) {
  1445. bool valid;
  1446. int count_val = object->get(count_property, &valid);
  1447. ERR_FAIL_COND_V_MSG(!valid, 0, vformat("%s is not a valid property to be used as array count.", count_property));
  1448. return count_val;
  1449. }
  1450. return 0;
  1451. }
  1452. void EditorInspectorArray::_add_button_pressed() {
  1453. _move_element(-1, -1);
  1454. }
  1455. void EditorInspectorArray::_paginator_page_changed(int p_page) {
  1456. emit_signal("page_change_request", p_page);
  1457. }
  1458. void EditorInspectorArray::_rmb_popup_id_pressed(int p_id) {
  1459. switch (p_id) {
  1460. case OPTION_MOVE_UP:
  1461. if (popup_array_index_pressed > 0) {
  1462. _move_element(popup_array_index_pressed, popup_array_index_pressed - 1);
  1463. }
  1464. break;
  1465. case OPTION_MOVE_DOWN:
  1466. if (popup_array_index_pressed < count - 1) {
  1467. _move_element(popup_array_index_pressed, popup_array_index_pressed + 2);
  1468. }
  1469. break;
  1470. case OPTION_NEW_BEFORE:
  1471. _move_element(-1, popup_array_index_pressed);
  1472. break;
  1473. case OPTION_NEW_AFTER:
  1474. _move_element(-1, popup_array_index_pressed + 1);
  1475. break;
  1476. case OPTION_REMOVE:
  1477. _move_element(popup_array_index_pressed, -1);
  1478. break;
  1479. case OPTION_CLEAR_ARRAY:
  1480. _clear_array();
  1481. break;
  1482. case OPTION_RESIZE_ARRAY:
  1483. new_size_spin_box->set_value(count);
  1484. resize_dialog->get_ok_button()->set_disabled(true);
  1485. resize_dialog->popup_centered(Size2(250, 0) * EDSCALE);
  1486. new_size_spin_box->get_line_edit()->grab_focus();
  1487. new_size_spin_box->get_line_edit()->select_all();
  1488. break;
  1489. default:
  1490. break;
  1491. }
  1492. }
  1493. void EditorInspectorArray::_control_dropping_draw() {
  1494. int drop_position = _drop_position();
  1495. if (dropping && drop_position >= 0) {
  1496. Vector2 from;
  1497. Vector2 to;
  1498. if (drop_position < elements_vbox->get_child_count()) {
  1499. Transform2D xform = Object::cast_to<Control>(elements_vbox->get_child(drop_position))->get_transform();
  1500. from = xform.xform(Vector2());
  1501. to = xform.xform(Vector2(elements_vbox->get_size().x, 0));
  1502. } else {
  1503. Control *child = Object::cast_to<Control>(elements_vbox->get_child(drop_position - 1));
  1504. Transform2D xform = child->get_transform();
  1505. from = xform.xform(Vector2(0, child->get_size().y));
  1506. to = xform.xform(Vector2(elements_vbox->get_size().x, child->get_size().y));
  1507. }
  1508. Color color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor));
  1509. control_dropping->draw_line(from, to, color, 2);
  1510. }
  1511. }
  1512. void EditorInspectorArray::_vbox_visibility_changed() {
  1513. control_dropping->set_visible(vbox->is_visible_in_tree());
  1514. }
  1515. void EditorInspectorArray::_panel_draw(int p_index) {
  1516. ERR_FAIL_INDEX(p_index, (int)array_elements.size());
  1517. Ref<StyleBox> style = get_theme_stylebox(SNAME("Focus"), EditorStringName(EditorStyles));
  1518. if (!style.is_valid()) {
  1519. return;
  1520. }
  1521. if (array_elements[p_index].panel->has_focus()) {
  1522. array_elements[p_index].panel->draw_style_box(style, Rect2(Vector2(), array_elements[p_index].panel->get_size()));
  1523. }
  1524. }
  1525. void EditorInspectorArray::_panel_gui_input(Ref<InputEvent> p_event, int p_index) {
  1526. ERR_FAIL_INDEX(p_index, (int)array_elements.size());
  1527. if (read_only) {
  1528. return;
  1529. }
  1530. Ref<InputEventKey> key_ref = p_event;
  1531. if (key_ref.is_valid()) {
  1532. const InputEventKey &key = **key_ref;
  1533. if (array_elements[p_index].panel->has_focus() && key.is_pressed() && key.get_keycode() == Key::KEY_DELETE) {
  1534. _move_element(begin_array_index + p_index, -1);
  1535. array_elements[p_index].panel->accept_event();
  1536. }
  1537. }
  1538. Ref<InputEventMouseButton> mb = p_event;
  1539. if (mb.is_valid()) {
  1540. if (movable && mb->get_button_index() == MouseButton::RIGHT) {
  1541. array_elements[p_index].panel->accept_event();
  1542. popup_array_index_pressed = begin_array_index + p_index;
  1543. rmb_popup->set_item_disabled(OPTION_MOVE_UP, popup_array_index_pressed == 0);
  1544. rmb_popup->set_item_disabled(OPTION_MOVE_DOWN, popup_array_index_pressed == count - 1);
  1545. rmb_popup->set_position(get_screen_position() + mb->get_position());
  1546. rmb_popup->reset_size();
  1547. rmb_popup->popup();
  1548. }
  1549. }
  1550. }
  1551. void EditorInspectorArray::_move_element(int p_element_index, int p_to_pos) {
  1552. String action_name;
  1553. if (p_element_index < 0) {
  1554. action_name = vformat(TTR("Add element to property array with prefix %s."), array_element_prefix);
  1555. } else if (p_to_pos < 0) {
  1556. action_name = vformat(TTR("Remove element %d from property array with prefix %s."), p_element_index, array_element_prefix);
  1557. } else {
  1558. action_name = vformat(TTR("Move element %d to position %d in property array with prefix %s."), p_element_index, p_to_pos, array_element_prefix);
  1559. }
  1560. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  1561. undo_redo->create_action(action_name);
  1562. if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
  1563. // Call the function.
  1564. Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name());
  1565. if (move_function.is_valid()) {
  1566. move_function.call(undo_redo, object, array_element_prefix, p_element_index, p_to_pos);
  1567. } else {
  1568. WARN_PRINT(vformat("Could not find a function to move arrays elements for class %s. Register a move element function using EditorData::add_move_array_element_function", object->get_class_name()));
  1569. }
  1570. } else if (mode == MODE_USE_COUNT_PROPERTY) {
  1571. ERR_FAIL_COND(p_to_pos < -1 || p_to_pos > count);
  1572. if (!swap_method.is_empty()) {
  1573. ERR_FAIL_COND(!object->has_method(swap_method));
  1574. // Swap method was provided, use it.
  1575. if (p_element_index < 0) {
  1576. // Add an element at position
  1577. undo_redo->add_do_property(object, count_property, count + 1);
  1578. if (p_to_pos >= 0) {
  1579. for (int i = count; i > p_to_pos; i--) {
  1580. undo_redo->add_do_method(object, swap_method, i, i - 1);
  1581. }
  1582. for (int i = p_to_pos; i < count; i++) {
  1583. undo_redo->add_undo_method(object, swap_method, i, i + 1);
  1584. }
  1585. }
  1586. undo_redo->add_undo_property(object, count_property, count);
  1587. } else if (p_to_pos < 0) {
  1588. if (count > 0) {
  1589. // Remove element at position
  1590. undo_redo->add_undo_property(object, count_property, count);
  1591. List<PropertyInfo> object_property_list;
  1592. object->get_property_list(&object_property_list);
  1593. for (int i = p_element_index; i < count - 1; i++) {
  1594. undo_redo->add_do_method(object, swap_method, i, i + 1);
  1595. }
  1596. for (int i = count; i > p_element_index; i--) {
  1597. undo_redo->add_undo_method(object, swap_method, i, i - 1);
  1598. }
  1599. String erase_prefix = String(array_element_prefix) + itos(p_element_index);
  1600. for (const PropertyInfo &E : object_property_list) {
  1601. if (E.name.begins_with(erase_prefix)) {
  1602. undo_redo->add_undo_property(object, E.name, object->get(E.name));
  1603. }
  1604. }
  1605. undo_redo->add_do_property(object, count_property, count - 1);
  1606. }
  1607. } else {
  1608. if (p_to_pos > p_element_index) {
  1609. p_to_pos--;
  1610. }
  1611. if (p_to_pos < p_element_index) {
  1612. for (int i = p_element_index; i > p_to_pos; i--) {
  1613. undo_redo->add_do_method(object, swap_method, i, i - 1);
  1614. }
  1615. for (int i = p_to_pos; i < p_element_index; i++) {
  1616. undo_redo->add_undo_method(object, swap_method, i, i + 1);
  1617. }
  1618. } else if (p_to_pos > p_element_index) {
  1619. for (int i = p_element_index; i < p_to_pos; i++) {
  1620. undo_redo->add_do_method(object, swap_method, i, i + 1);
  1621. }
  1622. for (int i = p_to_pos; i > p_element_index; i--) {
  1623. undo_redo->add_undo_method(object, swap_method, i, i - 1);
  1624. }
  1625. }
  1626. }
  1627. } else {
  1628. // Use standard properties.
  1629. List<PropertyInfo> object_property_list;
  1630. object->get_property_list(&object_property_list);
  1631. Array properties_as_array = _extract_properties_as_array(object_property_list);
  1632. properties_as_array.resize(count);
  1633. // For undoing things
  1634. undo_redo->add_undo_property(object, count_property, properties_as_array.size());
  1635. for (int i = 0; i < (int)properties_as_array.size(); i++) {
  1636. Dictionary d = Dictionary(properties_as_array[i]);
  1637. Array keys = d.keys();
  1638. for (int j = 0; j < keys.size(); j++) {
  1639. String key = keys[j];
  1640. undo_redo->add_undo_property(object, vformat(key, i), d[key]);
  1641. }
  1642. }
  1643. if (p_element_index < 0) {
  1644. // Add an element.
  1645. properties_as_array.insert(p_to_pos < 0 ? properties_as_array.size() : p_to_pos, Dictionary());
  1646. } else if (p_to_pos < 0) {
  1647. // Delete the element.
  1648. properties_as_array.remove_at(p_element_index);
  1649. } else {
  1650. // Move the element.
  1651. properties_as_array.insert(p_to_pos, properties_as_array[p_element_index].duplicate());
  1652. properties_as_array.remove_at(p_to_pos < p_element_index ? p_element_index + 1 : p_element_index);
  1653. }
  1654. // Change the array size then set the properties.
  1655. undo_redo->add_do_property(object, count_property, properties_as_array.size());
  1656. for (int i = 0; i < (int)properties_as_array.size(); i++) {
  1657. Dictionary d = properties_as_array[i];
  1658. Array keys = d.keys();
  1659. for (int j = 0; j < keys.size(); j++) {
  1660. String key = keys[j];
  1661. undo_redo->add_do_property(object, vformat(key, i), d[key]);
  1662. }
  1663. }
  1664. }
  1665. }
  1666. undo_redo->commit_action();
  1667. // Handle page change and update counts.
  1668. if (p_element_index < 0) {
  1669. int added_index = p_to_pos < 0 ? count : p_to_pos;
  1670. emit_signal(SNAME("page_change_request"), added_index / page_length);
  1671. count += 1;
  1672. } else if (p_to_pos < 0) {
  1673. count -= 1;
  1674. if (page == max_page && (MAX(0, count - 1) / page_length != max_page)) {
  1675. emit_signal(SNAME("page_change_request"), max_page - 1);
  1676. }
  1677. } else if (p_to_pos == begin_array_index - 1) {
  1678. emit_signal(SNAME("page_change_request"), page - 1);
  1679. } else if (p_to_pos > end_array_index) {
  1680. emit_signal(SNAME("page_change_request"), page + 1);
  1681. }
  1682. begin_array_index = page * page_length;
  1683. end_array_index = MIN(count, (page + 1) * page_length);
  1684. max_page = MAX(0, count - 1) / page_length;
  1685. }
  1686. void EditorInspectorArray::_clear_array() {
  1687. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  1688. undo_redo->create_action(vformat(TTR("Clear Property Array with Prefix %s"), array_element_prefix));
  1689. if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
  1690. for (int i = count - 1; i >= 0; i--) {
  1691. // Call the function.
  1692. Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name());
  1693. if (move_function.is_valid()) {
  1694. move_function.call(undo_redo, object, array_element_prefix, i, -1);
  1695. } else {
  1696. WARN_PRINT(vformat("Could not find a function to move arrays elements for class %s. Register a move element function using EditorData::add_move_array_element_function", object->get_class_name()));
  1697. }
  1698. }
  1699. } else if (mode == MODE_USE_COUNT_PROPERTY) {
  1700. List<PropertyInfo> object_property_list;
  1701. object->get_property_list(&object_property_list);
  1702. Array properties_as_array = _extract_properties_as_array(object_property_list);
  1703. properties_as_array.resize(count);
  1704. // For undoing things
  1705. undo_redo->add_undo_property(object, count_property, count);
  1706. for (int i = 0; i < (int)properties_as_array.size(); i++) {
  1707. Dictionary d = Dictionary(properties_as_array[i]);
  1708. Array keys = d.keys();
  1709. for (int j = 0; j < keys.size(); j++) {
  1710. String key = keys[j];
  1711. undo_redo->add_undo_property(object, vformat(key, i), d[key]);
  1712. }
  1713. }
  1714. // Change the array size then set the properties.
  1715. undo_redo->add_do_property(object, count_property, 0);
  1716. }
  1717. undo_redo->commit_action();
  1718. // Handle page change and update counts.
  1719. emit_signal(SNAME("page_change_request"), 0);
  1720. count = 0;
  1721. begin_array_index = 0;
  1722. end_array_index = 0;
  1723. max_page = 0;
  1724. }
  1725. void EditorInspectorArray::_resize_array(int p_size) {
  1726. ERR_FAIL_COND(p_size < 0);
  1727. if (p_size == count) {
  1728. return;
  1729. }
  1730. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  1731. undo_redo->create_action(vformat(TTR("Resize Property Array with Prefix %s"), array_element_prefix));
  1732. if (p_size > count) {
  1733. if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
  1734. for (int i = count; i < p_size; i++) {
  1735. // Call the function.
  1736. Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name());
  1737. if (move_function.is_valid()) {
  1738. move_function.call(undo_redo, object, array_element_prefix, -1, -1);
  1739. } else {
  1740. WARN_PRINT(vformat("Could not find a function to move arrays elements for class %s. Register a move element function using EditorData::add_move_array_element_function", object->get_class_name()));
  1741. }
  1742. }
  1743. } else if (mode == MODE_USE_COUNT_PROPERTY) {
  1744. undo_redo->add_undo_property(object, count_property, count);
  1745. undo_redo->add_do_property(object, count_property, p_size);
  1746. }
  1747. } else {
  1748. if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
  1749. for (int i = count - 1; i > p_size - 1; i--) {
  1750. // Call the function.
  1751. Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name());
  1752. if (move_function.is_valid()) {
  1753. move_function.call(undo_redo, object, array_element_prefix, i, -1);
  1754. } else {
  1755. WARN_PRINT(vformat("Could not find a function to move arrays elements for class %s. Register a move element function using EditorData::add_move_array_element_function", object->get_class_name()));
  1756. }
  1757. }
  1758. } else if (mode == MODE_USE_COUNT_PROPERTY) {
  1759. List<PropertyInfo> object_property_list;
  1760. object->get_property_list(&object_property_list);
  1761. Array properties_as_array = _extract_properties_as_array(object_property_list);
  1762. properties_as_array.resize(count);
  1763. // For undoing things
  1764. undo_redo->add_undo_property(object, count_property, count);
  1765. for (int i = count - 1; i > p_size - 1; i--) {
  1766. Dictionary d = Dictionary(properties_as_array[i]);
  1767. Array keys = d.keys();
  1768. for (int j = 0; j < keys.size(); j++) {
  1769. String key = keys[j];
  1770. undo_redo->add_undo_property(object, vformat(key, i), d[key]);
  1771. }
  1772. }
  1773. // Change the array size then set the properties.
  1774. undo_redo->add_do_property(object, count_property, p_size);
  1775. }
  1776. }
  1777. undo_redo->commit_action();
  1778. // Handle page change and update counts.
  1779. emit_signal(SNAME("page_change_request"), 0);
  1780. /*
  1781. count = 0;
  1782. begin_array_index = 0;
  1783. end_array_index = 0;
  1784. max_page = 0;
  1785. */
  1786. }
  1787. Array EditorInspectorArray::_extract_properties_as_array(const List<PropertyInfo> &p_list) {
  1788. Array output;
  1789. for (const PropertyInfo &pi : p_list) {
  1790. if (!(pi.usage & PROPERTY_USAGE_EDITOR)) {
  1791. continue;
  1792. }
  1793. if (pi.name.begins_with(array_element_prefix)) {
  1794. String str = pi.name.trim_prefix(array_element_prefix);
  1795. int to_char_index = 0;
  1796. while (to_char_index < str.length()) {
  1797. if (!is_digit(str[to_char_index])) {
  1798. break;
  1799. }
  1800. to_char_index++;
  1801. }
  1802. if (to_char_index > 0) {
  1803. int array_index = str.left(to_char_index).to_int();
  1804. Error error = OK;
  1805. if (array_index >= output.size()) {
  1806. error = output.resize(array_index + 1);
  1807. }
  1808. if (error == OK) {
  1809. String format_string = String(array_element_prefix) + "%d" + str.substr(to_char_index);
  1810. Dictionary dict = output[array_index];
  1811. dict[format_string] = object->get(pi.name);
  1812. output[array_index] = dict;
  1813. } else {
  1814. WARN_PRINT(vformat("Array element %s has an index too high. Array allocation failed.", pi.name));
  1815. }
  1816. }
  1817. }
  1818. }
  1819. return output;
  1820. }
  1821. int EditorInspectorArray::_drop_position() const {
  1822. for (int i = 0; i < (int)array_elements.size(); i++) {
  1823. const ArrayElement &ae = array_elements[i];
  1824. Size2 size = ae.panel->get_size();
  1825. Vector2 mp = ae.panel->get_local_mouse_position();
  1826. if (Rect2(Vector2(), size).has_point(mp)) {
  1827. if (mp.y < size.y / 2) {
  1828. return i;
  1829. } else {
  1830. return i + 1;
  1831. }
  1832. }
  1833. }
  1834. return -1;
  1835. }
  1836. void EditorInspectorArray::_resize_dialog_confirmed() {
  1837. if (int(new_size_spin_box->get_value()) == count) {
  1838. return;
  1839. }
  1840. resize_dialog->hide();
  1841. _resize_array(int(new_size_spin_box->get_value()));
  1842. }
  1843. void EditorInspectorArray::_new_size_spin_box_value_changed(float p_value) {
  1844. resize_dialog->get_ok_button()->set_disabled(int(p_value) == count);
  1845. }
  1846. void EditorInspectorArray::_new_size_spin_box_text_submitted(const String &p_text) {
  1847. _resize_dialog_confirmed();
  1848. }
  1849. void EditorInspectorArray::_setup() {
  1850. // Setup counts.
  1851. count = _get_array_count();
  1852. begin_array_index = page * page_length;
  1853. end_array_index = MIN(count, (page + 1) * page_length);
  1854. max_page = MAX(0, count - 1) / page_length;
  1855. array_elements.resize(MAX(0, end_array_index - begin_array_index));
  1856. if (page < 0 || page > max_page) {
  1857. WARN_PRINT(vformat("Invalid page number %d", page));
  1858. page = CLAMP(page, 0, max_page);
  1859. }
  1860. Ref<Font> numbers_font;
  1861. int numbers_min_w = 0;
  1862. if (numbered) {
  1863. numbers_font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
  1864. int digits_found = count;
  1865. String test;
  1866. while (digits_found) {
  1867. test += "8";
  1868. digits_found /= 10;
  1869. }
  1870. numbers_min_w = numbers_font->get_string_size(test).width;
  1871. }
  1872. for (int i = 0; i < (int)array_elements.size(); i++) {
  1873. ArrayElement &ae = array_elements[i];
  1874. // Panel and its hbox.
  1875. ae.panel = memnew(PanelContainer);
  1876. ae.panel->set_focus_mode(FOCUS_ALL);
  1877. ae.panel->set_mouse_filter(MOUSE_FILTER_PASS);
  1878. SET_DRAG_FORWARDING_GCD(ae.panel, EditorInspectorArray);
  1879. int element_position = begin_array_index + i;
  1880. ae.panel->set_meta("index", element_position);
  1881. ae.panel->set_tooltip_text(vformat(TTR("Element %d: %s%d*"), element_position, array_element_prefix, element_position));
  1882. ae.panel->connect(SceneStringName(focus_entered), callable_mp((CanvasItem *)ae.panel, &PanelContainer::queue_redraw));
  1883. ae.panel->connect(SceneStringName(focus_exited), callable_mp((CanvasItem *)ae.panel, &PanelContainer::queue_redraw));
  1884. ae.panel->connect(SceneStringName(draw), callable_mp(this, &EditorInspectorArray::_panel_draw).bind(i));
  1885. ae.panel->connect(SceneStringName(gui_input), callable_mp(this, &EditorInspectorArray::_panel_gui_input).bind(i));
  1886. ae.panel->add_theme_style_override(SceneStringName(panel), i % 2 ? odd_style : even_style);
  1887. elements_vbox->add_child(ae.panel);
  1888. ae.margin = memnew(MarginContainer);
  1889. ae.margin->set_mouse_filter(MOUSE_FILTER_PASS);
  1890. if (is_inside_tree()) {
  1891. Size2 min_size = get_theme_stylebox(SNAME("Focus"), EditorStringName(EditorStyles))->get_minimum_size();
  1892. ae.margin->begin_bulk_theme_override();
  1893. ae.margin->add_theme_constant_override("margin_left", min_size.x / 2);
  1894. ae.margin->add_theme_constant_override("margin_top", min_size.y / 2);
  1895. ae.margin->add_theme_constant_override("margin_right", min_size.x / 2);
  1896. ae.margin->add_theme_constant_override("margin_bottom", min_size.y / 2);
  1897. ae.margin->end_bulk_theme_override();
  1898. }
  1899. ae.panel->add_child(ae.margin);
  1900. ae.hbox = memnew(HBoxContainer);
  1901. ae.hbox->set_h_size_flags(SIZE_EXPAND_FILL);
  1902. ae.hbox->set_v_size_flags(SIZE_EXPAND_FILL);
  1903. ae.margin->add_child(ae.hbox);
  1904. // Move button.
  1905. if (movable) {
  1906. VBoxContainer *move_vbox = memnew(VBoxContainer);
  1907. move_vbox->set_v_size_flags(SIZE_EXPAND_FILL);
  1908. move_vbox->set_alignment(BoxContainer::ALIGNMENT_CENTER);
  1909. ae.hbox->add_child(move_vbox);
  1910. if (element_position > 0) {
  1911. ae.move_up = memnew(Button);
  1912. ae.move_up->set_button_icon(get_editor_theme_icon(SNAME("MoveUp")));
  1913. ae.move_up->connect(SceneStringName(pressed), callable_mp(this, &EditorInspectorArray::_move_element).bind(element_position, element_position - 1));
  1914. move_vbox->add_child(ae.move_up);
  1915. }
  1916. ae.move_texture_rect = memnew(TextureRect);
  1917. ae.move_texture_rect->set_stretch_mode(TextureRect::STRETCH_KEEP_CENTERED);
  1918. ae.move_texture_rect->set_default_cursor_shape(Control::CURSOR_MOVE);
  1919. if (is_inside_tree()) {
  1920. ae.move_texture_rect->set_texture(get_editor_theme_icon(SNAME("TripleBar")));
  1921. }
  1922. move_vbox->add_child(ae.move_texture_rect);
  1923. if (element_position < count - 1) {
  1924. ae.move_down = memnew(Button);
  1925. ae.move_down->set_button_icon(get_editor_theme_icon(SNAME("MoveDown")));
  1926. ae.move_down->connect(SceneStringName(pressed), callable_mp(this, &EditorInspectorArray::_move_element).bind(element_position, element_position + 2));
  1927. move_vbox->add_child(ae.move_down);
  1928. }
  1929. }
  1930. if (numbered) {
  1931. ae.number = memnew(Label);
  1932. ae.number->add_theme_font_override(SceneStringName(font), numbers_font);
  1933. ae.number->set_custom_minimum_size(Size2(numbers_min_w, 0));
  1934. ae.number->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT);
  1935. ae.number->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER);
  1936. ae.number->set_text(itos(element_position));
  1937. ae.hbox->add_child(ae.number);
  1938. }
  1939. // Right vbox.
  1940. ae.vbox = memnew(VBoxContainer);
  1941. ae.vbox->set_h_size_flags(SIZE_EXPAND_FILL);
  1942. ae.vbox->set_v_size_flags(SIZE_EXPAND_FILL);
  1943. ae.hbox->add_child(ae.vbox);
  1944. ae.erase = memnew(Button);
  1945. ae.erase->set_button_icon(get_editor_theme_icon(SNAME("Remove")));
  1946. ae.erase->set_v_size_flags(SIZE_SHRINK_CENTER);
  1947. ae.erase->connect(SceneStringName(pressed), callable_mp(this, &EditorInspectorArray::_remove_item).bind(element_position));
  1948. ae.hbox->add_child(ae.erase);
  1949. }
  1950. // Hide/show the add button.
  1951. add_button->set_visible(page == max_page);
  1952. // Add paginator if there's more than 1 page.
  1953. if (max_page > 0) {
  1954. EditorPaginator *paginator = memnew(EditorPaginator);
  1955. paginator->update(page, max_page);
  1956. paginator->connect("page_changed", callable_mp(this, &EditorInspectorArray::_paginator_page_changed));
  1957. vbox->add_child(paginator);
  1958. }
  1959. }
  1960. void EditorInspectorArray::_remove_item(int p_index) {
  1961. _move_element(p_index, -1);
  1962. }
  1963. Variant EditorInspectorArray::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  1964. if (!movable) {
  1965. return Variant();
  1966. }
  1967. int index = p_from->get_meta("index");
  1968. Dictionary dict;
  1969. dict["type"] = "property_array_element";
  1970. dict["property_array_prefix"] = array_element_prefix;
  1971. dict["index"] = index;
  1972. return dict;
  1973. }
  1974. void EditorInspectorArray::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  1975. Dictionary dict = p_data;
  1976. int to_drop = dict["index"];
  1977. int drop_position = _drop_position();
  1978. if (drop_position < 0) {
  1979. return;
  1980. }
  1981. _move_element(to_drop, begin_array_index + drop_position);
  1982. }
  1983. bool EditorInspectorArray::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  1984. if (!movable || read_only) {
  1985. return false;
  1986. }
  1987. // First, update drawing.
  1988. control_dropping->queue_redraw();
  1989. if (p_data.get_type() != Variant::DICTIONARY) {
  1990. return false;
  1991. }
  1992. Dictionary dict = p_data;
  1993. int drop_position = _drop_position();
  1994. if (!dict.has("type") || dict["type"] != "property_array_element" || String(dict["property_array_prefix"]) != array_element_prefix || drop_position < 0) {
  1995. return false;
  1996. }
  1997. // Check in dropping at the given index does indeed move the item.
  1998. int moved_array_index = (int)dict["index"];
  1999. int drop_array_index = begin_array_index + drop_position;
  2000. return drop_array_index != moved_array_index && drop_array_index - 1 != moved_array_index;
  2001. }
  2002. void EditorInspectorArray::_notification(int p_what) {
  2003. switch (p_what) {
  2004. case NOTIFICATION_ENTER_TREE:
  2005. case NOTIFICATION_THEME_CHANGED: {
  2006. Color color = get_theme_color(SNAME("dark_color_1"), EditorStringName(Editor));
  2007. odd_style->set_bg_color(color.darkened(-0.08));
  2008. even_style->set_bg_color(color.darkened(0.08));
  2009. for (ArrayElement &ae : array_elements) {
  2010. if (ae.move_texture_rect) {
  2011. ae.move_texture_rect->set_texture(get_editor_theme_icon(SNAME("TripleBar")));
  2012. }
  2013. if (ae.move_up) {
  2014. ae.move_up->set_button_icon(get_editor_theme_icon(SNAME("MoveUp")));
  2015. }
  2016. if (ae.move_down) {
  2017. ae.move_down->set_button_icon(get_editor_theme_icon(SNAME("MoveDown")));
  2018. }
  2019. Size2 min_size = get_theme_stylebox(SNAME("Focus"), EditorStringName(EditorStyles))->get_minimum_size();
  2020. ae.margin->begin_bulk_theme_override();
  2021. ae.margin->add_theme_constant_override("margin_left", min_size.x / 2);
  2022. ae.margin->add_theme_constant_override("margin_top", min_size.y / 2);
  2023. ae.margin->add_theme_constant_override("margin_right", min_size.x / 2);
  2024. ae.margin->add_theme_constant_override("margin_bottom", min_size.y / 2);
  2025. ae.margin->end_bulk_theme_override();
  2026. if (ae.erase) {
  2027. ae.erase->set_button_icon(get_editor_theme_icon(SNAME("Remove")));
  2028. }
  2029. }
  2030. add_button->set_button_icon(get_editor_theme_icon(SNAME("Add")));
  2031. update_minimum_size();
  2032. } break;
  2033. case NOTIFICATION_DRAG_BEGIN: {
  2034. Dictionary dict = get_viewport()->gui_get_drag_data();
  2035. if (dict.has("type") && dict["type"] == "property_array_element" && String(dict["property_array_prefix"]) == array_element_prefix) {
  2036. dropping = true;
  2037. control_dropping->queue_redraw();
  2038. }
  2039. } break;
  2040. case NOTIFICATION_DRAG_END: {
  2041. if (dropping) {
  2042. dropping = false;
  2043. control_dropping->queue_redraw();
  2044. }
  2045. } break;
  2046. }
  2047. }
  2048. void EditorInspectorArray::_bind_methods() {
  2049. ADD_SIGNAL(MethodInfo("page_change_request"));
  2050. }
  2051. void EditorInspectorArray::setup_with_move_element_function(Object *p_object, const String &p_label, const StringName &p_array_element_prefix, int p_page, const Color &p_bg_color, bool p_foldable, bool p_movable, bool p_numbered, int p_page_length, const String &p_add_item_text) {
  2052. count_property = "";
  2053. mode = MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION;
  2054. array_element_prefix = p_array_element_prefix;
  2055. page = p_page;
  2056. movable = p_movable;
  2057. page_length = p_page_length;
  2058. numbered = p_numbered;
  2059. EditorInspectorSection::setup(String(p_array_element_prefix) + "_array", p_label, p_object, p_bg_color, p_foldable, 0);
  2060. _setup();
  2061. }
  2062. void EditorInspectorArray::setup_with_count_property(Object *p_object, const String &p_label, const StringName &p_count_property, const StringName &p_array_element_prefix, int p_page, const Color &p_bg_color, bool p_foldable, bool p_movable, bool p_numbered, int p_page_length, const String &p_add_item_text, const String &p_swap_method) {
  2063. count_property = p_count_property;
  2064. mode = MODE_USE_COUNT_PROPERTY;
  2065. array_element_prefix = p_array_element_prefix;
  2066. page = p_page;
  2067. movable = p_movable;
  2068. page_length = p_page_length;
  2069. numbered = p_numbered;
  2070. swap_method = p_swap_method;
  2071. add_button->set_text(p_add_item_text);
  2072. EditorInspectorSection::setup(String(count_property) + "_array", p_label, p_object, p_bg_color, p_foldable, 0);
  2073. _setup();
  2074. }
  2075. VBoxContainer *EditorInspectorArray::get_vbox(int p_index) {
  2076. if (p_index >= begin_array_index && p_index < end_array_index) {
  2077. return array_elements[p_index - begin_array_index].vbox;
  2078. } else if (p_index < 0) {
  2079. return vbox;
  2080. } else {
  2081. return nullptr;
  2082. }
  2083. }
  2084. EditorInspectorArray::EditorInspectorArray(bool p_read_only) {
  2085. read_only = p_read_only;
  2086. set_mouse_filter(Control::MOUSE_FILTER_STOP);
  2087. odd_style.instantiate();
  2088. even_style.instantiate();
  2089. rmb_popup = memnew(PopupMenu);
  2090. rmb_popup->add_item(TTR("Move Up"), OPTION_MOVE_UP);
  2091. rmb_popup->add_item(TTR("Move Down"), OPTION_MOVE_DOWN);
  2092. rmb_popup->add_separator();
  2093. rmb_popup->add_item(TTR("Insert New Before"), OPTION_NEW_BEFORE);
  2094. rmb_popup->add_item(TTR("Insert New After"), OPTION_NEW_AFTER);
  2095. rmb_popup->add_separator();
  2096. rmb_popup->add_item(TTR("Remove"), OPTION_REMOVE);
  2097. rmb_popup->add_separator();
  2098. rmb_popup->add_item(TTR("Clear Array"), OPTION_CLEAR_ARRAY);
  2099. rmb_popup->add_item(TTR("Resize Array..."), OPTION_RESIZE_ARRAY);
  2100. rmb_popup->connect(SceneStringName(id_pressed), callable_mp(this, &EditorInspectorArray::_rmb_popup_id_pressed));
  2101. add_child(rmb_popup);
  2102. elements_vbox = memnew(VBoxContainer);
  2103. elements_vbox->add_theme_constant_override("separation", 0);
  2104. vbox->add_child(elements_vbox);
  2105. add_button = EditorInspector::create_inspector_action_button(TTR("Add Element"));
  2106. add_button->connect(SceneStringName(pressed), callable_mp(this, &EditorInspectorArray::_add_button_pressed));
  2107. add_button->set_disabled(read_only);
  2108. vbox->add_child(add_button);
  2109. control_dropping = memnew(Control);
  2110. control_dropping->connect(SceneStringName(draw), callable_mp(this, &EditorInspectorArray::_control_dropping_draw));
  2111. control_dropping->set_mouse_filter(Control::MOUSE_FILTER_IGNORE);
  2112. add_child(control_dropping);
  2113. resize_dialog = memnew(AcceptDialog);
  2114. resize_dialog->set_title(TTRC("Resize Array"));
  2115. resize_dialog->add_cancel_button();
  2116. resize_dialog->connect(SceneStringName(confirmed), callable_mp(this, &EditorInspectorArray::_resize_dialog_confirmed));
  2117. add_child(resize_dialog);
  2118. VBoxContainer *resize_dialog_vbox = memnew(VBoxContainer);
  2119. resize_dialog->add_child(resize_dialog_vbox);
  2120. new_size_spin_box = memnew(SpinBox);
  2121. new_size_spin_box->set_max(16384);
  2122. new_size_spin_box->connect(SceneStringName(value_changed), callable_mp(this, &EditorInspectorArray::_new_size_spin_box_value_changed));
  2123. new_size_spin_box->get_line_edit()->connect("text_submitted", callable_mp(this, &EditorInspectorArray::_new_size_spin_box_text_submitted));
  2124. new_size_spin_box->set_editable(!read_only);
  2125. resize_dialog_vbox->add_margin_child(TTRC("New Size:"), new_size_spin_box);
  2126. vbox->connect(SceneStringName(visibility_changed), callable_mp(this, &EditorInspectorArray::_vbox_visibility_changed));
  2127. }
  2128. ////////////////////////////////////////////////
  2129. ////////////////////////////////////////////////
  2130. void EditorPaginator::_first_page_button_pressed() {
  2131. emit_signal("page_changed", 0);
  2132. }
  2133. void EditorPaginator::_prev_page_button_pressed() {
  2134. emit_signal("page_changed", MAX(0, page - 1));
  2135. }
  2136. void EditorPaginator::_page_line_edit_text_submitted(const String &p_text) {
  2137. if (p_text.is_valid_int()) {
  2138. int new_page = p_text.to_int() - 1;
  2139. new_page = MIN(MAX(0, new_page), max_page);
  2140. page_line_edit->set_text(Variant(new_page));
  2141. emit_signal("page_changed", new_page);
  2142. } else {
  2143. page_line_edit->set_text(Variant(page));
  2144. }
  2145. }
  2146. void EditorPaginator::_next_page_button_pressed() {
  2147. emit_signal("page_changed", MIN(max_page, page + 1));
  2148. }
  2149. void EditorPaginator::_last_page_button_pressed() {
  2150. emit_signal("page_changed", max_page);
  2151. }
  2152. void EditorPaginator::update(int p_page, int p_max_page) {
  2153. page = p_page;
  2154. max_page = p_max_page;
  2155. // Update buttons.
  2156. first_page_button->set_disabled(page == 0);
  2157. prev_page_button->set_disabled(page == 0);
  2158. next_page_button->set_disabled(page == max_page);
  2159. last_page_button->set_disabled(page == max_page);
  2160. // Update page number and page count.
  2161. page_line_edit->set_text(vformat("%d", page + 1));
  2162. page_count_label->set_text(vformat("/ %d", max_page + 1));
  2163. }
  2164. void EditorPaginator::_notification(int p_what) {
  2165. switch (p_what) {
  2166. case NOTIFICATION_ENTER_TREE:
  2167. case NOTIFICATION_THEME_CHANGED: {
  2168. first_page_button->set_button_icon(get_editor_theme_icon(SNAME("PageFirst")));
  2169. prev_page_button->set_button_icon(get_editor_theme_icon(SNAME("PagePrevious")));
  2170. next_page_button->set_button_icon(get_editor_theme_icon(SNAME("PageNext")));
  2171. last_page_button->set_button_icon(get_editor_theme_icon(SNAME("PageLast")));
  2172. } break;
  2173. }
  2174. }
  2175. void EditorPaginator::_bind_methods() {
  2176. ADD_SIGNAL(MethodInfo("page_changed", PropertyInfo(Variant::INT, "page")));
  2177. }
  2178. EditorPaginator::EditorPaginator() {
  2179. set_h_size_flags(SIZE_EXPAND_FILL);
  2180. set_alignment(ALIGNMENT_CENTER);
  2181. first_page_button = memnew(Button);
  2182. first_page_button->set_flat(true);
  2183. first_page_button->connect(SceneStringName(pressed), callable_mp(this, &EditorPaginator::_first_page_button_pressed));
  2184. add_child(first_page_button);
  2185. prev_page_button = memnew(Button);
  2186. prev_page_button->set_flat(true);
  2187. prev_page_button->connect(SceneStringName(pressed), callable_mp(this, &EditorPaginator::_prev_page_button_pressed));
  2188. add_child(prev_page_button);
  2189. page_line_edit = memnew(LineEdit);
  2190. page_line_edit->connect("text_submitted", callable_mp(this, &EditorPaginator::_page_line_edit_text_submitted));
  2191. page_line_edit->add_theme_constant_override("minimum_character_width", 2);
  2192. add_child(page_line_edit);
  2193. page_count_label = memnew(Label);
  2194. add_child(page_count_label);
  2195. next_page_button = memnew(Button);
  2196. next_page_button->set_flat(true);
  2197. next_page_button->connect(SceneStringName(pressed), callable_mp(this, &EditorPaginator::_next_page_button_pressed));
  2198. add_child(next_page_button);
  2199. last_page_button = memnew(Button);
  2200. last_page_button->set_flat(true);
  2201. last_page_button->connect(SceneStringName(pressed), callable_mp(this, &EditorPaginator::_last_page_button_pressed));
  2202. add_child(last_page_button);
  2203. }
  2204. ////////////////////////////////////////////////
  2205. ////////////////////////////////////////////////
  2206. Ref<EditorInspectorPlugin> EditorInspector::inspector_plugins[MAX_PLUGINS];
  2207. int EditorInspector::inspector_plugin_count = 0;
  2208. EditorProperty *EditorInspector::instantiate_property_editor(Object *p_object, const Variant::Type p_type, const String &p_path, PropertyHint p_hint, const String &p_hint_text, const uint32_t p_usage, const bool p_wide) {
  2209. for (int i = inspector_plugin_count - 1; i >= 0; i--) {
  2210. if (!inspector_plugins[i]->can_handle(p_object)) {
  2211. continue;
  2212. }
  2213. inspector_plugins[i]->parse_property(p_object, p_type, p_path, p_hint, p_hint_text, p_usage, p_wide);
  2214. if (inspector_plugins[i]->added_editors.size()) {
  2215. for (List<EditorInspectorPlugin::AddedEditor>::Element *E = inspector_plugins[i]->added_editors.front()->next(); E; E = E->next()) { //only keep first one
  2216. memdelete(E->get().property_editor);
  2217. }
  2218. EditorProperty *prop = Object::cast_to<EditorProperty>(inspector_plugins[i]->added_editors.front()->get().property_editor);
  2219. if (prop) {
  2220. inspector_plugins[i]->added_editors.clear();
  2221. return prop;
  2222. } else {
  2223. memdelete(inspector_plugins[i]->added_editors.front()->get().property_editor);
  2224. inspector_plugins[i]->added_editors.clear();
  2225. }
  2226. }
  2227. }
  2228. return nullptr;
  2229. }
  2230. void EditorInspector::add_inspector_plugin(const Ref<EditorInspectorPlugin> &p_plugin) {
  2231. ERR_FAIL_COND(inspector_plugin_count == MAX_PLUGINS);
  2232. for (int i = 0; i < inspector_plugin_count; i++) {
  2233. if (inspector_plugins[i] == p_plugin) {
  2234. return; //already exists
  2235. }
  2236. }
  2237. inspector_plugins[inspector_plugin_count++] = p_plugin;
  2238. }
  2239. void EditorInspector::remove_inspector_plugin(const Ref<EditorInspectorPlugin> &p_plugin) {
  2240. ERR_FAIL_COND(inspector_plugin_count == MAX_PLUGINS);
  2241. int idx = -1;
  2242. for (int i = 0; i < inspector_plugin_count; i++) {
  2243. if (inspector_plugins[i] == p_plugin) {
  2244. idx = i;
  2245. break;
  2246. }
  2247. }
  2248. ERR_FAIL_COND_MSG(idx == -1, "Trying to remove nonexistent inspector plugin.");
  2249. for (int i = idx; i < inspector_plugin_count - 1; i++) {
  2250. inspector_plugins[i] = inspector_plugins[i + 1];
  2251. }
  2252. inspector_plugins[inspector_plugin_count - 1] = Ref<EditorInspectorPlugin>();
  2253. inspector_plugin_count--;
  2254. }
  2255. void EditorInspector::cleanup_plugins() {
  2256. for (int i = 0; i < inspector_plugin_count; i++) {
  2257. inspector_plugins[i].unref();
  2258. }
  2259. inspector_plugin_count = 0;
  2260. }
  2261. Button *EditorInspector::create_inspector_action_button(const String &p_text) {
  2262. Button *button = memnew(Button);
  2263. button->set_text(p_text);
  2264. button->set_theme_type_variation(SNAME("InspectorActionButton"));
  2265. button->set_h_size_flags(SIZE_SHRINK_CENTER);
  2266. return button;
  2267. }
  2268. bool EditorInspector::is_main_editor_inspector() const {
  2269. return InspectorDock::get_singleton() && InspectorDock::get_inspector_singleton() == this;
  2270. }
  2271. String EditorInspector::get_selected_path() const {
  2272. return property_selected;
  2273. }
  2274. void EditorInspector::_parse_added_editors(VBoxContainer *current_vbox, EditorInspectorSection *p_section, Ref<EditorInspectorPlugin> ped) {
  2275. for (const EditorInspectorPlugin::AddedEditor &F : ped->added_editors) {
  2276. EditorProperty *ep = Object::cast_to<EditorProperty>(F.property_editor);
  2277. current_vbox->add_child(F.property_editor);
  2278. if (ep) {
  2279. ep->object = object;
  2280. ep->connect("property_changed", callable_mp(this, &EditorInspector::_property_changed).bind(false));
  2281. ep->connect("property_keyed", callable_mp(this, &EditorInspector::_property_keyed));
  2282. ep->connect("property_deleted", callable_mp(this, &EditorInspector::_property_deleted), CONNECT_DEFERRED);
  2283. ep->connect("property_keyed_with_value", callable_mp(this, &EditorInspector::_property_keyed_with_value));
  2284. ep->connect("property_checked", callable_mp(this, &EditorInspector::_property_checked));
  2285. ep->connect("property_pinned", callable_mp(this, &EditorInspector::_property_pinned));
  2286. ep->connect("selected", callable_mp(this, &EditorInspector::_property_selected));
  2287. ep->connect("multiple_properties_changed", callable_mp(this, &EditorInspector::_multiple_properties_changed));
  2288. ep->connect("resource_selected", callable_mp(this, &EditorInspector::_resource_selected), CONNECT_DEFERRED);
  2289. ep->connect("object_id_selected", callable_mp(this, &EditorInspector::_object_id_selected), CONNECT_DEFERRED);
  2290. if (F.properties.size()) {
  2291. if (F.properties.size() == 1) {
  2292. //since it's one, associate:
  2293. ep->property = F.properties[0];
  2294. ep->property_path = property_prefix + F.properties[0];
  2295. ep->property_usage = 0;
  2296. }
  2297. if (!F.label.is_empty()) {
  2298. ep->set_label(F.label);
  2299. }
  2300. for (int i = 0; i < F.properties.size(); i++) {
  2301. String prop = F.properties[i];
  2302. if (!editor_property_map.has(prop)) {
  2303. editor_property_map[prop] = List<EditorProperty *>();
  2304. }
  2305. editor_property_map[prop].push_back(ep);
  2306. }
  2307. }
  2308. Node *section_search = p_section;
  2309. while (section_search) {
  2310. EditorInspectorSection *section = Object::cast_to<EditorInspectorSection>(section_search);
  2311. if (section) {
  2312. ep->connect("property_can_revert_changed", callable_mp(section, &EditorInspectorSection::property_can_revert_changed));
  2313. }
  2314. section_search = section_search->get_parent();
  2315. if (Object::cast_to<EditorInspector>(section_search)) {
  2316. // Skip sub-resource inspectors.
  2317. break;
  2318. }
  2319. }
  2320. ep->set_read_only(read_only);
  2321. ep->update_property();
  2322. ep->_update_pin_flags();
  2323. ep->update_editor_property_status();
  2324. ep->set_deletable(deletable_properties);
  2325. ep->update_cache();
  2326. }
  2327. }
  2328. ped->added_editors.clear();
  2329. }
  2330. bool EditorInspector::_is_property_disabled_by_feature_profile(const StringName &p_property) {
  2331. Ref<EditorFeatureProfile> profile = EditorFeatureProfileManager::get_singleton()->get_current_profile();
  2332. if (profile.is_null()) {
  2333. return false;
  2334. }
  2335. StringName class_name = object->get_class();
  2336. while (class_name != StringName()) {
  2337. if (profile->is_class_property_disabled(class_name, p_property)) {
  2338. return true;
  2339. }
  2340. if (profile->is_class_disabled(class_name)) {
  2341. //won't see properties of a disabled class
  2342. return true;
  2343. }
  2344. class_name = ClassDB::get_parent_class(class_name);
  2345. }
  2346. return false;
  2347. }
  2348. void EditorInspector::update_tree() {
  2349. // Store currently selected and focused elements to restore after the update.
  2350. // TODO: Can be useful to store more context for the focusable, such as the caret position in LineEdit.
  2351. StringName current_selected = property_selected;
  2352. int current_focusable = -1;
  2353. // Temporarily disable focus following on the root inspector to avoid jumping while the inspector is updating.
  2354. get_root_inspector()->set_follow_focus(false);
  2355. if (property_focusable != -1) {
  2356. // Check that focusable is actually focusable.
  2357. bool restore_focus = false;
  2358. Control *focused = get_viewport() ? get_viewport()->gui_get_focus_owner() : nullptr;
  2359. if (focused) {
  2360. Node *parent = focused->get_parent();
  2361. while (parent) {
  2362. EditorInspector *inspector = Object::cast_to<EditorInspector>(parent);
  2363. if (inspector) {
  2364. restore_focus = inspector == this; // May be owned by another inspector.
  2365. break; // Exit after the first inspector is found, since there may be nested ones.
  2366. }
  2367. parent = parent->get_parent();
  2368. }
  2369. }
  2370. if (restore_focus) {
  2371. current_focusable = property_focusable;
  2372. }
  2373. }
  2374. // Only hide plugins if we are not editing any object.
  2375. // This should be handled outside of the update_tree call anyway (see EditorInspector::edit), but might as well keep it safe.
  2376. _clear(!object);
  2377. if (!object) {
  2378. get_root_inspector()->set_follow_focus(true);
  2379. return;
  2380. }
  2381. List<Ref<EditorInspectorPlugin>> valid_plugins;
  2382. for (int i = inspector_plugin_count - 1; i >= 0; i--) { //start by last, so lastly added can override newly added
  2383. if (!inspector_plugins[i]->can_handle(object)) {
  2384. continue;
  2385. }
  2386. valid_plugins.push_back(inspector_plugins[i]);
  2387. }
  2388. // Decide if properties should be drawn with the warning color (yellow),
  2389. // or if the whole object should be considered read-only.
  2390. bool draw_warning = false;
  2391. bool all_read_only = false;
  2392. if (is_inside_tree()) {
  2393. if (object->has_method("_is_read_only")) {
  2394. all_read_only = object->call("_is_read_only");
  2395. }
  2396. Node *nod = Object::cast_to<Node>(object);
  2397. Node *es = EditorNode::get_singleton()->get_edited_scene();
  2398. if (nod && es != nod && nod->get_owner() != es) {
  2399. // Draw in warning color edited nodes that are not in the currently edited scene,
  2400. // as changes may be lost in the future.
  2401. draw_warning = true;
  2402. } else {
  2403. if (!all_read_only) {
  2404. Resource *res = Object::cast_to<Resource>(object);
  2405. if (res) {
  2406. all_read_only = EditorNode::get_singleton()->is_resource_read_only(res);
  2407. }
  2408. }
  2409. }
  2410. }
  2411. String filter = search_box ? search_box->get_text() : "";
  2412. String group;
  2413. String group_base;
  2414. String subgroup;
  2415. String subgroup_base;
  2416. int section_depth = 0;
  2417. VBoxContainer *category_vbox = nullptr;
  2418. List<PropertyInfo> plist;
  2419. object->get_property_list(&plist, true);
  2420. HashMap<VBoxContainer *, HashMap<String, VBoxContainer *>> vbox_per_path;
  2421. HashMap<String, EditorInspectorArray *> editor_inspector_array_per_prefix;
  2422. Color sscolor = get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor));
  2423. // Get the lists of editors to add the beginning.
  2424. for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
  2425. ped->parse_begin(object);
  2426. _parse_added_editors(main_vbox, nullptr, ped);
  2427. }
  2428. StringName doc_name;
  2429. // Get the lists of editors for properties.
  2430. for (List<PropertyInfo>::Element *E_property = plist.front(); E_property; E_property = E_property->next()) {
  2431. PropertyInfo &p = E_property->get();
  2432. if (p.usage & PROPERTY_USAGE_SUBGROUP) {
  2433. // Setup a property sub-group.
  2434. subgroup = p.name;
  2435. Vector<String> hint_parts = p.hint_string.split(",");
  2436. subgroup_base = hint_parts[0];
  2437. if (hint_parts.size() > 1) {
  2438. section_depth = hint_parts[1].to_int();
  2439. } else {
  2440. section_depth = 0;
  2441. }
  2442. continue;
  2443. } else if (p.usage & PROPERTY_USAGE_GROUP) {
  2444. // Setup a property group.
  2445. group = p.name;
  2446. Vector<String> hint_parts = p.hint_string.split(",");
  2447. group_base = hint_parts[0];
  2448. if (hint_parts.size() > 1) {
  2449. section_depth = hint_parts[1].to_int();
  2450. } else {
  2451. section_depth = 0;
  2452. }
  2453. subgroup = "";
  2454. subgroup_base = "";
  2455. continue;
  2456. } else if (p.usage & PROPERTY_USAGE_CATEGORY) {
  2457. // Setup a property category.
  2458. group = "";
  2459. group_base = "";
  2460. subgroup = "";
  2461. subgroup_base = "";
  2462. section_depth = 0;
  2463. vbox_per_path.clear();
  2464. editor_inspector_array_per_prefix.clear();
  2465. // `hint_script` should contain a native class name or a script path.
  2466. // Otherwise the category was probably added via `@export_category` or `_get_property_list()`.
  2467. const bool is_custom_category = p.hint_string.is_empty();
  2468. // Iterate over remaining properties. If no properties in category, skip the category.
  2469. List<PropertyInfo>::Element *N = E_property->next();
  2470. bool valid = true;
  2471. while (N) {
  2472. if (!N->get().name.begins_with("metadata/_") && N->get().usage & PROPERTY_USAGE_EDITOR &&
  2473. (!filter.is_empty() || !restrict_to_basic || (N->get().usage & PROPERTY_USAGE_EDITOR_BASIC_SETTING))) {
  2474. break;
  2475. }
  2476. // Treat custom categories as second-level ones. Do not skip a normal category if it is followed by a custom one.
  2477. // Skip in the other 3 cases (normal -> normal, custom -> custom, custom -> normal).
  2478. if ((N->get().usage & PROPERTY_USAGE_CATEGORY) && (is_custom_category || !N->get().hint_string.is_empty())) {
  2479. valid = false;
  2480. break;
  2481. }
  2482. N = N->next();
  2483. }
  2484. if (!valid) {
  2485. continue; // Empty, ignore it.
  2486. }
  2487. String category_label;
  2488. String category_tooltip;
  2489. Ref<Texture> category_icon;
  2490. // Do not add an icon, do not change the current class (`doc_name`) for custom categories.
  2491. if (is_custom_category) {
  2492. category_label = p.name;
  2493. category_tooltip = p.name;
  2494. } else {
  2495. doc_name = p.name;
  2496. category_label = p.name;
  2497. // Use category's owner script to update some of its information.
  2498. if (!EditorNode::get_editor_data().is_type_recognized(p.name) && ResourceLoader::exists(p.hint_string)) {
  2499. Ref<Script> scr = ResourceLoader::load(p.hint_string, "Script");
  2500. if (scr.is_valid()) {
  2501. StringName script_name = EditorNode::get_editor_data().script_class_get_name(scr->get_path());
  2502. // Update the docs reference and the label based on the script.
  2503. Vector<DocData::ClassDoc> docs = scr->get_documentation();
  2504. if (!docs.is_empty()) {
  2505. // The documentation of a GDScript's main class is at the end of the array.
  2506. // Hacky because this isn't necessarily always guaranteed.
  2507. doc_name = docs[docs.size() - 1].name;
  2508. }
  2509. if (script_name != StringName()) {
  2510. category_label = script_name;
  2511. }
  2512. // Find the icon corresponding to the script.
  2513. if (script_name != StringName()) {
  2514. category_icon = EditorNode::get_singleton()->get_class_icon(script_name);
  2515. } else {
  2516. category_icon = EditorNode::get_singleton()->get_object_icon(scr.ptr(), "Object");
  2517. }
  2518. }
  2519. }
  2520. if (category_icon.is_null() && !p.name.is_empty()) {
  2521. category_icon = EditorNode::get_singleton()->get_class_icon(p.name);
  2522. }
  2523. if (use_doc_hints) {
  2524. // `|` separators used in `EditorHelpBit`.
  2525. category_tooltip = "class|" + doc_name + "|";
  2526. }
  2527. }
  2528. if ((is_custom_category && !show_custom_categories) || (!is_custom_category && !show_standard_categories)) {
  2529. continue;
  2530. }
  2531. // Hide the "MultiNodeEdit" category for MultiNodeEdit.
  2532. if (Object::cast_to<MultiNodeEdit>(object) && p.name == "MultiNodeEdit") {
  2533. continue;
  2534. }
  2535. // Create an EditorInspectorCategory and add it to the inspector.
  2536. EditorInspectorCategory *category = memnew(EditorInspectorCategory);
  2537. main_vbox->add_child(category);
  2538. category_vbox = nullptr; // Reset.
  2539. // Set the category info.
  2540. category->label = category_label;
  2541. category->set_tooltip_text(category_tooltip);
  2542. category->icon = category_icon;
  2543. if (!is_custom_category) {
  2544. category->doc_class_name = doc_name;
  2545. }
  2546. // Add editors at the start of a category.
  2547. for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
  2548. ped->parse_category(object, p.name);
  2549. _parse_added_editors(main_vbox, nullptr, ped);
  2550. }
  2551. continue;
  2552. } else if (p.name.begins_with("metadata/_") || !(p.usage & PROPERTY_USAGE_EDITOR) || _is_property_disabled_by_feature_profile(p.name) ||
  2553. (filter.is_empty() && restrict_to_basic && !(p.usage & PROPERTY_USAGE_EDITOR_BASIC_SETTING))) {
  2554. // Ignore properties that are not supposed to be in the inspector.
  2555. continue;
  2556. }
  2557. if (p.name == "script") {
  2558. // Script should go into its own category.
  2559. category_vbox = nullptr;
  2560. }
  2561. if (p.usage & PROPERTY_USAGE_HIGH_END_GFX && RS::get_singleton()->is_low_end()) {
  2562. // Do not show this property in low end gfx.
  2563. continue;
  2564. }
  2565. if (p.name == "script" && (hide_script || bool(object->call("_hide_script_from_inspector")))) {
  2566. // Hide script variables from inspector if required.
  2567. continue;
  2568. }
  2569. if (p.name.begins_with("metadata/") && bool(object->call("_hide_metadata_from_inspector"))) {
  2570. // Hide metadata from inspector if required.
  2571. continue;
  2572. }
  2573. // Get the path for property.
  2574. String path = p.name;
  2575. // First check if we have an array that fits the prefix.
  2576. String array_prefix = "";
  2577. int array_index = -1;
  2578. for (KeyValue<String, EditorInspectorArray *> &E : editor_inspector_array_per_prefix) {
  2579. if (p.name.begins_with(E.key) && E.key.length() > array_prefix.length()) {
  2580. array_prefix = E.key;
  2581. }
  2582. }
  2583. if (!array_prefix.is_empty()) {
  2584. // If we have an array element, find the according index in array.
  2585. String str = p.name.trim_prefix(array_prefix);
  2586. int to_char_index = 0;
  2587. while (to_char_index < str.length()) {
  2588. if (!is_digit(str[to_char_index])) {
  2589. break;
  2590. }
  2591. to_char_index++;
  2592. }
  2593. if (to_char_index > 0) {
  2594. array_index = str.left(to_char_index).to_int();
  2595. } else {
  2596. array_prefix = "";
  2597. }
  2598. }
  2599. if (!array_prefix.is_empty()) {
  2600. path = path.trim_prefix(array_prefix);
  2601. int char_index = path.find("/");
  2602. if (char_index >= 0) {
  2603. path = path.right(-char_index - 1);
  2604. } else {
  2605. path = vformat(TTR("Element %s"), array_index);
  2606. }
  2607. } else {
  2608. // Check if we exit or not a subgroup. If there is a prefix, remove it from the property label string.
  2609. if (!subgroup.is_empty() && !subgroup_base.is_empty()) {
  2610. if (path.begins_with(subgroup_base)) {
  2611. path = path.trim_prefix(subgroup_base);
  2612. } else if (subgroup_base.begins_with(path)) {
  2613. // Keep it, this is used pretty often.
  2614. } else {
  2615. subgroup = ""; // The prefix changed, we are no longer in the subgroup.
  2616. }
  2617. }
  2618. // Check if we exit or not a group. If there is a prefix, remove it from the property label string.
  2619. if (!group.is_empty() && !group_base.is_empty() && subgroup.is_empty()) {
  2620. if (path.begins_with(group_base)) {
  2621. path = path.trim_prefix(group_base);
  2622. } else if (group_base.begins_with(path)) {
  2623. // Keep it, this is used pretty often.
  2624. } else {
  2625. group = ""; // The prefix changed, we are no longer in the group.
  2626. subgroup = "";
  2627. }
  2628. }
  2629. // Add the group and subgroup to the path.
  2630. if (!subgroup.is_empty()) {
  2631. path = subgroup + "/" + path;
  2632. }
  2633. if (!group.is_empty()) {
  2634. path = group + "/" + path;
  2635. }
  2636. }
  2637. // Get the property label's string.
  2638. String name_override = (path.contains("/")) ? path.substr(path.rfind("/") + 1) : path;
  2639. String feature_tag;
  2640. {
  2641. const int dot = name_override.find(".");
  2642. if (dot != -1) {
  2643. feature_tag = name_override.substr(dot);
  2644. name_override = name_override.substr(0, dot);
  2645. }
  2646. }
  2647. // Don't localize script variables.
  2648. EditorPropertyNameProcessor::Style name_style = property_name_style;
  2649. if ((p.usage & PROPERTY_USAGE_SCRIPT_VARIABLE) && name_style == EditorPropertyNameProcessor::STYLE_LOCALIZED) {
  2650. name_style = EditorPropertyNameProcessor::STYLE_CAPITALIZED;
  2651. }
  2652. const String property_label_string = EditorPropertyNameProcessor::get_singleton()->process_name(name_override, name_style, p.name, doc_name) + feature_tag;
  2653. // Remove the property from the path.
  2654. int idx = path.rfind("/");
  2655. if (idx > -1) {
  2656. path = path.left(idx);
  2657. } else {
  2658. path = "";
  2659. }
  2660. // Ignore properties that do not fit the filter.
  2661. if (use_filter && !filter.is_empty()) {
  2662. const String property_path = property_prefix + (path.is_empty() ? "" : path + "/") + name_override;
  2663. if (!_property_path_matches(property_path, filter, property_name_style)) {
  2664. continue;
  2665. }
  2666. }
  2667. // Recreate the category vbox if it was reset.
  2668. if (category_vbox == nullptr) {
  2669. category_vbox = memnew(VBoxContainer);
  2670. category_vbox->hide();
  2671. main_vbox->add_child(category_vbox);
  2672. }
  2673. // Find the correct section/vbox to add the property editor to.
  2674. VBoxContainer *root_vbox = array_prefix.is_empty() ? main_vbox : editor_inspector_array_per_prefix[array_prefix]->get_vbox(array_index);
  2675. if (!root_vbox) {
  2676. continue;
  2677. }
  2678. if (!vbox_per_path.has(root_vbox)) {
  2679. vbox_per_path[root_vbox] = HashMap<String, VBoxContainer *>();
  2680. vbox_per_path[root_vbox][""] = root_vbox;
  2681. }
  2682. VBoxContainer *current_vbox = root_vbox;
  2683. String acc_path = "";
  2684. int level = 1;
  2685. Vector<String> components = path.split("/");
  2686. for (int i = 0; i < components.size(); i++) {
  2687. const String &component = components[i];
  2688. acc_path += (i > 0) ? "/" + component : component;
  2689. if (!vbox_per_path[root_vbox].has(acc_path)) {
  2690. // If the section does not exists, create it.
  2691. EditorInspectorSection *section = memnew(EditorInspectorSection);
  2692. current_vbox->add_child(section);
  2693. sections.push_back(section);
  2694. String label;
  2695. String tooltip;
  2696. // Don't localize groups for script variables.
  2697. EditorPropertyNameProcessor::Style section_name_style = property_name_style;
  2698. if ((p.usage & PROPERTY_USAGE_SCRIPT_VARIABLE) && section_name_style == EditorPropertyNameProcessor::STYLE_LOCALIZED) {
  2699. section_name_style = EditorPropertyNameProcessor::STYLE_CAPITALIZED;
  2700. }
  2701. // Only process group label if this is not the group or subgroup.
  2702. if ((i == 0 && component == group) || (i == 1 && component == subgroup)) {
  2703. if (section_name_style == EditorPropertyNameProcessor::STYLE_LOCALIZED) {
  2704. label = EditorPropertyNameProcessor::get_singleton()->translate_group_name(component);
  2705. tooltip = component;
  2706. } else {
  2707. label = component;
  2708. tooltip = EditorPropertyNameProcessor::get_singleton()->translate_group_name(component);
  2709. }
  2710. } else {
  2711. label = EditorPropertyNameProcessor::get_singleton()->process_name(component, section_name_style, p.name, doc_name);
  2712. tooltip = EditorPropertyNameProcessor::get_singleton()->process_name(component, EditorPropertyNameProcessor::get_tooltip_style(section_name_style), p.name, doc_name);
  2713. }
  2714. Color c = sscolor;
  2715. c.a /= level;
  2716. section->setup(acc_path, label, object, c, use_folding, section_depth, level);
  2717. section->set_tooltip_text(tooltip);
  2718. // Add editors at the start of a group.
  2719. for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
  2720. ped->parse_group(object, path);
  2721. _parse_added_editors(section->get_vbox(), section, ped);
  2722. }
  2723. vbox_per_path[root_vbox][acc_path] = section->get_vbox();
  2724. }
  2725. current_vbox = vbox_per_path[root_vbox][acc_path];
  2726. level = (MIN(level + 1, 4));
  2727. }
  2728. // If we did not find a section to add the property to, add it to the category vbox instead (the category vbox handles margins correctly).
  2729. if (current_vbox == main_vbox) {
  2730. category_vbox->show();
  2731. current_vbox = category_vbox;
  2732. }
  2733. // Check if the property is an array counter, if so create a dedicated array editor for the array.
  2734. if (p.usage & PROPERTY_USAGE_ARRAY) {
  2735. EditorInspectorArray *editor_inspector_array = nullptr;
  2736. StringName array_element_prefix;
  2737. Color c = sscolor;
  2738. c.a /= level;
  2739. Vector<String> class_name_components = String(p.class_name).split(",");
  2740. int page_size = 5;
  2741. bool movable = true;
  2742. bool numbered = false;
  2743. bool foldable = use_folding;
  2744. String add_button_text = TTR("Add Element");
  2745. String swap_method;
  2746. for (int i = (p.type == Variant::NIL ? 1 : 2); i < class_name_components.size(); i++) {
  2747. if (class_name_components[i].begins_with("page_size") && class_name_components[i].get_slice_count("=") == 2) {
  2748. page_size = class_name_components[i].get_slice("=", 1).to_int();
  2749. } else if (class_name_components[i].begins_with("add_button_text") && class_name_components[i].get_slice_count("=") == 2) {
  2750. add_button_text = class_name_components[i].get_slice("=", 1).strip_edges();
  2751. } else if (class_name_components[i] == "static") {
  2752. movable = false;
  2753. } else if (class_name_components[i] == "numbered") {
  2754. numbered = true;
  2755. } else if (class_name_components[i] == "unfoldable") {
  2756. foldable = false;
  2757. } else if (class_name_components[i].begins_with("swap_method") && class_name_components[i].get_slice_count("=") == 2) {
  2758. swap_method = class_name_components[i].get_slice("=", 1).strip_edges();
  2759. }
  2760. }
  2761. if (p.type == Variant::NIL) {
  2762. // Setup the array to use a method to create/move/delete elements.
  2763. array_element_prefix = class_name_components[0];
  2764. editor_inspector_array = memnew(EditorInspectorArray(all_read_only));
  2765. String array_label = path.contains("/") ? path.substr(path.rfind("/") + 1) : path;
  2766. array_label = EditorPropertyNameProcessor::get_singleton()->process_name(property_label_string, property_name_style, p.name, doc_name);
  2767. int page = per_array_page.has(array_element_prefix) ? per_array_page[array_element_prefix] : 0;
  2768. editor_inspector_array->setup_with_move_element_function(object, array_label, array_element_prefix, page, c, use_folding);
  2769. editor_inspector_array->connect("page_change_request", callable_mp(this, &EditorInspector::_page_change_request).bind(array_element_prefix));
  2770. } else if (p.type == Variant::INT) {
  2771. // Setup the array to use the count property and built-in functions to create/move/delete elements.
  2772. if (class_name_components.size() >= 2) {
  2773. array_element_prefix = class_name_components[1];
  2774. editor_inspector_array = memnew(EditorInspectorArray(all_read_only));
  2775. int page = per_array_page.has(array_element_prefix) ? per_array_page[array_element_prefix] : 0;
  2776. editor_inspector_array->setup_with_count_property(object, class_name_components[0], p.name, array_element_prefix, page, c, foldable, movable, numbered, page_size, add_button_text, swap_method);
  2777. editor_inspector_array->connect("page_change_request", callable_mp(this, &EditorInspector::_page_change_request).bind(array_element_prefix));
  2778. }
  2779. }
  2780. if (editor_inspector_array) {
  2781. current_vbox->add_child(editor_inspector_array);
  2782. editor_inspector_array_per_prefix[array_element_prefix] = editor_inspector_array;
  2783. }
  2784. continue;
  2785. }
  2786. // Checkable and checked properties.
  2787. bool checkable = false;
  2788. bool checked = false;
  2789. if (p.usage & PROPERTY_USAGE_CHECKABLE) {
  2790. checkable = true;
  2791. checked = p.usage & PROPERTY_USAGE_CHECKED;
  2792. }
  2793. bool property_read_only = (p.usage & PROPERTY_USAGE_READ_ONLY) || read_only;
  2794. // Mark properties that would require an editor restart (mostly when editing editor settings).
  2795. if (p.usage & PROPERTY_USAGE_RESTART_IF_CHANGED) {
  2796. restart_request_props.insert(p.name);
  2797. }
  2798. String doc_path;
  2799. String theme_item_name;
  2800. StringName classname = doc_name;
  2801. // Build the doc hint, to use as tooltip.
  2802. if (use_doc_hints) {
  2803. if (!object_class.is_empty()) {
  2804. classname = object_class;
  2805. } else if (Object::cast_to<MultiNodeEdit>(object)) {
  2806. classname = Object::cast_to<MultiNodeEdit>(object)->get_edited_class_name();
  2807. } else if (classname == "") {
  2808. classname = object->get_class_name();
  2809. Resource *res = Object::cast_to<Resource>(object);
  2810. if (res && !res->get_script().is_null()) {
  2811. // Grab the script of this resource to get the evaluated script class.
  2812. Ref<Script> scr = res->get_script();
  2813. if (scr.is_valid()) {
  2814. Vector<DocData::ClassDoc> docs = scr->get_documentation();
  2815. if (!docs.is_empty()) {
  2816. // The documentation of a GDScript's main class is at the end of the array.
  2817. // Hacky because this isn't necessarily always guaranteed.
  2818. classname = docs[docs.size() - 1].name;
  2819. }
  2820. }
  2821. }
  2822. }
  2823. StringName propname = property_prefix + p.name;
  2824. bool found = false;
  2825. // Small hack for theme_overrides. They are listed under Control, but come from another class.
  2826. if (classname == "Control" && p.name.begins_with("theme_override_")) {
  2827. classname = get_edited_object()->get_class();
  2828. }
  2829. // Search for the doc path in the cache.
  2830. HashMap<StringName, HashMap<StringName, DocCacheInfo>>::Iterator E = doc_cache.find(classname);
  2831. if (E) {
  2832. HashMap<StringName, DocCacheInfo>::Iterator F = E->value.find(propname);
  2833. if (F) {
  2834. found = true;
  2835. doc_path = F->value.doc_path;
  2836. theme_item_name = F->value.theme_item_name;
  2837. }
  2838. }
  2839. if (!found) {
  2840. DocTools *dd = EditorHelp::get_doc_data();
  2841. // Do not cache the doc path information of scripts.
  2842. bool is_native_class = ClassDB::class_exists(classname);
  2843. HashMap<String, DocData::ClassDoc>::ConstIterator F = dd->class_list.find(classname);
  2844. while (F) {
  2845. Vector<String> slices = propname.operator String().split("/");
  2846. // Check if it's a theme item first.
  2847. if (slices.size() == 2 && slices[0].begins_with("theme_override_")) {
  2848. for (int i = 0; i < F->value.theme_properties.size(); i++) {
  2849. String doc_path_current = "class_theme_item:" + F->value.name + ":" + F->value.theme_properties[i].name;
  2850. if (F->value.theme_properties[i].name == slices[1]) {
  2851. doc_path = doc_path_current;
  2852. theme_item_name = F->value.theme_properties[i].name;
  2853. }
  2854. }
  2855. } else {
  2856. for (int i = 0; i < F->value.properties.size(); i++) {
  2857. String doc_path_current = "class_property:" + F->value.name + ":" + F->value.properties[i].name;
  2858. if (F->value.properties[i].name == propname.operator String()) {
  2859. doc_path = doc_path_current;
  2860. }
  2861. }
  2862. }
  2863. if (is_native_class) {
  2864. DocCacheInfo cache_info;
  2865. cache_info.doc_path = doc_path;
  2866. cache_info.theme_item_name = theme_item_name;
  2867. doc_cache[classname][propname] = cache_info;
  2868. }
  2869. if (!doc_path.is_empty() || F->value.inherits.is_empty()) {
  2870. break;
  2871. }
  2872. // Couldn't find the doc path in the class itself, try its super class.
  2873. F = dd->class_list.find(F->value.inherits);
  2874. }
  2875. }
  2876. }
  2877. Vector<EditorInspectorPlugin::AddedEditor> editors;
  2878. Vector<EditorInspectorPlugin::AddedEditor> late_editors;
  2879. // Search for the inspector plugin that will handle the properties. Then add the correct property editor to it.
  2880. for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
  2881. bool exclusive = ped->parse_property(object, p.type, p.name, p.hint, p.hint_string, p.usage, wide_editors);
  2882. for (const EditorInspectorPlugin::AddedEditor &F : ped->added_editors) {
  2883. if (F.add_to_end) {
  2884. late_editors.push_back(F);
  2885. } else {
  2886. editors.push_back(F);
  2887. }
  2888. }
  2889. ped->added_editors.clear();
  2890. if (exclusive) {
  2891. break;
  2892. }
  2893. }
  2894. editors.append_array(late_editors);
  2895. for (int i = 0; i < editors.size(); i++) {
  2896. EditorProperty *ep = Object::cast_to<EditorProperty>(editors[i].property_editor);
  2897. const Vector<String> &properties = editors[i].properties;
  2898. if (ep) {
  2899. // Set all this before the control gets the ENTER_TREE notification.
  2900. ep->object = object;
  2901. if (properties.size()) {
  2902. if (properties.size() == 1) {
  2903. // Since it's one, associate:
  2904. ep->property = properties[0];
  2905. ep->property_path = property_prefix + properties[0];
  2906. ep->property_usage = p.usage;
  2907. // And set label?
  2908. }
  2909. if (!editors[i].label.is_empty()) {
  2910. ep->set_label(editors[i].label);
  2911. } else {
  2912. // Use the existing one.
  2913. ep->set_label(property_label_string);
  2914. }
  2915. for (int j = 0; j < properties.size(); j++) {
  2916. String prop = properties[j];
  2917. if (!editor_property_map.has(prop)) {
  2918. editor_property_map[prop] = List<EditorProperty *>();
  2919. }
  2920. editor_property_map[prop].push_back(ep);
  2921. }
  2922. }
  2923. Node *section_search = current_vbox->get_parent();
  2924. while (section_search) {
  2925. EditorInspectorSection *section = Object::cast_to<EditorInspectorSection>(section_search);
  2926. if (section) {
  2927. ep->connect("property_can_revert_changed", callable_mp(section, &EditorInspectorSection::property_can_revert_changed));
  2928. }
  2929. section_search = section_search->get_parent();
  2930. if (Object::cast_to<EditorInspector>(section_search)) {
  2931. // Skip sub-resource inspectors.
  2932. break;
  2933. }
  2934. }
  2935. ep->set_draw_warning(draw_warning);
  2936. ep->set_use_folding(use_folding);
  2937. ep->set_checkable(checkable);
  2938. ep->set_checked(checked);
  2939. ep->set_keying(keying);
  2940. ep->set_read_only(property_read_only || all_read_only);
  2941. ep->set_deletable(deletable_properties || p.name.begins_with("metadata/"));
  2942. }
  2943. current_vbox->add_child(editors[i].property_editor);
  2944. if (ep) {
  2945. // Eventually, set other properties/signals after the property editor got added to the tree.
  2946. bool update_all = (p.usage & PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED);
  2947. ep->connect("property_changed", callable_mp(this, &EditorInspector::_property_changed).bind(update_all));
  2948. ep->connect("property_keyed", callable_mp(this, &EditorInspector::_property_keyed));
  2949. ep->connect("property_deleted", callable_mp(this, &EditorInspector::_property_deleted), CONNECT_DEFERRED);
  2950. ep->connect("property_keyed_with_value", callable_mp(this, &EditorInspector::_property_keyed_with_value));
  2951. ep->connect("property_checked", callable_mp(this, &EditorInspector::_property_checked));
  2952. ep->connect("property_pinned", callable_mp(this, &EditorInspector::_property_pinned));
  2953. ep->connect("selected", callable_mp(this, &EditorInspector::_property_selected));
  2954. ep->connect("multiple_properties_changed", callable_mp(this, &EditorInspector::_multiple_properties_changed));
  2955. ep->connect("resource_selected", callable_mp(this, &EditorInspector::_resource_selected), CONNECT_DEFERRED);
  2956. ep->connect("object_id_selected", callable_mp(this, &EditorInspector::_object_id_selected), CONNECT_DEFERRED);
  2957. if (use_doc_hints) {
  2958. // `|` separators used in `EditorHelpBit`.
  2959. if (theme_item_name.is_empty()) {
  2960. if (p.name.contains("shader_parameter/")) {
  2961. ShaderMaterial *shader_material = Object::cast_to<ShaderMaterial>(object);
  2962. if (shader_material) {
  2963. ep->set_tooltip_text("property|" + shader_material->get_shader()->get_path() + "|" + property_prefix + p.name);
  2964. }
  2965. } else if (p.usage & PROPERTY_USAGE_INTERNAL) {
  2966. ep->set_tooltip_text("internal_property|" + classname + "|" + property_prefix + p.name);
  2967. } else {
  2968. ep->set_tooltip_text("property|" + classname + "|" + property_prefix + p.name);
  2969. }
  2970. } else {
  2971. ep->set_tooltip_text("theme_item|" + classname + "|" + theme_item_name);
  2972. }
  2973. ep->has_doc_tooltip = true;
  2974. }
  2975. ep->set_doc_path(doc_path);
  2976. ep->set_internal(p.usage & PROPERTY_USAGE_INTERNAL);
  2977. ep->update_property();
  2978. ep->_update_pin_flags();
  2979. ep->update_editor_property_status();
  2980. ep->update_cache();
  2981. if (current_selected && ep->property == current_selected) {
  2982. ep->select(current_focusable);
  2983. }
  2984. }
  2985. }
  2986. }
  2987. if (!hide_metadata && !object->call("_hide_metadata_from_inspector")) {
  2988. // Add 4px of spacing between the "Add Metadata" button and the content above it.
  2989. Control *spacer = memnew(Control);
  2990. spacer->set_custom_minimum_size(Size2(0, 4) * EDSCALE);
  2991. main_vbox->add_child(spacer);
  2992. Button *add_md = EditorInspector::create_inspector_action_button(TTR("Add Metadata"));
  2993. add_md->set_button_icon(get_editor_theme_icon(SNAME("Add")));
  2994. add_md->connect(SceneStringName(pressed), callable_mp(this, &EditorInspector::_show_add_meta_dialog));
  2995. main_vbox->add_child(add_md);
  2996. if (all_read_only) {
  2997. add_md->set_disabled(true);
  2998. }
  2999. }
  3000. // Get the lists of to add at the end.
  3001. for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
  3002. ped->parse_end(object);
  3003. _parse_added_editors(main_vbox, nullptr, ped);
  3004. }
  3005. if (is_main_editor_inspector()) {
  3006. // Updating inspector might invalidate some editing owners.
  3007. EditorNode::get_singleton()->hide_unused_editors();
  3008. }
  3009. get_root_inspector()->set_follow_focus(true);
  3010. }
  3011. void EditorInspector::update_property(const String &p_prop) {
  3012. if (!editor_property_map.has(p_prop)) {
  3013. return;
  3014. }
  3015. for (EditorProperty *E : editor_property_map[p_prop]) {
  3016. E->update_property();
  3017. E->update_editor_property_status();
  3018. E->update_cache();
  3019. }
  3020. }
  3021. void EditorInspector::_clear(bool p_hide_plugins) {
  3022. while (main_vbox->get_child_count()) {
  3023. memdelete(main_vbox->get_child(0));
  3024. }
  3025. property_selected = StringName();
  3026. property_focusable = -1;
  3027. editor_property_map.clear();
  3028. sections.clear();
  3029. pending.clear();
  3030. restart_request_props.clear();
  3031. if (p_hide_plugins && is_main_editor_inspector()) {
  3032. EditorNode::get_singleton()->hide_unused_editors(this);
  3033. }
  3034. }
  3035. Object *EditorInspector::get_edited_object() {
  3036. return object;
  3037. }
  3038. Object *EditorInspector::get_next_edited_object() {
  3039. return next_object;
  3040. }
  3041. void EditorInspector::edit(Object *p_object) {
  3042. if (object == p_object) {
  3043. return;
  3044. }
  3045. next_object = p_object; // Some plugins need to know the next edited object when clearing the inspector.
  3046. if (object) {
  3047. if (likely(Variant(object).get_validated_object())) {
  3048. object->disconnect(CoreStringName(property_list_changed), callable_mp(this, &EditorInspector::_changed_callback));
  3049. }
  3050. _clear();
  3051. }
  3052. per_array_page.clear();
  3053. object = p_object;
  3054. if (object) {
  3055. update_scroll_request = 0; //reset
  3056. if (scroll_cache.has(object->get_instance_id())) { //if exists, set something else
  3057. update_scroll_request = scroll_cache[object->get_instance_id()]; //done this way because wait until full size is accommodated
  3058. }
  3059. object->connect(CoreStringName(property_list_changed), callable_mp(this, &EditorInspector::_changed_callback));
  3060. update_tree();
  3061. }
  3062. // Keep it available until the end so it works with both main and sub inspectors.
  3063. next_object = nullptr;
  3064. emit_signal(SNAME("edited_object_changed"));
  3065. }
  3066. void EditorInspector::set_keying(bool p_active) {
  3067. if (keying == p_active) {
  3068. return;
  3069. }
  3070. keying = p_active;
  3071. _keying_changed();
  3072. }
  3073. void EditorInspector::_keying_changed() {
  3074. for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
  3075. for (EditorProperty *E : F.value) {
  3076. if (E) {
  3077. E->set_keying(keying);
  3078. }
  3079. }
  3080. }
  3081. }
  3082. void EditorInspector::set_read_only(bool p_read_only) {
  3083. if (p_read_only == read_only) {
  3084. return;
  3085. }
  3086. read_only = p_read_only;
  3087. update_tree();
  3088. }
  3089. EditorPropertyNameProcessor::Style EditorInspector::get_property_name_style() const {
  3090. return property_name_style;
  3091. }
  3092. void EditorInspector::set_property_name_style(EditorPropertyNameProcessor::Style p_style) {
  3093. if (property_name_style == p_style) {
  3094. return;
  3095. }
  3096. property_name_style = p_style;
  3097. update_tree();
  3098. }
  3099. void EditorInspector::set_use_settings_name_style(bool p_enable) {
  3100. if (use_settings_name_style == p_enable) {
  3101. return;
  3102. }
  3103. use_settings_name_style = p_enable;
  3104. if (use_settings_name_style) {
  3105. set_property_name_style(EditorPropertyNameProcessor::get_singleton()->get_settings_style());
  3106. }
  3107. }
  3108. void EditorInspector::set_autoclear(bool p_enable) {
  3109. autoclear = p_enable;
  3110. }
  3111. void EditorInspector::set_show_categories(bool p_show_standard, bool p_show_custom) {
  3112. show_standard_categories = p_show_standard;
  3113. show_custom_categories = p_show_custom;
  3114. update_tree();
  3115. }
  3116. void EditorInspector::set_use_doc_hints(bool p_enable) {
  3117. use_doc_hints = p_enable;
  3118. update_tree();
  3119. }
  3120. void EditorInspector::set_hide_script(bool p_hide) {
  3121. hide_script = p_hide;
  3122. update_tree();
  3123. }
  3124. void EditorInspector::set_hide_metadata(bool p_hide) {
  3125. hide_metadata = p_hide;
  3126. update_tree();
  3127. }
  3128. void EditorInspector::set_use_filter(bool p_use) {
  3129. use_filter = p_use;
  3130. update_tree();
  3131. }
  3132. void EditorInspector::register_text_enter(Node *p_line_edit) {
  3133. search_box = Object::cast_to<LineEdit>(p_line_edit);
  3134. if (search_box) {
  3135. search_box->connect(SceneStringName(text_changed), callable_mp(this, &EditorInspector::_filter_changed));
  3136. }
  3137. }
  3138. void EditorInspector::_filter_changed(const String &p_text) {
  3139. update_tree();
  3140. }
  3141. void EditorInspector::set_use_folding(bool p_use_folding, bool p_update_tree) {
  3142. use_folding = p_use_folding;
  3143. if (p_update_tree) {
  3144. update_tree();
  3145. }
  3146. }
  3147. bool EditorInspector::is_using_folding() {
  3148. return use_folding;
  3149. }
  3150. void EditorInspector::collapse_all_folding() {
  3151. for (EditorInspectorSection *E : sections) {
  3152. E->fold();
  3153. }
  3154. for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
  3155. for (EditorProperty *E : F.value) {
  3156. E->collapse_all_folding();
  3157. }
  3158. }
  3159. }
  3160. void EditorInspector::expand_all_folding() {
  3161. for (EditorInspectorSection *E : sections) {
  3162. E->unfold();
  3163. }
  3164. for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
  3165. for (EditorProperty *E : F.value) {
  3166. E->expand_all_folding();
  3167. }
  3168. }
  3169. }
  3170. void EditorInspector::expand_revertable() {
  3171. HashSet<EditorInspectorSection *> sections_to_unfold[2];
  3172. for (EditorInspectorSection *E : sections) {
  3173. if (E->has_revertable_properties()) {
  3174. sections_to_unfold[0].insert(E);
  3175. }
  3176. }
  3177. // Climb up the hierarchy doing double buffering with the sets.
  3178. int a = 0;
  3179. int b = 1;
  3180. while (sections_to_unfold[a].size()) {
  3181. for (EditorInspectorSection *E : sections_to_unfold[a]) {
  3182. E->unfold();
  3183. Node *n = E->get_parent();
  3184. while (n) {
  3185. if (Object::cast_to<EditorInspector>(n)) {
  3186. break;
  3187. }
  3188. if (Object::cast_to<EditorInspectorSection>(n) && !sections_to_unfold[a].has((EditorInspectorSection *)n)) {
  3189. sections_to_unfold[b].insert((EditorInspectorSection *)n);
  3190. }
  3191. n = n->get_parent();
  3192. }
  3193. }
  3194. sections_to_unfold[a].clear();
  3195. SWAP(a, b);
  3196. }
  3197. for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
  3198. for (EditorProperty *E : F.value) {
  3199. E->expand_revertable();
  3200. }
  3201. }
  3202. }
  3203. void EditorInspector::set_scroll_offset(int p_offset) {
  3204. set_v_scroll(p_offset);
  3205. }
  3206. int EditorInspector::get_scroll_offset() const {
  3207. return get_v_scroll();
  3208. }
  3209. void EditorInspector::set_use_wide_editors(bool p_enable) {
  3210. wide_editors = p_enable;
  3211. }
  3212. void EditorInspector::set_root_inspector(EditorInspector *p_root_inspector) {
  3213. root_inspector = p_root_inspector;
  3214. // Only the root inspector should follow focus.
  3215. set_follow_focus(false);
  3216. }
  3217. void EditorInspector::set_use_deletable_properties(bool p_enabled) {
  3218. deletable_properties = p_enabled;
  3219. }
  3220. void EditorInspector::_page_change_request(int p_new_page, const StringName &p_array_prefix) {
  3221. int prev_page = per_array_page.has(p_array_prefix) ? per_array_page[p_array_prefix] : 0;
  3222. int new_page = MAX(0, p_new_page);
  3223. if (new_page != prev_page) {
  3224. per_array_page[p_array_prefix] = new_page;
  3225. update_tree_pending = true;
  3226. }
  3227. }
  3228. void EditorInspector::_edit_request_change(Object *p_object, const String &p_property) {
  3229. if (object != p_object) { //may be undoing/redoing for a non edited object, so ignore
  3230. return;
  3231. }
  3232. if (changing) {
  3233. return;
  3234. }
  3235. if (p_property.is_empty()) {
  3236. update_tree_pending = true;
  3237. } else {
  3238. pending.insert(p_property);
  3239. }
  3240. }
  3241. void EditorInspector::_edit_set(const String &p_name, const Variant &p_value, bool p_refresh_all, const String &p_changed_field) {
  3242. if (autoclear && editor_property_map.has(p_name)) {
  3243. for (EditorProperty *E : editor_property_map[p_name]) {
  3244. if (E->is_checkable()) {
  3245. E->set_checked(true);
  3246. }
  3247. }
  3248. }
  3249. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  3250. if (bool(object->call("_dont_undo_redo"))) {
  3251. object->set(p_name, p_value);
  3252. if (p_refresh_all) {
  3253. _edit_request_change(object, "");
  3254. } else {
  3255. _edit_request_change(object, p_name);
  3256. }
  3257. emit_signal(_prop_edited, p_name);
  3258. } else if (Object::cast_to<MultiNodeEdit>(object)) {
  3259. Object::cast_to<MultiNodeEdit>(object)->set_property_field(p_name, p_value, p_changed_field);
  3260. _edit_request_change(object, p_name);
  3261. emit_signal(_prop_edited, p_name);
  3262. } else {
  3263. undo_redo->create_action(vformat(TTR("Set %s"), p_name), UndoRedo::MERGE_ENDS);
  3264. undo_redo->add_do_property(object, p_name, p_value);
  3265. bool valid = false;
  3266. Variant value = object->get(p_name, &valid);
  3267. if (valid) {
  3268. undo_redo->add_undo_property(object, p_name, value);
  3269. }
  3270. List<StringName> linked_properties;
  3271. ClassDB::get_linked_properties_info(object->get_class_name(), p_name, &linked_properties);
  3272. for (const StringName &linked_prop : linked_properties) {
  3273. valid = false;
  3274. Variant undo_value = object->get(linked_prop, &valid);
  3275. if (valid) {
  3276. undo_redo->add_undo_property(object, linked_prop, undo_value);
  3277. }
  3278. }
  3279. PackedStringArray linked_properties_dynamic = object->call("_get_linked_undo_properties", p_name, p_value);
  3280. for (int i = 0; i < linked_properties_dynamic.size(); i++) {
  3281. valid = false;
  3282. Variant undo_value = object->get(linked_properties_dynamic[i], &valid);
  3283. if (valid) {
  3284. undo_redo->add_undo_property(object, linked_properties_dynamic[i], undo_value);
  3285. }
  3286. }
  3287. Variant v_undo_redo = undo_redo;
  3288. Variant v_object = object;
  3289. Variant v_name = p_name;
  3290. const Vector<Callable> &callbacks = EditorNode::get_editor_data().get_undo_redo_inspector_hook_callback();
  3291. for (int i = 0; i < callbacks.size(); i++) {
  3292. const Callable &callback = callbacks[i];
  3293. const Variant *p_arguments[] = { &v_undo_redo, &v_object, &v_name, &p_value };
  3294. Variant return_value;
  3295. Callable::CallError call_error;
  3296. callback.callp(p_arguments, 4, return_value, call_error);
  3297. if (call_error.error != Callable::CallError::CALL_OK) {
  3298. ERR_PRINT("Invalid UndoRedo callback.");
  3299. }
  3300. }
  3301. if (p_refresh_all) {
  3302. undo_redo->add_do_method(this, "_edit_request_change", object, "");
  3303. undo_redo->add_undo_method(this, "_edit_request_change", object, "");
  3304. } else {
  3305. undo_redo->add_do_method(this, "_edit_request_change", object, p_name);
  3306. undo_redo->add_undo_method(this, "_edit_request_change", object, p_name);
  3307. }
  3308. Resource *r = Object::cast_to<Resource>(object);
  3309. if (r) {
  3310. if (String(p_name) == "resource_local_to_scene") {
  3311. bool prev = object->get(p_name);
  3312. bool next = p_value;
  3313. if (next) {
  3314. undo_redo->add_do_method(r, "setup_local_to_scene");
  3315. }
  3316. if (prev) {
  3317. undo_redo->add_undo_method(r, "setup_local_to_scene");
  3318. }
  3319. }
  3320. }
  3321. undo_redo->add_do_method(this, "emit_signal", _prop_edited, p_name);
  3322. undo_redo->add_undo_method(this, "emit_signal", _prop_edited, p_name);
  3323. undo_redo->commit_action();
  3324. }
  3325. if (editor_property_map.has(p_name)) {
  3326. for (EditorProperty *E : editor_property_map[p_name]) {
  3327. E->update_editor_property_status();
  3328. }
  3329. }
  3330. }
  3331. void EditorInspector::_property_changed(const String &p_path, const Variant &p_value, const String &p_name, bool p_changing, bool p_update_all) {
  3332. // The "changing" variable must be true for properties that trigger events as typing occurs,
  3333. // like "text_changed" signal. E.g. text property of Label, Button, RichTextLabel, etc.
  3334. if (p_changing) {
  3335. changing++;
  3336. }
  3337. _edit_set(p_path, p_value, p_update_all, p_name);
  3338. if (p_changing) {
  3339. changing--;
  3340. }
  3341. if (restart_request_props.has(p_path)) {
  3342. emit_signal(SNAME("restart_requested"));
  3343. }
  3344. }
  3345. void EditorInspector::_multiple_properties_changed(const Vector<String> &p_paths, const Array &p_values, bool p_changing) {
  3346. ERR_FAIL_COND(p_paths.is_empty() || p_values.is_empty());
  3347. ERR_FAIL_COND(p_paths.size() != p_values.size());
  3348. String names;
  3349. for (int i = 0; i < p_paths.size(); i++) {
  3350. if (i > 0) {
  3351. names += ",";
  3352. }
  3353. names += p_paths[i];
  3354. }
  3355. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  3356. // TRANSLATORS: This is describing a change to multiple properties at once. The parameter is a list of property names.
  3357. undo_redo->create_action(vformat(TTR("Set Multiple: %s"), names), UndoRedo::MERGE_ENDS);
  3358. for (int i = 0; i < p_paths.size(); i++) {
  3359. _edit_set(p_paths[i], p_values[i], false, "");
  3360. if (restart_request_props.has(p_paths[i])) {
  3361. emit_signal(SNAME("restart_requested"));
  3362. }
  3363. }
  3364. if (p_changing) {
  3365. changing++;
  3366. }
  3367. undo_redo->commit_action();
  3368. if (p_changing) {
  3369. changing--;
  3370. }
  3371. }
  3372. void EditorInspector::_property_keyed(const String &p_path, bool p_advance) {
  3373. if (!object) {
  3374. return;
  3375. }
  3376. // The second parameter could be null, causing the event to fire with less arguments, so use the pointer call which preserves it.
  3377. const Variant args[3] = { p_path, object->get(p_path), p_advance };
  3378. const Variant *argp[3] = { &args[0], &args[1], &args[2] };
  3379. emit_signalp(SNAME("property_keyed"), argp, 3);
  3380. }
  3381. void EditorInspector::_property_deleted(const String &p_path) {
  3382. if (!object) {
  3383. return;
  3384. }
  3385. if (p_path.begins_with("metadata/")) {
  3386. String name = p_path.replace_first("metadata/", "");
  3387. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  3388. undo_redo->create_action(vformat(TTR("Remove metadata %s"), name));
  3389. undo_redo->add_do_method(object, "remove_meta", name);
  3390. undo_redo->add_undo_method(object, "set_meta", name, object->get_meta(name));
  3391. undo_redo->commit_action();
  3392. }
  3393. emit_signal(SNAME("property_deleted"), p_path);
  3394. }
  3395. void EditorInspector::_property_keyed_with_value(const String &p_path, const Variant &p_value, bool p_advance) {
  3396. if (!object) {
  3397. return;
  3398. }
  3399. // The second parameter could be null, causing the event to fire with less arguments, so use the pointer call which preserves it.
  3400. const Variant args[3] = { p_path, p_value, p_advance };
  3401. const Variant *argp[3] = { &args[0], &args[1], &args[2] };
  3402. emit_signalp(SNAME("property_keyed"), argp, 3);
  3403. }
  3404. void EditorInspector::_property_checked(const String &p_path, bool p_checked) {
  3405. if (!object) {
  3406. return;
  3407. }
  3408. //property checked
  3409. if (autoclear) {
  3410. if (!p_checked) {
  3411. _edit_set(p_path, Variant(), false, "");
  3412. } else {
  3413. Variant to_create;
  3414. List<PropertyInfo> pinfo;
  3415. object->get_property_list(&pinfo);
  3416. for (const PropertyInfo &E : pinfo) {
  3417. if (E.name == p_path) {
  3418. Callable::CallError ce;
  3419. Variant::construct(E.type, to_create, nullptr, 0, ce);
  3420. break;
  3421. }
  3422. }
  3423. _edit_set(p_path, to_create, false, "");
  3424. }
  3425. if (editor_property_map.has(p_path)) {
  3426. for (EditorProperty *E : editor_property_map[p_path]) {
  3427. E->set_checked(p_checked);
  3428. E->update_property();
  3429. E->update_editor_property_status();
  3430. E->update_cache();
  3431. }
  3432. }
  3433. } else {
  3434. emit_signal(SNAME("property_toggled"), p_path, p_checked);
  3435. }
  3436. }
  3437. void EditorInspector::_property_pinned(const String &p_path, bool p_pinned) {
  3438. if (!object) {
  3439. return;
  3440. }
  3441. Node *node = Object::cast_to<Node>(object);
  3442. ERR_FAIL_NULL(node);
  3443. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  3444. undo_redo->create_action(vformat(p_pinned ? TTR("Pinned %s") : TTR("Unpinned %s"), p_path));
  3445. undo_redo->add_do_method(node, "_set_property_pinned", p_path, p_pinned);
  3446. undo_redo->add_undo_method(node, "_set_property_pinned", p_path, !p_pinned);
  3447. if (editor_property_map.has(p_path)) {
  3448. for (List<EditorProperty *>::Element *E = editor_property_map[p_path].front(); E; E = E->next()) {
  3449. undo_redo->add_do_method(E->get(), "_update_editor_property_status");
  3450. undo_redo->add_undo_method(E->get(), "_update_editor_property_status");
  3451. }
  3452. }
  3453. undo_redo->commit_action();
  3454. }
  3455. void EditorInspector::_property_selected(const String &p_path, int p_focusable) {
  3456. property_selected = p_path;
  3457. property_focusable = p_focusable;
  3458. // Deselect the others.
  3459. for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
  3460. if (F.key == property_selected) {
  3461. continue;
  3462. }
  3463. for (EditorProperty *E : F.value) {
  3464. if (E->is_selected()) {
  3465. E->deselect();
  3466. }
  3467. }
  3468. }
  3469. emit_signal(SNAME("property_selected"), p_path);
  3470. }
  3471. void EditorInspector::_object_id_selected(const String &p_path, ObjectID p_id) {
  3472. emit_signal(SNAME("object_id_selected"), p_id);
  3473. }
  3474. void EditorInspector::_resource_selected(const String &p_path, Ref<Resource> p_resource) {
  3475. emit_signal(SNAME("resource_selected"), p_resource, p_path);
  3476. }
  3477. void EditorInspector::_node_removed(Node *p_node) {
  3478. if (p_node == object) {
  3479. edit(nullptr);
  3480. }
  3481. }
  3482. void EditorInspector::_notification(int p_what) {
  3483. switch (p_what) {
  3484. case NOTIFICATION_THEME_CHANGED: {
  3485. main_vbox->add_theme_constant_override("separation", get_theme_constant(SNAME("v_separation"), SNAME("EditorInspector")));
  3486. } break;
  3487. case NOTIFICATION_READY: {
  3488. EditorFeatureProfileManager::get_singleton()->connect("current_feature_profile_changed", callable_mp(this, &EditorInspector::_feature_profile_changed));
  3489. set_process(is_visible_in_tree());
  3490. add_theme_style_override(SceneStringName(panel), get_theme_stylebox(SceneStringName(panel), SNAME("Tree")));
  3491. if (!is_sub_inspector()) {
  3492. get_tree()->connect("node_removed", callable_mp(this, &EditorInspector::_node_removed));
  3493. }
  3494. } break;
  3495. case NOTIFICATION_PREDELETE: {
  3496. if (!is_sub_inspector() && is_inside_tree()) {
  3497. get_tree()->disconnect("node_removed", callable_mp(this, &EditorInspector::_node_removed));
  3498. }
  3499. edit(nullptr);
  3500. } break;
  3501. case NOTIFICATION_VISIBILITY_CHANGED: {
  3502. set_process(is_visible_in_tree());
  3503. } break;
  3504. case NOTIFICATION_PROCESS: {
  3505. if (update_scroll_request >= 0) {
  3506. callable_mp((Range *)get_v_scroll_bar(), &Range::set_value).call_deferred(update_scroll_request);
  3507. update_scroll_request = -1;
  3508. }
  3509. if (update_tree_pending) {
  3510. refresh_countdown = float(EDITOR_GET("docks/property_editor/auto_refresh_interval"));
  3511. } else if (refresh_countdown > 0) {
  3512. refresh_countdown -= get_process_delta_time();
  3513. if (refresh_countdown <= 0) {
  3514. for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
  3515. for (EditorProperty *E : F.value) {
  3516. if (E && !E->is_cache_valid()) {
  3517. E->update_property();
  3518. E->update_editor_property_status();
  3519. E->update_cache();
  3520. }
  3521. }
  3522. }
  3523. refresh_countdown = float(EDITOR_GET("docks/property_editor/auto_refresh_interval"));
  3524. }
  3525. }
  3526. changing++;
  3527. if (update_tree_pending) {
  3528. update_tree();
  3529. update_tree_pending = false;
  3530. pending.clear();
  3531. } else {
  3532. while (pending.size()) {
  3533. StringName prop = *pending.begin();
  3534. if (editor_property_map.has(prop)) {
  3535. for (EditorProperty *E : editor_property_map[prop]) {
  3536. E->update_property();
  3537. E->update_editor_property_status();
  3538. E->update_cache();
  3539. }
  3540. }
  3541. pending.remove(pending.begin());
  3542. }
  3543. }
  3544. changing--;
  3545. } break;
  3546. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  3547. bool needs_update = false;
  3548. if (!is_sub_inspector() && EditorThemeManager::is_generated_theme_outdated()) {
  3549. add_theme_style_override(SceneStringName(panel), get_theme_stylebox(SceneStringName(panel), SNAME("Tree")));
  3550. }
  3551. if (use_settings_name_style && EditorSettings::get_singleton()->check_changed_settings_in_group("interface/editor/localize_settings")) {
  3552. EditorPropertyNameProcessor::Style style = EditorPropertyNameProcessor::get_settings_style();
  3553. if (property_name_style != style) {
  3554. property_name_style = style;
  3555. needs_update = true;
  3556. }
  3557. }
  3558. if (EditorSettings::get_singleton()->check_changed_settings_in_group("interface/inspector")) {
  3559. needs_update = true;
  3560. }
  3561. if (needs_update) {
  3562. update_tree();
  3563. }
  3564. } break;
  3565. }
  3566. }
  3567. void EditorInspector::_changed_callback() {
  3568. //this is called when property change is notified via notify_property_list_changed()
  3569. if (object != nullptr) {
  3570. _edit_request_change(object, String());
  3571. }
  3572. }
  3573. void EditorInspector::_vscroll_changed(double p_offset) {
  3574. if (update_scroll_request >= 0) { //waiting, do nothing
  3575. return;
  3576. }
  3577. if (object) {
  3578. scroll_cache[object->get_instance_id()] = p_offset;
  3579. }
  3580. }
  3581. void EditorInspector::set_property_prefix(const String &p_prefix) {
  3582. property_prefix = p_prefix;
  3583. }
  3584. String EditorInspector::get_property_prefix() const {
  3585. return property_prefix;
  3586. }
  3587. void EditorInspector::add_custom_property_description(const String &p_class, const String &p_property, const String &p_description) {
  3588. const String key = vformat("property|%s|%s", p_class, p_property);
  3589. custom_property_descriptions[key] = p_description;
  3590. }
  3591. String EditorInspector::get_custom_property_description(const String &p_property) const {
  3592. HashMap<String, String>::ConstIterator E = custom_property_descriptions.find(p_property);
  3593. if (E) {
  3594. return E->value;
  3595. }
  3596. return "";
  3597. }
  3598. void EditorInspector::set_object_class(const String &p_class) {
  3599. object_class = p_class;
  3600. }
  3601. String EditorInspector::get_object_class() const {
  3602. return object_class;
  3603. }
  3604. void EditorInspector::_feature_profile_changed() {
  3605. update_tree();
  3606. }
  3607. void EditorInspector::set_restrict_to_basic_settings(bool p_restrict) {
  3608. restrict_to_basic = p_restrict;
  3609. update_tree();
  3610. }
  3611. void EditorInspector::set_property_clipboard(const Variant &p_value) {
  3612. property_clipboard = p_value;
  3613. }
  3614. Variant EditorInspector::get_property_clipboard() const {
  3615. return property_clipboard;
  3616. }
  3617. void EditorInspector::_show_add_meta_dialog() {
  3618. if (!add_meta_dialog) {
  3619. add_meta_dialog = memnew(AddMetadataDialog());
  3620. add_meta_dialog->connect(SceneStringName(confirmed), callable_mp(this, &EditorInspector::_add_meta_confirm));
  3621. add_child(add_meta_dialog);
  3622. }
  3623. StringName dialog_title;
  3624. Node *node = Object::cast_to<Node>(object);
  3625. // If object is derived from Node use node name, if derived from Resource use classname.
  3626. dialog_title = node ? node->get_name() : StringName(object->get_class());
  3627. List<StringName> existing_meta_keys;
  3628. object->get_meta_list(&existing_meta_keys);
  3629. add_meta_dialog->open(dialog_title, existing_meta_keys);
  3630. }
  3631. void EditorInspector::_add_meta_confirm() {
  3632. // Ensure metadata is unfolded when adding a new metadata.
  3633. object->editor_set_section_unfold("metadata", true);
  3634. String name = add_meta_dialog->get_meta_name();
  3635. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  3636. undo_redo->create_action(vformat(TTR("Add metadata %s"), name));
  3637. undo_redo->add_do_method(object, "set_meta", name, add_meta_dialog->get_meta_defval());
  3638. undo_redo->add_undo_method(object, "remove_meta", name);
  3639. undo_redo->commit_action();
  3640. }
  3641. void EditorInspector::_bind_methods() {
  3642. ClassDB::bind_method("_edit_request_change", &EditorInspector::_edit_request_change);
  3643. ClassDB::bind_method("get_selected_path", &EditorInspector::get_selected_path);
  3644. ClassDB::bind_method("get_edited_object", &EditorInspector::get_edited_object);
  3645. ADD_SIGNAL(MethodInfo("property_selected", PropertyInfo(Variant::STRING, "property")));
  3646. ADD_SIGNAL(MethodInfo("property_keyed", PropertyInfo(Variant::STRING, "property"), PropertyInfo(Variant::NIL, "value", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NIL_IS_VARIANT), PropertyInfo(Variant::BOOL, "advance")));
  3647. ADD_SIGNAL(MethodInfo("property_deleted", PropertyInfo(Variant::STRING, "property")));
  3648. ADD_SIGNAL(MethodInfo("resource_selected", PropertyInfo(Variant::OBJECT, "resource", PROPERTY_HINT_RESOURCE_TYPE, "Resource"), PropertyInfo(Variant::STRING, "path")));
  3649. ADD_SIGNAL(MethodInfo("object_id_selected", PropertyInfo(Variant::INT, "id")));
  3650. ADD_SIGNAL(MethodInfo("property_edited", PropertyInfo(Variant::STRING, "property")));
  3651. ADD_SIGNAL(MethodInfo("property_toggled", PropertyInfo(Variant::STRING, "property"), PropertyInfo(Variant::BOOL, "checked")));
  3652. ADD_SIGNAL(MethodInfo("edited_object_changed"));
  3653. ADD_SIGNAL(MethodInfo("restart_requested"));
  3654. }
  3655. EditorInspector::EditorInspector() {
  3656. object = nullptr;
  3657. main_vbox = memnew(VBoxContainer);
  3658. main_vbox->set_h_size_flags(SIZE_EXPAND_FILL);
  3659. add_child(main_vbox);
  3660. set_horizontal_scroll_mode(SCROLL_MODE_DISABLED);
  3661. set_follow_focus(true);
  3662. changing = 0;
  3663. search_box = nullptr;
  3664. _prop_edited = "property_edited";
  3665. set_process(false);
  3666. property_focusable = -1;
  3667. property_clipboard = Variant();
  3668. get_v_scroll_bar()->connect(SceneStringName(value_changed), callable_mp(this, &EditorInspector::_vscroll_changed));
  3669. update_scroll_request = -1;
  3670. if (EditorSettings::get_singleton()) {
  3671. refresh_countdown = float(EDITOR_GET("docks/property_editor/auto_refresh_interval"));
  3672. } else {
  3673. //used when class is created by the docgen to dump default values of everything bindable, editorsettings may not be created
  3674. refresh_countdown = 0.33;
  3675. }
  3676. ED_SHORTCUT("property_editor/copy_value", TTR("Copy Value"), KeyModifierMask::CMD_OR_CTRL | Key::C);
  3677. ED_SHORTCUT("property_editor/paste_value", TTR("Paste Value"), KeyModifierMask::CMD_OR_CTRL | Key::V);
  3678. ED_SHORTCUT("property_editor/copy_property_path", TTR("Copy Property Path"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::C);
  3679. // `use_settings_name_style` is true by default, set the name style accordingly.
  3680. set_property_name_style(EditorPropertyNameProcessor::get_singleton()->get_settings_style());
  3681. }