12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238 |
- /**************************************************************************/
- /* editor_inspector.cpp */
- /**************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /**************************************************************************/
- /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
- /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
- /* */
- /* Permission is hereby granted, free of charge, to any person obtaining */
- /* a copy of this software and associated documentation files (the */
- /* "Software"), to deal in the Software without restriction, including */
- /* without limitation the rights to use, copy, modify, merge, publish, */
- /* distribute, sublicense, and/or sell copies of the Software, and to */
- /* permit persons to whom the Software is furnished to do so, subject to */
- /* the following conditions: */
- /* */
- /* The above copyright notice and this permission notice shall be */
- /* included in all copies or substantial portions of the Software. */
- /* */
- /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
- /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
- /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
- /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
- /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
- /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
- /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
- /**************************************************************************/
- #include "editor_inspector.h"
- #include "core/os/keyboard.h"
- #include "editor/doc_tools.h"
- #include "editor/editor_feature_profile.h"
- #include "editor/editor_node.h"
- #include "editor/editor_property_name_processor.h"
- #include "editor/editor_scale.h"
- #include "editor/editor_settings.h"
- #include "editor/editor_string_names.h"
- #include "editor/editor_undo_redo_manager.h"
- #include "editor/gui/editor_validation_panel.h"
- #include "editor/inspector_dock.h"
- #include "editor/plugins/script_editor_plugin.h"
- #include "multi_node_edit.h"
- #include "scene/gui/spin_box.h"
- #include "scene/gui/texture_rect.h"
- #include "scene/property_utils.h"
- #include "scene/resources/packed_scene.h"
- #include "scene/resources/style_box_flat.h"
- bool EditorInspector::_property_path_matches(const String &p_property_path, const String &p_filter, EditorPropertyNameProcessor::Style p_style) {
- if (p_property_path.findn(p_filter) != -1) {
- return true;
- }
- const Vector<String> prop_sections = p_property_path.split("/");
- for (int i = 0; i < prop_sections.size(); i++) {
- if (p_filter.is_subsequence_ofn(EditorPropertyNameProcessor::get_singleton()->process_name(prop_sections[i], p_style))) {
- return true;
- }
- }
- return false;
- }
- Size2 EditorProperty::get_minimum_size() const {
- Size2 ms;
- Ref<Font> font = get_theme_font(SNAME("font"), SNAME("Tree"));
- int font_size = get_theme_font_size(SNAME("font_size"), SNAME("Tree"));
- ms.height = font->get_height(font_size) + 4 * EDSCALE;
- for (int i = 0; i < get_child_count(); i++) {
- Control *c = Object::cast_to<Control>(get_child(i));
- if (!c) {
- continue;
- }
- if (c->is_set_as_top_level()) {
- continue;
- }
- if (!c->is_visible()) {
- continue;
- }
- if (c == bottom_editor) {
- continue;
- }
- Size2 minsize = c->get_combined_minimum_size();
- ms.width = MAX(ms.width, minsize.width);
- ms.height = MAX(ms.height, minsize.height);
- }
- if (keying) {
- Ref<Texture2D> key = get_editor_theme_icon(SNAME("Key"));
- ms.width += key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree"));
- }
- if (deletable) {
- Ref<Texture2D> key = get_editor_theme_icon(SNAME("Close"));
- ms.width += key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree"));
- }
- if (checkable) {
- Ref<Texture2D> check = get_theme_icon(SNAME("checked"), SNAME("CheckBox"));
- ms.width += check->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("CheckBox")) + get_theme_constant(SNAME("hseparator"), SNAME("Tree"));
- }
- if (bottom_editor != nullptr && bottom_editor->is_visible()) {
- ms.height += get_theme_constant(SNAME("v_separation"));
- Size2 bems = bottom_editor->get_combined_minimum_size();
- //bems.width += get_constant("item_margin", "Tree");
- ms.height += bems.height;
- ms.width = MAX(ms.width, bems.width);
- }
- return ms;
- }
- void EditorProperty::emit_changed(const StringName &p_property, const Variant &p_value, const StringName &p_field, bool p_changing) {
- Variant args[4] = { p_property, p_value, p_field, p_changing };
- const Variant *argptrs[4] = { &args[0], &args[1], &args[2], &args[3] };
- cache[p_property] = p_value;
- emit_signalp(SNAME("property_changed"), (const Variant **)argptrs, 4);
- }
- void EditorProperty::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_SORT_CHILDREN: {
- Size2 size = get_size();
- Rect2 rect;
- Rect2 bottom_rect;
- right_child_rect = Rect2();
- bottom_child_rect = Rect2();
- {
- int child_room = size.width * (1.0 - split_ratio);
- Ref<Font> font = get_theme_font(SNAME("font"), SNAME("Tree"));
- int font_size = get_theme_font_size(SNAME("font_size"), SNAME("Tree"));
- int height = font->get_height(font_size) + 4 * EDSCALE;
- bool no_children = true;
- //compute room needed
- for (int i = 0; i < get_child_count(); i++) {
- Control *c = Object::cast_to<Control>(get_child(i));
- if (!c) {
- continue;
- }
- if (c->is_set_as_top_level()) {
- continue;
- }
- if (c == bottom_editor) {
- continue;
- }
- Size2 minsize = c->get_combined_minimum_size();
- child_room = MAX(child_room, minsize.width);
- height = MAX(height, minsize.height);
- no_children = false;
- }
- if (no_children) {
- text_size = size.width;
- rect = Rect2(size.width - 1, 0, 1, height);
- } else {
- text_size = MAX(0, size.width - (child_room + 4 * EDSCALE));
- if (is_layout_rtl()) {
- rect = Rect2(1, 0, child_room, height);
- } else {
- rect = Rect2(size.width - child_room, 0, child_room, height);
- }
- }
- if (bottom_editor) {
- int m = 0; //get_constant("item_margin", "Tree");
- bottom_rect = Rect2(m, rect.size.height + get_theme_constant(SNAME("v_separation")), size.width - m, bottom_editor->get_combined_minimum_size().height);
- }
- if (keying) {
- Ref<Texture2D> key;
- if (use_keying_next()) {
- key = get_editor_theme_icon(SNAME("KeyNext"));
- } else {
- key = get_editor_theme_icon(SNAME("Key"));
- }
- rect.size.x -= key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree"));
- if (is_layout_rtl()) {
- rect.position.x += key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree"));
- }
- if (no_children) {
- text_size -= key->get_width() + 4 * EDSCALE;
- }
- }
- if (deletable) {
- Ref<Texture2D> close;
- close = get_editor_theme_icon(SNAME("Close"));
- rect.size.x -= close->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree"));
- if (is_layout_rtl()) {
- rect.position.x += close->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree"));
- }
- if (no_children) {
- text_size -= close->get_width() + 4 * EDSCALE;
- }
- }
- }
- //set children
- for (int i = 0; i < get_child_count(); i++) {
- Control *c = Object::cast_to<Control>(get_child(i));
- if (!c) {
- continue;
- }
- if (c->is_set_as_top_level()) {
- continue;
- }
- if (c == bottom_editor) {
- continue;
- }
- fit_child_in_rect(c, rect);
- right_child_rect = rect;
- }
- if (bottom_editor) {
- fit_child_in_rect(bottom_editor, bottom_rect);
- bottom_child_rect = bottom_rect;
- }
- queue_redraw(); //need to redraw text
- } break;
- case NOTIFICATION_DRAW: {
- Ref<Font> font = get_theme_font(SNAME("font"), SNAME("Tree"));
- int font_size = get_theme_font_size(SNAME("font_size"), SNAME("Tree"));
- bool rtl = is_layout_rtl();
- Size2 size = get_size();
- if (bottom_editor) {
- size.height = bottom_editor->get_offset(SIDE_TOP) - get_theme_constant(SNAME("v_separation"));
- } else if (label_reference) {
- size.height = label_reference->get_size().height;
- }
- Ref<StyleBox> sb = get_theme_stylebox(selected ? SNAME("bg_selected") : SNAME("bg"));
- draw_style_box(sb, Rect2(Vector2(), size));
- Ref<StyleBox> bg_stylebox = get_theme_stylebox(SNAME("child_bg"));
- if (draw_top_bg && right_child_rect != Rect2()) {
- draw_style_box(bg_stylebox, right_child_rect);
- }
- if (bottom_child_rect != Rect2()) {
- draw_style_box(bg_stylebox, bottom_child_rect);
- }
- Color color;
- if (draw_warning || draw_prop_warning) {
- color = get_theme_color(is_read_only() ? SNAME("readonly_warning_color") : SNAME("warning_color"));
- } else {
- color = get_theme_color(is_read_only() ? SNAME("readonly_color") : SNAME("property_color"));
- }
- if (label.contains(".")) {
- // FIXME: Move this to the project settings editor, as this is only used
- // for project settings feature tag overrides.
- color.a = 0.5;
- }
- int ofs = get_theme_constant(SNAME("font_offset"));
- int text_limit = text_size - ofs;
- if (checkable) {
- Ref<Texture2D> checkbox;
- if (checked) {
- checkbox = get_editor_theme_icon(SNAME("GuiChecked"));
- } else {
- checkbox = get_editor_theme_icon(SNAME("GuiUnchecked"));
- }
- Color color2(1, 1, 1);
- if (check_hover) {
- color2.r *= 1.2;
- color2.g *= 1.2;
- color2.b *= 1.2;
- }
- check_rect = Rect2(ofs, ((size.height - checkbox->get_height()) / 2), checkbox->get_width(), checkbox->get_height());
- if (rtl) {
- draw_texture(checkbox, Vector2(size.width - check_rect.position.x - checkbox->get_width(), check_rect.position.y), color2);
- } else {
- draw_texture(checkbox, check_rect.position, color2);
- }
- int check_ofs = get_theme_constant(SNAME("hseparator"), SNAME("Tree")) + checkbox->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("CheckBox"));
- ofs += check_ofs;
- text_limit -= check_ofs;
- } else {
- check_rect = Rect2();
- }
- if (can_revert && !is_read_only()) {
- Ref<Texture2D> reload_icon = get_editor_theme_icon(SNAME("ReloadSmall"));
- text_limit -= reload_icon->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")) * 2;
- revert_rect = Rect2(ofs + text_limit, (size.height - reload_icon->get_height()) / 2, reload_icon->get_width(), reload_icon->get_height());
- Color color2(1, 1, 1);
- if (revert_hover) {
- color2.r *= 1.2;
- color2.g *= 1.2;
- color2.b *= 1.2;
- }
- if (rtl) {
- draw_texture(reload_icon, Vector2(size.width - revert_rect.position.x - reload_icon->get_width(), revert_rect.position.y), color2);
- } else {
- draw_texture(reload_icon, revert_rect.position, color2);
- }
- } else {
- revert_rect = Rect2();
- }
- if (!pin_hidden && pinned) {
- Ref<Texture2D> pinned_icon = get_editor_theme_icon(SNAME("Pin"));
- int margin_w = get_theme_constant(SNAME("hseparator"), SNAME("Tree")) * 2;
- int total_icon_w = margin_w + pinned_icon->get_width();
- int text_w = font->get_string_size(label, rtl ? HORIZONTAL_ALIGNMENT_RIGHT : HORIZONTAL_ALIGNMENT_LEFT, text_limit - total_icon_w, font_size).x;
- int y = (size.height - pinned_icon->get_height()) / 2;
- if (rtl) {
- draw_texture(pinned_icon, Vector2(size.width - ofs - text_w - total_icon_w, y), color);
- } else {
- draw_texture(pinned_icon, Vector2(ofs + text_w + margin_w, y), color);
- }
- text_limit -= total_icon_w;
- }
- int v_ofs = (size.height - font->get_height(font_size)) / 2;
- if (rtl) {
- 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);
- } else {
- draw_string(font, Point2(ofs, v_ofs + font->get_ascent(font_size)), label, HORIZONTAL_ALIGNMENT_LEFT, text_limit, font_size, color);
- }
- ofs = size.width;
- if (keying) {
- Ref<Texture2D> key;
- if (use_keying_next()) {
- key = get_editor_theme_icon(SNAME("KeyNext"));
- } else {
- key = get_editor_theme_icon(SNAME("Key"));
- }
- ofs -= key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree"));
- Color color2(1, 1, 1);
- if (keying_hover) {
- color2.r *= 1.2;
- color2.g *= 1.2;
- color2.b *= 1.2;
- }
- keying_rect = Rect2(ofs, ((size.height - key->get_height()) / 2), key->get_width(), key->get_height());
- if (rtl) {
- draw_texture(key, Vector2(size.width - keying_rect.position.x - key->get_width(), keying_rect.position.y), color2);
- } else {
- draw_texture(key, keying_rect.position, color2);
- }
- } else {
- keying_rect = Rect2();
- }
- if (deletable) {
- Ref<Texture2D> close;
- close = get_editor_theme_icon(SNAME("Close"));
- ofs -= close->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree"));
- Color color2(1, 1, 1);
- if (delete_hover) {
- color2.r *= 1.2;
- color2.g *= 1.2;
- color2.b *= 1.2;
- }
- delete_rect = Rect2(ofs, ((size.height - close->get_height()) / 2), close->get_width(), close->get_height());
- if (rtl) {
- draw_texture(close, Vector2(size.width - delete_rect.position.x - close->get_width(), delete_rect.position.y), color2);
- } else {
- draw_texture(close, delete_rect.position, color2);
- }
- } else {
- delete_rect = Rect2();
- }
- } break;
- }
- }
- void EditorProperty::set_label(const String &p_label) {
- label = p_label;
- queue_redraw();
- }
- String EditorProperty::get_label() const {
- return label;
- }
- Object *EditorProperty::get_edited_object() {
- return object;
- }
- StringName EditorProperty::get_edited_property() const {
- return property;
- }
- EditorInspector *EditorProperty::get_parent_inspector() const {
- Node *parent = get_parent();
- while (parent) {
- EditorInspector *ei = Object::cast_to<EditorInspector>(parent);
- if (ei) {
- return ei;
- }
- parent = parent->get_parent();
- }
- ERR_FAIL_V_MSG(nullptr, "EditorProperty is outside inspector.");
- }
- void EditorProperty::set_doc_path(const String &p_doc_path) {
- doc_path = p_doc_path;
- }
- void EditorProperty::update_property() {
- GDVIRTUAL_CALL(_update_property);
- }
- void EditorProperty::_set_read_only(bool p_read_only) {
- }
- void EditorProperty::set_read_only(bool p_read_only) {
- read_only = p_read_only;
- if (GDVIRTUAL_CALL(_set_read_only, p_read_only)) {
- return;
- }
- _set_read_only(p_read_only);
- }
- bool EditorProperty::is_read_only() const {
- return read_only;
- }
- Variant EditorPropertyRevert::get_property_revert_value(Object *p_object, const StringName &p_property, bool *r_is_valid) {
- if (p_object->property_can_revert(p_property)) {
- if (r_is_valid) {
- *r_is_valid = true;
- }
- return p_object->property_get_revert(p_property);
- }
- return PropertyUtils::get_property_default_value(p_object, p_property, r_is_valid);
- }
- bool EditorPropertyRevert::can_property_revert(Object *p_object, const StringName &p_property, const Variant *p_custom_current_value) {
- bool is_valid_revert = false;
- Variant revert_value = EditorPropertyRevert::get_property_revert_value(p_object, p_property, &is_valid_revert);
- if (!is_valid_revert) {
- return false;
- }
- Variant current_value = p_custom_current_value ? *p_custom_current_value : p_object->get(p_property);
- return PropertyUtils::is_property_value_different(current_value, revert_value);
- }
- StringName EditorProperty::_get_revert_property() const {
- return property;
- }
- void EditorProperty::update_editor_property_status() {
- if (property == StringName()) {
- return; //no property, so nothing to do
- }
- bool new_pinned = false;
- if (can_pin) {
- Node *node = Object::cast_to<Node>(object);
- CRASH_COND(!node);
- new_pinned = node->is_property_pinned(property);
- }
- bool new_warning = false;
- if (object->has_method("_get_property_warning")) {
- new_warning = !String(object->call("_get_property_warning", property)).is_empty();
- }
- Variant current = object->get(_get_revert_property());
- bool new_can_revert = EditorPropertyRevert::can_property_revert(object, property, ¤t) && !is_read_only();
- bool new_checked = checked;
- if (checkable) { // for properties like theme overrides.
- bool valid = false;
- Variant value = object->get(property, &valid);
- if (valid) {
- new_checked = value.get_type() != Variant::NIL;
- }
- }
- if (new_can_revert != can_revert || new_pinned != pinned || new_checked != checked || new_warning != draw_prop_warning) {
- if (new_can_revert != can_revert) {
- emit_signal(SNAME("property_can_revert_changed"), property, new_can_revert);
- }
- draw_prop_warning = new_warning;
- can_revert = new_can_revert;
- pinned = new_pinned;
- checked = new_checked;
- queue_redraw();
- }
- }
- bool EditorProperty::use_keying_next() const {
- List<PropertyInfo> plist;
- object->get_property_list(&plist, true);
- for (List<PropertyInfo>::Element *I = plist.front(); I; I = I->next()) {
- PropertyInfo &p = I->get();
- if (p.name == property) {
- return (p.usage & PROPERTY_USAGE_KEYING_INCREMENTS);
- }
- }
- return false;
- }
- void EditorProperty::set_checkable(bool p_checkable) {
- checkable = p_checkable;
- queue_redraw();
- queue_sort();
- }
- bool EditorProperty::is_checkable() const {
- return checkable;
- }
- void EditorProperty::set_checked(bool p_checked) {
- checked = p_checked;
- queue_redraw();
- }
- bool EditorProperty::is_checked() const {
- return checked;
- }
- void EditorProperty::set_draw_warning(bool p_draw_warning) {
- draw_warning = p_draw_warning;
- queue_redraw();
- }
- void EditorProperty::set_keying(bool p_keying) {
- keying = p_keying;
- queue_redraw();
- queue_sort();
- }
- void EditorProperty::set_deletable(bool p_deletable) {
- deletable = p_deletable;
- queue_redraw();
- queue_sort();
- }
- bool EditorProperty::is_deletable() const {
- return deletable;
- }
- bool EditorProperty::is_keying() const {
- return keying;
- }
- bool EditorProperty::is_draw_warning() const {
- return draw_warning;
- }
- void EditorProperty::_focusable_focused(int p_index) {
- if (!selectable) {
- return;
- }
- bool already_selected = selected;
- selected = true;
- selected_focusable = p_index;
- queue_redraw();
- if (!already_selected && selected) {
- emit_signal(SNAME("selected"), property, selected_focusable);
- }
- }
- void EditorProperty::add_focusable(Control *p_control) {
- p_control->connect("focus_entered", callable_mp(this, &EditorProperty::_focusable_focused).bind(focusables.size()));
- focusables.push_back(p_control);
- }
- void EditorProperty::select(int p_focusable) {
- bool already_selected = selected;
- if (!selectable) {
- return;
- }
- if (p_focusable >= 0) {
- ERR_FAIL_INDEX(p_focusable, focusables.size());
- focusables[p_focusable]->grab_focus();
- } else {
- selected = true;
- queue_redraw();
- }
- if (!already_selected && selected) {
- emit_signal(SNAME("selected"), property, selected_focusable);
- }
- }
- void EditorProperty::deselect() {
- selected = false;
- selected_focusable = -1;
- queue_redraw();
- }
- bool EditorProperty::is_selected() const {
- return selected;
- }
- void EditorProperty::gui_input(const Ref<InputEvent> &p_event) {
- ERR_FAIL_COND(p_event.is_null());
- if (property == StringName()) {
- return;
- }
- Ref<InputEventMouse> me = p_event;
- if (me.is_valid()) {
- Vector2 mpos = me->get_position();
- if (is_layout_rtl()) {
- mpos.x = get_size().x - mpos.x;
- }
- bool button_left = me->get_button_mask().has_flag(MouseButtonMask::LEFT);
- bool new_keying_hover = keying_rect.has_point(mpos) && !button_left;
- if (new_keying_hover != keying_hover) {
- keying_hover = new_keying_hover;
- queue_redraw();
- }
- bool new_delete_hover = delete_rect.has_point(mpos) && !button_left;
- if (new_delete_hover != delete_hover) {
- delete_hover = new_delete_hover;
- queue_redraw();
- }
- bool new_revert_hover = revert_rect.has_point(mpos) && !button_left;
- if (new_revert_hover != revert_hover) {
- revert_hover = new_revert_hover;
- queue_redraw();
- }
- bool new_check_hover = check_rect.has_point(mpos) && !button_left;
- if (new_check_hover != check_hover) {
- check_hover = new_check_hover;
- queue_redraw();
- }
- }
- Ref<InputEventMouseButton> mb = p_event;
- if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == MouseButton::LEFT) {
- Vector2 mpos = mb->get_position();
- if (is_layout_rtl()) {
- mpos.x = get_size().x - mpos.x;
- }
- select();
- if (keying_rect.has_point(mpos)) {
- accept_event();
- emit_signal(SNAME("property_keyed"), property, use_keying_next());
- if (use_keying_next()) {
- if (property == "frame_coords" && (object->is_class("Sprite2D") || object->is_class("Sprite3D"))) {
- Vector2i new_coords = object->get(property);
- new_coords.x++;
- if (new_coords.x >= int64_t(object->get("hframes"))) {
- new_coords.x = 0;
- new_coords.y++;
- }
- if (new_coords.x < int64_t(object->get("hframes")) && new_coords.y < int64_t(object->get("vframes"))) {
- call_deferred(SNAME("emit_changed"), property, new_coords, "", false);
- }
- } else {
- if (int64_t(object->get(property)) + 1 < (int64_t(object->get("hframes")) * int64_t(object->get("vframes")))) {
- call_deferred(SNAME("emit_changed"), property, object->get(property).operator int64_t() + 1, "", false);
- }
- }
- call_deferred(SNAME("update_property"));
- }
- }
- if (delete_rect.has_point(mpos)) {
- accept_event();
- emit_signal(SNAME("property_deleted"), property);
- }
- if (revert_rect.has_point(mpos)) {
- accept_event();
- get_viewport()->gui_release_focus();
- bool is_valid_revert = false;
- Variant revert_value = EditorPropertyRevert::get_property_revert_value(object, property, &is_valid_revert);
- ERR_FAIL_COND(!is_valid_revert);
- emit_changed(_get_revert_property(), revert_value);
- update_property();
- }
- if (check_rect.has_point(mpos)) {
- accept_event();
- checked = !checked;
- queue_redraw();
- emit_signal(SNAME("property_checked"), property, checked);
- }
- } else if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == MouseButton::RIGHT) {
- accept_event();
- _update_popup();
- menu->set_position(get_screen_position() + get_local_mouse_position());
- menu->reset_size();
- menu->popup();
- select();
- return;
- }
- }
- void EditorProperty::shortcut_input(const Ref<InputEvent> &p_event) {
- if (!selected || !p_event->is_pressed()) {
- return;
- }
- const Ref<InputEventKey> k = p_event;
- if (k.is_valid() && k->is_pressed()) {
- if (ED_IS_SHORTCUT("property_editor/copy_value", p_event)) {
- menu_option(MENU_COPY_VALUE);
- accept_event();
- } else if (ED_IS_SHORTCUT("property_editor/paste_value", p_event) && !is_read_only()) {
- menu_option(MENU_PASTE_VALUE);
- accept_event();
- } else if (ED_IS_SHORTCUT("property_editor/copy_property_path", p_event)) {
- menu_option(MENU_COPY_PROPERTY_PATH);
- accept_event();
- }
- }
- }
- const Color *EditorProperty::_get_property_colors() {
- static Color c[4];
- c[0] = get_theme_color(SNAME("property_color_x"), EditorStringName(Editor));
- c[1] = get_theme_color(SNAME("property_color_y"), EditorStringName(Editor));
- c[2] = get_theme_color(SNAME("property_color_z"), EditorStringName(Editor));
- c[3] = get_theme_color(SNAME("property_color_w"), EditorStringName(Editor));
- return c;
- }
- void EditorProperty::set_label_reference(Control *p_control) {
- label_reference = p_control;
- }
- void EditorProperty::set_bottom_editor(Control *p_control) {
- bottom_editor = p_control;
- }
- Variant EditorProperty::_get_cache_value(const StringName &p_prop, bool &r_valid) const {
- return object->get(p_prop, &r_valid);
- }
- bool EditorProperty::is_cache_valid() const {
- if (object) {
- for (const KeyValue<StringName, Variant> &E : cache) {
- bool valid;
- Variant value = _get_cache_value(E.key, valid);
- if (!valid || value != E.value) {
- return false;
- }
- }
- }
- return true;
- }
- void EditorProperty::update_cache() {
- cache.clear();
- if (object && property != StringName()) {
- bool valid;
- Variant value = _get_cache_value(property, valid);
- if (valid) {
- cache[property] = value;
- }
- }
- }
- Variant EditorProperty::get_drag_data(const Point2 &p_point) {
- if (property == StringName()) {
- return Variant();
- }
- Dictionary dp;
- dp["type"] = "obj_property";
- dp["object"] = object;
- dp["property"] = property;
- dp["value"] = object->get(property);
- Label *drag_label = memnew(Label);
- drag_label->set_text(property);
- set_drag_preview(drag_label);
- return dp;
- }
- void EditorProperty::set_use_folding(bool p_use_folding) {
- use_folding = p_use_folding;
- }
- bool EditorProperty::is_using_folding() const {
- return use_folding;
- }
- void EditorProperty::expand_all_folding() {
- }
- void EditorProperty::collapse_all_folding() {
- }
- void EditorProperty::expand_revertable() {
- }
- void EditorProperty::set_selectable(bool p_selectable) {
- selectable = p_selectable;
- }
- bool EditorProperty::is_selectable() const {
- return selectable;
- }
- void EditorProperty::set_name_split_ratio(float p_ratio) {
- split_ratio = p_ratio;
- }
- float EditorProperty::get_name_split_ratio() const {
- return split_ratio;
- }
- void EditorProperty::set_object_and_property(Object *p_object, const StringName &p_property) {
- object = p_object;
- property = p_property;
- _update_pin_flags();
- }
- static bool _is_value_potential_override(Node *p_node, const String &p_property) {
- // Consider a value is potentially overriding another if either of the following is true:
- // a) The node is foreign (inheriting or an instance), so the original value may come from another scene.
- // b) The node belongs to the scene, but the original value comes from somewhere but the builtin class (i.e., a script).
- Node *edited_scene = EditorNode::get_singleton()->get_edited_scene();
- Vector<SceneState::PackState> states_stack = PropertyUtils::get_node_states_stack(p_node, edited_scene);
- if (states_stack.size()) {
- return true;
- } else {
- bool is_valid_default = false;
- bool is_class_default = false;
- PropertyUtils::get_property_default_value(p_node, p_property, &is_valid_default, &states_stack, false, nullptr, &is_class_default);
- return !is_class_default;
- }
- }
- void EditorProperty::_update_pin_flags() {
- can_pin = false;
- pin_hidden = true;
- if (read_only) {
- return;
- }
- if (Node *node = Object::cast_to<Node>(object)) {
- // Avoid errors down the road by ignoring nodes which are not part of a scene
- if (!node->get_owner()) {
- bool is_scene_root = false;
- for (int i = 0; i < EditorNode::get_editor_data().get_edited_scene_count(); ++i) {
- if (EditorNode::get_editor_data().get_edited_scene_root(i) == node) {
- is_scene_root = true;
- break;
- }
- }
- if (!is_scene_root) {
- return;
- }
- }
- if (!_is_value_potential_override(node, property)) {
- return;
- }
- pin_hidden = false;
- {
- HashSet<StringName> storable_properties;
- node->get_storable_properties(storable_properties);
- if (storable_properties.has(node->get_property_store_alias(property))) {
- can_pin = true;
- }
- }
- }
- }
- Control *EditorProperty::make_custom_tooltip(const String &p_text) const {
- EditorHelpBit *tooltip = nullptr;
- if (has_doc_tooltip) {
- tooltip = memnew(EditorHelpTooltip(p_text));
- }
- if (object->has_method("_get_property_warning")) {
- String warn = object->call("_get_property_warning", property);
- if (!warn.is_empty()) {
- String prev_text;
- if (tooltip == nullptr) {
- tooltip = memnew(EditorHelpBit());
- tooltip->set_text(p_text);
- tooltip->get_rich_text()->set_custom_minimum_size(Size2(360 * EDSCALE, 0));
- } else {
- prev_text = tooltip->get_rich_text()->get_text() + "\n";
- }
- tooltip->set_text(prev_text + "[b][color=" + get_theme_color(SNAME("warning_color")).to_html(false) + "]" + warn + "[/color][/b]");
- }
- }
- return tooltip;
- }
- void EditorProperty::menu_option(int p_option) {
- switch (p_option) {
- case MENU_COPY_VALUE: {
- InspectorDock::get_inspector_singleton()->set_property_clipboard(object->get(property));
- } break;
- case MENU_PASTE_VALUE: {
- emit_changed(property, InspectorDock::get_inspector_singleton()->get_property_clipboard());
- } break;
- case MENU_COPY_PROPERTY_PATH: {
- DisplayServer::get_singleton()->clipboard_set(property_path);
- } break;
- case MENU_PIN_VALUE: {
- emit_signal(SNAME("property_pinned"), property, !pinned);
- queue_redraw();
- } break;
- case MENU_OPEN_DOCUMENTATION: {
- ScriptEditor::get_singleton()->goto_help(doc_path);
- EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT);
- } break;
- }
- }
- void EditorProperty::_bind_methods() {
- ClassDB::bind_method(D_METHOD("set_label", "text"), &EditorProperty::set_label);
- ClassDB::bind_method(D_METHOD("get_label"), &EditorProperty::get_label);
- ClassDB::bind_method(D_METHOD("set_read_only", "read_only"), &EditorProperty::set_read_only);
- ClassDB::bind_method(D_METHOD("is_read_only"), &EditorProperty::is_read_only);
- ClassDB::bind_method(D_METHOD("set_checkable", "checkable"), &EditorProperty::set_checkable);
- ClassDB::bind_method(D_METHOD("is_checkable"), &EditorProperty::is_checkable);
- ClassDB::bind_method(D_METHOD("set_checked", "checked"), &EditorProperty::set_checked);
- ClassDB::bind_method(D_METHOD("is_checked"), &EditorProperty::is_checked);
- ClassDB::bind_method(D_METHOD("set_draw_warning", "draw_warning"), &EditorProperty::set_draw_warning);
- ClassDB::bind_method(D_METHOD("is_draw_warning"), &EditorProperty::is_draw_warning);
- ClassDB::bind_method(D_METHOD("set_keying", "keying"), &EditorProperty::set_keying);
- ClassDB::bind_method(D_METHOD("is_keying"), &EditorProperty::is_keying);
- ClassDB::bind_method(D_METHOD("set_deletable", "deletable"), &EditorProperty::set_deletable);
- ClassDB::bind_method(D_METHOD("is_deletable"), &EditorProperty::is_deletable);
- ClassDB::bind_method(D_METHOD("get_edited_property"), &EditorProperty::get_edited_property);
- ClassDB::bind_method(D_METHOD("get_edited_object"), &EditorProperty::get_edited_object);
- ClassDB::bind_method(D_METHOD("update_property"), &EditorProperty::update_property);
- ClassDB::bind_method(D_METHOD("add_focusable", "control"), &EditorProperty::add_focusable);
- ClassDB::bind_method(D_METHOD("set_bottom_editor", "editor"), &EditorProperty::set_bottom_editor);
- ClassDB::bind_method(D_METHOD("emit_changed", "property", "value", "field", "changing"), &EditorProperty::emit_changed, DEFVAL(StringName()), DEFVAL(false));
- ADD_PROPERTY(PropertyInfo(Variant::STRING, "label"), "set_label", "get_label");
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "read_only"), "set_read_only", "is_read_only");
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "checkable"), "set_checkable", "is_checkable");
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "checked"), "set_checked", "is_checked");
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_warning"), "set_draw_warning", "is_draw_warning");
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "keying"), "set_keying", "is_keying");
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "deletable"), "set_deletable", "is_deletable");
- 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")));
- ADD_SIGNAL(MethodInfo("multiple_properties_changed", PropertyInfo(Variant::PACKED_STRING_ARRAY, "properties"), PropertyInfo(Variant::ARRAY, "value")));
- ADD_SIGNAL(MethodInfo("property_keyed", PropertyInfo(Variant::STRING_NAME, "property")));
- ADD_SIGNAL(MethodInfo("property_deleted", PropertyInfo(Variant::STRING_NAME, "property")));
- ADD_SIGNAL(MethodInfo("property_keyed_with_value", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::NIL, "value", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NIL_IS_VARIANT)));
- ADD_SIGNAL(MethodInfo("property_checked", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::BOOL, "checked")));
- ADD_SIGNAL(MethodInfo("property_pinned", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::BOOL, "pinned")));
- ADD_SIGNAL(MethodInfo("property_can_revert_changed", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::BOOL, "can_revert")));
- ADD_SIGNAL(MethodInfo("resource_selected", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::OBJECT, "resource", PROPERTY_HINT_RESOURCE_TYPE, "Resource")));
- ADD_SIGNAL(MethodInfo("object_id_selected", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::INT, "id")));
- ADD_SIGNAL(MethodInfo("selected", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::INT, "focusable_idx")));
- GDVIRTUAL_BIND(_update_property)
- GDVIRTUAL_BIND(_set_read_only, "read_only")
- ClassDB::bind_method(D_METHOD("_update_editor_property_status"), &EditorProperty::update_editor_property_status);
- }
- EditorProperty::EditorProperty() {
- object = nullptr;
- split_ratio = 0.5;
- text_size = 0;
- property_usage = 0;
- selected_focusable = -1;
- label_reference = nullptr;
- bottom_editor = nullptr;
- menu = nullptr;
- set_process_shortcut_input(true);
- }
- void EditorProperty::_update_popup() {
- if (menu) {
- menu->clear();
- } else {
- menu = memnew(PopupMenu);
- add_child(menu);
- menu->connect("id_pressed", callable_mp(this, &EditorProperty::menu_option));
- }
- menu->add_icon_shortcut(get_editor_theme_icon(SNAME("ActionCopy")), ED_GET_SHORTCUT("property_editor/copy_value"), MENU_COPY_VALUE);
- menu->add_icon_shortcut(get_editor_theme_icon(SNAME("ActionPaste")), ED_GET_SHORTCUT("property_editor/paste_value"), MENU_PASTE_VALUE);
- menu->add_icon_shortcut(get_editor_theme_icon(SNAME("CopyNodePath")), ED_GET_SHORTCUT("property_editor/copy_property_path"), MENU_COPY_PROPERTY_PATH);
- menu->set_item_disabled(MENU_PASTE_VALUE, is_read_only());
- if (!pin_hidden) {
- menu->add_separator();
- if (can_pin) {
- menu->add_icon_check_item(get_editor_theme_icon(SNAME("Pin")), TTR("Pin Value"), MENU_PIN_VALUE);
- menu->set_item_checked(menu->get_item_index(MENU_PIN_VALUE), pinned);
- } else {
- 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);
- menu->set_item_disabled(menu->get_item_index(MENU_PIN_VALUE), true);
- }
- 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."));
- }
- if (!doc_path.is_empty()) {
- menu->add_separator();
- menu->add_icon_item(get_editor_theme_icon(SNAME("Help")), TTR("Open Documentation"), MENU_OPEN_DOCUMENTATION);
- }
- }
- ////////////////////////////////////////////////
- ////////////////////////////////////////////////
- void EditorInspectorPlugin::add_custom_control(Control *control) {
- AddedEditor ae;
- ae.property_editor = control;
- added_editors.push_back(ae);
- }
- void EditorInspectorPlugin::add_property_editor(const String &p_for_property, Control *p_prop, bool p_add_to_end) {
- AddedEditor ae;
- ae.properties.push_back(p_for_property);
- ae.property_editor = p_prop;
- ae.add_to_end = p_add_to_end;
- added_editors.push_back(ae);
- }
- void EditorInspectorPlugin::add_property_editor_for_multiple_properties(const String &p_label, const Vector<String> &p_properties, Control *p_prop) {
- AddedEditor ae;
- ae.properties = p_properties;
- ae.property_editor = p_prop;
- ae.label = p_label;
- added_editors.push_back(ae);
- }
- bool EditorInspectorPlugin::can_handle(Object *p_object) {
- bool success = false;
- GDVIRTUAL_CALL(_can_handle, p_object, success);
- return success;
- }
- void EditorInspectorPlugin::parse_begin(Object *p_object) {
- GDVIRTUAL_CALL(_parse_begin, p_object);
- }
- void EditorInspectorPlugin::parse_category(Object *p_object, const String &p_category) {
- GDVIRTUAL_CALL(_parse_category, p_object, p_category);
- }
- void EditorInspectorPlugin::parse_group(Object *p_object, const String &p_group) {
- GDVIRTUAL_CALL(_parse_group, p_object, p_group);
- }
- 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) {
- bool ret = false;
- GDVIRTUAL_CALL(_parse_property, p_object, p_type, p_path, p_hint, p_hint_text, p_usage, p_wide, ret);
- return ret;
- }
- void EditorInspectorPlugin::parse_end(Object *p_object) {
- GDVIRTUAL_CALL(_parse_end, p_object);
- }
- void EditorInspectorPlugin::_bind_methods() {
- ClassDB::bind_method(D_METHOD("add_custom_control", "control"), &EditorInspectorPlugin::add_custom_control);
- ClassDB::bind_method(D_METHOD("add_property_editor", "property", "editor", "add_to_end"), &EditorInspectorPlugin::add_property_editor, DEFVAL(false));
- ClassDB::bind_method(D_METHOD("add_property_editor_for_multiple_properties", "label", "properties", "editor"), &EditorInspectorPlugin::add_property_editor_for_multiple_properties);
- GDVIRTUAL_BIND(_can_handle, "object")
- GDVIRTUAL_BIND(_parse_begin, "object")
- GDVIRTUAL_BIND(_parse_category, "object", "category")
- GDVIRTUAL_BIND(_parse_group, "object", "group")
- GDVIRTUAL_BIND(_parse_property, "object", "type", "name", "hint_type", "hint_string", "usage_flags", "wide");
- GDVIRTUAL_BIND(_parse_end, "object")
- }
- ////////////////////////////////////////////////
- ////////////////////////////////////////////////
- void EditorInspectorCategory::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_ENTER_TREE:
- case NOTIFICATION_THEME_CHANGED: {
- menu->set_item_icon(menu->get_item_index(MENU_OPEN_DOCS), get_editor_theme_icon(SNAME("Help")));
- } break;
- case NOTIFICATION_DRAW: {
- Ref<StyleBox> sb = get_theme_stylebox(SNAME("bg"));
- draw_style_box(sb, Rect2(Vector2(), get_size()));
- Ref<Font> font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
- int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts));
- int hs = get_theme_constant(SNAME("h_separation"), SNAME("Tree"));
- int icon_size = get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor));
- int w = font->get_string_size(label, HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width;
- if (icon.is_valid()) {
- w += hs + icon_size;
- }
- int ofs = (get_size().width - w) / 2;
- if (icon.is_valid()) {
- Size2 rect_size = Size2(icon_size, icon_size);
- Point2 rect_pos = Point2(ofs, (get_size().height - icon_size) / 2).floor();
- draw_texture_rect(icon, Rect2(rect_pos, rect_size));
- ofs += hs + icon_size;
- }
- Color color = get_theme_color(SNAME("font_color"), SNAME("Tree"));
- draw_string(font, Point2(ofs, font->get_ascent(font_size) + (get_size().height - font->get_height(font_size)) / 2).floor(), label, HORIZONTAL_ALIGNMENT_LEFT, get_size().width, font_size, color);
- } break;
- }
- }
- Control *EditorInspectorCategory::make_custom_tooltip(const String &p_text) const {
- return doc_class_name.is_empty() ? nullptr : memnew(EditorHelpTooltip(p_text));
- }
- Size2 EditorInspectorCategory::get_minimum_size() const {
- Ref<Font> font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
- int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts));
- Size2 ms;
- ms.height = font->get_height(font_size);
- if (icon.is_valid()) {
- int icon_size = get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor));
- ms.height = MAX(icon_size, ms.height);
- }
- ms.height += get_theme_constant(SNAME("v_separation"), SNAME("Tree"));
- return ms;
- }
- void EditorInspectorCategory::_handle_menu_option(int p_option) {
- switch (p_option) {
- case MENU_OPEN_DOCS:
- ScriptEditor::get_singleton()->goto_help("class:" + doc_class_name);
- EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT);
- break;
- }
- }
- void EditorInspectorCategory::gui_input(const Ref<InputEvent> &p_event) {
- if (doc_class_name.is_empty()) {
- return;
- }
- const Ref<InputEventMouseButton> &mb_event = p_event;
- if (mb_event.is_null() || !mb_event->is_pressed() || mb_event->get_button_index() != MouseButton::RIGHT) {
- return;
- }
- menu->set_item_disabled(menu->get_item_index(MENU_OPEN_DOCS), !EditorHelp::get_doc_data()->class_list.has(doc_class_name));
- menu->set_position(get_screen_position() + mb_event->get_position());
- menu->reset_size();
- menu->popup();
- }
- EditorInspectorCategory::EditorInspectorCategory() {
- menu = memnew(PopupMenu);
- menu->connect("id_pressed", callable_mp(this, &EditorInspectorCategory::_handle_menu_option));
- menu->add_item(TTR("Open Documentation"), MENU_OPEN_DOCS);
- add_child(menu);
- }
- ////////////////////////////////////////////////
- ////////////////////////////////////////////////
- void EditorInspectorSection::_test_unfold() {
- if (!vbox_added) {
- add_child(vbox);
- move_child(vbox, 0);
- vbox_added = true;
- }
- }
- Ref<Texture2D> EditorInspectorSection::_get_arrow() {
- Ref<Texture2D> arrow;
- if (foldable) {
- if (object->editor_is_section_unfolded(section)) {
- arrow = get_theme_icon(SNAME("arrow"), SNAME("Tree"));
- } else {
- if (is_layout_rtl()) {
- arrow = get_theme_icon(SNAME("arrow_collapsed_mirrored"), SNAME("Tree"));
- } else {
- arrow = get_theme_icon(SNAME("arrow_collapsed"), SNAME("Tree"));
- }
- }
- }
- return arrow;
- }
- int EditorInspectorSection::_get_header_height() {
- Ref<Font> font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
- int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts));
- int header_height = font->get_height(font_size);
- Ref<Texture2D> arrow = _get_arrow();
- if (arrow.is_valid()) {
- header_height = MAX(header_height, arrow->get_height());
- }
- header_height += get_theme_constant(SNAME("v_separation"), SNAME("Tree"));
- return header_height;
- }
- void EditorInspectorSection::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_THEME_CHANGED: {
- update_minimum_size();
- } break;
- case NOTIFICATION_SORT_CHILDREN: {
- if (!vbox_added) {
- return;
- }
- int inspector_margin = get_theme_constant(SNAME("inspector_margin"), EditorStringName(Editor));
- int section_indent_size = get_theme_constant(SNAME("indent_size"), SNAME("EditorInspectorSection"));
- if (indent_depth > 0 && section_indent_size > 0) {
- inspector_margin += indent_depth * section_indent_size;
- }
- Ref<StyleBoxFlat> section_indent_style = get_theme_stylebox(SNAME("indent_box"), SNAME("EditorInspectorSection"));
- if (indent_depth > 0 && section_indent_style.is_valid()) {
- inspector_margin += section_indent_style->get_margin(SIDE_LEFT) + section_indent_style->get_margin(SIDE_RIGHT);
- }
- Size2 size = get_size() - Vector2(inspector_margin, 0);
- int header_height = _get_header_height();
- Vector2 offset = Vector2(is_layout_rtl() ? 0 : inspector_margin, header_height);
- for (int i = 0; i < get_child_count(); i++) {
- Control *c = Object::cast_to<Control>(get_child(i));
- if (!c) {
- continue;
- }
- if (c->is_set_as_top_level()) {
- continue;
- }
- fit_child_in_rect(c, Rect2(offset, size));
- }
- } break;
- case NOTIFICATION_DRAW: {
- int section_indent = 0;
- int section_indent_size = get_theme_constant(SNAME("indent_size"), SNAME("EditorInspectorSection"));
- if (indent_depth > 0 && section_indent_size > 0) {
- section_indent = indent_depth * section_indent_size;
- }
- Ref<StyleBoxFlat> section_indent_style = get_theme_stylebox(SNAME("indent_box"), SNAME("EditorInspectorSection"));
- if (indent_depth > 0 && section_indent_style.is_valid()) {
- section_indent += section_indent_style->get_margin(SIDE_LEFT) + section_indent_style->get_margin(SIDE_RIGHT);
- }
- int header_width = get_size().width - section_indent;
- int header_offset_x = 0.0;
- bool rtl = is_layout_rtl();
- if (!rtl) {
- header_offset_x += section_indent;
- }
- // Draw header area.
- int header_height = _get_header_height();
- Rect2 header_rect = Rect2(Vector2(header_offset_x, 0.0), Vector2(header_width, header_height));
- Color c = bg_color;
- c.a *= 0.4;
- if (foldable && header_rect.has_point(get_local_mouse_position())) {
- c = c.lightened(Input::get_singleton()->is_mouse_button_pressed(MouseButton::LEFT) ? -0.05 : 0.2);
- }
- draw_rect(header_rect, c);
- // Draw header title, folding arrow and count of revertable properties.
- {
- int separation = Math::round(2 * EDSCALE);
- int margin_start = section_indent + separation;
- int margin_end = separation;
- // - Arrow.
- Ref<Texture2D> arrow = _get_arrow();
- if (arrow.is_valid()) {
- Point2 arrow_position;
- if (rtl) {
- arrow_position.x = get_size().width - (margin_start + arrow->get_width());
- } else {
- arrow_position.x = margin_start;
- }
- arrow_position.y = (header_height - arrow->get_height()) / 2;
- draw_texture(arrow, arrow_position);
- margin_start += arrow->get_width();
- }
- int available = get_size().width - (margin_start + margin_end);
- // - Count of revertable properties.
- String num_revertable_str;
- int num_revertable_width = 0;
- bool folded = foldable && !object->editor_is_section_unfolded(section);
- Ref<Font> font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
- int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts));
- Color font_color = get_theme_color(SNAME("font_color"), EditorStringName(Editor));
- if (folded && revertable_properties.size()) {
- int label_width = font->get_string_size(label, HORIZONTAL_ALIGNMENT_LEFT, available, font_size, TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_CONSTRAIN_ELLIPSIS).x;
- Ref<Font> light_font = get_theme_font(SNAME("main"), EditorStringName(EditorFonts));
- int light_font_size = get_theme_font_size(SNAME("main_size"), EditorStringName(EditorFonts));
- Color light_font_color = get_theme_color(SNAME("disabled_font_color"), EditorStringName(Editor));
- // Can we fit the long version of the revertable count text?
- num_revertable_str = vformat(TTRN("(%d change)", "(%d changes)", revertable_properties.size()), revertable_properties.size());
- num_revertable_width = light_font->get_string_size(num_revertable_str, HORIZONTAL_ALIGNMENT_LEFT, -1.0f, light_font_size, TextServer::JUSTIFICATION_NONE).x;
- if (label_width + separation + num_revertable_width > available) {
- // We'll have to use the short version.
- num_revertable_str = vformat("(%d)", revertable_properties.size());
- num_revertable_width = light_font->get_string_size(num_revertable_str, HORIZONTAL_ALIGNMENT_LEFT, -1.0f, light_font_size, TextServer::JUSTIFICATION_NONE).x;
- }
- Point2 text_offset = Point2(
- margin_end,
- light_font->get_ascent(light_font_size) + (header_height - light_font->get_height(light_font_size)) / 2);
- if (!rtl) {
- text_offset.x = get_size().width - (text_offset.x + num_revertable_width);
- }
- draw_string(light_font, text_offset, num_revertable_str, HORIZONTAL_ALIGNMENT_LEFT, -1.0f, light_font_size, light_font_color, TextServer::JUSTIFICATION_NONE);
- margin_end += num_revertable_width + separation;
- available -= num_revertable_width + separation;
- }
- // - Label.
- Point2 text_offset = Point2(
- margin_start,
- font->get_ascent(font_size) + (header_height - font->get_height(font_size)) / 2);
- if (rtl) {
- text_offset.x = margin_end;
- }
- HorizontalAlignment text_align = rtl ? HORIZONTAL_ALIGNMENT_RIGHT : HORIZONTAL_ALIGNMENT_LEFT;
- draw_string(font, text_offset, label, text_align, available, font_size, font_color, TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_CONSTRAIN_ELLIPSIS);
- }
- // Draw dropping highlight.
- if (dropping && !vbox->is_visible_in_tree()) {
- Color accent_color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor));
- draw_rect(Rect2(Point2(), get_size()), accent_color, false);
- }
- // Draw section indentation.
- if (section_indent_style.is_valid() && section_indent > 0) {
- Rect2 indent_rect = Rect2(Vector2(), Vector2(indent_depth * section_indent_size, get_size().height));
- if (rtl) {
- indent_rect.position.x = get_size().width - section_indent + section_indent_style->get_margin(SIDE_RIGHT);
- } else {
- indent_rect.position.x = section_indent_style->get_margin(SIDE_LEFT);
- }
- draw_style_box(section_indent_style, indent_rect);
- }
- } break;
- case NOTIFICATION_DRAG_BEGIN: {
- dropping_for_unfold = true;
- } break;
- case NOTIFICATION_DRAG_END: {
- dropping_for_unfold = false;
- } break;
- case NOTIFICATION_MOUSE_ENTER: {
- if (dropping || dropping_for_unfold) {
- dropping_unfold_timer->start();
- }
- queue_redraw();
- } break;
- case NOTIFICATION_MOUSE_EXIT: {
- if (dropping || dropping_for_unfold) {
- dropping_unfold_timer->stop();
- }
- queue_redraw();
- } break;
- }
- }
- Size2 EditorInspectorSection::get_minimum_size() const {
- Size2 ms;
- for (int i = 0; i < get_child_count(); i++) {
- Control *c = Object::cast_to<Control>(get_child(i));
- if (!c) {
- continue;
- }
- if (c->is_set_as_top_level()) {
- continue;
- }
- if (!c->is_visible()) {
- continue;
- }
- Size2 minsize = c->get_combined_minimum_size();
- ms.width = MAX(ms.width, minsize.width);
- ms.height = MAX(ms.height, minsize.height);
- }
- Ref<Font> font = get_theme_font(SNAME("font"), SNAME("Tree"));
- int font_size = get_theme_font_size(SNAME("font_size"), SNAME("Tree"));
- ms.height += font->get_height(font_size) + get_theme_constant(SNAME("v_separation"), SNAME("Tree"));
- ms.width += get_theme_constant(SNAME("inspector_margin"), EditorStringName(Editor));
- int section_indent_size = get_theme_constant(SNAME("indent_size"), SNAME("EditorInspectorSection"));
- if (indent_depth > 0 && section_indent_size > 0) {
- ms.width += indent_depth * section_indent_size;
- }
- Ref<StyleBoxFlat> section_indent_style = get_theme_stylebox(SNAME("indent_box"), SNAME("EditorInspectorSection"));
- if (indent_depth > 0 && section_indent_style.is_valid()) {
- ms.width += section_indent_style->get_margin(SIDE_LEFT) + section_indent_style->get_margin(SIDE_RIGHT);
- }
- return ms;
- }
- 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) {
- section = p_section;
- label = p_label;
- object = p_object;
- bg_color = p_bg_color;
- foldable = p_foldable;
- indent_depth = p_indent_depth;
- if (!foldable && !vbox_added) {
- add_child(vbox);
- move_child(vbox, 0);
- vbox_added = true;
- }
- if (foldable) {
- _test_unfold();
- if (object->editor_is_section_unfolded(section)) {
- vbox->show();
- } else {
- vbox->hide();
- }
- }
- }
- void EditorInspectorSection::gui_input(const Ref<InputEvent> &p_event) {
- ERR_FAIL_COND(p_event.is_null());
- if (!foldable) {
- return;
- }
- Ref<InputEventMouseButton> mb = p_event;
- if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == MouseButton::LEFT) {
- if (object->editor_is_section_unfolded(section)) {
- int header_height = _get_header_height();
- if (mb->get_position().y >= header_height) {
- return;
- }
- }
- accept_event();
- bool should_unfold = !object->editor_is_section_unfolded(section);
- if (should_unfold) {
- unfold();
- } else {
- fold();
- }
- } else if (mb.is_valid() && !mb->is_pressed()) {
- queue_redraw();
- }
- }
- VBoxContainer *EditorInspectorSection::get_vbox() {
- return vbox;
- }
- void EditorInspectorSection::unfold() {
- if (!foldable) {
- return;
- }
- _test_unfold();
- object->editor_set_section_unfold(section, true);
- vbox->show();
- queue_redraw();
- }
- void EditorInspectorSection::fold() {
- if (!foldable) {
- return;
- }
- if (!vbox_added) {
- return;
- }
- object->editor_set_section_unfold(section, false);
- vbox->hide();
- queue_redraw();
- }
- void EditorInspectorSection::set_bg_color(const Color &p_bg_color) {
- bg_color = p_bg_color;
- queue_redraw();
- }
- bool EditorInspectorSection::has_revertable_properties() const {
- return !revertable_properties.is_empty();
- }
- void EditorInspectorSection::property_can_revert_changed(const String &p_path, bool p_can_revert) {
- bool had_revertable_properties = has_revertable_properties();
- if (p_can_revert) {
- revertable_properties.insert(p_path);
- } else {
- revertable_properties.erase(p_path);
- }
- if (has_revertable_properties() != had_revertable_properties) {
- queue_redraw();
- }
- }
- void EditorInspectorSection::_bind_methods() {
- ClassDB::bind_method(D_METHOD("setup", "section", "label", "object", "bg_color", "foldable"), &EditorInspectorSection::setup);
- ClassDB::bind_method(D_METHOD("get_vbox"), &EditorInspectorSection::get_vbox);
- ClassDB::bind_method(D_METHOD("unfold"), &EditorInspectorSection::unfold);
- ClassDB::bind_method(D_METHOD("fold"), &EditorInspectorSection::fold);
- }
- EditorInspectorSection::EditorInspectorSection() {
- vbox = memnew(VBoxContainer);
- dropping_unfold_timer = memnew(Timer);
- dropping_unfold_timer->set_wait_time(0.6);
- dropping_unfold_timer->set_one_shot(true);
- add_child(dropping_unfold_timer);
- dropping_unfold_timer->connect("timeout", callable_mp(this, &EditorInspectorSection::unfold));
- }
- EditorInspectorSection::~EditorInspectorSection() {
- if (!vbox_added) {
- memdelete(vbox);
- }
- }
- ////////////////////////////////////////////////
- ////////////////////////////////////////////////
- int EditorInspectorArray::_get_array_count() {
- if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
- List<PropertyInfo> object_property_list;
- object->get_property_list(&object_property_list);
- return _extract_properties_as_array(object_property_list).size();
- } else if (mode == MODE_USE_COUNT_PROPERTY) {
- bool valid;
- int count_val = object->get(count_property, &valid);
- ERR_FAIL_COND_V_MSG(!valid, 0, vformat("%s is not a valid property to be used as array count.", count_property));
- return count_val;
- }
- return 0;
- }
- void EditorInspectorArray::_add_button_pressed() {
- _move_element(-1, -1);
- }
- void EditorInspectorArray::_paginator_page_changed(int p_page) {
- emit_signal("page_change_request", p_page);
- }
- void EditorInspectorArray::_rmb_popup_id_pressed(int p_id) {
- switch (p_id) {
- case OPTION_MOVE_UP:
- if (popup_array_index_pressed > 0) {
- _move_element(popup_array_index_pressed, popup_array_index_pressed - 1);
- }
- break;
- case OPTION_MOVE_DOWN:
- if (popup_array_index_pressed < count - 1) {
- _move_element(popup_array_index_pressed, popup_array_index_pressed + 2);
- }
- break;
- case OPTION_NEW_BEFORE:
- _move_element(-1, popup_array_index_pressed);
- break;
- case OPTION_NEW_AFTER:
- _move_element(-1, popup_array_index_pressed + 1);
- break;
- case OPTION_REMOVE:
- _move_element(popup_array_index_pressed, -1);
- break;
- case OPTION_CLEAR_ARRAY:
- _clear_array();
- break;
- case OPTION_RESIZE_ARRAY:
- new_size_spin_box->set_value(count);
- resize_dialog->get_ok_button()->set_disabled(true);
- resize_dialog->popup_centered(Size2(250, 0) * EDSCALE);
- new_size_spin_box->get_line_edit()->grab_focus();
- new_size_spin_box->get_line_edit()->select_all();
- break;
- default:
- break;
- }
- }
- void EditorInspectorArray::_control_dropping_draw() {
- int drop_position = _drop_position();
- if (dropping && drop_position >= 0) {
- Vector2 from;
- Vector2 to;
- if (drop_position < elements_vbox->get_child_count()) {
- Transform2D xform = Object::cast_to<Control>(elements_vbox->get_child(drop_position))->get_transform();
- from = xform.xform(Vector2());
- to = xform.xform(Vector2(elements_vbox->get_size().x, 0));
- } else {
- Control *child = Object::cast_to<Control>(elements_vbox->get_child(drop_position - 1));
- Transform2D xform = child->get_transform();
- from = xform.xform(Vector2(0, child->get_size().y));
- to = xform.xform(Vector2(elements_vbox->get_size().x, child->get_size().y));
- }
- Color color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor));
- control_dropping->draw_line(from, to, color, 2);
- }
- }
- void EditorInspectorArray::_vbox_visibility_changed() {
- control_dropping->set_visible(vbox->is_visible_in_tree());
- }
- void EditorInspectorArray::_panel_draw(int p_index) {
- ERR_FAIL_INDEX(p_index, (int)array_elements.size());
- Ref<StyleBox> style = get_theme_stylebox(SNAME("Focus"), EditorStringName(EditorStyles));
- if (!style.is_valid()) {
- return;
- }
- if (array_elements[p_index].panel->has_focus()) {
- array_elements[p_index].panel->draw_style_box(style, Rect2(Vector2(), array_elements[p_index].panel->get_size()));
- }
- }
- void EditorInspectorArray::_panel_gui_input(Ref<InputEvent> p_event, int p_index) {
- ERR_FAIL_INDEX(p_index, (int)array_elements.size());
- if (read_only) {
- return;
- }
- Ref<InputEventKey> key_ref = p_event;
- if (key_ref.is_valid()) {
- const InputEventKey &key = **key_ref;
- if (array_elements[p_index].panel->has_focus() && key.is_pressed() && key.get_keycode() == Key::KEY_DELETE) {
- _move_element(begin_array_index + p_index, -1);
- array_elements[p_index].panel->accept_event();
- }
- }
- Ref<InputEventMouseButton> mb = p_event;
- if (mb.is_valid()) {
- if (movable && mb->get_button_index() == MouseButton::RIGHT) {
- array_elements[p_index].panel->accept_event();
- popup_array_index_pressed = begin_array_index + p_index;
- rmb_popup->set_item_disabled(OPTION_MOVE_UP, popup_array_index_pressed == 0);
- rmb_popup->set_item_disabled(OPTION_MOVE_DOWN, popup_array_index_pressed == count - 1);
- rmb_popup->set_position(get_screen_position() + mb->get_position());
- rmb_popup->reset_size();
- rmb_popup->popup();
- }
- }
- }
- void EditorInspectorArray::_move_element(int p_element_index, int p_to_pos) {
- String action_name;
- if (p_element_index < 0) {
- action_name = vformat(TTR("Add element to property array with prefix %s."), array_element_prefix);
- } else if (p_to_pos < 0) {
- action_name = vformat(TTR("Remove element %d from property array with prefix %s."), p_element_index, array_element_prefix);
- } else {
- 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);
- }
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(action_name);
- if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
- // Call the function.
- Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name());
- if (move_function.is_valid()) {
- move_function.call(undo_redo, object, array_element_prefix, p_element_index, p_to_pos);
- } else {
- 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()));
- }
- } else if (mode == MODE_USE_COUNT_PROPERTY) {
- ERR_FAIL_COND(p_to_pos < -1 || p_to_pos > count);
- if (!swap_method.is_empty()) {
- ERR_FAIL_COND(!object->has_method(swap_method));
- // Swap method was provided, use it.
- if (p_element_index < 0) {
- // Add an element at position
- undo_redo->add_do_property(object, count_property, count + 1);
- if (p_to_pos >= 0) {
- for (int i = count; i > p_to_pos; i--) {
- undo_redo->add_do_method(object, swap_method, i, i - 1);
- }
- for (int i = p_to_pos; i < count; i++) {
- undo_redo->add_undo_method(object, swap_method, i, i + 1);
- }
- }
- undo_redo->add_undo_property(object, count_property, count);
- } else if (p_to_pos < 0) {
- if (count > 0) {
- // Remove element at position
- undo_redo->add_undo_property(object, count_property, count);
- List<PropertyInfo> object_property_list;
- object->get_property_list(&object_property_list);
- for (int i = p_element_index; i < count - 1; i++) {
- undo_redo->add_do_method(object, swap_method, i, i + 1);
- }
- for (int i = count; i > p_element_index; i--) {
- undo_redo->add_undo_method(object, swap_method, i, i - 1);
- }
- String erase_prefix = String(array_element_prefix) + itos(p_element_index);
- for (const PropertyInfo &E : object_property_list) {
- if (E.name.begins_with(erase_prefix)) {
- undo_redo->add_undo_property(object, E.name, object->get(E.name));
- }
- }
- undo_redo->add_do_property(object, count_property, count - 1);
- }
- } else {
- if (p_to_pos > p_element_index) {
- p_to_pos--;
- }
- if (p_to_pos < p_element_index) {
- for (int i = p_element_index; i > p_to_pos; i--) {
- undo_redo->add_do_method(object, swap_method, i, i - 1);
- }
- for (int i = p_to_pos; i < p_element_index; i++) {
- undo_redo->add_undo_method(object, swap_method, i, i + 1);
- }
- } else if (p_to_pos > p_element_index) {
- for (int i = p_element_index; i < p_to_pos; i++) {
- undo_redo->add_do_method(object, swap_method, i, i + 1);
- }
- for (int i = p_to_pos; i > p_element_index; i--) {
- undo_redo->add_undo_method(object, swap_method, i, i - 1);
- }
- }
- }
- } else {
- // Use standard properties.
- List<PropertyInfo> object_property_list;
- object->get_property_list(&object_property_list);
- Array properties_as_array = _extract_properties_as_array(object_property_list);
- properties_as_array.resize(count);
- // For undoing things
- undo_redo->add_undo_property(object, count_property, properties_as_array.size());
- for (int i = 0; i < (int)properties_as_array.size(); i++) {
- Dictionary d = Dictionary(properties_as_array[i]);
- Array keys = d.keys();
- for (int j = 0; j < keys.size(); j++) {
- String key = keys[j];
- undo_redo->add_undo_property(object, vformat(key, i), d[key]);
- }
- }
- if (p_element_index < 0) {
- // Add an element.
- properties_as_array.insert(p_to_pos < 0 ? properties_as_array.size() : p_to_pos, Dictionary());
- } else if (p_to_pos < 0) {
- // Delete the element.
- properties_as_array.remove_at(p_element_index);
- } else {
- // Move the element.
- properties_as_array.insert(p_to_pos, properties_as_array[p_element_index].duplicate());
- properties_as_array.remove_at(p_to_pos < p_element_index ? p_element_index + 1 : p_element_index);
- }
- // Change the array size then set the properties.
- undo_redo->add_do_property(object, count_property, properties_as_array.size());
- for (int i = 0; i < (int)properties_as_array.size(); i++) {
- Dictionary d = properties_as_array[i];
- Array keys = d.keys();
- for (int j = 0; j < keys.size(); j++) {
- String key = keys[j];
- undo_redo->add_do_property(object, vformat(key, i), d[key]);
- }
- }
- }
- }
- undo_redo->commit_action();
- // Handle page change and update counts.
- if (p_element_index < 0) {
- int added_index = p_to_pos < 0 ? count : p_to_pos;
- emit_signal(SNAME("page_change_request"), added_index / page_length);
- count += 1;
- } else if (p_to_pos < 0) {
- count -= 1;
- if (page == max_page && (MAX(0, count - 1) / page_length != max_page)) {
- emit_signal(SNAME("page_change_request"), max_page - 1);
- }
- } else if (p_to_pos == begin_array_index - 1) {
- emit_signal(SNAME("page_change_request"), page - 1);
- } else if (p_to_pos > end_array_index) {
- emit_signal(SNAME("page_change_request"), page + 1);
- }
- begin_array_index = page * page_length;
- end_array_index = MIN(count, (page + 1) * page_length);
- max_page = MAX(0, count - 1) / page_length;
- }
- void EditorInspectorArray::_clear_array() {
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Clear Property Array with Prefix %s"), array_element_prefix));
- if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
- for (int i = count - 1; i >= 0; i--) {
- // Call the function.
- Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name());
- if (move_function.is_valid()) {
- move_function.call(undo_redo, object, array_element_prefix, i, -1);
- } else {
- 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()));
- }
- }
- } else if (mode == MODE_USE_COUNT_PROPERTY) {
- List<PropertyInfo> object_property_list;
- object->get_property_list(&object_property_list);
- Array properties_as_array = _extract_properties_as_array(object_property_list);
- properties_as_array.resize(count);
- // For undoing things
- undo_redo->add_undo_property(object, count_property, count);
- for (int i = 0; i < (int)properties_as_array.size(); i++) {
- Dictionary d = Dictionary(properties_as_array[i]);
- Array keys = d.keys();
- for (int j = 0; j < keys.size(); j++) {
- String key = keys[j];
- undo_redo->add_undo_property(object, vformat(key, i), d[key]);
- }
- }
- // Change the array size then set the properties.
- undo_redo->add_do_property(object, count_property, 0);
- }
- undo_redo->commit_action();
- // Handle page change and update counts.
- emit_signal(SNAME("page_change_request"), 0);
- count = 0;
- begin_array_index = 0;
- end_array_index = 0;
- max_page = 0;
- }
- void EditorInspectorArray::_resize_array(int p_size) {
- ERR_FAIL_COND(p_size < 0);
- if (p_size == count) {
- return;
- }
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Resize Property Array with Prefix %s"), array_element_prefix));
- if (p_size > count) {
- if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
- for (int i = count; i < p_size; i++) {
- // Call the function.
- Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name());
- if (move_function.is_valid()) {
- move_function.call(undo_redo, object, array_element_prefix, -1, -1);
- } else {
- 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()));
- }
- }
- } else if (mode == MODE_USE_COUNT_PROPERTY) {
- undo_redo->add_undo_property(object, count_property, count);
- undo_redo->add_do_property(object, count_property, p_size);
- }
- } else {
- if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) {
- for (int i = count - 1; i > p_size - 1; i--) {
- // Call the function.
- Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name());
- if (move_function.is_valid()) {
- move_function.call(undo_redo, object, array_element_prefix, i, -1);
- } else {
- 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()));
- }
- }
- } else if (mode == MODE_USE_COUNT_PROPERTY) {
- List<PropertyInfo> object_property_list;
- object->get_property_list(&object_property_list);
- Array properties_as_array = _extract_properties_as_array(object_property_list);
- properties_as_array.resize(count);
- // For undoing things
- undo_redo->add_undo_property(object, count_property, count);
- for (int i = count - 1; i > p_size - 1; i--) {
- Dictionary d = Dictionary(properties_as_array[i]);
- Array keys = d.keys();
- for (int j = 0; j < keys.size(); j++) {
- String key = keys[j];
- undo_redo->add_undo_property(object, vformat(key, i), d[key]);
- }
- }
- // Change the array size then set the properties.
- undo_redo->add_do_property(object, count_property, p_size);
- }
- }
- undo_redo->commit_action();
- // Handle page change and update counts.
- emit_signal(SNAME("page_change_request"), 0);
- /*
- count = 0;
- begin_array_index = 0;
- end_array_index = 0;
- max_page = 0;
- */
- }
- Array EditorInspectorArray::_extract_properties_as_array(const List<PropertyInfo> &p_list) {
- Array output;
- for (const PropertyInfo &pi : p_list) {
- if (pi.name.begins_with(array_element_prefix)) {
- String str = pi.name.trim_prefix(array_element_prefix);
- int to_char_index = 0;
- while (to_char_index < str.length()) {
- if (!is_digit(str[to_char_index])) {
- break;
- }
- to_char_index++;
- }
- if (to_char_index > 0) {
- int array_index = str.left(to_char_index).to_int();
- Error error = OK;
- if (array_index >= output.size()) {
- error = output.resize(array_index + 1);
- }
- if (error == OK) {
- String format_string = String(array_element_prefix) + "%d" + str.substr(to_char_index);
- Dictionary dict = output[array_index];
- dict[format_string] = object->get(pi.name);
- output[array_index] = dict;
- } else {
- WARN_PRINT(vformat("Array element %s has an index too high. Array allocation failed.", pi.name));
- }
- }
- }
- }
- return output;
- }
- int EditorInspectorArray::_drop_position() const {
- for (int i = 0; i < (int)array_elements.size(); i++) {
- const ArrayElement &ae = array_elements[i];
- Size2 size = ae.panel->get_size();
- Vector2 mp = ae.panel->get_local_mouse_position();
- if (Rect2(Vector2(), size).has_point(mp)) {
- if (mp.y < size.y / 2) {
- return i;
- } else {
- return i + 1;
- }
- }
- }
- return -1;
- }
- void EditorInspectorArray::_resize_dialog_confirmed() {
- if (int(new_size_spin_box->get_value()) == count) {
- return;
- }
- resize_dialog->hide();
- _resize_array(int(new_size_spin_box->get_value()));
- }
- void EditorInspectorArray::_new_size_spin_box_value_changed(float p_value) {
- resize_dialog->get_ok_button()->set_disabled(int(p_value) == count);
- }
- void EditorInspectorArray::_new_size_spin_box_text_submitted(String p_text) {
- _resize_dialog_confirmed();
- }
- void EditorInspectorArray::_setup() {
- // Setup counts.
- count = _get_array_count();
- begin_array_index = page * page_length;
- end_array_index = MIN(count, (page + 1) * page_length);
- max_page = MAX(0, count - 1) / page_length;
- array_elements.resize(MAX(0, end_array_index - begin_array_index));
- if (page < 0 || page > max_page) {
- WARN_PRINT(vformat("Invalid page number %d", page));
- page = CLAMP(page, 0, max_page);
- }
- Ref<Font> numbers_font;
- int numbers_min_w = 0;
- if (numbered) {
- numbers_font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts));
- int digits_found = count;
- String test;
- while (digits_found) {
- test += "8";
- digits_found /= 10;
- }
- numbers_min_w = numbers_font->get_string_size(test).width;
- }
- for (int i = 0; i < (int)array_elements.size(); i++) {
- ArrayElement &ae = array_elements[i];
- // Panel and its hbox.
- ae.panel = memnew(PanelContainer);
- ae.panel->set_focus_mode(FOCUS_ALL);
- ae.panel->set_mouse_filter(MOUSE_FILTER_PASS);
- SET_DRAG_FORWARDING_GCD(ae.panel, EditorInspectorArray);
- int element_position = begin_array_index + i;
- ae.panel->set_meta("index", element_position);
- ae.panel->set_tooltip_text(vformat(TTR("Element %d: %s%d*"), element_position, array_element_prefix, element_position));
- ae.panel->connect("focus_entered", callable_mp((CanvasItem *)ae.panel, &PanelContainer::queue_redraw));
- ae.panel->connect("focus_exited", callable_mp((CanvasItem *)ae.panel, &PanelContainer::queue_redraw));
- ae.panel->connect("draw", callable_mp(this, &EditorInspectorArray::_panel_draw).bind(i));
- ae.panel->connect("gui_input", callable_mp(this, &EditorInspectorArray::_panel_gui_input).bind(i));
- ae.panel->add_theme_style_override(SNAME("panel"), i % 2 ? odd_style : even_style);
- elements_vbox->add_child(ae.panel);
- ae.margin = memnew(MarginContainer);
- ae.margin->set_mouse_filter(MOUSE_FILTER_PASS);
- if (is_inside_tree()) {
- Size2 min_size = get_theme_stylebox(SNAME("Focus"), EditorStringName(EditorStyles))->get_minimum_size();
- ae.margin->begin_bulk_theme_override();
- ae.margin->add_theme_constant_override("margin_left", min_size.x / 2);
- ae.margin->add_theme_constant_override("margin_top", min_size.y / 2);
- ae.margin->add_theme_constant_override("margin_right", min_size.x / 2);
- ae.margin->add_theme_constant_override("margin_bottom", min_size.y / 2);
- ae.margin->end_bulk_theme_override();
- }
- ae.panel->add_child(ae.margin);
- ae.hbox = memnew(HBoxContainer);
- ae.hbox->set_h_size_flags(SIZE_EXPAND_FILL);
- ae.hbox->set_v_size_flags(SIZE_EXPAND_FILL);
- ae.margin->add_child(ae.hbox);
- // Move button.
- if (movable) {
- VBoxContainer *move_vbox = memnew(VBoxContainer);
- move_vbox->set_v_size_flags(SIZE_EXPAND_FILL);
- move_vbox->set_alignment(BoxContainer::ALIGNMENT_CENTER);
- ae.hbox->add_child(move_vbox);
- if (element_position > 0) {
- ae.move_up = memnew(Button);
- ae.move_up->set_icon(get_editor_theme_icon(SNAME("MoveUp")));
- ae.move_up->connect("pressed", callable_mp(this, &EditorInspectorArray::_move_element).bind(element_position, element_position - 1));
- move_vbox->add_child(ae.move_up);
- }
- ae.move_texture_rect = memnew(TextureRect);
- ae.move_texture_rect->set_stretch_mode(TextureRect::STRETCH_KEEP_CENTERED);
- ae.move_texture_rect->set_default_cursor_shape(Control::CURSOR_MOVE);
- if (is_inside_tree()) {
- ae.move_texture_rect->set_texture(get_editor_theme_icon(SNAME("TripleBar")));
- }
- move_vbox->add_child(ae.move_texture_rect);
- if (element_position < _get_array_count() - 1) {
- ae.move_down = memnew(Button);
- ae.move_down->set_icon(get_editor_theme_icon(SNAME("MoveDown")));
- ae.move_down->connect("pressed", callable_mp(this, &EditorInspectorArray::_move_element).bind(element_position, element_position + 2));
- move_vbox->add_child(ae.move_down);
- }
- }
- if (numbered) {
- ae.number = memnew(Label);
- ae.number->add_theme_font_override("font", numbers_font);
- ae.number->set_custom_minimum_size(Size2(numbers_min_w, 0));
- ae.number->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT);
- ae.number->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER);
- ae.number->set_text(itos(element_position));
- ae.hbox->add_child(ae.number);
- }
- // Right vbox.
- ae.vbox = memnew(VBoxContainer);
- ae.vbox->set_h_size_flags(SIZE_EXPAND_FILL);
- ae.vbox->set_v_size_flags(SIZE_EXPAND_FILL);
- ae.hbox->add_child(ae.vbox);
- ae.erase = memnew(Button);
- ae.erase->set_icon(get_editor_theme_icon(SNAME("Remove")));
- ae.erase->set_v_size_flags(SIZE_SHRINK_CENTER);
- ae.erase->connect("pressed", callable_mp(this, &EditorInspectorArray::_remove_item).bind(element_position));
- ae.hbox->add_child(ae.erase);
- }
- // Hide/show the add button.
- add_button->set_visible(page == max_page);
- // Add paginator if there's more than 1 page.
- if (max_page > 0) {
- EditorPaginator *paginator = memnew(EditorPaginator);
- paginator->update(page, max_page);
- paginator->connect("page_changed", callable_mp(this, &EditorInspectorArray::_paginator_page_changed));
- vbox->add_child(paginator);
- }
- }
- void EditorInspectorArray::_remove_item(int p_index) {
- _move_element(p_index, -1);
- }
- Variant EditorInspectorArray::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
- if (!movable) {
- return Variant();
- }
- int index = p_from->get_meta("index");
- Dictionary dict;
- dict["type"] = "property_array_element";
- dict["property_array_prefix"] = array_element_prefix;
- dict["index"] = index;
- return dict;
- }
- void EditorInspectorArray::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
- Dictionary dict = p_data;
- int to_drop = dict["index"];
- int drop_position = _drop_position();
- if (drop_position < 0) {
- return;
- }
- _move_element(to_drop, begin_array_index + drop_position);
- }
- bool EditorInspectorArray::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
- if (!movable || read_only) {
- return false;
- }
- // First, update drawing.
- control_dropping->queue_redraw();
- if (p_data.get_type() != Variant::DICTIONARY) {
- return false;
- }
- Dictionary dict = p_data;
- int drop_position = _drop_position();
- if (!dict.has("type") || dict["type"] != "property_array_element" || String(dict["property_array_prefix"]) != array_element_prefix || drop_position < 0) {
- return false;
- }
- // Check in dropping at the given index does indeed move the item.
- int moved_array_index = (int)dict["index"];
- int drop_array_index = begin_array_index + drop_position;
- return drop_array_index != moved_array_index && drop_array_index - 1 != moved_array_index;
- }
- void EditorInspectorArray::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_ENTER_TREE:
- case NOTIFICATION_THEME_CHANGED: {
- Color color = get_theme_color(SNAME("dark_color_1"), EditorStringName(Editor));
- odd_style->set_bg_color(color.darkened(-0.08));
- even_style->set_bg_color(color.darkened(0.08));
- for (ArrayElement &ae : array_elements) {
- if (ae.move_texture_rect) {
- ae.move_texture_rect->set_texture(get_editor_theme_icon(SNAME("TripleBar")));
- }
- if (ae.move_up) {
- ae.move_up->set_icon(get_editor_theme_icon(SNAME("MoveUp")));
- }
- if (ae.move_down) {
- ae.move_down->set_icon(get_editor_theme_icon(SNAME("MoveDown")));
- }
- Size2 min_size = get_theme_stylebox(SNAME("Focus"), EditorStringName(EditorStyles))->get_minimum_size();
- ae.margin->begin_bulk_theme_override();
- ae.margin->add_theme_constant_override("margin_left", min_size.x / 2);
- ae.margin->add_theme_constant_override("margin_top", min_size.y / 2);
- ae.margin->add_theme_constant_override("margin_right", min_size.x / 2);
- ae.margin->add_theme_constant_override("margin_bottom", min_size.y / 2);
- ae.margin->end_bulk_theme_override();
- if (ae.erase) {
- ae.erase->set_icon(get_editor_theme_icon(SNAME("Remove")));
- }
- }
- add_button->set_icon(get_editor_theme_icon(SNAME("Add")));
- update_minimum_size();
- } break;
- case NOTIFICATION_DRAG_BEGIN: {
- Dictionary dict = get_viewport()->gui_get_drag_data();
- if (dict.has("type") && dict["type"] == "property_array_element" && String(dict["property_array_prefix"]) == array_element_prefix) {
- dropping = true;
- control_dropping->queue_redraw();
- }
- } break;
- case NOTIFICATION_DRAG_END: {
- if (dropping) {
- dropping = false;
- control_dropping->queue_redraw();
- }
- } break;
- }
- }
- void EditorInspectorArray::_bind_methods() {
- ADD_SIGNAL(MethodInfo("page_change_request"));
- }
- void EditorInspectorArray::setup_with_move_element_function(Object *p_object, 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) {
- count_property = "";
- mode = MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION;
- array_element_prefix = p_array_element_prefix;
- page = p_page;
- movable = p_movable;
- page_length = p_page_length;
- numbered = p_numbered;
- EditorInspectorSection::setup(String(p_array_element_prefix) + "_array", p_label, p_object, p_bg_color, p_foldable, 0);
- _setup();
- }
- void EditorInspectorArray::setup_with_count_property(Object *p_object, 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) {
- count_property = p_count_property;
- mode = MODE_USE_COUNT_PROPERTY;
- array_element_prefix = p_array_element_prefix;
- page = p_page;
- movable = p_movable;
- page_length = p_page_length;
- numbered = p_numbered;
- swap_method = p_swap_method;
- add_button->set_text(p_add_item_text);
- EditorInspectorSection::setup(String(count_property) + "_array", p_label, p_object, p_bg_color, p_foldable, 0);
- _setup();
- }
- VBoxContainer *EditorInspectorArray::get_vbox(int p_index) {
- if (p_index >= begin_array_index && p_index < end_array_index) {
- return array_elements[p_index - begin_array_index].vbox;
- } else if (p_index < 0) {
- return vbox;
- } else {
- return nullptr;
- }
- }
- EditorInspectorArray::EditorInspectorArray(bool p_read_only) {
- read_only = p_read_only;
- set_mouse_filter(Control::MOUSE_FILTER_STOP);
- odd_style.instantiate();
- even_style.instantiate();
- rmb_popup = memnew(PopupMenu);
- rmb_popup->add_item(TTR("Move Up"), OPTION_MOVE_UP);
- rmb_popup->add_item(TTR("Move Down"), OPTION_MOVE_DOWN);
- rmb_popup->add_separator();
- rmb_popup->add_item(TTR("Insert New Before"), OPTION_NEW_BEFORE);
- rmb_popup->add_item(TTR("Insert New After"), OPTION_NEW_AFTER);
- rmb_popup->add_separator();
- rmb_popup->add_item(TTR("Remove"), OPTION_REMOVE);
- rmb_popup->add_separator();
- rmb_popup->add_item(TTR("Clear Array"), OPTION_CLEAR_ARRAY);
- rmb_popup->add_item(TTR("Resize Array..."), OPTION_RESIZE_ARRAY);
- rmb_popup->connect("id_pressed", callable_mp(this, &EditorInspectorArray::_rmb_popup_id_pressed));
- add_child(rmb_popup);
- elements_vbox = memnew(VBoxContainer);
- elements_vbox->add_theme_constant_override("separation", 0);
- vbox->add_child(elements_vbox);
- add_button = EditorInspector::create_inspector_action_button(TTR("Add Element"));
- add_button->connect("pressed", callable_mp(this, &EditorInspectorArray::_add_button_pressed));
- add_button->set_disabled(read_only);
- vbox->add_child(add_button);
- control_dropping = memnew(Control);
- control_dropping->connect("draw", callable_mp(this, &EditorInspectorArray::_control_dropping_draw));
- control_dropping->set_mouse_filter(Control::MOUSE_FILTER_IGNORE);
- add_child(control_dropping);
- resize_dialog = memnew(AcceptDialog);
- resize_dialog->set_title(TTRC("Resize Array"));
- resize_dialog->add_cancel_button();
- resize_dialog->connect("confirmed", callable_mp(this, &EditorInspectorArray::_resize_dialog_confirmed));
- add_child(resize_dialog);
- VBoxContainer *resize_dialog_vbox = memnew(VBoxContainer);
- resize_dialog->add_child(resize_dialog_vbox);
- new_size_spin_box = memnew(SpinBox);
- new_size_spin_box->set_max(16384);
- new_size_spin_box->connect("value_changed", callable_mp(this, &EditorInspectorArray::_new_size_spin_box_value_changed));
- new_size_spin_box->get_line_edit()->connect("text_submitted", callable_mp(this, &EditorInspectorArray::_new_size_spin_box_text_submitted));
- new_size_spin_box->set_editable(!read_only);
- resize_dialog_vbox->add_margin_child(TTRC("New Size:"), new_size_spin_box);
- vbox->connect("visibility_changed", callable_mp(this, &EditorInspectorArray::_vbox_visibility_changed));
- }
- ////////////////////////////////////////////////
- ////////////////////////////////////////////////
- void EditorPaginator::_first_page_button_pressed() {
- emit_signal("page_changed", 0);
- }
- void EditorPaginator::_prev_page_button_pressed() {
- emit_signal("page_changed", MAX(0, page - 1));
- }
- void EditorPaginator::_page_line_edit_text_submitted(String p_text) {
- if (p_text.is_valid_int()) {
- int new_page = p_text.to_int() - 1;
- new_page = MIN(MAX(0, new_page), max_page);
- page_line_edit->set_text(Variant(new_page));
- emit_signal("page_changed", new_page);
- } else {
- page_line_edit->set_text(Variant(page));
- }
- }
- void EditorPaginator::_next_page_button_pressed() {
- emit_signal("page_changed", MIN(max_page, page + 1));
- }
- void EditorPaginator::_last_page_button_pressed() {
- emit_signal("page_changed", max_page);
- }
- void EditorPaginator::update(int p_page, int p_max_page) {
- page = p_page;
- max_page = p_max_page;
- // Update buttons.
- first_page_button->set_disabled(page == 0);
- prev_page_button->set_disabled(page == 0);
- next_page_button->set_disabled(page == max_page);
- last_page_button->set_disabled(page == max_page);
- // Update page number and page count.
- page_line_edit->set_text(vformat("%d", page + 1));
- page_count_label->set_text(vformat("/ %d", max_page + 1));
- }
- void EditorPaginator::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_ENTER_TREE:
- case NOTIFICATION_THEME_CHANGED: {
- first_page_button->set_icon(get_editor_theme_icon(SNAME("PageFirst")));
- prev_page_button->set_icon(get_editor_theme_icon(SNAME("PagePrevious")));
- next_page_button->set_icon(get_editor_theme_icon(SNAME("PageNext")));
- last_page_button->set_icon(get_editor_theme_icon(SNAME("PageLast")));
- } break;
- }
- }
- void EditorPaginator::_bind_methods() {
- ADD_SIGNAL(MethodInfo("page_changed", PropertyInfo(Variant::INT, "page")));
- }
- EditorPaginator::EditorPaginator() {
- set_h_size_flags(SIZE_EXPAND_FILL);
- set_alignment(ALIGNMENT_CENTER);
- first_page_button = memnew(Button);
- first_page_button->set_flat(true);
- first_page_button->connect("pressed", callable_mp(this, &EditorPaginator::_first_page_button_pressed));
- add_child(first_page_button);
- prev_page_button = memnew(Button);
- prev_page_button->set_flat(true);
- prev_page_button->connect("pressed", callable_mp(this, &EditorPaginator::_prev_page_button_pressed));
- add_child(prev_page_button);
- page_line_edit = memnew(LineEdit);
- page_line_edit->connect("text_submitted", callable_mp(this, &EditorPaginator::_page_line_edit_text_submitted));
- page_line_edit->add_theme_constant_override("minimum_character_width", 2);
- add_child(page_line_edit);
- page_count_label = memnew(Label);
- add_child(page_count_label);
- next_page_button = memnew(Button);
- next_page_button->set_flat(true);
- next_page_button->connect("pressed", callable_mp(this, &EditorPaginator::_next_page_button_pressed));
- add_child(next_page_button);
- last_page_button = memnew(Button);
- last_page_button->set_flat(true);
- last_page_button->connect("pressed", callable_mp(this, &EditorPaginator::_last_page_button_pressed));
- add_child(last_page_button);
- }
- ////////////////////////////////////////////////
- ////////////////////////////////////////////////
- Ref<EditorInspectorPlugin> EditorInspector::inspector_plugins[MAX_PLUGINS];
- int EditorInspector::inspector_plugin_count = 0;
- 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) {
- for (int i = inspector_plugin_count - 1; i >= 0; i--) {
- inspector_plugins[i]->parse_property(p_object, p_type, p_path, p_hint, p_hint_text, p_usage, p_wide);
- if (inspector_plugins[i]->added_editors.size()) {
- for (int j = 1; j < inspector_plugins[i]->added_editors.size(); j++) { //only keep first one
- memdelete(inspector_plugins[i]->added_editors[j].property_editor);
- }
- EditorProperty *prop = Object::cast_to<EditorProperty>(inspector_plugins[i]->added_editors[0].property_editor);
- if (prop) {
- inspector_plugins[i]->added_editors.clear();
- return prop;
- } else {
- memdelete(inspector_plugins[i]->added_editors[0].property_editor);
- inspector_plugins[i]->added_editors.clear();
- }
- }
- }
- return nullptr;
- }
- void EditorInspector::add_inspector_plugin(const Ref<EditorInspectorPlugin> &p_plugin) {
- ERR_FAIL_COND(inspector_plugin_count == MAX_PLUGINS);
- for (int i = 0; i < inspector_plugin_count; i++) {
- if (inspector_plugins[i] == p_plugin) {
- return; //already exists
- }
- }
- inspector_plugins[inspector_plugin_count++] = p_plugin;
- }
- void EditorInspector::remove_inspector_plugin(const Ref<EditorInspectorPlugin> &p_plugin) {
- ERR_FAIL_COND(inspector_plugin_count == MAX_PLUGINS);
- int idx = -1;
- for (int i = 0; i < inspector_plugin_count; i++) {
- if (inspector_plugins[i] == p_plugin) {
- idx = i;
- break;
- }
- }
- ERR_FAIL_COND_MSG(idx == -1, "Trying to remove nonexistent inspector plugin.");
- for (int i = idx; i < inspector_plugin_count - 1; i++) {
- inspector_plugins[i] = inspector_plugins[i + 1];
- }
- inspector_plugins[inspector_plugin_count - 1] = Ref<EditorInspectorPlugin>();
- inspector_plugin_count--;
- }
- void EditorInspector::cleanup_plugins() {
- for (int i = 0; i < inspector_plugin_count; i++) {
- inspector_plugins[i].unref();
- }
- inspector_plugin_count = 0;
- }
- Button *EditorInspector::create_inspector_action_button(const String &p_text) {
- Button *button = memnew(Button);
- button->set_text(p_text);
- button->set_theme_type_variation(SNAME("InspectorActionButton"));
- button->set_h_size_flags(SIZE_SHRINK_CENTER);
- return button;
- }
- bool EditorInspector::is_main_editor_inspector() const {
- return InspectorDock::get_singleton() && InspectorDock::get_inspector_singleton() == this;
- }
- String EditorInspector::get_selected_path() const {
- return property_selected;
- }
- void EditorInspector::_parse_added_editors(VBoxContainer *current_vbox, EditorInspectorSection *p_section, Ref<EditorInspectorPlugin> ped) {
- for (const EditorInspectorPlugin::AddedEditor &F : ped->added_editors) {
- EditorProperty *ep = Object::cast_to<EditorProperty>(F.property_editor);
- current_vbox->add_child(F.property_editor);
- if (ep) {
- ep->object = object;
- ep->connect("property_changed", callable_mp(this, &EditorInspector::_property_changed).bind(false));
- ep->connect("property_keyed", callable_mp(this, &EditorInspector::_property_keyed));
- ep->connect("property_deleted", callable_mp(this, &EditorInspector::_property_deleted), CONNECT_DEFERRED);
- ep->connect("property_keyed_with_value", callable_mp(this, &EditorInspector::_property_keyed_with_value));
- ep->connect("property_checked", callable_mp(this, &EditorInspector::_property_checked));
- ep->connect("property_pinned", callable_mp(this, &EditorInspector::_property_pinned));
- ep->connect("selected", callable_mp(this, &EditorInspector::_property_selected));
- ep->connect("multiple_properties_changed", callable_mp(this, &EditorInspector::_multiple_properties_changed));
- ep->connect("resource_selected", callable_mp(this, &EditorInspector::_resource_selected), CONNECT_DEFERRED);
- ep->connect("object_id_selected", callable_mp(this, &EditorInspector::_object_id_selected), CONNECT_DEFERRED);
- if (F.properties.size()) {
- if (F.properties.size() == 1) {
- //since it's one, associate:
- ep->property = F.properties[0];
- ep->property_path = property_prefix + F.properties[0];
- ep->property_usage = 0;
- }
- if (!F.label.is_empty()) {
- ep->set_label(F.label);
- }
- for (int i = 0; i < F.properties.size(); i++) {
- String prop = F.properties[i];
- if (!editor_property_map.has(prop)) {
- editor_property_map[prop] = List<EditorProperty *>();
- }
- editor_property_map[prop].push_back(ep);
- }
- }
- if (p_section) {
- ep->connect("property_can_revert_changed", callable_mp(p_section, &EditorInspectorSection::property_can_revert_changed));
- }
- ep->set_read_only(read_only);
- ep->update_property();
- ep->_update_pin_flags();
- ep->update_editor_property_status();
- ep->set_deletable(deletable_properties);
- ep->update_cache();
- }
- }
- ped->added_editors.clear();
- }
- bool EditorInspector::_is_property_disabled_by_feature_profile(const StringName &p_property) {
- Ref<EditorFeatureProfile> profile = EditorFeatureProfileManager::get_singleton()->get_current_profile();
- if (profile.is_null()) {
- return false;
- }
- StringName class_name = object->get_class();
- while (class_name != StringName()) {
- if (profile->is_class_property_disabled(class_name, p_property)) {
- return true;
- }
- if (profile->is_class_disabled(class_name)) {
- //won't see properties of a disabled class
- return true;
- }
- class_name = ClassDB::get_parent_class(class_name);
- }
- return false;
- }
- void EditorInspector::update_tree() {
- // Store currently selected and focused elements to restore after the update.
- // TODO: Can be useful to store more context for the focusable, such as the caret position in LineEdit.
- StringName current_selected = property_selected;
- int current_focusable = -1;
- if (property_focusable != -1) {
- // Check that focusable is actually focusable.
- bool restore_focus = false;
- Control *focused = get_viewport() ? get_viewport()->gui_get_focus_owner() : nullptr;
- if (focused) {
- Node *parent = focused->get_parent();
- while (parent) {
- EditorInspector *inspector = Object::cast_to<EditorInspector>(parent);
- if (inspector) {
- restore_focus = inspector == this; // May be owned by another inspector.
- break; // Exit after the first inspector is found, since there may be nested ones.
- }
- parent = parent->get_parent();
- }
- }
- if (restore_focus) {
- current_focusable = property_focusable;
- }
- }
- // Only hide plugins if we are not editing any object.
- // This should be handled outside of the update_tree call anyway (see EditorInspector::edit), but might as well keep it safe.
- _clear(!object);
- if (!object) {
- return;
- }
- List<Ref<EditorInspectorPlugin>> valid_plugins;
- for (int i = inspector_plugin_count - 1; i >= 0; i--) { //start by last, so lastly added can override newly added
- if (!inspector_plugins[i]->can_handle(object)) {
- continue;
- }
- valid_plugins.push_back(inspector_plugins[i]);
- }
- // Decide if properties should be drawn with the warning color (yellow),
- // or if the whole object should be considered read-only.
- bool draw_warning = false;
- bool all_read_only = false;
- if (is_inside_tree()) {
- if (object->has_method("_is_read_only")) {
- all_read_only = object->call("_is_read_only");
- }
- Node *nod = Object::cast_to<Node>(object);
- Node *es = EditorNode::get_singleton()->get_edited_scene();
- if (nod && es != nod && nod->get_owner() != es) {
- // Draw in warning color edited nodes that are not in the currently edited scene,
- // as changes may be lost in the future.
- draw_warning = true;
- } else {
- if (!all_read_only) {
- Resource *res = Object::cast_to<Resource>(object);
- if (res) {
- all_read_only = EditorNode::get_singleton()->is_resource_read_only(res);
- }
- }
- }
- }
- String filter = search_box ? search_box->get_text() : "";
- String group;
- String group_base;
- String subgroup;
- String subgroup_base;
- int section_depth = 0;
- VBoxContainer *category_vbox = nullptr;
- List<PropertyInfo> plist;
- object->get_property_list(&plist, true);
- HashMap<VBoxContainer *, HashMap<String, VBoxContainer *>> vbox_per_path;
- HashMap<String, EditorInspectorArray *> editor_inspector_array_per_prefix;
- Color sscolor = get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor));
- // Get the lists of editors to add the beginning.
- for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
- ped->parse_begin(object);
- _parse_added_editors(main_vbox, nullptr, ped);
- }
- StringName doc_name;
- // Get the lists of editors for properties.
- for (List<PropertyInfo>::Element *E_property = plist.front(); E_property; E_property = E_property->next()) {
- PropertyInfo &p = E_property->get();
- if (p.usage & PROPERTY_USAGE_SUBGROUP) {
- // Setup a property sub-group.
- subgroup = p.name;
- Vector<String> hint_parts = p.hint_string.split(",");
- subgroup_base = hint_parts[0];
- if (hint_parts.size() > 1) {
- section_depth = hint_parts[1].to_int();
- } else {
- section_depth = 0;
- }
- continue;
- } else if (p.usage & PROPERTY_USAGE_GROUP) {
- // Setup a property group.
- group = p.name;
- Vector<String> hint_parts = p.hint_string.split(",");
- group_base = hint_parts[0];
- if (hint_parts.size() > 1) {
- section_depth = hint_parts[1].to_int();
- } else {
- section_depth = 0;
- }
- subgroup = "";
- subgroup_base = "";
- continue;
- } else if (p.usage & PROPERTY_USAGE_CATEGORY) {
- // Setup a property category.
- group = "";
- group_base = "";
- subgroup = "";
- subgroup_base = "";
- section_depth = 0;
- vbox_per_path.clear();
- editor_inspector_array_per_prefix.clear();
- if (!show_categories) {
- continue;
- }
- // Hide the "MultiNodeEdit" category for MultiNodeEdit.
- if (Object::cast_to<MultiNodeEdit>(object) && p.name == "MultiNodeEdit") {
- continue;
- }
- // Iterate over remaining properties. If no properties in category, skip the category.
- List<PropertyInfo>::Element *N = E_property->next();
- bool valid = true;
- while (N) {
- if (!N->get().name.begins_with("metadata/_") && N->get().usage & PROPERTY_USAGE_EDITOR &&
- (!filter.is_empty() || !restrict_to_basic || (N->get().usage & PROPERTY_USAGE_EDITOR_BASIC_SETTING))) {
- break;
- }
- // Treat custom categories as second-level ones. Do not skip a normal category if it is followed by a custom one.
- // Skip in the other 3 cases (normal -> normal, custom -> custom, custom -> normal).
- if ((N->get().usage & PROPERTY_USAGE_CATEGORY) && (p.hint_string.is_empty() || !N->get().hint_string.is_empty())) {
- valid = false;
- break;
- }
- N = N->next();
- }
- if (!valid) {
- continue; // Empty, ignore it.
- }
- // Create an EditorInspectorCategory and add it to the inspector.
- EditorInspectorCategory *category = memnew(EditorInspectorCategory);
- main_vbox->add_child(category);
- category_vbox = nullptr; //reset
- // `hint_script` should contain a native class name or a script path.
- // Otherwise the category was probably added via `@export_category` or `_get_property_list()`.
- // Do not add an icon, do not change the current class (`doc_name`) for custom categories.
- if (p.hint_string.is_empty()) {
- category->label = p.name;
- category->set_tooltip_text(p.name);
- } else {
- String type = p.name;
- String label = p.name;
- doc_name = p.name;
- // Use category's owner script to update some of its information.
- if (!EditorNode::get_editor_data().is_type_recognized(type) && ResourceLoader::exists(p.hint_string)) {
- Ref<Script> scr = ResourceLoader::load(p.hint_string, "Script");
- if (scr.is_valid()) {
- StringName script_name = EditorNode::get_editor_data().script_class_get_name(scr->get_path());
- // Update the docs reference and the label based on the script.
- Vector<DocData::ClassDoc> docs = scr->get_documentation();
- if (!docs.is_empty()) {
- // The documentation of a GDScript's main class is at the end of the array.
- // Hacky because this isn't necessarily always guaranteed.
- doc_name = docs[docs.size() - 1].name;
- }
- if (script_name != StringName()) {
- label = script_name;
- }
- // Find the icon corresponding to the script.
- if (script_name != StringName()) {
- category->icon = EditorNode::get_singleton()->get_class_icon(script_name);
- } else {
- category->icon = EditorNode::get_singleton()->get_object_icon(scr.ptr(), "Object");
- }
- }
- }
- if (category->icon.is_null() && !type.is_empty()) {
- category->icon = EditorNode::get_singleton()->get_class_icon(type);
- }
- // Set the category label.
- category->label = label;
- category->doc_class_name = doc_name;
- if (use_doc_hints) {
- // `|` separator used in `EditorHelpTooltip` for formatting.
- category->set_tooltip_text("class|" + doc_name + "||");
- }
- }
- // Add editors at the start of a category.
- for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
- ped->parse_category(object, p.name);
- _parse_added_editors(main_vbox, nullptr, ped);
- }
- continue;
- } else if (p.name.begins_with("metadata/_") || !(p.usage & PROPERTY_USAGE_EDITOR) || _is_property_disabled_by_feature_profile(p.name) ||
- (filter.is_empty() && restrict_to_basic && !(p.usage & PROPERTY_USAGE_EDITOR_BASIC_SETTING))) {
- // Ignore properties that are not supposed to be in the inspector.
- continue;
- }
- if (p.name == "script") {
- // Script should go into its own category.
- category_vbox = nullptr;
- }
- if (p.usage & PROPERTY_USAGE_HIGH_END_GFX && RS::get_singleton()->is_low_end()) {
- // Do not show this property in low end gfx.
- continue;
- }
- if (p.name == "script" && (hide_script || bool(object->call("_hide_script_from_inspector")))) {
- // Hide script variables from inspector if required.
- continue;
- }
- if (p.name.begins_with("metadata/") && bool(object->call("_hide_metadata_from_inspector"))) {
- // Hide metadata from inspector if required.
- continue;
- }
- // Get the path for property.
- String path = p.name;
- // First check if we have an array that fits the prefix.
- String array_prefix = "";
- int array_index = -1;
- for (KeyValue<String, EditorInspectorArray *> &E : editor_inspector_array_per_prefix) {
- if (p.name.begins_with(E.key) && E.key.length() > array_prefix.length()) {
- array_prefix = E.key;
- }
- }
- if (!array_prefix.is_empty()) {
- // If we have an array element, find the according index in array.
- String str = p.name.trim_prefix(array_prefix);
- int to_char_index = 0;
- while (to_char_index < str.length()) {
- if (!is_digit(str[to_char_index])) {
- break;
- }
- to_char_index++;
- }
- if (to_char_index > 0) {
- array_index = str.left(to_char_index).to_int();
- } else {
- array_prefix = "";
- }
- }
- if (!array_prefix.is_empty()) {
- path = path.trim_prefix(array_prefix);
- int char_index = path.find("/");
- if (char_index >= 0) {
- path = path.right(-char_index - 1);
- } else {
- path = vformat(TTR("Element %s"), array_index);
- }
- } else {
- // Check if we exit or not a subgroup. If there is a prefix, remove it from the property label string.
- if (!subgroup.is_empty() && !subgroup_base.is_empty()) {
- if (path.begins_with(subgroup_base)) {
- path = path.trim_prefix(subgroup_base);
- } else if (subgroup_base.begins_with(path)) {
- // Keep it, this is used pretty often.
- } else {
- subgroup = ""; // The prefix changed, we are no longer in the subgroup.
- }
- }
- // Check if we exit or not a group. If there is a prefix, remove it from the property label string.
- if (!group.is_empty() && !group_base.is_empty() && subgroup.is_empty()) {
- if (path.begins_with(group_base)) {
- path = path.trim_prefix(group_base);
- } else if (group_base.begins_with(path)) {
- // Keep it, this is used pretty often.
- } else {
- group = ""; // The prefix changed, we are no longer in the group.
- subgroup = "";
- }
- }
- // Add the group and subgroup to the path.
- if (!subgroup.is_empty()) {
- path = subgroup + "/" + path;
- }
- if (!group.is_empty()) {
- path = group + "/" + path;
- }
- }
- // Get the property label's string.
- String name_override = (path.contains("/")) ? path.substr(path.rfind("/") + 1) : path;
- String feature_tag;
- {
- const int dot = name_override.find(".");
- if (dot != -1) {
- feature_tag = name_override.substr(dot);
- name_override = name_override.substr(0, dot);
- }
- }
- // Don't localize script variables.
- EditorPropertyNameProcessor::Style name_style = property_name_style;
- if ((p.usage & PROPERTY_USAGE_SCRIPT_VARIABLE) && name_style == EditorPropertyNameProcessor::STYLE_LOCALIZED) {
- name_style = EditorPropertyNameProcessor::STYLE_CAPITALIZED;
- }
- const String property_label_string = EditorPropertyNameProcessor::get_singleton()->process_name(name_override, name_style) + feature_tag;
- // Remove the property from the path.
- int idx = path.rfind("/");
- if (idx > -1) {
- path = path.left(idx);
- } else {
- path = "";
- }
- // Ignore properties that do not fit the filter.
- if (use_filter && !filter.is_empty()) {
- const String property_path = property_prefix + (path.is_empty() ? "" : path + "/") + name_override;
- if (!_property_path_matches(property_path, filter, property_name_style)) {
- continue;
- }
- }
- // Recreate the category vbox if it was reset.
- if (category_vbox == nullptr) {
- category_vbox = memnew(VBoxContainer);
- main_vbox->add_child(category_vbox);
- }
- // Find the correct section/vbox to add the property editor to.
- VBoxContainer *root_vbox = array_prefix.is_empty() ? main_vbox : editor_inspector_array_per_prefix[array_prefix]->get_vbox(array_index);
- if (!root_vbox) {
- continue;
- }
- if (!vbox_per_path.has(root_vbox)) {
- vbox_per_path[root_vbox] = HashMap<String, VBoxContainer *>();
- vbox_per_path[root_vbox][""] = root_vbox;
- }
- VBoxContainer *current_vbox = root_vbox;
- String acc_path = "";
- int level = 1;
- Vector<String> components = path.split("/");
- for (int i = 0; i < components.size(); i++) {
- String component = components[i];
- acc_path += (i > 0) ? "/" + component : component;
- if (!vbox_per_path[root_vbox].has(acc_path)) {
- // If the section does not exists, create it.
- EditorInspectorSection *section = memnew(EditorInspectorSection);
- current_vbox->add_child(section);
- sections.push_back(section);
- String label;
- String tooltip;
- // Don't localize groups for script variables.
- EditorPropertyNameProcessor::Style section_name_style = property_name_style;
- if ((p.usage & PROPERTY_USAGE_SCRIPT_VARIABLE) && section_name_style == EditorPropertyNameProcessor::STYLE_LOCALIZED) {
- section_name_style = EditorPropertyNameProcessor::STYLE_CAPITALIZED;
- }
- // Only process group label if this is not the group or subgroup.
- if ((i == 0 && component == group) || (i == 1 && component == subgroup)) {
- if (section_name_style == EditorPropertyNameProcessor::STYLE_LOCALIZED) {
- label = EditorPropertyNameProcessor::get_singleton()->translate_group_name(component);
- tooltip = component;
- } else {
- label = component;
- tooltip = EditorPropertyNameProcessor::get_singleton()->translate_group_name(component);
- }
- } else {
- label = EditorPropertyNameProcessor::get_singleton()->process_name(component, section_name_style);
- tooltip = EditorPropertyNameProcessor::get_singleton()->process_name(component, EditorPropertyNameProcessor::get_tooltip_style(section_name_style));
- }
- Color c = sscolor;
- c.a /= level;
- section->setup(acc_path, label, object, c, use_folding, section_depth);
- section->set_tooltip_text(tooltip);
- // Add editors at the start of a group.
- for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
- ped->parse_group(object, path);
- _parse_added_editors(section->get_vbox(), section, ped);
- }
- vbox_per_path[root_vbox][acc_path] = section->get_vbox();
- }
- current_vbox = vbox_per_path[root_vbox][acc_path];
- level = (MIN(level + 1, 4));
- }
- // 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).
- if (current_vbox == main_vbox) {
- current_vbox = category_vbox;
- }
- // Check if the property is an array counter, if so create a dedicated array editor for the array.
- if (p.usage & PROPERTY_USAGE_ARRAY) {
- EditorInspectorArray *editor_inspector_array = nullptr;
- StringName array_element_prefix;
- Color c = sscolor;
- c.a /= level;
- Vector<String> class_name_components = String(p.class_name).split(",");
- int page_size = 5;
- bool movable = true;
- bool numbered = false;
- bool foldable = use_folding;
- String add_button_text = TTR("Add Element");
- String swap_method;
- for (int i = (p.type == Variant::NIL ? 1 : 2); i < class_name_components.size(); i++) {
- if (class_name_components[i].begins_with("page_size") && class_name_components[i].get_slice_count("=") == 2) {
- page_size = class_name_components[i].get_slice("=", 1).to_int();
- } else if (class_name_components[i].begins_with("add_button_text") && class_name_components[i].get_slice_count("=") == 2) {
- add_button_text = class_name_components[i].get_slice("=", 1).strip_edges();
- } else if (class_name_components[i] == "static") {
- movable = false;
- } else if (class_name_components[i] == "numbered") {
- numbered = true;
- } else if (class_name_components[i] == "unfoldable") {
- foldable = false;
- } else if (class_name_components[i].begins_with("swap_method") && class_name_components[i].get_slice_count("=") == 2) {
- swap_method = class_name_components[i].get_slice("=", 1).strip_edges();
- }
- }
- if (p.type == Variant::NIL) {
- // Setup the array to use a method to create/move/delete elements.
- array_element_prefix = class_name_components[0];
- editor_inspector_array = memnew(EditorInspectorArray(all_read_only));
- String array_label = path.contains("/") ? path.substr(path.rfind("/") + 1) : path;
- array_label = EditorPropertyNameProcessor::get_singleton()->process_name(property_label_string, property_name_style);
- int page = per_array_page.has(array_element_prefix) ? per_array_page[array_element_prefix] : 0;
- editor_inspector_array->setup_with_move_element_function(object, array_label, array_element_prefix, page, c, use_folding);
- editor_inspector_array->connect("page_change_request", callable_mp(this, &EditorInspector::_page_change_request).bind(array_element_prefix));
- } else if (p.type == Variant::INT) {
- // Setup the array to use the count property and built-in functions to create/move/delete elements.
- if (class_name_components.size() >= 2) {
- array_element_prefix = class_name_components[1];
- editor_inspector_array = memnew(EditorInspectorArray(all_read_only));
- int page = per_array_page.has(array_element_prefix) ? per_array_page[array_element_prefix] : 0;
- 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);
- editor_inspector_array->connect("page_change_request", callable_mp(this, &EditorInspector::_page_change_request).bind(array_element_prefix));
- }
- }
- if (editor_inspector_array) {
- current_vbox->add_child(editor_inspector_array);
- editor_inspector_array_per_prefix[array_element_prefix] = editor_inspector_array;
- }
- continue;
- }
- // Checkable and checked properties.
- bool checkable = false;
- bool checked = false;
- if (p.usage & PROPERTY_USAGE_CHECKABLE) {
- checkable = true;
- checked = p.usage & PROPERTY_USAGE_CHECKED;
- }
- bool property_read_only = (p.usage & PROPERTY_USAGE_READ_ONLY) || read_only;
- // Mark properties that would require an editor restart (mostly when editing editor settings).
- if (p.usage & PROPERTY_USAGE_RESTART_IF_CHANGED) {
- restart_request_props.insert(p.name);
- }
- String doc_path;
- String theme_item_name;
- StringName classname = doc_name;
- // Build the doc hint, to use as tooltip.
- if (use_doc_hints) {
- if (!object_class.is_empty()) {
- classname = object_class;
- } else if (Object::cast_to<MultiNodeEdit>(object)) {
- classname = Object::cast_to<MultiNodeEdit>(object)->get_edited_class_name();
- } else if (classname == "") {
- classname = object->get_class_name();
- Resource *res = Object::cast_to<Resource>(object);
- if (res && !res->get_script().is_null()) {
- // Grab the script of this resource to get the evaluated script class.
- Ref<Script> scr = res->get_script();
- if (scr.is_valid()) {
- Vector<DocData::ClassDoc> docs = scr->get_documentation();
- if (!docs.is_empty()) {
- // The documentation of a GDScript's main class is at the end of the array.
- // Hacky because this isn't necessarily always guaranteed.
- classname = docs[docs.size() - 1].name;
- }
- }
- }
- }
- StringName propname = property_prefix + p.name;
- bool found = false;
- // Small hack for theme_overrides. They are listed under Control, but come from another class.
- if (classname == "Control" && p.name.begins_with("theme_override_")) {
- classname = get_edited_object()->get_class();
- }
- // Search for the doc path in the cache.
- HashMap<StringName, HashMap<StringName, String>>::Iterator E = doc_path_cache.find(classname);
- if (E) {
- HashMap<StringName, String>::Iterator F = E->value.find(propname);
- if (F) {
- found = true;
- doc_path = F->value;
- }
- }
- if (!found) {
- DocTools *dd = EditorHelp::get_doc_data();
- // Do not cache the doc path information of scripts.
- bool is_native_class = ClassDB::class_exists(classname);
- HashMap<String, DocData::ClassDoc>::ConstIterator F = dd->class_list.find(classname);
- while (F) {
- Vector<String> slices = propname.operator String().split("/");
- // Check if it's a theme item first.
- if (slices.size() == 2 && slices[0].begins_with("theme_override_")) {
- for (int i = 0; i < F->value.theme_properties.size(); i++) {
- String doc_path_current = "class_theme_item:" + F->value.name + ":" + F->value.theme_properties[i].name;
- if (F->value.theme_properties[i].name == slices[1]) {
- doc_path = doc_path_current;
- theme_item_name = F->value.theme_properties[i].name;
- }
- }
- if (is_native_class) {
- doc_path_cache[classname][propname] = doc_path;
- }
- } else {
- for (int i = 0; i < F->value.properties.size(); i++) {
- String doc_path_current = "class_property:" + F->value.name + ":" + F->value.properties[i].name;
- if (F->value.properties[i].name == propname.operator String()) {
- doc_path = doc_path_current;
- }
- if (is_native_class) {
- doc_path_cache[classname][propname] = doc_path;
- }
- }
- }
- if (!doc_path.is_empty() || F->value.inherits.is_empty()) {
- break;
- }
- // Couldn't find the doc path in the class itself, try its super class.
- F = dd->class_list.find(F->value.inherits);
- }
- }
- }
- Vector<EditorInspectorPlugin::AddedEditor> editors;
- Vector<EditorInspectorPlugin::AddedEditor> late_editors;
- // Search for the inspector plugin that will handle the properties. Then add the correct property editor to it.
- for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
- bool exclusive = ped->parse_property(object, p.type, p.name, p.hint, p.hint_string, p.usage, wide_editors);
- for (const EditorInspectorPlugin::AddedEditor &F : ped->added_editors) {
- if (F.add_to_end) {
- late_editors.push_back(F);
- } else {
- editors.push_back(F);
- }
- }
- ped->added_editors.clear();
- if (exclusive) {
- break;
- }
- }
- editors.append_array(late_editors);
- for (int i = 0; i < editors.size(); i++) {
- EditorProperty *ep = Object::cast_to<EditorProperty>(editors[i].property_editor);
- const Vector<String> &properties = editors[i].properties;
- if (ep) {
- // Set all this before the control gets the ENTER_TREE notification.
- ep->object = object;
- if (properties.size()) {
- if (properties.size() == 1) {
- // Since it's one, associate:
- ep->property = properties[0];
- ep->property_path = property_prefix + properties[0];
- ep->property_usage = p.usage;
- // And set label?
- }
- if (!editors[i].label.is_empty()) {
- ep->set_label(editors[i].label);
- } else {
- // Use the existing one.
- ep->set_label(property_label_string);
- }
- for (int j = 0; j < properties.size(); j++) {
- String prop = properties[j];
- if (!editor_property_map.has(prop)) {
- editor_property_map[prop] = List<EditorProperty *>();
- }
- editor_property_map[prop].push_back(ep);
- }
- }
- EditorInspectorSection *section = Object::cast_to<EditorInspectorSection>(current_vbox->get_parent());
- if (section) {
- ep->connect("property_can_revert_changed", callable_mp(section, &EditorInspectorSection::property_can_revert_changed));
- }
- ep->set_draw_warning(draw_warning);
- ep->set_use_folding(use_folding);
- ep->set_checkable(checkable);
- ep->set_checked(checked);
- ep->set_keying(keying);
- ep->set_read_only(property_read_only || all_read_only);
- ep->set_deletable(deletable_properties || p.name.begins_with("metadata/"));
- }
- current_vbox->add_child(editors[i].property_editor);
- if (ep) {
- // Eventually, set other properties/signals after the property editor got added to the tree.
- bool update_all = (p.usage & PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED);
- ep->connect("property_changed", callable_mp(this, &EditorInspector::_property_changed).bind(update_all));
- ep->connect("property_keyed", callable_mp(this, &EditorInspector::_property_keyed));
- ep->connect("property_deleted", callable_mp(this, &EditorInspector::_property_deleted), CONNECT_DEFERRED);
- ep->connect("property_keyed_with_value", callable_mp(this, &EditorInspector::_property_keyed_with_value));
- ep->connect("property_checked", callable_mp(this, &EditorInspector::_property_checked));
- ep->connect("property_pinned", callable_mp(this, &EditorInspector::_property_pinned));
- ep->connect("selected", callable_mp(this, &EditorInspector::_property_selected));
- ep->connect("multiple_properties_changed", callable_mp(this, &EditorInspector::_multiple_properties_changed));
- ep->connect("resource_selected", callable_mp(this, &EditorInspector::_resource_selected), CONNECT_DEFERRED);
- ep->connect("object_id_selected", callable_mp(this, &EditorInspector::_object_id_selected), CONNECT_DEFERRED);
- if (use_doc_hints) {
- // `|` separator used in `EditorHelpTooltip` for formatting.
- if (theme_item_name.is_empty()) {
- ep->set_tooltip_text("property|" + classname + "|" + property_prefix + p.name + "|");
- } else {
- ep->set_tooltip_text("theme_item|" + classname + "|" + theme_item_name + "|");
- }
- ep->has_doc_tooltip = true;
- }
- ep->set_doc_path(doc_path);
- ep->update_property();
- ep->_update_pin_flags();
- ep->update_editor_property_status();
- ep->update_cache();
- if (current_selected && ep->property == current_selected) {
- ep->select(current_focusable);
- }
- }
- }
- }
- if (!hide_metadata && !object->call("_hide_metadata_from_inspector")) {
- // Add 4px of spacing between the "Add Metadata" button and the content above it.
- Control *spacer = memnew(Control);
- spacer->set_custom_minimum_size(Size2(0, 4) * EDSCALE);
- main_vbox->add_child(spacer);
- Button *add_md = EditorInspector::create_inspector_action_button(TTR("Add Metadata"));
- add_md->set_icon(get_editor_theme_icon(SNAME("Add")));
- add_md->connect(SNAME("pressed"), callable_mp(this, &EditorInspector::_show_add_meta_dialog));
- main_vbox->add_child(add_md);
- if (all_read_only) {
- add_md->set_disabled(true);
- }
- }
- // Get the lists of to add at the end.
- for (Ref<EditorInspectorPlugin> &ped : valid_plugins) {
- ped->parse_end(object);
- _parse_added_editors(main_vbox, nullptr, ped);
- }
- if (is_main_editor_inspector()) {
- // Updating inspector might invalidate some editing owners.
- EditorNode::get_singleton()->hide_unused_editors();
- }
- }
- void EditorInspector::update_property(const String &p_prop) {
- if (!editor_property_map.has(p_prop)) {
- return;
- }
- for (EditorProperty *E : editor_property_map[p_prop]) {
- E->update_property();
- E->update_editor_property_status();
- E->update_cache();
- }
- }
- void EditorInspector::_clear(bool p_hide_plugins) {
- while (main_vbox->get_child_count()) {
- memdelete(main_vbox->get_child(0));
- }
- property_selected = StringName();
- property_focusable = -1;
- editor_property_map.clear();
- sections.clear();
- pending.clear();
- restart_request_props.clear();
- if (p_hide_plugins && is_main_editor_inspector()) {
- EditorNode::get_singleton()->hide_unused_editors(this);
- }
- }
- Object *EditorInspector::get_edited_object() {
- return object;
- }
- Object *EditorInspector::get_next_edited_object() {
- return next_object;
- }
- void EditorInspector::edit(Object *p_object) {
- if (object == p_object) {
- return;
- }
- next_object = p_object; // Some plugins need to know the next edited object when clearing the inspector.
- if (object) {
- _clear();
- object->disconnect("property_list_changed", callable_mp(this, &EditorInspector::_changed_callback));
- }
- per_array_page.clear();
- object = p_object;
- if (object) {
- update_scroll_request = 0; //reset
- if (scroll_cache.has(object->get_instance_id())) { //if exists, set something else
- update_scroll_request = scroll_cache[object->get_instance_id()]; //done this way because wait until full size is accommodated
- }
- object->connect("property_list_changed", callable_mp(this, &EditorInspector::_changed_callback));
- update_tree();
- }
- // Keep it available until the end so it works with both main and sub inspectors.
- next_object = nullptr;
- emit_signal(SNAME("edited_object_changed"));
- }
- void EditorInspector::set_keying(bool p_active) {
- if (keying == p_active) {
- return;
- }
- keying = p_active;
- _keying_changed();
- }
- void EditorInspector::_keying_changed() {
- for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
- for (EditorProperty *E : F.value) {
- if (E) {
- E->set_keying(keying);
- }
- }
- }
- }
- void EditorInspector::set_read_only(bool p_read_only) {
- if (p_read_only == read_only) {
- return;
- }
- read_only = p_read_only;
- update_tree();
- }
- EditorPropertyNameProcessor::Style EditorInspector::get_property_name_style() const {
- return property_name_style;
- }
- void EditorInspector::set_property_name_style(EditorPropertyNameProcessor::Style p_style) {
- if (property_name_style == p_style) {
- return;
- }
- property_name_style = p_style;
- update_tree();
- }
- void EditorInspector::set_use_settings_name_style(bool p_enable) {
- if (use_settings_name_style == p_enable) {
- return;
- }
- use_settings_name_style = p_enable;
- if (use_settings_name_style) {
- set_property_name_style(EditorPropertyNameProcessor::get_singleton()->get_settings_style());
- }
- }
- void EditorInspector::set_autoclear(bool p_enable) {
- autoclear = p_enable;
- }
- void EditorInspector::set_show_categories(bool p_show) {
- show_categories = p_show;
- update_tree();
- }
- void EditorInspector::set_use_doc_hints(bool p_enable) {
- use_doc_hints = p_enable;
- update_tree();
- }
- void EditorInspector::set_hide_script(bool p_hide) {
- hide_script = p_hide;
- update_tree();
- }
- void EditorInspector::set_hide_metadata(bool p_hide) {
- hide_metadata = p_hide;
- update_tree();
- }
- void EditorInspector::set_use_filter(bool p_use) {
- use_filter = p_use;
- update_tree();
- }
- void EditorInspector::register_text_enter(Node *p_line_edit) {
- search_box = Object::cast_to<LineEdit>(p_line_edit);
- if (search_box) {
- search_box->connect("text_changed", callable_mp(this, &EditorInspector::_filter_changed));
- }
- }
- void EditorInspector::_filter_changed(const String &p_text) {
- update_tree();
- }
- void EditorInspector::set_use_folding(bool p_use_folding, bool p_update_tree) {
- use_folding = p_use_folding;
- if (p_update_tree) {
- update_tree();
- }
- }
- bool EditorInspector::is_using_folding() {
- return use_folding;
- }
- void EditorInspector::collapse_all_folding() {
- for (EditorInspectorSection *E : sections) {
- E->fold();
- }
- for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
- for (EditorProperty *E : F.value) {
- E->collapse_all_folding();
- }
- }
- }
- void EditorInspector::expand_all_folding() {
- for (EditorInspectorSection *E : sections) {
- E->unfold();
- }
- for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
- for (EditorProperty *E : F.value) {
- E->expand_all_folding();
- }
- }
- }
- void EditorInspector::expand_revertable() {
- HashSet<EditorInspectorSection *> sections_to_unfold[2];
- for (EditorInspectorSection *E : sections) {
- if (E->has_revertable_properties()) {
- sections_to_unfold[0].insert(E);
- }
- }
- // Climb up the hierarchy doing double buffering with the sets.
- int a = 0;
- int b = 1;
- while (sections_to_unfold[a].size()) {
- for (EditorInspectorSection *E : sections_to_unfold[a]) {
- E->unfold();
- Node *n = E->get_parent();
- while (n) {
- if (Object::cast_to<EditorInspector>(n)) {
- break;
- }
- if (Object::cast_to<EditorInspectorSection>(n) && !sections_to_unfold[a].has((EditorInspectorSection *)n)) {
- sections_to_unfold[b].insert((EditorInspectorSection *)n);
- }
- n = n->get_parent();
- }
- }
- sections_to_unfold[a].clear();
- SWAP(a, b);
- }
- for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
- for (EditorProperty *E : F.value) {
- E->expand_revertable();
- }
- }
- }
- void EditorInspector::set_scroll_offset(int p_offset) {
- set_v_scroll(p_offset);
- }
- int EditorInspector::get_scroll_offset() const {
- return get_v_scroll();
- }
- void EditorInspector::set_use_wide_editors(bool p_enable) {
- wide_editors = p_enable;
- }
- void EditorInspector::_update_inspector_bg() {
- if (sub_inspector) {
- int count_subinspectors = 0;
- Node *n = get_parent();
- while (n) {
- EditorInspector *ei = Object::cast_to<EditorInspector>(n);
- if (ei && ei->sub_inspector) {
- count_subinspectors++;
- }
- n = n->get_parent();
- }
- count_subinspectors = MIN(15, count_subinspectors);
- add_theme_style_override("panel", get_theme_stylebox("sub_inspector_bg" + itos(count_subinspectors), EditorStringName(Editor)));
- } else {
- add_theme_style_override("panel", get_theme_stylebox(SNAME("panel"), SNAME("Tree")));
- }
- }
- void EditorInspector::set_sub_inspector(bool p_enable) {
- sub_inspector = p_enable;
- if (!is_inside_tree()) {
- return;
- }
- _update_inspector_bg();
- }
- void EditorInspector::set_use_deletable_properties(bool p_enabled) {
- deletable_properties = p_enabled;
- }
- void EditorInspector::_page_change_request(int p_new_page, const StringName &p_array_prefix) {
- int prev_page = per_array_page.has(p_array_prefix) ? per_array_page[p_array_prefix] : 0;
- int new_page = MAX(0, p_new_page);
- if (new_page != prev_page) {
- per_array_page[p_array_prefix] = new_page;
- update_tree_pending = true;
- }
- }
- void EditorInspector::_edit_request_change(Object *p_object, const String &p_property) {
- if (object != p_object) { //may be undoing/redoing for a non edited object, so ignore
- return;
- }
- if (changing) {
- return;
- }
- if (p_property.is_empty()) {
- update_tree_pending = true;
- } else {
- pending.insert(p_property);
- }
- }
- void EditorInspector::_edit_set(const String &p_name, const Variant &p_value, bool p_refresh_all, const String &p_changed_field) {
- if (autoclear && editor_property_map.has(p_name)) {
- for (EditorProperty *E : editor_property_map[p_name]) {
- if (E->is_checkable()) {
- E->set_checked(true);
- }
- }
- }
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- if (bool(object->call("_dont_undo_redo"))) {
- object->set(p_name, p_value);
- if (p_refresh_all) {
- _edit_request_change(object, "");
- } else {
- _edit_request_change(object, p_name);
- }
- emit_signal(_prop_edited, p_name);
- } else if (Object::cast_to<MultiNodeEdit>(object)) {
- Object::cast_to<MultiNodeEdit>(object)->set_property_field(p_name, p_value, p_changed_field);
- _edit_request_change(object, p_name);
- emit_signal(_prop_edited, p_name);
- } else {
- undo_redo->create_action(vformat(TTR("Set %s"), p_name), UndoRedo::MERGE_ENDS);
- undo_redo->add_do_property(object, p_name, p_value);
- bool valid = false;
- Variant value = object->get(p_name, &valid);
- if (valid) {
- undo_redo->add_undo_property(object, p_name, value);
- }
- List<StringName> linked_properties;
- ClassDB::get_linked_properties_info(object->get_class_name(), p_name, &linked_properties);
- for (const StringName &linked_prop : linked_properties) {
- valid = false;
- Variant undo_value = object->get(linked_prop, &valid);
- if (valid) {
- undo_redo->add_undo_property(object, linked_prop, undo_value);
- }
- }
- PackedStringArray linked_properties_dynamic = object->call("_get_linked_undo_properties", p_name, p_value);
- for (int i = 0; i < linked_properties_dynamic.size(); i++) {
- valid = false;
- Variant undo_value = object->get(linked_properties_dynamic[i], &valid);
- if (valid) {
- undo_redo->add_undo_property(object, linked_properties_dynamic[i], undo_value);
- }
- }
- Variant v_undo_redo = undo_redo;
- Variant v_object = object;
- Variant v_name = p_name;
- const Vector<Callable> &callbacks = EditorNode::get_editor_data().get_undo_redo_inspector_hook_callback();
- for (int i = 0; i < callbacks.size(); i++) {
- const Callable &callback = callbacks[i];
- const Variant *p_arguments[] = { &v_undo_redo, &v_object, &v_name, &p_value };
- Variant return_value;
- Callable::CallError call_error;
- callback.callp(p_arguments, 4, return_value, call_error);
- if (call_error.error != Callable::CallError::CALL_OK) {
- ERR_PRINT("Invalid UndoRedo callback.");
- }
- }
- if (p_refresh_all) {
- undo_redo->add_do_method(this, "_edit_request_change", object, "");
- undo_redo->add_undo_method(this, "_edit_request_change", object, "");
- } else {
- undo_redo->add_do_method(this, "_edit_request_change", object, p_name);
- undo_redo->add_undo_method(this, "_edit_request_change", object, p_name);
- }
- Resource *r = Object::cast_to<Resource>(object);
- if (r) {
- if (String(p_name) == "resource_local_to_scene") {
- bool prev = object->get(p_name);
- bool next = p_value;
- if (next) {
- undo_redo->add_do_method(r, "setup_local_to_scene");
- }
- if (prev) {
- undo_redo->add_undo_method(r, "setup_local_to_scene");
- }
- }
- }
- undo_redo->add_do_method(this, "emit_signal", _prop_edited, p_name);
- undo_redo->add_undo_method(this, "emit_signal", _prop_edited, p_name);
- undo_redo->commit_action();
- }
- if (editor_property_map.has(p_name)) {
- for (EditorProperty *E : editor_property_map[p_name]) {
- E->update_editor_property_status();
- }
- }
- }
- void EditorInspector::_property_changed(const String &p_path, const Variant &p_value, const String &p_name, bool p_changing, bool p_update_all) {
- // The "changing" variable must be true for properties that trigger events as typing occurs,
- // like "text_changed" signal. E.g. text property of Label, Button, RichTextLabel, etc.
- if (p_changing) {
- this->changing++;
- }
- _edit_set(p_path, p_value, p_update_all, p_name);
- if (p_changing) {
- this->changing--;
- }
- if (restart_request_props.has(p_path)) {
- emit_signal(SNAME("restart_requested"));
- }
- }
- void EditorInspector::_multiple_properties_changed(Vector<String> p_paths, Array p_values, bool p_changing) {
- ERR_FAIL_COND(p_paths.size() == 0 || p_values.size() == 0);
- ERR_FAIL_COND(p_paths.size() != p_values.size());
- String names;
- for (int i = 0; i < p_paths.size(); i++) {
- if (i > 0) {
- names += ",";
- }
- names += p_paths[i];
- }
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- // TRANSLATORS: This is describing a change to multiple properties at once. The parameter is a list of property names.
- undo_redo->create_action(vformat(TTR("Set Multiple: %s"), names), UndoRedo::MERGE_ENDS);
- for (int i = 0; i < p_paths.size(); i++) {
- _edit_set(p_paths[i], p_values[i], false, "");
- if (restart_request_props.has(p_paths[i])) {
- emit_signal(SNAME("restart_requested"));
- }
- }
- if (p_changing) {
- changing++;
- }
- undo_redo->commit_action();
- if (p_changing) {
- changing--;
- }
- }
- void EditorInspector::_property_keyed(const String &p_path, bool p_advance) {
- if (!object) {
- return;
- }
- // The second parameter could be null, causing the event to fire with less arguments, so use the pointer call which preserves it.
- const Variant args[3] = { p_path, object->get(p_path), p_advance };
- const Variant *argp[3] = { &args[0], &args[1], &args[2] };
- emit_signalp(SNAME("property_keyed"), argp, 3);
- }
- void EditorInspector::_property_deleted(const String &p_path) {
- if (!object) {
- return;
- }
- if (p_path.begins_with("metadata/")) {
- String name = p_path.replace_first("metadata/", "");
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Remove metadata %s"), name));
- undo_redo->add_do_method(object, "remove_meta", name);
- undo_redo->add_undo_method(object, "set_meta", name, object->get_meta(name));
- undo_redo->commit_action();
- }
- emit_signal(SNAME("property_deleted"), p_path);
- }
- void EditorInspector::_property_keyed_with_value(const String &p_path, const Variant &p_value, bool p_advance) {
- if (!object) {
- return;
- }
- // The second parameter could be null, causing the event to fire with less arguments, so use the pointer call which preserves it.
- const Variant args[3] = { p_path, p_value, p_advance };
- const Variant *argp[3] = { &args[0], &args[1], &args[2] };
- emit_signalp(SNAME("property_keyed"), argp, 3);
- }
- void EditorInspector::_property_checked(const String &p_path, bool p_checked) {
- if (!object) {
- return;
- }
- //property checked
- if (autoclear) {
- if (!p_checked) {
- object->set(p_path, Variant());
- } else {
- Variant to_create;
- List<PropertyInfo> pinfo;
- object->get_property_list(&pinfo);
- for (const PropertyInfo &E : pinfo) {
- if (E.name == p_path) {
- Callable::CallError ce;
- Variant::construct(E.type, to_create, nullptr, 0, ce);
- break;
- }
- }
- object->set(p_path, to_create);
- }
- if (editor_property_map.has(p_path)) {
- for (EditorProperty *E : editor_property_map[p_path]) {
- E->set_checked(p_checked);
- E->update_property();
- E->update_editor_property_status();
- E->update_cache();
- }
- }
- } else {
- emit_signal(SNAME("property_toggled"), p_path, p_checked);
- }
- }
- void EditorInspector::_property_pinned(const String &p_path, bool p_pinned) {
- if (!object) {
- return;
- }
- Node *node = Object::cast_to<Node>(object);
- ERR_FAIL_NULL(node);
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(p_pinned ? TTR("Pinned %s") : TTR("Unpinned %s"), p_path));
- undo_redo->add_do_method(node, "_set_property_pinned", p_path, p_pinned);
- undo_redo->add_undo_method(node, "_set_property_pinned", p_path, !p_pinned);
- if (editor_property_map.has(p_path)) {
- for (List<EditorProperty *>::Element *E = editor_property_map[p_path].front(); E; E = E->next()) {
- undo_redo->add_do_method(E->get(), "_update_editor_property_status");
- undo_redo->add_undo_method(E->get(), "_update_editor_property_status");
- }
- }
- undo_redo->commit_action();
- }
- void EditorInspector::_property_selected(const String &p_path, int p_focusable) {
- property_selected = p_path;
- property_focusable = p_focusable;
- // Deselect the others.
- for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
- if (F.key == property_selected) {
- continue;
- }
- for (EditorProperty *E : F.value) {
- if (E->is_selected()) {
- E->deselect();
- }
- }
- }
- emit_signal(SNAME("property_selected"), p_path);
- }
- void EditorInspector::_object_id_selected(const String &p_path, ObjectID p_id) {
- emit_signal(SNAME("object_id_selected"), p_id);
- }
- void EditorInspector::_resource_selected(const String &p_path, Ref<Resource> p_resource) {
- emit_signal(SNAME("resource_selected"), p_resource, p_path);
- }
- void EditorInspector::_node_removed(Node *p_node) {
- if (p_node == object) {
- edit(nullptr);
- }
- }
- void EditorInspector::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_READY: {
- EditorFeatureProfileManager::get_singleton()->connect("current_feature_profile_changed", callable_mp(this, &EditorInspector::_feature_profile_changed));
- set_process(is_visible_in_tree());
- _update_inspector_bg();
- } break;
- case NOTIFICATION_ENTER_TREE: {
- if (!sub_inspector) {
- get_tree()->connect("node_removed", callable_mp(this, &EditorInspector::_node_removed));
- }
- } break;
- case NOTIFICATION_PREDELETE: {
- edit(nullptr); //just in case
- } break;
- case NOTIFICATION_EXIT_TREE: {
- if (!sub_inspector) {
- get_tree()->disconnect("node_removed", callable_mp(this, &EditorInspector::_node_removed));
- }
- edit(nullptr);
- } break;
- case NOTIFICATION_VISIBILITY_CHANGED: {
- set_process(is_visible_in_tree());
- } break;
- case NOTIFICATION_PROCESS: {
- if (update_scroll_request >= 0) {
- get_v_scroll_bar()->call_deferred(SNAME("set_value"), update_scroll_request);
- update_scroll_request = -1;
- }
- if (update_tree_pending) {
- refresh_countdown = float(EDITOR_GET("docks/property_editor/auto_refresh_interval"));
- } else if (refresh_countdown > 0) {
- refresh_countdown -= get_process_delta_time();
- if (refresh_countdown <= 0) {
- for (const KeyValue<StringName, List<EditorProperty *>> &F : editor_property_map) {
- for (EditorProperty *E : F.value) {
- if (E && !E->is_cache_valid()) {
- E->update_property();
- E->update_editor_property_status();
- E->update_cache();
- }
- }
- }
- refresh_countdown = float(EDITOR_GET("docks/property_editor/auto_refresh_interval"));
- }
- }
- changing++;
- if (update_tree_pending) {
- update_tree();
- update_tree_pending = false;
- pending.clear();
- } else {
- while (pending.size()) {
- StringName prop = *pending.begin();
- if (editor_property_map.has(prop)) {
- for (EditorProperty *E : editor_property_map[prop]) {
- E->update_property();
- E->update_editor_property_status();
- E->update_cache();
- }
- }
- pending.remove(pending.begin());
- }
- }
- changing--;
- } break;
- case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
- _update_inspector_bg();
- bool needs_update = false;
- if (use_settings_name_style && EditorSettings::get_singleton()->check_changed_settings_in_group("interface/editor/localize_settings")) {
- EditorPropertyNameProcessor::Style style = EditorPropertyNameProcessor::get_settings_style();
- if (property_name_style != style) {
- property_name_style = style;
- needs_update = true;
- }
- }
- if (EditorSettings::get_singleton()->check_changed_settings_in_group("interface/inspector")) {
- needs_update = true;
- }
- if (needs_update) {
- update_tree();
- }
- } break;
- }
- }
- void EditorInspector::_changed_callback() {
- //this is called when property change is notified via notify_property_list_changed()
- if (object != nullptr) {
- _edit_request_change(object, String());
- }
- }
- void EditorInspector::_vscroll_changed(double p_offset) {
- if (update_scroll_request >= 0) { //waiting, do nothing
- return;
- }
- if (object) {
- scroll_cache[object->get_instance_id()] = p_offset;
- }
- }
- void EditorInspector::set_property_prefix(const String &p_prefix) {
- property_prefix = p_prefix;
- }
- String EditorInspector::get_property_prefix() const {
- return property_prefix;
- }
- void EditorInspector::set_object_class(const String &p_class) {
- object_class = p_class;
- }
- String EditorInspector::get_object_class() const {
- return object_class;
- }
- void EditorInspector::_feature_profile_changed() {
- update_tree();
- }
- void EditorInspector::set_restrict_to_basic_settings(bool p_restrict) {
- restrict_to_basic = p_restrict;
- update_tree();
- }
- void EditorInspector::set_property_clipboard(const Variant &p_value) {
- property_clipboard = p_value;
- }
- Variant EditorInspector::get_property_clipboard() const {
- return property_clipboard;
- }
- void EditorInspector::_add_meta_confirm() {
- String name = add_meta_name->get_text();
- object->editor_set_section_unfold("metadata", true); // Ensure metadata is unfolded when adding a new metadata.
- Variant defval;
- Callable::CallError ce;
- Variant::construct(Variant::Type(add_meta_type->get_selected_id()), defval, nullptr, 0, ce);
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Add metadata %s"), name));
- undo_redo->add_do_method(object, "set_meta", name, defval);
- undo_redo->add_undo_method(object, "remove_meta", name);
- undo_redo->commit_action();
- }
- void EditorInspector::_check_meta_name() {
- const String meta_name = add_meta_name->get_text();
- if (meta_name.is_empty()) {
- validation_panel->set_message(EditorValidationPanel::MSG_ID_DEFAULT, TTR("Metadata name can't be empty."), EditorValidationPanel::MSG_ERROR);
- } else if (!meta_name.is_valid_identifier()) {
- validation_panel->set_message(EditorValidationPanel::MSG_ID_DEFAULT, TTR("Metadata name must be a valid identifier."), EditorValidationPanel::MSG_ERROR);
- } else if (object->has_meta(meta_name)) {
- validation_panel->set_message(EditorValidationPanel::MSG_ID_DEFAULT, vformat(TTR("Metadata with name \"%s\" already exists."), meta_name), EditorValidationPanel::MSG_ERROR);
- } else if (meta_name[0] == '_') {
- validation_panel->set_message(EditorValidationPanel::MSG_ID_DEFAULT, TTR("Names starting with _ are reserved for editor-only metadata."), EditorValidationPanel::MSG_ERROR);
- }
- }
- void EditorInspector::_show_add_meta_dialog() {
- if (!add_meta_dialog) {
- add_meta_dialog = memnew(ConfirmationDialog);
- VBoxContainer *vbc = memnew(VBoxContainer);
- add_meta_dialog->add_child(vbc);
- HBoxContainer *hbc = memnew(HBoxContainer);
- vbc->add_child(hbc);
- hbc->add_child(memnew(Label(TTR("Name:"))));
- add_meta_name = memnew(LineEdit);
- add_meta_name->set_custom_minimum_size(Size2(200 * EDSCALE, 1));
- hbc->add_child(add_meta_name);
- hbc->add_child(memnew(Label(TTR("Type:"))));
- add_meta_type = memnew(OptionButton);
- for (int i = 0; i < Variant::VARIANT_MAX; i++) {
- if (i == Variant::NIL || i == Variant::RID || i == Variant::CALLABLE || i == Variant::SIGNAL) {
- continue; //not editable by inspector.
- }
- String type = i == Variant::OBJECT ? String("Resource") : Variant::get_type_name(Variant::Type(i));
- add_meta_type->add_icon_item(get_editor_theme_icon(type), type, i);
- }
- hbc->add_child(add_meta_type);
- Control *spacing = memnew(Control);
- vbc->add_child(spacing);
- spacing->set_custom_minimum_size(Size2(0, 10 * EDSCALE));
- add_meta_dialog->set_ok_button_text(TTR("Add"));
- add_child(add_meta_dialog);
- add_meta_dialog->register_text_enter(add_meta_name);
- add_meta_dialog->connect("confirmed", callable_mp(this, &EditorInspector::_add_meta_confirm));
- validation_panel = memnew(EditorValidationPanel);
- vbc->add_child(validation_panel);
- validation_panel->add_line(EditorValidationPanel::MSG_ID_DEFAULT, TTR("Metadata name is valid."));
- validation_panel->set_update_callback(callable_mp(this, &EditorInspector::_check_meta_name));
- validation_panel->set_accept_button(add_meta_dialog->get_ok_button());
- add_meta_name->connect("text_changed", callable_mp(validation_panel, &EditorValidationPanel::update).unbind(1));
- }
- Node *node = Object::cast_to<Node>(object);
- if (node) {
- add_meta_dialog->set_title(vformat(TTR("Add Metadata Property for \"%s\""), node->get_name()));
- } else {
- // This should normally be reached when the object is derived from Resource.
- add_meta_dialog->set_title(vformat(TTR("Add Metadata Property for \"%s\""), object->get_class()));
- }
- add_meta_dialog->popup_centered();
- add_meta_name->grab_focus();
- add_meta_name->set_text("");
- validation_panel->update();
- }
- void EditorInspector::_bind_methods() {
- ClassDB::bind_method("_edit_request_change", &EditorInspector::_edit_request_change);
- ClassDB::bind_method("get_selected_path", &EditorInspector::get_selected_path);
- ClassDB::bind_method("get_edited_object", &EditorInspector::get_edited_object);
- ADD_SIGNAL(MethodInfo("property_selected", PropertyInfo(Variant::STRING, "property")));
- 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")));
- ADD_SIGNAL(MethodInfo("property_deleted", PropertyInfo(Variant::STRING, "property")));
- ADD_SIGNAL(MethodInfo("resource_selected", PropertyInfo(Variant::OBJECT, "resource", PROPERTY_HINT_RESOURCE_TYPE, "Resource"), PropertyInfo(Variant::STRING, "path")));
- ADD_SIGNAL(MethodInfo("object_id_selected", PropertyInfo(Variant::INT, "id")));
- ADD_SIGNAL(MethodInfo("property_edited", PropertyInfo(Variant::STRING, "property")));
- ADD_SIGNAL(MethodInfo("property_toggled", PropertyInfo(Variant::STRING, "property"), PropertyInfo(Variant::BOOL, "checked")));
- ADD_SIGNAL(MethodInfo("edited_object_changed"));
- ADD_SIGNAL(MethodInfo("restart_requested"));
- }
- EditorInspector::EditorInspector() {
- object = nullptr;
- main_vbox = memnew(VBoxContainer);
- main_vbox->set_h_size_flags(SIZE_EXPAND_FILL);
- main_vbox->add_theme_constant_override("separation", 0);
- add_child(main_vbox);
- set_horizontal_scroll_mode(SCROLL_MODE_DISABLED);
- changing = 0;
- search_box = nullptr;
- _prop_edited = "property_edited";
- set_process(false);
- property_focusable = -1;
- property_clipboard = Variant();
- get_v_scroll_bar()->connect("value_changed", callable_mp(this, &EditorInspector::_vscroll_changed));
- update_scroll_request = -1;
- if (EditorSettings::get_singleton()) {
- refresh_countdown = float(EDITOR_GET("docks/property_editor/auto_refresh_interval"));
- } else {
- //used when class is created by the docgen to dump default values of everything bindable, editorsettings may not be created
- refresh_countdown = 0.33;
- }
- ED_SHORTCUT("property_editor/copy_value", TTR("Copy Value"), KeyModifierMask::CMD_OR_CTRL | Key::C);
- ED_SHORTCUT("property_editor/paste_value", TTR("Paste Value"), KeyModifierMask::CMD_OR_CTRL | Key::V);
- ED_SHORTCUT("property_editor/copy_property_path", TTR("Copy Property Path"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::C);
- // `use_settings_name_style` is true by default, set the name style accordingly.
- set_property_name_style(EditorPropertyNameProcessor::get_singleton()->get_settings_style());
- }
|