scene_debugger.cpp 95 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003
  1. /**************************************************************************/
  2. /* scene_debugger.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "scene_debugger.h"
  31. #include "core/debugger/debugger_marshalls.h"
  32. #include "core/debugger/engine_debugger.h"
  33. #include "core/io/dir_access.h"
  34. #include "core/io/marshalls.h"
  35. #include "core/math/math_fieldwise.h"
  36. #include "core/object/script_language.h"
  37. #include "core/os/time.h"
  38. #include "core/templates/local_vector.h"
  39. #include "scene/gui/popup_menu.h"
  40. #include "scene/main/canvas_layer.h"
  41. #include "scene/main/scene_tree.h"
  42. #include "scene/main/window.h"
  43. #include "scene/resources/packed_scene.h"
  44. #include "scene/theme/theme_db.h"
  45. #include "servers/audio_server.h"
  46. #ifndef PHYSICS_2D_DISABLED
  47. #include "scene/2d/physics/collision_object_2d.h"
  48. #include "scene/2d/physics/collision_polygon_2d.h"
  49. #include "scene/2d/physics/collision_shape_2d.h"
  50. #endif // PHYSICS_2D_DISABLED
  51. #ifndef _3D_DISABLED
  52. #include "scene/3d/camera_3d.h"
  53. #ifndef PHYSICS_3D_DISABLED
  54. #include "scene/3d/physics/collision_object_3d.h"
  55. #include "scene/3d/physics/collision_shape_3d.h"
  56. #endif // PHYSICS_3D_DISABLED
  57. #include "scene/3d/visual_instance_3d.h"
  58. #include "scene/resources/3d/convex_polygon_shape_3d.h"
  59. #include "scene/resources/surface_tool.h"
  60. #endif // _3D_DISABLED
  61. SceneDebugger::SceneDebugger() {
  62. singleton = this;
  63. #ifdef DEBUG_ENABLED
  64. LiveEditor::singleton = memnew(LiveEditor);
  65. RuntimeNodeSelect::singleton = memnew(RuntimeNodeSelect);
  66. EngineDebugger::register_message_capture("scene", EngineDebugger::Capture(nullptr, SceneDebugger::parse_message));
  67. #endif // DEBUG_ENABLED
  68. }
  69. SceneDebugger::~SceneDebugger() {
  70. #ifdef DEBUG_ENABLED
  71. if (LiveEditor::singleton) {
  72. EngineDebugger::unregister_message_capture("scene");
  73. memdelete(LiveEditor::singleton);
  74. LiveEditor::singleton = nullptr;
  75. }
  76. if (RuntimeNodeSelect::singleton) {
  77. memdelete(RuntimeNodeSelect::singleton);
  78. RuntimeNodeSelect::singleton = nullptr;
  79. }
  80. #endif // DEBUG_ENABLED
  81. singleton = nullptr;
  82. }
  83. void SceneDebugger::initialize() {
  84. if (EngineDebugger::is_active()) {
  85. #ifdef DEBUG_ENABLED
  86. _init_message_handlers();
  87. #endif
  88. memnew(SceneDebugger);
  89. }
  90. }
  91. void SceneDebugger::deinitialize() {
  92. if (singleton) {
  93. memdelete(singleton);
  94. }
  95. }
  96. #ifdef DEBUG_ENABLED
  97. void SceneDebugger::_handle_input(const Ref<InputEvent> &p_event, const Ref<Shortcut> &p_shortcut) {
  98. Ref<InputEventKey> k = p_event;
  99. if (p_shortcut.is_valid() && k.is_valid() && k->is_pressed() && !k->is_echo() && p_shortcut->matches_event(k)) {
  100. EngineDebugger::get_singleton()->send_message("request_quit", Array());
  101. }
  102. }
  103. void SceneDebugger::_handle_embed_input(const Ref<InputEvent> &p_event, const Dictionary &p_settings) {
  104. Ref<InputEventKey> k = p_event;
  105. if (k.is_null() || !k->is_pressed()) {
  106. return;
  107. }
  108. Ref<Shortcut> p_shortcut = p_settings.get("editor/next_frame_embedded_project", Ref<Shortcut>());
  109. if (p_shortcut.is_valid() && p_shortcut->matches_event(k)) {
  110. EngineDebugger::get_singleton()->send_message("request_embed_next_frame", Array());
  111. return;
  112. }
  113. if (k->is_echo()) {
  114. return;
  115. } // Shortcuts that doesn't need is_echo goes below here
  116. p_shortcut = p_settings.get("editor/suspend_resume_embedded_project", Ref<Shortcut>());
  117. if (p_shortcut.is_valid() && p_shortcut->matches_event(k)) {
  118. EngineDebugger::get_singleton()->send_message("request_embed_suspend_toggle", Array());
  119. return;
  120. }
  121. }
  122. Error SceneDebugger::_msg_setup_scene(const Array &p_args) {
  123. SceneTree::get_singleton()->get_root()->connect(SceneStringName(window_input), callable_mp_static(SceneDebugger::_handle_input).bind(DebuggerMarshalls::deserialize_key_shortcut(p_args)));
  124. return OK;
  125. }
  126. Error SceneDebugger::_msg_request_scene_tree(const Array &p_args) {
  127. LiveEditor::get_singleton()->_send_tree();
  128. return OK;
  129. }
  130. Error SceneDebugger::_msg_save_node(const Array &p_args) {
  131. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA);
  132. _save_node(p_args[0], p_args[1]);
  133. Array arr;
  134. arr.append(p_args[1]);
  135. EngineDebugger::get_singleton()->send_message("filesystem:update_file", { arr });
  136. return OK;
  137. }
  138. Error SceneDebugger::_msg_inspect_objects(const Array &p_args) {
  139. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA);
  140. Vector<ObjectID> ids;
  141. for (const Variant &id : (Array)p_args[0]) {
  142. ids.append(ObjectID(id.operator uint64_t()));
  143. }
  144. _send_object_ids(ids, p_args[1]);
  145. return OK;
  146. }
  147. Error SceneDebugger::_msg_clear_selection(const Array &p_args) {
  148. RuntimeNodeSelect::get_singleton()->_clear_selection();
  149. return OK;
  150. }
  151. Error SceneDebugger::_msg_suspend_changed(const Array &p_args) {
  152. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  153. bool suspended = p_args[0];
  154. SceneTree::get_singleton()->set_suspend(suspended);
  155. RuntimeNodeSelect::get_singleton()->_update_input_state();
  156. return OK;
  157. }
  158. Error SceneDebugger::_msg_next_frame(const Array &p_args) {
  159. _next_frame();
  160. return OK;
  161. }
  162. Error SceneDebugger::_msg_debug_mute_audio(const Array &p_args) {
  163. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  164. bool do_mute = p_args[0];
  165. AudioServer::get_singleton()->set_debug_mute(do_mute);
  166. return OK;
  167. }
  168. Error SceneDebugger::_msg_override_cameras(const Array &p_args) {
  169. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  170. bool enable = p_args[0];
  171. bool from_editor = p_args[1];
  172. SceneTree::get_singleton()->get_root()->enable_canvas_transform_override(enable);
  173. #ifndef _3D_DISABLED
  174. SceneTree::get_singleton()->get_root()->enable_camera_3d_override(enable);
  175. #endif // _3D_DISABLED
  176. RuntimeNodeSelect::get_singleton()->_set_camera_override_enabled(enable && !from_editor);
  177. return OK;
  178. }
  179. Error SceneDebugger::_msg_transform_camera_2d(const Array &p_args) {
  180. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  181. Transform2D transform = p_args[0];
  182. SceneTree::get_singleton()->get_root()->set_canvas_transform_override(transform);
  183. RuntimeNodeSelect::get_singleton()->_queue_selection_update();
  184. return OK;
  185. }
  186. #ifndef _3D_DISABLED
  187. Error SceneDebugger::_msg_transform_camera_3d(const Array &p_args) {
  188. ERR_FAIL_COND_V(p_args.size() < 5, ERR_INVALID_DATA);
  189. Transform3D transform = p_args[0];
  190. bool is_perspective = p_args[1];
  191. float size_or_fov = p_args[2];
  192. float depth_near = p_args[3];
  193. float depth_far = p_args[4];
  194. if (is_perspective) {
  195. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(size_or_fov, depth_near, depth_far);
  196. } else {
  197. SceneTree::get_singleton()->get_root()->set_camera_3d_override_orthogonal(size_or_fov, depth_near, depth_far);
  198. }
  199. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(transform);
  200. RuntimeNodeSelect::get_singleton()->_queue_selection_update();
  201. return OK;
  202. }
  203. #endif // _3D_DISABLED
  204. Error SceneDebugger::_msg_set_object_property(const Array &p_args) {
  205. ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA);
  206. _set_object_property(p_args[0], p_args[1], p_args[2]);
  207. RuntimeNodeSelect::get_singleton()->_queue_selection_update();
  208. return OK;
  209. }
  210. Error SceneDebugger::_msg_set_object_property_field(const Array &p_args) {
  211. ERR_FAIL_COND_V(p_args.size() < 4, ERR_INVALID_DATA);
  212. _set_object_property(p_args[0], p_args[1], p_args[2], p_args[3]);
  213. RuntimeNodeSelect::get_singleton()->_queue_selection_update();
  214. return OK;
  215. }
  216. Error SceneDebugger::_msg_reload_cached_files(const Array &p_args) {
  217. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  218. PackedStringArray files = p_args[0];
  219. reload_cached_files(files);
  220. return OK;
  221. }
  222. Error SceneDebugger::_msg_setup_embedded_shortcuts(const Array &p_args) {
  223. ERR_FAIL_COND_V(p_args.is_empty() || p_args[0].get_type() != Variant::DICTIONARY, ERR_INVALID_DATA);
  224. Dictionary dict = p_args[0];
  225. LocalVector<Variant> keys = dict.get_key_list();
  226. for (const Variant &key : keys) {
  227. dict[key] = DebuggerMarshalls::deserialize_key_shortcut(dict[key]);
  228. }
  229. SceneTree::get_singleton()->get_root()->connect(SceneStringName(window_input), callable_mp_static(SceneDebugger::_handle_embed_input).bind(dict));
  230. return OK;
  231. }
  232. // region Live editing.
  233. Error SceneDebugger::_msg_live_set_root(const Array &p_args) {
  234. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA);
  235. LiveEditor::get_singleton()->_root_func(p_args[0], p_args[1]);
  236. return OK;
  237. }
  238. Error SceneDebugger::_msg_live_node_path(const Array &p_args) {
  239. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA);
  240. LiveEditor::get_singleton()->_node_path_func(p_args[0], p_args[1]);
  241. return OK;
  242. }
  243. Error SceneDebugger::_msg_live_res_path(const Array &p_args) {
  244. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA);
  245. LiveEditor::get_singleton()->_res_path_func(p_args[0], p_args[1]);
  246. return OK;
  247. }
  248. Error SceneDebugger::_msg_live_node_prop_res(const Array &p_args) {
  249. ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA);
  250. LiveEditor::get_singleton()->_node_set_res_func(p_args[0], p_args[1], p_args[2]);
  251. return OK;
  252. }
  253. Error SceneDebugger::_msg_live_node_prop(const Array &p_args) {
  254. ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA);
  255. LiveEditor::get_singleton()->_node_set_func(p_args[0], p_args[1], p_args[2]);
  256. return OK;
  257. }
  258. Error SceneDebugger::_msg_live_res_prop_res(const Array &p_args) {
  259. ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA);
  260. LiveEditor::get_singleton()->_res_set_res_func(p_args[0], p_args[1], p_args[2]);
  261. return OK;
  262. }
  263. Error SceneDebugger::_msg_live_res_prop(const Array &p_args) {
  264. ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA);
  265. LiveEditor::get_singleton()->_res_set_func(p_args[0], p_args[1], p_args[2]);
  266. return OK;
  267. }
  268. Error SceneDebugger::_msg_live_node_call(const Array &p_args) {
  269. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA);
  270. LocalVector<Variant> args;
  271. LocalVector<Variant *> argptrs;
  272. args.resize(p_args.size() - 2);
  273. argptrs.resize(args.size());
  274. for (uint32_t i = 0; i < args.size(); i++) {
  275. args[i] = p_args[i + 2];
  276. argptrs[i] = &args[i];
  277. }
  278. LiveEditor::get_singleton()->_node_call_func(p_args[0], p_args[1], argptrs.size() ? (const Variant **)argptrs.ptr() : nullptr, argptrs.size());
  279. return OK;
  280. }
  281. Error SceneDebugger::_msg_live_res_call(const Array &p_args) {
  282. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA);
  283. LocalVector<Variant> args;
  284. LocalVector<Variant *> argptrs;
  285. args.resize(p_args.size() - 2);
  286. argptrs.resize(args.size());
  287. for (uint32_t i = 0; i < args.size(); i++) {
  288. args[i] = p_args[i + 2];
  289. argptrs[i] = &args[i];
  290. }
  291. LiveEditor::get_singleton()->_res_call_func(p_args[0], p_args[1], argptrs.size() ? (const Variant **)argptrs.ptr() : nullptr, argptrs.size());
  292. return OK;
  293. }
  294. Error SceneDebugger::_msg_live_create_node(const Array &p_args) {
  295. ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA);
  296. LiveEditor::get_singleton()->_create_node_func(p_args[0], p_args[1], p_args[2]);
  297. return OK;
  298. }
  299. Error SceneDebugger::_msg_live_instantiate_node(const Array &p_args) {
  300. ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA);
  301. LiveEditor::get_singleton()->_instance_node_func(p_args[0], p_args[1], p_args[2]);
  302. return OK;
  303. }
  304. Error SceneDebugger::_msg_live_remove_node(const Array &p_args) {
  305. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  306. LiveEditor::get_singleton()->_remove_node_func(p_args[0]);
  307. RuntimeNodeSelect::get_singleton()->_queue_selection_update();
  308. return OK;
  309. }
  310. Error SceneDebugger::_msg_live_remove_and_keep_node(const Array &p_args) {
  311. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA);
  312. LiveEditor::get_singleton()->_remove_and_keep_node_func(p_args[0], p_args[1]);
  313. RuntimeNodeSelect::get_singleton()->_queue_selection_update();
  314. return OK;
  315. }
  316. Error SceneDebugger::_msg_live_restore_node(const Array &p_args) {
  317. ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA);
  318. LiveEditor::get_singleton()->_restore_node_func(p_args[0], p_args[1], p_args[2]);
  319. return OK;
  320. }
  321. Error SceneDebugger::_msg_live_duplicate_node(const Array &p_args) {
  322. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA);
  323. LiveEditor::get_singleton()->_duplicate_node_func(p_args[0], p_args[1]);
  324. return OK;
  325. }
  326. Error SceneDebugger::_msg_live_reparent_node(const Array &p_args) {
  327. ERR_FAIL_COND_V(p_args.size() < 4, ERR_INVALID_DATA);
  328. LiveEditor::get_singleton()->_reparent_node_func(p_args[0], p_args[1], p_args[2], p_args[3]);
  329. return OK;
  330. }
  331. // endregion
  332. // region Runtime Node Selection.
  333. Error SceneDebugger::_msg_runtime_node_select_setup(const Array &p_args) {
  334. ERR_FAIL_COND_V(p_args.is_empty() || p_args[0].get_type() != Variant::DICTIONARY, ERR_INVALID_DATA);
  335. RuntimeNodeSelect::get_singleton()->_setup(p_args[0]);
  336. return OK;
  337. }
  338. Error SceneDebugger::_msg_runtime_node_select_set_type(const Array &p_args) {
  339. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  340. RuntimeNodeSelect::NodeType type = (RuntimeNodeSelect::NodeType)(int)p_args[0];
  341. RuntimeNodeSelect::get_singleton()->_node_set_type(type);
  342. return OK;
  343. }
  344. Error SceneDebugger::_msg_runtime_node_select_set_mode(const Array &p_args) {
  345. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  346. RuntimeNodeSelect::SelectMode mode = (RuntimeNodeSelect::SelectMode)(int)p_args[0];
  347. RuntimeNodeSelect::get_singleton()->_select_set_mode(mode);
  348. return OK;
  349. }
  350. Error SceneDebugger::_msg_runtime_node_select_set_visible(const Array &p_args) {
  351. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  352. bool visible = p_args[0];
  353. RuntimeNodeSelect::get_singleton()->_set_selection_visible(visible);
  354. return OK;
  355. }
  356. Error SceneDebugger::_msg_runtime_node_select_reset_camera_2d(const Array &p_args) {
  357. RuntimeNodeSelect::get_singleton()->_reset_camera_2d();
  358. return OK;
  359. }
  360. #ifndef _3D_DISABLED
  361. Error SceneDebugger::_msg_runtime_node_select_reset_camera_3d(const Array &p_args) {
  362. RuntimeNodeSelect::get_singleton()->_reset_camera_3d();
  363. return OK;
  364. }
  365. #endif // _3D_DISABLED
  366. // endregion
  367. // region Embedded process screenshot.
  368. Error SceneDebugger::_msg_rq_screenshot(const Array &p_args) {
  369. ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
  370. Viewport *viewport = SceneTree::get_singleton()->get_root();
  371. ERR_FAIL_NULL_V_MSG(viewport, ERR_UNCONFIGURED, "Cannot get a viewport from the main screen.");
  372. Ref<ViewportTexture> texture = viewport->get_texture();
  373. ERR_FAIL_COND_V_MSG(texture.is_null(), ERR_UNCONFIGURED, "Cannot get a viewport texture from the main screen.");
  374. Ref<Image> img = texture->get_image();
  375. ERR_FAIL_COND_V_MSG(img.is_null(), ERR_UNCONFIGURED, "Cannot get an image from a viewport texture of the main screen.");
  376. img->clear_mipmaps();
  377. const String TEMP_DIR = OS::get_singleton()->get_temp_path();
  378. uint32_t suffix_i = 0;
  379. String path;
  380. while (true) {
  381. String datetime = Time::get_singleton()->get_datetime_string_from_system().remove_chars("-T:");
  382. datetime += itos(Time::get_singleton()->get_ticks_usec());
  383. String suffix = datetime + (suffix_i > 0 ? itos(suffix_i) : "");
  384. path = TEMP_DIR.path_join("scr-" + suffix + ".png");
  385. if (!DirAccess::exists(path)) {
  386. break;
  387. }
  388. suffix_i += 1;
  389. }
  390. img->save_png(path);
  391. Array arr;
  392. arr.append(p_args[0]);
  393. arr.append(img->get_width());
  394. arr.append(img->get_height());
  395. arr.append(path);
  396. EngineDebugger::get_singleton()->send_message("game_view:get_screenshot", arr);
  397. return OK;
  398. }
  399. // endregion
  400. HashMap<String, SceneDebugger::ParseMessageFunc> SceneDebugger::message_handlers;
  401. Error SceneDebugger::parse_message(void *p_user, const String &p_msg, const Array &p_args, bool &r_captured) {
  402. ERR_FAIL_NULL_V(SceneTree::get_singleton(), ERR_UNCONFIGURED);
  403. ERR_FAIL_NULL_V(LiveEditor::get_singleton(), ERR_UNCONFIGURED);
  404. ERR_FAIL_NULL_V(RuntimeNodeSelect::get_singleton(), ERR_UNCONFIGURED);
  405. ParseMessageFunc *fn_ptr = message_handlers.getptr(p_msg);
  406. if (fn_ptr) {
  407. r_captured = true;
  408. return (*fn_ptr)(p_args);
  409. }
  410. if (p_msg.begins_with("live_") || p_msg.begins_with("runtime_node_select_")) {
  411. // Messages with these prefixes are reserved and should be handled by the LiveEditor or RuntimeNodeSelect classes,
  412. // so return ERR_SKIP.
  413. r_captured = true;
  414. return ERR_SKIP;
  415. }
  416. r_captured = false;
  417. return OK;
  418. }
  419. void SceneDebugger::_init_message_handlers() {
  420. message_handlers["setup_scene"] = _msg_setup_scene;
  421. message_handlers["setup_embedded_shortcuts"] = _msg_setup_embedded_shortcuts;
  422. message_handlers["request_scene_tree"] = _msg_request_scene_tree;
  423. message_handlers["save_node"] = _msg_save_node;
  424. message_handlers["inspect_objects"] = _msg_inspect_objects;
  425. message_handlers["clear_selection"] = _msg_clear_selection;
  426. message_handlers["suspend_changed"] = _msg_suspend_changed;
  427. message_handlers["next_frame"] = _msg_next_frame;
  428. message_handlers["debug_mute_audio"] = _msg_debug_mute_audio;
  429. message_handlers["override_cameras"] = _msg_override_cameras;
  430. message_handlers["transform_camera_2d"] = _msg_transform_camera_2d;
  431. #ifndef _3D_DISABLED
  432. message_handlers["transform_camera_3d"] = _msg_transform_camera_3d;
  433. #endif
  434. message_handlers["set_object_property"] = _msg_set_object_property;
  435. message_handlers["set_object_property_field"] = _msg_set_object_property_field;
  436. message_handlers["reload_cached_files"] = _msg_reload_cached_files;
  437. message_handlers["live_set_root"] = _msg_live_set_root;
  438. message_handlers["live_node_path"] = _msg_live_node_path;
  439. message_handlers["live_res_path"] = _msg_live_res_path;
  440. message_handlers["live_node_prop_res"] = _msg_live_node_prop_res;
  441. message_handlers["live_node_prop"] = _msg_live_node_prop;
  442. message_handlers["live_res_prop_res"] = _msg_live_res_prop_res;
  443. message_handlers["live_res_prop"] = _msg_live_res_prop;
  444. message_handlers["live_node_call"] = _msg_live_node_call;
  445. message_handlers["live_res_call"] = _msg_live_res_call;
  446. message_handlers["live_create_node"] = _msg_live_create_node;
  447. message_handlers["live_instantiate_node"] = _msg_live_instantiate_node;
  448. message_handlers["live_remove_node"] = _msg_live_remove_node;
  449. message_handlers["live_remove_and_keep_node"] = _msg_live_remove_and_keep_node;
  450. message_handlers["live_restore_node"] = _msg_live_restore_node;
  451. message_handlers["live_duplicate_node"] = _msg_live_duplicate_node;
  452. message_handlers["live_reparent_node"] = _msg_live_reparent_node;
  453. message_handlers["runtime_node_select_setup"] = _msg_runtime_node_select_setup;
  454. message_handlers["runtime_node_select_set_type"] = _msg_runtime_node_select_set_type;
  455. message_handlers["runtime_node_select_set_mode"] = _msg_runtime_node_select_set_mode;
  456. message_handlers["runtime_node_select_set_visible"] = _msg_runtime_node_select_set_visible;
  457. message_handlers["runtime_node_select_reset_camera_2d"] = _msg_runtime_node_select_reset_camera_2d;
  458. #ifndef _3D_DISABLED
  459. message_handlers["runtime_node_select_reset_camera_3d"] = _msg_runtime_node_select_reset_camera_3d;
  460. #endif
  461. message_handlers["rq_screenshot"] = _msg_rq_screenshot;
  462. }
  463. void SceneDebugger::_save_node(ObjectID id, const String &p_path) {
  464. Node *node = ObjectDB::get_instance<Node>(id);
  465. ERR_FAIL_NULL(node);
  466. #ifdef TOOLS_ENABLED
  467. HashMap<const Node *, Node *> duplimap;
  468. Node *copy = node->duplicate_from_editor(duplimap);
  469. #else
  470. Node *copy = node->duplicate();
  471. #endif // TOOLS_ENABLED
  472. // Handle Unique Nodes.
  473. for (int i = 0; i < copy->get_child_count(false); i++) {
  474. _set_node_owner_recursive(copy->get_child(i, false), copy);
  475. }
  476. // Root node cannot ever be unique name in its own Scene!
  477. copy->set_unique_name_in_owner(false);
  478. Ref<PackedScene> ps = memnew(PackedScene);
  479. ps->pack(copy);
  480. ResourceSaver::save(ps, p_path);
  481. memdelete(copy);
  482. }
  483. void SceneDebugger::_set_node_owner_recursive(Node *p_node, Node *p_owner) {
  484. if (!p_node->get_owner()) {
  485. p_node->set_owner(p_owner);
  486. }
  487. for (int i = 0; i < p_node->get_child_count(false); i++) {
  488. _set_node_owner_recursive(p_node->get_child(i, false), p_owner);
  489. }
  490. }
  491. void SceneDebugger::_send_object_ids(const Vector<ObjectID> &p_ids, bool p_update_selection) {
  492. Vector<ObjectID> ids = p_ids;
  493. if (ids.size() > RuntimeNodeSelect::get_singleton()->max_selection) {
  494. ids.resize(RuntimeNodeSelect::get_singleton()->max_selection);
  495. EngineDebugger::get_singleton()->send_message("show_selection_limit_warning", Array());
  496. }
  497. LocalVector<Node *> nodes;
  498. Array objs;
  499. bool objs_missing = false;
  500. for (const ObjectID &id : ids) {
  501. SceneDebuggerObject obj(id);
  502. if (obj.id.is_null()) {
  503. objs_missing = true;
  504. continue;
  505. }
  506. if (p_update_selection) {
  507. if (Node *node = ObjectDB::get_instance<Node>(id)) {
  508. nodes.push_back(node);
  509. }
  510. }
  511. Array arr;
  512. obj.serialize(arr);
  513. objs.append(arr);
  514. }
  515. if (p_update_selection) {
  516. RuntimeNodeSelect::get_singleton()->_set_selected_nodes(nodes);
  517. }
  518. if (objs_missing) {
  519. Array invalid_selection;
  520. for (const ObjectID &id : ids) {
  521. invalid_selection.append(id);
  522. }
  523. Array arr;
  524. arr.append(invalid_selection);
  525. EngineDebugger::get_singleton()->send_message("remote_selection_invalidated", arr);
  526. EngineDebugger::get_singleton()->send_message(objs.is_empty() ? "remote_nothing_selected" : "remote_objects_selected", objs);
  527. } else {
  528. EngineDebugger::get_singleton()->send_message(p_update_selection ? "remote_objects_selected" : "scene:inspect_objects", objs);
  529. }
  530. }
  531. void SceneDebugger::_set_object_property(ObjectID p_id, const String &p_property, const Variant &p_value, const String &p_field) {
  532. Object *obj = ObjectDB::get_instance(p_id);
  533. if (!obj) {
  534. return;
  535. }
  536. String prop_name = p_property;
  537. if (p_property.begins_with("Members/")) {
  538. Vector<String> ss = p_property.split("/");
  539. prop_name = ss[ss.size() - 1];
  540. }
  541. Variant value;
  542. if (p_field.is_empty()) {
  543. // Whole value.
  544. value = p_value;
  545. } else {
  546. // Only one field.
  547. value = fieldwise_assign(obj->get(prop_name), p_value, p_field);
  548. }
  549. obj->set(prop_name, value);
  550. }
  551. void SceneDebugger::_next_frame() {
  552. SceneTree *scene_tree = SceneTree::get_singleton();
  553. if (!scene_tree->is_suspended()) {
  554. return;
  555. }
  556. scene_tree->set_suspend(false);
  557. RenderingServer::get_singleton()->connect("frame_post_draw", callable_mp(scene_tree, &SceneTree::set_suspend).bind(true), Object::CONNECT_ONE_SHOT);
  558. }
  559. void SceneDebugger::add_to_cache(const String &p_filename, Node *p_node) {
  560. LiveEditor *debugger = LiveEditor::get_singleton();
  561. if (!debugger) {
  562. return;
  563. }
  564. if (EngineDebugger::get_script_debugger() && !p_filename.is_empty()) {
  565. debugger->live_scene_edit_cache[p_filename].insert(p_node);
  566. }
  567. }
  568. void SceneDebugger::remove_from_cache(const String &p_filename, Node *p_node) {
  569. LiveEditor *debugger = LiveEditor::get_singleton();
  570. if (!debugger) {
  571. return;
  572. }
  573. HashMap<String, HashSet<Node *>> &edit_cache = debugger->live_scene_edit_cache;
  574. HashMap<String, HashSet<Node *>>::Iterator E = edit_cache.find(p_filename);
  575. if (E) {
  576. E->value.erase(p_node);
  577. if (E->value.is_empty()) {
  578. edit_cache.remove(E);
  579. }
  580. }
  581. HashMap<Node *, HashMap<ObjectID, Node *>> &remove_list = debugger->live_edit_remove_list;
  582. HashMap<Node *, HashMap<ObjectID, Node *>>::Iterator F = remove_list.find(p_node);
  583. if (F) {
  584. for (const KeyValue<ObjectID, Node *> &G : F->value) {
  585. memdelete(G.value);
  586. }
  587. remove_list.remove(F);
  588. }
  589. }
  590. void SceneDebugger::reload_cached_files(const PackedStringArray &p_files) {
  591. for (const String &file : p_files) {
  592. Ref<Resource> res = ResourceCache::get_ref(file);
  593. if (res.is_valid()) {
  594. res->reload_from_file();
  595. }
  596. }
  597. }
  598. SceneDebuggerObject::SceneDebuggerObject(ObjectID p_id) :
  599. SceneDebuggerObject(ObjectDB::get_instance(p_id)) {
  600. }
  601. /// SceneDebuggerObject
  602. SceneDebuggerObject::SceneDebuggerObject(Object *p_obj) {
  603. if (!p_obj) {
  604. return;
  605. }
  606. id = p_obj->get_instance_id();
  607. class_name = p_obj->get_class();
  608. if (ScriptInstance *si = p_obj->get_script_instance()) {
  609. // Read script instance constants and variables
  610. if (!si->get_script().is_null()) {
  611. Script *s = si->get_script().ptr();
  612. _parse_script_properties(s, si);
  613. }
  614. }
  615. if (Node *node = Object::cast_to<Node>(p_obj)) {
  616. // For debugging multiplayer.
  617. {
  618. PropertyInfo pi(Variant::INT, String("Node/multiplayer_authority"), PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_READ_ONLY);
  619. properties.push_back(SceneDebuggerProperty(pi, node->get_multiplayer_authority()));
  620. }
  621. // Add specialized NodePath info (if inside tree).
  622. if (node->is_inside_tree()) {
  623. PropertyInfo pi(Variant::NODE_PATH, String("Node/path"));
  624. properties.push_back(SceneDebuggerProperty(pi, node->get_path()));
  625. } else { // Can't ask for path if a node is not in tree.
  626. PropertyInfo pi(Variant::STRING, String("Node/path"));
  627. properties.push_back(SceneDebuggerProperty(pi, "[Orphan]"));
  628. }
  629. } else if (Script *s = Object::cast_to<Script>(p_obj)) {
  630. // Add script constants (no instance).
  631. _parse_script_properties(s, nullptr);
  632. }
  633. // Add base object properties.
  634. List<PropertyInfo> pinfo;
  635. p_obj->get_property_list(&pinfo, true);
  636. for (const PropertyInfo &E : pinfo) {
  637. if (E.usage & (PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_CATEGORY)) {
  638. properties.push_back(SceneDebuggerProperty(E, p_obj->get(E.name)));
  639. }
  640. }
  641. }
  642. void SceneDebuggerObject::_parse_script_properties(Script *p_script, ScriptInstance *p_instance) {
  643. typedef HashMap<const Script *, HashSet<StringName>> ScriptMemberMap;
  644. typedef HashMap<const Script *, HashMap<StringName, Variant>> ScriptConstantsMap;
  645. ScriptMemberMap members;
  646. if (p_instance) {
  647. members[p_script] = HashSet<StringName>();
  648. p_script->get_members(&(members[p_script]));
  649. }
  650. ScriptConstantsMap constants;
  651. constants[p_script] = HashMap<StringName, Variant>();
  652. p_script->get_constants(&(constants[p_script]));
  653. Ref<Script> base = p_script->get_base_script();
  654. while (base.is_valid()) {
  655. if (p_instance) {
  656. members[base.ptr()] = HashSet<StringName>();
  657. base->get_members(&(members[base.ptr()]));
  658. }
  659. constants[base.ptr()] = HashMap<StringName, Variant>();
  660. base->get_constants(&(constants[base.ptr()]));
  661. base = base->get_base_script();
  662. }
  663. // Members
  664. for (KeyValue<const Script *, HashSet<StringName>> sm : members) {
  665. for (const StringName &E : sm.value) {
  666. Variant m;
  667. if (p_instance->get(E, m)) {
  668. String script_path = sm.key == p_script ? "" : sm.key->get_path().get_file() + "/";
  669. PropertyInfo pi(m.get_type(), "Members/" + script_path + E);
  670. properties.push_back(SceneDebuggerProperty(pi, m));
  671. }
  672. }
  673. }
  674. // Constants
  675. for (KeyValue<const Script *, HashMap<StringName, Variant>> &sc : constants) {
  676. for (const KeyValue<StringName, Variant> &E : sc.value) {
  677. String script_path = sc.key == p_script ? "" : sc.key->get_path().get_file() + "/";
  678. if (E.value.get_type() == Variant::OBJECT) {
  679. Variant inst_id = ((Object *)E.value)->get_instance_id();
  680. PropertyInfo pi(inst_id.get_type(), "Constants/" + E.key, PROPERTY_HINT_OBJECT_ID, "Object");
  681. properties.push_back(SceneDebuggerProperty(pi, inst_id));
  682. } else {
  683. PropertyInfo pi(E.value.get_type(), "Constants/" + script_path + E.key);
  684. properties.push_back(SceneDebuggerProperty(pi, E.value));
  685. }
  686. }
  687. }
  688. }
  689. void SceneDebuggerObject::serialize(Array &r_arr, int p_max_size) {
  690. Array send_props;
  691. for (SceneDebuggerObject::SceneDebuggerProperty &property : properties) {
  692. const PropertyInfo &pi = property.first;
  693. Variant &var = property.second;
  694. Ref<Resource> res = var;
  695. Array prop = { pi.name, pi.type };
  696. PropertyHint hint = pi.hint;
  697. String hint_string = pi.hint_string;
  698. if (res.is_valid() && !res->get_path().is_empty()) {
  699. var = res->get_path();
  700. } else { //only send information that can be sent..
  701. int len = 0; //test how big is this to encode
  702. encode_variant(var, nullptr, len);
  703. if (len > p_max_size) { //limit to max size
  704. hint = PROPERTY_HINT_OBJECT_TOO_BIG;
  705. hint_string = "";
  706. var = Variant();
  707. }
  708. }
  709. prop.push_back(hint);
  710. prop.push_back(hint_string);
  711. prop.push_back(pi.usage);
  712. prop.push_back(var);
  713. send_props.push_back(prop);
  714. }
  715. r_arr.push_back(uint64_t(id));
  716. r_arr.push_back(class_name);
  717. r_arr.push_back(send_props);
  718. }
  719. void SceneDebuggerObject::deserialize(const Array &p_arr) {
  720. #define CHECK_TYPE(p_what, p_type) ERR_FAIL_COND(p_what.get_type() != Variant::p_type);
  721. ERR_FAIL_COND(p_arr.size() < 3);
  722. CHECK_TYPE(p_arr[0], INT);
  723. CHECK_TYPE(p_arr[1], STRING);
  724. CHECK_TYPE(p_arr[2], ARRAY);
  725. deserialize(uint64_t(p_arr[0]), p_arr[1], p_arr[2]);
  726. }
  727. void SceneDebuggerObject::deserialize(uint64_t p_id, const String &p_class_name, const Array &p_props) {
  728. id = p_id;
  729. class_name = p_class_name;
  730. for (int i = 0; i < p_props.size(); i++) {
  731. CHECK_TYPE(p_props[i], ARRAY);
  732. Array prop = p_props[i];
  733. ERR_FAIL_COND(prop.size() != 6);
  734. CHECK_TYPE(prop[0], STRING);
  735. CHECK_TYPE(prop[1], INT);
  736. CHECK_TYPE(prop[2], INT);
  737. CHECK_TYPE(prop[3], STRING);
  738. CHECK_TYPE(prop[4], INT);
  739. PropertyInfo pinfo;
  740. pinfo.name = prop[0];
  741. pinfo.type = Variant::Type(int(prop[1]));
  742. pinfo.hint = PropertyHint(int(prop[2]));
  743. pinfo.hint_string = prop[3];
  744. pinfo.usage = PropertyUsageFlags(int(prop[4]));
  745. Variant var = prop[5];
  746. if (pinfo.type == Variant::OBJECT) {
  747. if (var.is_zero()) {
  748. var = Ref<Resource>();
  749. } else if (var.get_type() == Variant::OBJECT) {
  750. if (((Object *)var)->is_class("EncodedObjectAsID")) {
  751. var = Object::cast_to<EncodedObjectAsID>(var)->get_object_id();
  752. pinfo.type = var.get_type();
  753. pinfo.hint = PROPERTY_HINT_OBJECT_ID;
  754. pinfo.hint_string = "Object";
  755. }
  756. }
  757. }
  758. properties.push_back(SceneDebuggerProperty(pinfo, var));
  759. }
  760. }
  761. /// SceneDebuggerTree
  762. SceneDebuggerTree::SceneDebuggerTree(Node *p_root) {
  763. // Flatten tree into list, depth first, use stack to avoid recursion.
  764. List<Node *> stack;
  765. stack.push_back(p_root);
  766. bool is_root = true;
  767. const StringName &is_visible_sn = SNAME("is_visible");
  768. const StringName &is_visible_in_tree_sn = SNAME("is_visible_in_tree");
  769. while (stack.size()) {
  770. Node *n = stack.front()->get();
  771. stack.pop_front();
  772. int count = n->get_child_count();
  773. for (int i = 0; i < count; i++) {
  774. stack.push_front(n->get_child(count - i - 1));
  775. }
  776. int view_flags = 0;
  777. if (is_root) {
  778. // Prevent root window visibility from being changed.
  779. is_root = false;
  780. } else if (n->has_method(is_visible_sn)) {
  781. const Variant visible = n->call(is_visible_sn);
  782. if (visible.get_type() == Variant::BOOL) {
  783. view_flags = RemoteNode::VIEW_HAS_VISIBLE_METHOD;
  784. view_flags |= uint8_t(visible) * RemoteNode::VIEW_VISIBLE;
  785. }
  786. if (n->has_method(is_visible_in_tree_sn)) {
  787. const Variant visible_in_tree = n->call(is_visible_in_tree_sn);
  788. if (visible_in_tree.get_type() == Variant::BOOL) {
  789. view_flags |= uint8_t(visible_in_tree) * RemoteNode::VIEW_VISIBLE_IN_TREE;
  790. }
  791. }
  792. }
  793. String class_name;
  794. ScriptInstance *script_instance = n->get_script_instance();
  795. if (script_instance) {
  796. Ref<Script> script = script_instance->get_script();
  797. if (script.is_valid()) {
  798. class_name = script->get_global_name();
  799. if (class_name.is_empty()) {
  800. // If there is no class_name in this script we just take the script path.
  801. class_name = script->get_path();
  802. }
  803. }
  804. }
  805. nodes.push_back(RemoteNode(count, n->get_name(), class_name.is_empty() ? n->get_class() : class_name, n->get_instance_id(), n->get_scene_file_path(), view_flags));
  806. }
  807. }
  808. void SceneDebuggerTree::serialize(Array &p_arr) {
  809. for (const RemoteNode &n : nodes) {
  810. p_arr.push_back(n.child_count);
  811. p_arr.push_back(n.name);
  812. p_arr.push_back(n.type_name);
  813. p_arr.push_back(n.id);
  814. p_arr.push_back(n.scene_file_path);
  815. p_arr.push_back(n.view_flags);
  816. }
  817. }
  818. void SceneDebuggerTree::deserialize(const Array &p_arr) {
  819. int idx = 0;
  820. while (p_arr.size() > idx) {
  821. ERR_FAIL_COND(p_arr.size() < 6);
  822. CHECK_TYPE(p_arr[idx], INT); // child_count.
  823. CHECK_TYPE(p_arr[idx + 1], STRING); // name.
  824. CHECK_TYPE(p_arr[idx + 2], STRING); // type_name.
  825. CHECK_TYPE(p_arr[idx + 3], INT); // id.
  826. CHECK_TYPE(p_arr[idx + 4], STRING); // scene_file_path.
  827. CHECK_TYPE(p_arr[idx + 5], INT); // view_flags.
  828. nodes.push_back(RemoteNode(p_arr[idx], p_arr[idx + 1], p_arr[idx + 2], p_arr[idx + 3], p_arr[idx + 4], p_arr[idx + 5]));
  829. idx += 6;
  830. }
  831. }
  832. /// LiveEditor
  833. LiveEditor *LiveEditor::get_singleton() {
  834. return singleton;
  835. }
  836. void LiveEditor::_send_tree() {
  837. SceneTree *scene_tree = SceneTree::get_singleton();
  838. if (!scene_tree) {
  839. return;
  840. }
  841. Array arr;
  842. // Encoded as a flat list depth first.
  843. SceneDebuggerTree tree(scene_tree->root);
  844. tree.serialize(arr);
  845. EngineDebugger::get_singleton()->send_message("scene:scene_tree", arr);
  846. }
  847. void LiveEditor::_node_path_func(const NodePath &p_path, int p_id) {
  848. live_edit_node_path_cache[p_id] = p_path;
  849. }
  850. void LiveEditor::_res_path_func(const String &p_path, int p_id) {
  851. live_edit_resource_cache[p_id] = p_path;
  852. }
  853. void LiveEditor::_node_set_func(int p_id, const StringName &p_prop, const Variant &p_value) {
  854. SceneTree *scene_tree = SceneTree::get_singleton();
  855. if (!scene_tree) {
  856. return;
  857. }
  858. if (!live_edit_node_path_cache.has(p_id)) {
  859. return;
  860. }
  861. NodePath np = live_edit_node_path_cache[p_id];
  862. Node *base = nullptr;
  863. if (scene_tree->root->has_node(live_edit_root)) {
  864. base = scene_tree->root->get_node(live_edit_root);
  865. }
  866. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  867. if (!E) {
  868. return; //scene not editable
  869. }
  870. for (Node *F : E->value) {
  871. Node *n = F;
  872. if (base && !base->is_ancestor_of(n)) {
  873. continue;
  874. }
  875. if (!n->has_node(np)) {
  876. continue;
  877. }
  878. Node *n2 = n->get_node(np);
  879. // Do not change transform of edited scene root, unless it's the scene being played.
  880. // See GH-86659 for additional context.
  881. bool keep_transform = (n2 == n) && (n2->get_parent() != scene_tree->root);
  882. Variant orig_tf;
  883. if (keep_transform) {
  884. if (n2->is_class("Node3D")) {
  885. orig_tf = n2->call("get_transform");
  886. } else if (n2->is_class("CanvasItem")) {
  887. orig_tf = n2->call("_edit_get_state");
  888. }
  889. }
  890. n2->set(p_prop, p_value);
  891. if (keep_transform) {
  892. if (n2->is_class("Node3D")) {
  893. Variant new_tf = n2->call("get_transform");
  894. if (new_tf != orig_tf) {
  895. n2->call("set_transform", orig_tf);
  896. }
  897. } else if (n2->is_class("CanvasItem")) {
  898. Variant new_tf = n2->call("_edit_get_state");
  899. if (new_tf != orig_tf) {
  900. n2->call("_edit_set_state", orig_tf);
  901. }
  902. }
  903. }
  904. }
  905. }
  906. void LiveEditor::_node_set_res_func(int p_id, const StringName &p_prop, const String &p_value) {
  907. Ref<Resource> r = ResourceLoader::load(p_value);
  908. if (r.is_null()) {
  909. return;
  910. }
  911. _node_set_func(p_id, p_prop, r);
  912. }
  913. void LiveEditor::_node_call_func(int p_id, const StringName &p_method, const Variant **p_args, int p_argcount) {
  914. SceneTree *scene_tree = SceneTree::get_singleton();
  915. if (!scene_tree) {
  916. return;
  917. }
  918. if (!live_edit_node_path_cache.has(p_id)) {
  919. return;
  920. }
  921. NodePath np = live_edit_node_path_cache[p_id];
  922. Node *base = nullptr;
  923. if (scene_tree->root->has_node(live_edit_root)) {
  924. base = scene_tree->root->get_node(live_edit_root);
  925. }
  926. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  927. if (!E) {
  928. return; //scene not editable
  929. }
  930. for (Node *F : E->value) {
  931. Node *n = F;
  932. if (base && !base->is_ancestor_of(n)) {
  933. continue;
  934. }
  935. if (!n->has_node(np)) {
  936. continue;
  937. }
  938. Node *n2 = n->get_node(np);
  939. // Do not change transform of edited scene root, unless it's the scene being played.
  940. // See GH-86659 for additional context.
  941. bool keep_transform = (n2 == n) && (n2->get_parent() != scene_tree->root);
  942. Variant orig_tf;
  943. if (keep_transform) {
  944. if (n2->is_class("Node3D")) {
  945. orig_tf = n2->call("get_transform");
  946. } else if (n2->is_class("CanvasItem")) {
  947. orig_tf = n2->call("_edit_get_state");
  948. }
  949. }
  950. Callable::CallError ce;
  951. n2->callp(p_method, p_args, p_argcount, ce);
  952. if (keep_transform) {
  953. if (n2->is_class("Node3D")) {
  954. Variant new_tf = n2->call("get_transform");
  955. if (new_tf != orig_tf) {
  956. n2->call("set_transform", orig_tf);
  957. }
  958. } else if (n2->is_class("CanvasItem")) {
  959. Variant new_tf = n2->call("_edit_get_state");
  960. if (new_tf != orig_tf) {
  961. n2->call("_edit_set_state", orig_tf);
  962. }
  963. }
  964. }
  965. }
  966. }
  967. void LiveEditor::_res_set_func(int p_id, const StringName &p_prop, const Variant &p_value) {
  968. if (!live_edit_resource_cache.has(p_id)) {
  969. return;
  970. }
  971. String resp = live_edit_resource_cache[p_id];
  972. if (!ResourceCache::has(resp)) {
  973. return;
  974. }
  975. Ref<Resource> r = ResourceCache::get_ref(resp);
  976. if (r.is_null()) {
  977. return;
  978. }
  979. r->set(p_prop, p_value);
  980. }
  981. void LiveEditor::_res_set_res_func(int p_id, const StringName &p_prop, const String &p_value) {
  982. Ref<Resource> r = ResourceLoader::load(p_value);
  983. if (r.is_null()) {
  984. return;
  985. }
  986. _res_set_func(p_id, p_prop, r);
  987. }
  988. void LiveEditor::_res_call_func(int p_id, const StringName &p_method, const Variant **p_args, int p_argcount) {
  989. if (!live_edit_resource_cache.has(p_id)) {
  990. return;
  991. }
  992. String resp = live_edit_resource_cache[p_id];
  993. if (!ResourceCache::has(resp)) {
  994. return;
  995. }
  996. Ref<Resource> r = ResourceCache::get_ref(resp);
  997. if (r.is_null()) {
  998. return;
  999. }
  1000. Callable::CallError ce;
  1001. r->callp(p_method, p_args, p_argcount, ce);
  1002. }
  1003. void LiveEditor::_root_func(const NodePath &p_scene_path, const String &p_scene_from) {
  1004. live_edit_root = p_scene_path;
  1005. live_edit_scene = p_scene_from;
  1006. }
  1007. void LiveEditor::_create_node_func(const NodePath &p_parent, const String &p_type, const String &p_name) {
  1008. SceneTree *scene_tree = SceneTree::get_singleton();
  1009. if (!scene_tree) {
  1010. return;
  1011. }
  1012. Node *base = nullptr;
  1013. if (scene_tree->root->has_node(live_edit_root)) {
  1014. base = scene_tree->root->get_node(live_edit_root);
  1015. }
  1016. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1017. if (!E) {
  1018. return; //scene not editable
  1019. }
  1020. for (Node *F : E->value) {
  1021. Node *n = F;
  1022. if (base && !base->is_ancestor_of(n)) {
  1023. continue;
  1024. }
  1025. if (!n->has_node(p_parent)) {
  1026. continue;
  1027. }
  1028. Node *n2 = n->get_node(p_parent);
  1029. Node *no = Object::cast_to<Node>(ClassDB::instantiate(p_type));
  1030. if (!no) {
  1031. continue;
  1032. }
  1033. no->set_name(p_name);
  1034. n2->add_child(no);
  1035. }
  1036. }
  1037. void LiveEditor::_instance_node_func(const NodePath &p_parent, const String &p_path, const String &p_name) {
  1038. SceneTree *scene_tree = SceneTree::get_singleton();
  1039. if (!scene_tree) {
  1040. return;
  1041. }
  1042. Ref<PackedScene> ps = ResourceLoader::load(p_path);
  1043. if (ps.is_null()) {
  1044. return;
  1045. }
  1046. Node *base = nullptr;
  1047. if (scene_tree->root->has_node(live_edit_root)) {
  1048. base = scene_tree->root->get_node(live_edit_root);
  1049. }
  1050. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1051. if (!E) {
  1052. return; //scene not editable
  1053. }
  1054. for (Node *F : E->value) {
  1055. Node *n = F;
  1056. if (base && !base->is_ancestor_of(n)) {
  1057. continue;
  1058. }
  1059. if (!n->has_node(p_parent)) {
  1060. continue;
  1061. }
  1062. Node *n2 = n->get_node(p_parent);
  1063. Node *no = ps->instantiate();
  1064. if (!no) {
  1065. continue;
  1066. }
  1067. no->set_name(p_name);
  1068. n2->add_child(no);
  1069. }
  1070. }
  1071. void LiveEditor::_remove_node_func(const NodePath &p_at) {
  1072. SceneTree *scene_tree = SceneTree::get_singleton();
  1073. if (!scene_tree) {
  1074. return;
  1075. }
  1076. Node *base = nullptr;
  1077. if (scene_tree->root->has_node(live_edit_root)) {
  1078. base = scene_tree->root->get_node(live_edit_root);
  1079. }
  1080. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1081. if (!E) {
  1082. return; //scene not editable
  1083. }
  1084. Vector<Node *> to_delete;
  1085. for (HashSet<Node *>::Iterator F = E->value.begin(); F; ++F) {
  1086. Node *n = *F;
  1087. if (base && !base->is_ancestor_of(n)) {
  1088. continue;
  1089. }
  1090. if (!n->has_node(p_at)) {
  1091. continue;
  1092. }
  1093. Node *n2 = n->get_node(p_at);
  1094. to_delete.push_back(n2);
  1095. }
  1096. for (int i = 0; i < to_delete.size(); i++) {
  1097. memdelete(to_delete[i]);
  1098. }
  1099. }
  1100. void LiveEditor::_remove_and_keep_node_func(const NodePath &p_at, ObjectID p_keep_id) {
  1101. SceneTree *scene_tree = SceneTree::get_singleton();
  1102. if (!scene_tree) {
  1103. return;
  1104. }
  1105. Node *base = nullptr;
  1106. if (scene_tree->root->has_node(live_edit_root)) {
  1107. base = scene_tree->root->get_node(live_edit_root);
  1108. }
  1109. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1110. if (!E) {
  1111. return; //scene not editable
  1112. }
  1113. Vector<Node *> to_remove;
  1114. for (HashSet<Node *>::Iterator F = E->value.begin(); F; ++F) {
  1115. Node *n = *F;
  1116. if (base && !base->is_ancestor_of(n)) {
  1117. continue;
  1118. }
  1119. if (!n->has_node(p_at)) {
  1120. continue;
  1121. }
  1122. to_remove.push_back(n);
  1123. }
  1124. for (int i = 0; i < to_remove.size(); i++) {
  1125. Node *n = to_remove[i];
  1126. Node *n2 = n->get_node(p_at);
  1127. n2->get_parent()->remove_child(n2);
  1128. live_edit_remove_list[n][p_keep_id] = n2;
  1129. }
  1130. }
  1131. void LiveEditor::_restore_node_func(ObjectID p_id, const NodePath &p_at, int p_at_pos) {
  1132. SceneTree *scene_tree = SceneTree::get_singleton();
  1133. if (!scene_tree) {
  1134. return;
  1135. }
  1136. Node *base = nullptr;
  1137. if (scene_tree->root->has_node(live_edit_root)) {
  1138. base = scene_tree->root->get_node(live_edit_root);
  1139. }
  1140. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1141. if (!E) {
  1142. return; //scene not editable
  1143. }
  1144. for (HashSet<Node *>::Iterator F = E->value.begin(); F;) {
  1145. HashSet<Node *>::Iterator N = F;
  1146. ++N;
  1147. Node *n = *F;
  1148. if (base && !base->is_ancestor_of(n)) {
  1149. continue;
  1150. }
  1151. if (!n->has_node(p_at)) {
  1152. continue;
  1153. }
  1154. Node *n2 = n->get_node(p_at);
  1155. HashMap<Node *, HashMap<ObjectID, Node *>>::Iterator EN = live_edit_remove_list.find(n);
  1156. if (!EN) {
  1157. continue;
  1158. }
  1159. HashMap<ObjectID, Node *>::Iterator FN = EN->value.find(p_id);
  1160. if (!FN) {
  1161. continue;
  1162. }
  1163. n2->add_child(FN->value);
  1164. EN->value.remove(FN);
  1165. if (EN->value.is_empty()) {
  1166. live_edit_remove_list.remove(EN);
  1167. }
  1168. F = N;
  1169. }
  1170. }
  1171. void LiveEditor::_duplicate_node_func(const NodePath &p_at, const String &p_new_name) {
  1172. SceneTree *scene_tree = SceneTree::get_singleton();
  1173. if (!scene_tree) {
  1174. return;
  1175. }
  1176. Node *base = nullptr;
  1177. if (scene_tree->root->has_node(live_edit_root)) {
  1178. base = scene_tree->root->get_node(live_edit_root);
  1179. }
  1180. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1181. if (!E) {
  1182. return; //scene not editable
  1183. }
  1184. for (Node *F : E->value) {
  1185. Node *n = F;
  1186. if (base && !base->is_ancestor_of(n)) {
  1187. continue;
  1188. }
  1189. if (!n->has_node(p_at)) {
  1190. continue;
  1191. }
  1192. Node *n2 = n->get_node(p_at);
  1193. Node *dup = n2->duplicate(Node::DUPLICATE_SIGNALS | Node::DUPLICATE_GROUPS | Node::DUPLICATE_SCRIPTS);
  1194. if (!dup) {
  1195. continue;
  1196. }
  1197. dup->set_name(p_new_name);
  1198. n2->get_parent()->add_child(dup);
  1199. }
  1200. }
  1201. void LiveEditor::_reparent_node_func(const NodePath &p_at, const NodePath &p_new_place, const String &p_new_name, int p_at_pos) {
  1202. SceneTree *scene_tree = SceneTree::get_singleton();
  1203. if (!scene_tree) {
  1204. return;
  1205. }
  1206. Node *base = nullptr;
  1207. if (scene_tree->root->has_node(live_edit_root)) {
  1208. base = scene_tree->root->get_node(live_edit_root);
  1209. }
  1210. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1211. if (!E) {
  1212. return; //scene not editable
  1213. }
  1214. for (Node *F : E->value) {
  1215. Node *n = F;
  1216. if (base && !base->is_ancestor_of(n)) {
  1217. continue;
  1218. }
  1219. if (!n->has_node(p_at)) {
  1220. continue;
  1221. }
  1222. Node *nfrom = n->get_node(p_at);
  1223. if (!n->has_node(p_new_place)) {
  1224. continue;
  1225. }
  1226. Node *nto = n->get_node(p_new_place);
  1227. nfrom->get_parent()->remove_child(nfrom);
  1228. nfrom->set_name(p_new_name);
  1229. nto->add_child(nfrom);
  1230. if (p_at_pos >= 0) {
  1231. nto->move_child(nfrom, p_at_pos);
  1232. }
  1233. }
  1234. }
  1235. /// RuntimeNodeSelect
  1236. RuntimeNodeSelect *RuntimeNodeSelect::get_singleton() {
  1237. return singleton;
  1238. }
  1239. RuntimeNodeSelect::~RuntimeNodeSelect() {
  1240. if (selection_list && !selection_list->is_visible()) {
  1241. memdelete(selection_list);
  1242. }
  1243. if (draw_canvas.is_valid()) {
  1244. RS::get_singleton()->free(sel_drag_ci);
  1245. RS::get_singleton()->free(sbox_2d_ci);
  1246. RS::get_singleton()->free(draw_canvas);
  1247. }
  1248. }
  1249. void RuntimeNodeSelect::_setup(const Dictionary &p_settings) {
  1250. Window *root = SceneTree::get_singleton()->get_root();
  1251. ERR_FAIL_COND(root->is_connected(SceneStringName(window_input), callable_mp(this, &RuntimeNodeSelect::_root_window_input)));
  1252. root->connect(SceneStringName(window_input), callable_mp(this, &RuntimeNodeSelect::_root_window_input));
  1253. root->connect("size_changed", callable_mp(this, &RuntimeNodeSelect::_queue_selection_update), CONNECT_DEFERRED);
  1254. max_selection = p_settings.get("debugger/max_node_selection", 1);
  1255. panner.instantiate();
  1256. panner->set_callbacks(callable_mp(this, &RuntimeNodeSelect::_pan_callback), callable_mp(this, &RuntimeNodeSelect::_zoom_callback));
  1257. ViewPanner::ControlScheme panning_scheme = (ViewPanner::ControlScheme)p_settings.get("editors/panning/2d_editor_panning_scheme", 0).operator int();
  1258. bool simple_panning = p_settings.get("editors/panning/simple_panning", false);
  1259. int pan_speed = p_settings.get("editors/panning/2d_editor_pan_speed", 20);
  1260. Array keys = p_settings.get("canvas_item_editor/pan_view", Array()).operator Array();
  1261. panner->setup(panning_scheme, DebuggerMarshalls::deserialize_key_shortcut(keys), simple_panning);
  1262. panner->setup_warped_panning(root, p_settings.get("editors/panning/warped_mouse_panning", true));
  1263. panner->set_scroll_speed(pan_speed);
  1264. sel_2d_grab_dist = p_settings.get("editors/polygon_editor/point_grab_radius", 0);
  1265. selection_area_fill = p_settings.get("box_selection_fill_color", Color());
  1266. selection_area_outline = p_settings.get("box_selection_stroke_color", Color());
  1267. draw_canvas = RS::get_singleton()->canvas_create();
  1268. sel_drag_ci = RS::get_singleton()->canvas_item_create();
  1269. /// 2D Selection Box Generation
  1270. sbox_2d_ci = RS::get_singleton()->canvas_item_create();
  1271. RS::get_singleton()->viewport_attach_canvas(root->get_viewport_rid(), draw_canvas);
  1272. RS::get_singleton()->canvas_item_set_parent(sel_drag_ci, draw_canvas);
  1273. RS::get_singleton()->canvas_item_set_parent(sbox_2d_ci, draw_canvas);
  1274. #ifndef _3D_DISABLED
  1275. cursor = Cursor();
  1276. camera_fov = p_settings.get("editors/3d/default_fov", 70);
  1277. camera_znear = p_settings.get("editors/3d/default_z_near", 0.05);
  1278. camera_zfar = p_settings.get("editors/3d/default_z_far", 4'000);
  1279. invert_x_axis = p_settings.get("editors/3d/navigation/invert_x_axis", false);
  1280. invert_y_axis = p_settings.get("editors/3d/navigation/invert_y_axis", false);
  1281. warped_mouse_panning_3d = p_settings.get("editors/3d/navigation/warped_mouse_panning", true);
  1282. freelook_base_speed = p_settings.get("editors/3d/freelook/freelook_base_speed", 5);
  1283. freelook_sensitivity = Math::deg_to_rad((real_t)p_settings.get("editors/3d/freelook/freelook_sensitivity", 0.25));
  1284. orbit_sensitivity = Math::deg_to_rad((real_t)p_settings.get("editors/3d/navigation_feel/orbit_sensitivity", 0.004));
  1285. translation_sensitivity = p_settings.get("editors/3d/navigation_feel/translation_sensitivity", 1);
  1286. /// 3D Selection Box Generation
  1287. // Copied from the Node3DEditor implementation.
  1288. sbox_3d_color = p_settings.get("editors/3d/selection_box_color", Color());
  1289. // Use two AABBs to create the illusion of a slightly thicker line.
  1290. AABB aabb(Vector3(), Vector3(1, 1, 1));
  1291. // Create a x-ray (visible through solid surfaces) and standard version of the selection box.
  1292. // Both will be drawn at the same position, but with different opacity.
  1293. // This lets the user see where the selection is while still having a sense of depth.
  1294. Ref<SurfaceTool> st = memnew(SurfaceTool);
  1295. Ref<SurfaceTool> st_xray = memnew(SurfaceTool);
  1296. st->begin(Mesh::PRIMITIVE_LINES);
  1297. st_xray->begin(Mesh::PRIMITIVE_LINES);
  1298. for (int i = 0; i < 12; i++) {
  1299. Vector3 a, b;
  1300. aabb.get_edge(i, a, b);
  1301. st->add_vertex(a);
  1302. st->add_vertex(b);
  1303. st_xray->add_vertex(a);
  1304. st_xray->add_vertex(b);
  1305. }
  1306. Ref<StandardMaterial3D> mat = memnew(StandardMaterial3D);
  1307. mat->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED);
  1308. mat->set_flag(StandardMaterial3D::FLAG_DISABLE_FOG, true);
  1309. mat->set_albedo(sbox_3d_color);
  1310. mat->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA);
  1311. st->set_material(mat);
  1312. sbox_3d_mesh = st->commit();
  1313. Ref<StandardMaterial3D> mat_xray = memnew(StandardMaterial3D);
  1314. mat_xray->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED);
  1315. mat_xray->set_flag(StandardMaterial3D::FLAG_DISABLE_FOG, true);
  1316. mat_xray->set_flag(StandardMaterial3D::FLAG_DISABLE_DEPTH_TEST, true);
  1317. mat_xray->set_albedo(sbox_3d_color * Color(1, 1, 1, 0.15));
  1318. mat_xray->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA);
  1319. st_xray->set_material(mat_xray);
  1320. sbox_3d_mesh_xray = st_xray->commit();
  1321. #endif // _3D_DISABLED
  1322. SceneTree::get_singleton()->connect("process_frame", callable_mp(this, &RuntimeNodeSelect::_process_frame));
  1323. SceneTree::get_singleton()->connect("physics_frame", callable_mp(this, &RuntimeNodeSelect::_physics_frame));
  1324. // This function will be called before the root enters the tree at first when the Game view is passing its settings to
  1325. // the debugger, so queue the update for after it enters.
  1326. root->connect(SceneStringName(tree_entered), callable_mp(this, &RuntimeNodeSelect::_update_input_state), Object::CONNECT_ONE_SHOT);
  1327. }
  1328. void RuntimeNodeSelect::_node_set_type(NodeType p_type) {
  1329. node_select_type = p_type;
  1330. _update_input_state();
  1331. }
  1332. void RuntimeNodeSelect::_select_set_mode(SelectMode p_mode) {
  1333. node_select_mode = p_mode;
  1334. }
  1335. void RuntimeNodeSelect::_set_camera_override_enabled(bool p_enabled) {
  1336. camera_override = p_enabled;
  1337. if (p_enabled) {
  1338. _update_view_2d();
  1339. }
  1340. #ifndef _3D_DISABLED
  1341. if (camera_first_override) {
  1342. _reset_camera_2d();
  1343. _reset_camera_3d();
  1344. camera_first_override = false;
  1345. } else if (p_enabled) {
  1346. _update_view_2d();
  1347. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  1348. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov * cursor.fov_scale, camera_znear, camera_zfar);
  1349. }
  1350. #endif // _3D_DISABLED
  1351. }
  1352. void RuntimeNodeSelect::_root_window_input(const Ref<InputEvent> &p_event) {
  1353. Window *root = SceneTree::get_singleton()->get_root();
  1354. if (node_select_type == NODE_TYPE_NONE || (selection_list && selection_list->is_visible())) {
  1355. // Workaround for platforms that don't allow subwindows.
  1356. if (selection_list && selection_list->is_visible() && selection_list->is_embedded()) {
  1357. root->set_disable_input_override(false);
  1358. selection_list->push_input(p_event);
  1359. callable_mp(root->get_viewport(), &Viewport::set_disable_input_override).call_deferred(true);
  1360. }
  1361. return;
  1362. }
  1363. bool is_dragging_camera = false;
  1364. if (camera_override) {
  1365. if (node_select_type == NODE_TYPE_2D) {
  1366. is_dragging_camera = panner->gui_input(p_event, Rect2(Vector2(), root->get_visible_rect().get_size()));
  1367. } else if (node_select_type == NODE_TYPE_3D && selection_drag_state == SELECTION_DRAG_NONE) {
  1368. #ifndef _3D_DISABLED
  1369. if (_handle_3d_input(p_event)) {
  1370. return;
  1371. }
  1372. #endif // _3D_DISABLED
  1373. }
  1374. }
  1375. Ref<InputEventMouseButton> b = p_event;
  1376. if (selection_drag_state == SELECTION_DRAG_MOVE) {
  1377. Ref<InputEventMouseMotion> m = p_event;
  1378. if (m.is_valid()) {
  1379. _update_selection_drag(root->get_screen_transform().affine_inverse().xform(m->get_position()));
  1380. return;
  1381. } else if (b.is_valid()) {
  1382. // Account for actions like zooming.
  1383. _update_selection_drag(root->get_screen_transform().affine_inverse().xform(b->get_position()));
  1384. }
  1385. }
  1386. if (b.is_null()) {
  1387. return;
  1388. }
  1389. // Ignore mouse wheel inputs.
  1390. if (b->get_button_index() != MouseButton::LEFT && b->get_button_index() != MouseButton::RIGHT) {
  1391. return;
  1392. }
  1393. if (selection_drag_state == SELECTION_DRAG_MOVE && !b->is_pressed() && b->get_button_index() == MouseButton::LEFT) {
  1394. selection_drag_state = SELECTION_DRAG_END;
  1395. selection_drag_area = selection_drag_area.abs();
  1396. _update_selection_drag();
  1397. // Trigger a selection in the position on release.
  1398. if (multi_shortcut_pressed) {
  1399. selection_position = root->get_screen_transform().affine_inverse().xform(b->get_position());
  1400. }
  1401. }
  1402. if (!is_dragging_camera && b->is_pressed()) {
  1403. multi_shortcut_pressed = b->is_shift_pressed();
  1404. list_shortcut_pressed = node_select_mode == SELECT_MODE_SINGLE && b->get_button_index() == MouseButton::RIGHT && b->is_alt_pressed();
  1405. if (list_shortcut_pressed || b->get_button_index() == MouseButton::LEFT) {
  1406. selection_position = root->get_screen_transform().affine_inverse().xform(b->get_position());
  1407. }
  1408. }
  1409. }
  1410. void RuntimeNodeSelect::_items_popup_index_pressed(int p_index, PopupMenu *p_popup) {
  1411. Object *obj = p_popup->get_item_metadata(p_index).get_validated_object();
  1412. if (obj) {
  1413. Vector<Node *> node;
  1414. node.append(Object::cast_to<Node>(obj));
  1415. _send_ids(node);
  1416. }
  1417. }
  1418. void RuntimeNodeSelect::_update_input_state() {
  1419. SceneTree *scene_tree = SceneTree::get_singleton();
  1420. // This function can be called at the very beginning, when the root hasn't entered the tree yet.
  1421. // So check first to avoid a crash.
  1422. if (!scene_tree->get_root()->is_inside_tree()) {
  1423. return;
  1424. }
  1425. bool disable_input = scene_tree->is_suspended() || node_select_type != RuntimeNodeSelect::NODE_TYPE_NONE;
  1426. Input::get_singleton()->set_disable_input(disable_input);
  1427. Input::get_singleton()->set_mouse_mode_override_enabled(disable_input);
  1428. scene_tree->get_root()->set_disable_input_override(disable_input);
  1429. }
  1430. void RuntimeNodeSelect::_process_frame() {
  1431. #ifndef _3D_DISABLED
  1432. if (camera_freelook) {
  1433. Transform3D transform = _get_cursor_transform();
  1434. Vector3 forward = transform.basis.xform(Vector3(0, 0, -1));
  1435. const Vector3 right = transform.basis.xform(Vector3(1, 0, 0));
  1436. Vector3 up = transform.basis.xform(Vector3(0, 1, 0));
  1437. Vector3 direction;
  1438. Input *input = Input::get_singleton();
  1439. bool was_input_disabled = input->is_input_disabled();
  1440. if (was_input_disabled) {
  1441. input->set_disable_input(false);
  1442. }
  1443. if (input->is_physical_key_pressed(Key::A)) {
  1444. direction -= right;
  1445. }
  1446. if (input->is_physical_key_pressed(Key::D)) {
  1447. direction += right;
  1448. }
  1449. if (input->is_physical_key_pressed(Key::W)) {
  1450. direction += forward;
  1451. }
  1452. if (input->is_physical_key_pressed(Key::S)) {
  1453. direction -= forward;
  1454. }
  1455. if (input->is_physical_key_pressed(Key::E)) {
  1456. direction += up;
  1457. }
  1458. if (input->is_physical_key_pressed(Key::Q)) {
  1459. direction -= up;
  1460. }
  1461. real_t speed = freelook_base_speed;
  1462. if (input->is_physical_key_pressed(Key::SHIFT)) {
  1463. speed *= 3.0;
  1464. }
  1465. if (input->is_physical_key_pressed(Key::ALT)) {
  1466. speed *= 0.333333;
  1467. }
  1468. if (was_input_disabled) {
  1469. input->set_disable_input(true);
  1470. }
  1471. if (direction != Vector3()) {
  1472. // Calculate the process time manually, as the time scale is frozen.
  1473. const double process_time = (1.0 / Engine::get_singleton()->get_frames_per_second()) * Engine::get_singleton()->get_unfrozen_time_scale();
  1474. const Vector3 motion = direction * speed * process_time;
  1475. cursor.pos += motion;
  1476. cursor.eye_pos += motion;
  1477. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  1478. }
  1479. }
  1480. #endif // _3D_DISABLED
  1481. if (selection_update_queued || !SceneTree::get_singleton()->is_suspended()) {
  1482. selection_update_queued = false;
  1483. if (has_selection) {
  1484. _update_selection();
  1485. }
  1486. }
  1487. }
  1488. void RuntimeNodeSelect::_physics_frame() {
  1489. if (selection_drag_state != SELECTION_DRAG_END && (selection_drag_state == SELECTION_DRAG_MOVE || Math::is_inf(selection_position.x))) {
  1490. return;
  1491. }
  1492. Window *root = SceneTree::get_singleton()->get_root();
  1493. bool selection_drag_valid = selection_drag_state == SELECTION_DRAG_END && selection_drag_area.get_area() > SELECTION_MIN_AREA;
  1494. Vector<SelectResult> items;
  1495. if (node_select_type == NODE_TYPE_2D) {
  1496. if (selection_drag_valid) {
  1497. for (int i = 0; i < root->get_child_count(); i++) {
  1498. _find_canvas_items_at_rect(selection_drag_area, root->get_child(i), items);
  1499. }
  1500. } else if (!Math::is_inf(selection_position.x)) {
  1501. for (int i = 0; i < root->get_child_count(); i++) {
  1502. _find_canvas_items_at_pos(selection_position, root->get_child(i), items);
  1503. }
  1504. }
  1505. // Remove possible duplicates.
  1506. for (int i = 0; i < items.size(); i++) {
  1507. Node *item = items[i].item;
  1508. for (int j = 0; j < i; j++) {
  1509. if (items[j].item == item) {
  1510. items.remove_at(i);
  1511. i--;
  1512. break;
  1513. }
  1514. }
  1515. }
  1516. } else if (node_select_type == NODE_TYPE_3D) {
  1517. #ifndef _3D_DISABLED
  1518. if (selection_drag_valid) {
  1519. _find_3d_items_at_rect(selection_drag_area, items);
  1520. } else {
  1521. _find_3d_items_at_pos(selection_position, items);
  1522. }
  1523. #endif // _3D_DISABLED
  1524. }
  1525. items.sort();
  1526. switch (selection_drag_state) {
  1527. case SELECTION_DRAG_END: {
  1528. selection_position = Point2(Math::INF, Math::INF);
  1529. selection_drag_state = SELECTION_DRAG_NONE;
  1530. if (selection_drag_area.get_area() > SELECTION_MIN_AREA) {
  1531. if (!items.is_empty()) {
  1532. Vector<Node *> nodes;
  1533. for (const SelectResult item : items) {
  1534. nodes.append(item.item);
  1535. }
  1536. _send_ids(nodes, false);
  1537. }
  1538. _update_selection_drag();
  1539. return;
  1540. }
  1541. _update_selection_drag();
  1542. } break;
  1543. case SELECTION_DRAG_NONE: {
  1544. if (node_select_mode == SELECT_MODE_LIST) {
  1545. break;
  1546. }
  1547. if (multi_shortcut_pressed) {
  1548. // Allow forcing box selection when an item was clicked.
  1549. selection_drag_state = SELECTION_DRAG_MOVE;
  1550. } else if (items.is_empty()) {
  1551. #ifdef _3D_DISABLED
  1552. if (!selected_ci_nodes.is_empty()) {
  1553. #else
  1554. if (!selected_ci_nodes.is_empty() || !selected_3d_nodes.is_empty()) {
  1555. #endif // _3D_DISABLED
  1556. EngineDebugger::get_singleton()->send_message("remote_nothing_selected", Array());
  1557. _clear_selection();
  1558. }
  1559. selection_drag_state = SELECTION_DRAG_MOVE;
  1560. } else {
  1561. break;
  1562. }
  1563. [[fallthrough]];
  1564. }
  1565. case SELECTION_DRAG_MOVE: {
  1566. selection_drag_area.position = selection_position;
  1567. // Stop selection on click, so it can happen on release if the selection area doesn't pass the threshold.
  1568. if (multi_shortcut_pressed) {
  1569. return;
  1570. }
  1571. }
  1572. }
  1573. if (items.is_empty()) {
  1574. selection_position = Point2(Math::INF, Math::INF);
  1575. return;
  1576. }
  1577. if ((!list_shortcut_pressed && node_select_mode == SELECT_MODE_SINGLE) || items.size() == 1) {
  1578. selection_position = Point2(Math::INF, Math::INF);
  1579. Vector<Node *> node;
  1580. node.append(items[0].item);
  1581. _send_ids(node);
  1582. return;
  1583. }
  1584. if (!selection_list && (list_shortcut_pressed || node_select_mode == SELECT_MODE_LIST)) {
  1585. _open_selection_list(items, selection_position);
  1586. }
  1587. selection_position = Point2(Math::INF, Math::INF);
  1588. }
  1589. void RuntimeNodeSelect::_send_ids(const Vector<Node *> &p_picked_nodes, bool p_invert_new_selections) {
  1590. ERR_FAIL_COND(p_picked_nodes.is_empty());
  1591. Vector<Node *> picked_nodes = p_picked_nodes;
  1592. Array message;
  1593. if (!multi_shortcut_pressed) {
  1594. if (picked_nodes.size() > max_selection) {
  1595. picked_nodes.resize(max_selection);
  1596. EngineDebugger::get_singleton()->send_message("show_selection_limit_warning", Array());
  1597. }
  1598. for (const Node *node : picked_nodes) {
  1599. SceneDebuggerObject obj(node->get_instance_id());
  1600. Array arr;
  1601. obj.serialize(arr);
  1602. message.append(arr);
  1603. }
  1604. EngineDebugger::get_singleton()->send_message("remote_objects_selected", message);
  1605. _set_selected_nodes(picked_nodes);
  1606. return;
  1607. }
  1608. int limit = max_selection - selected_ci_nodes.size();
  1609. #ifndef _3D_DISABLED
  1610. limit -= selected_3d_nodes.size();
  1611. #endif // _3D_DISABLED
  1612. if (limit <= 0) {
  1613. return;
  1614. }
  1615. if (picked_nodes.size() > limit) {
  1616. picked_nodes.resize(limit);
  1617. EngineDebugger::get_singleton()->send_message("show_selection_limit_warning", Array());
  1618. }
  1619. LocalVector<Node *> nodes;
  1620. LocalVector<ObjectID> ids;
  1621. for (Node *node : picked_nodes) {
  1622. ObjectID id = node->get_instance_id();
  1623. if (CanvasItem *ci = Object::cast_to<CanvasItem>(node)) {
  1624. if (selected_ci_nodes.has(id)) {
  1625. if (p_invert_new_selections) {
  1626. selected_ci_nodes.erase(id);
  1627. }
  1628. } else {
  1629. ids.push_back(id);
  1630. nodes.push_back(ci);
  1631. }
  1632. } else {
  1633. #ifndef _3D_DISABLED
  1634. if (Node3D *node3d = Object::cast_to<Node3D>(node)) {
  1635. if (selected_3d_nodes.has(id)) {
  1636. if (p_invert_new_selections) {
  1637. selected_3d_nodes.erase(id);
  1638. }
  1639. } else {
  1640. ids.push_back(id);
  1641. nodes.push_back(node3d);
  1642. }
  1643. }
  1644. #endif // _3D_DISABLED
  1645. }
  1646. }
  1647. for (ObjectID id : selected_ci_nodes) {
  1648. ids.push_back(id);
  1649. nodes.push_back(ObjectDB::get_instance<Node>(id));
  1650. }
  1651. #ifndef _3D_DISABLED
  1652. for (const KeyValue<ObjectID, Ref<SelectionBox3D>> &KV : selected_3d_nodes) {
  1653. ids.push_back(KV.key);
  1654. nodes.push_back(ObjectDB::get_instance<Node>(KV.key));
  1655. }
  1656. #endif // _3D_DISABLED
  1657. if (ids.size() > (unsigned)max_selection) {
  1658. ids.resize(max_selection);
  1659. EngineDebugger::get_singleton()->send_message("show_selection_limit_warning", Array());
  1660. }
  1661. if (ids.is_empty()) {
  1662. EngineDebugger::get_singleton()->send_message("remote_nothing_selected", message);
  1663. } else {
  1664. for (const ObjectID &id : ids) {
  1665. SceneDebuggerObject obj(id);
  1666. Array arr;
  1667. obj.serialize(arr);
  1668. message.append(arr);
  1669. }
  1670. EngineDebugger::get_singleton()->send_message("remote_objects_selected", message);
  1671. }
  1672. _set_selected_nodes(nodes);
  1673. }
  1674. void RuntimeNodeSelect::_set_selected_nodes(const Vector<Node *> &p_nodes) {
  1675. if (p_nodes.is_empty()) {
  1676. _clear_selection();
  1677. return;
  1678. }
  1679. bool changed = false;
  1680. LocalVector<ObjectID> nodes_ci;
  1681. #ifndef _3D_DISABLED
  1682. HashMap<ObjectID, Ref<SelectionBox3D>> nodes_3d;
  1683. #endif // _3D_DISABLED
  1684. for (Node *node : p_nodes) {
  1685. ObjectID id = node->get_instance_id();
  1686. if (Object::cast_to<CanvasItem>(node)) {
  1687. if (!changed || !selected_ci_nodes.has(id)) {
  1688. changed = true;
  1689. }
  1690. nodes_ci.push_back(id);
  1691. } else {
  1692. #ifndef _3D_DISABLED
  1693. Node3D *node_3d = Object::cast_to<Node3D>(node);
  1694. if (!node_3d || !node_3d->is_inside_world()) {
  1695. continue;
  1696. }
  1697. if (!changed || !selected_3d_nodes.has(id)) {
  1698. changed = true;
  1699. }
  1700. if (selected_3d_nodes.has(id)) {
  1701. // Assign an already available visual instance.
  1702. nodes_3d[id] = selected_3d_nodes.get(id);
  1703. continue;
  1704. }
  1705. if (sbox_3d_mesh.is_null() || sbox_3d_mesh_xray.is_null()) {
  1706. continue;
  1707. }
  1708. Ref<SelectionBox3D> sb;
  1709. sb.instantiate();
  1710. nodes_3d[id] = sb;
  1711. RID scenario = node_3d->get_world_3d()->get_scenario();
  1712. sb->instance = RS::get_singleton()->instance_create2(sbox_3d_mesh->get_rid(), scenario);
  1713. sb->instance_ofs = RS::get_singleton()->instance_create2(sbox_3d_mesh->get_rid(), scenario);
  1714. RS::get_singleton()->instance_geometry_set_cast_shadows_setting(sb->instance, RS::SHADOW_CASTING_SETTING_OFF);
  1715. RS::get_singleton()->instance_geometry_set_cast_shadows_setting(sb->instance_ofs, RS::SHADOW_CASTING_SETTING_OFF);
  1716. RS::get_singleton()->instance_geometry_set_flag(sb->instance, RS::INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING, true);
  1717. RS::get_singleton()->instance_geometry_set_flag(sb->instance, RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  1718. RS::get_singleton()->instance_geometry_set_flag(sb->instance_ofs, RS::INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING, true);
  1719. RS::get_singleton()->instance_geometry_set_flag(sb->instance_ofs, RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  1720. sb->instance_xray = RS::get_singleton()->instance_create2(sbox_3d_mesh_xray->get_rid(), scenario);
  1721. sb->instance_xray_ofs = RS::get_singleton()->instance_create2(sbox_3d_mesh_xray->get_rid(), scenario);
  1722. RS::get_singleton()->instance_geometry_set_cast_shadows_setting(sb->instance_xray, RS::SHADOW_CASTING_SETTING_OFF);
  1723. RS::get_singleton()->instance_geometry_set_cast_shadows_setting(sb->instance_xray_ofs, RS::SHADOW_CASTING_SETTING_OFF);
  1724. RS::get_singleton()->instance_geometry_set_flag(sb->instance_xray, RS::INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING, true);
  1725. RS::get_singleton()->instance_geometry_set_flag(sb->instance_xray, RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  1726. RS::get_singleton()->instance_geometry_set_flag(sb->instance_xray_ofs, RS::INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING, true);
  1727. RS::get_singleton()->instance_geometry_set_flag(sb->instance_xray_ofs, RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  1728. #endif // _3D_DISABLED
  1729. }
  1730. }
  1731. #ifdef _3D_DISABLED
  1732. if (!changed && nodes_ci.size() == selected_ci_nodes.size()) {
  1733. return;
  1734. }
  1735. #else
  1736. if (!changed && nodes_ci.size() == selected_ci_nodes.size() && nodes_3d.size() == selected_3d_nodes.size()) {
  1737. return;
  1738. }
  1739. #endif // _3D_DISABLED
  1740. _clear_selection();
  1741. selected_ci_nodes = nodes_ci;
  1742. has_selection = !nodes_ci.is_empty();
  1743. #ifndef _3D_DISABLED
  1744. if (!nodes_3d.is_empty()) {
  1745. selected_3d_nodes = nodes_3d;
  1746. has_selection = true;
  1747. }
  1748. #endif // _3D_DISABLED
  1749. _queue_selection_update();
  1750. }
  1751. void RuntimeNodeSelect::_queue_selection_update() {
  1752. if (has_selection && selection_visible) {
  1753. if (SceneTree::get_singleton()->is_suspended()) {
  1754. _update_selection();
  1755. } else {
  1756. selection_update_queued = true;
  1757. }
  1758. }
  1759. }
  1760. void RuntimeNodeSelect::_update_selection() {
  1761. Window *root = SceneTree::get_singleton()->get_root();
  1762. RS::get_singleton()->canvas_item_clear(sbox_2d_ci);
  1763. RS::get_singleton()->canvas_item_set_visible(sbox_2d_ci, selection_visible);
  1764. for (LocalVector<ObjectID>::Iterator E = selected_ci_nodes.begin(); E != selected_ci_nodes.end(); ++E) {
  1765. ObjectID id = *E;
  1766. CanvasItem *ci = ObjectDB::get_instance<CanvasItem>(id);
  1767. if (!ci) {
  1768. selected_ci_nodes.erase(id);
  1769. --E;
  1770. continue;
  1771. }
  1772. if (!ci->is_inside_tree()) {
  1773. continue;
  1774. }
  1775. Transform2D xform;
  1776. // Cameras (overridden or not) don't affect `CanvasLayer`s.
  1777. if (root->is_canvas_transform_override_enabled() && !(ci->get_canvas_layer_node() && !ci->get_canvas_layer_node()->is_following_viewport())) {
  1778. xform = root->get_canvas_transform_override() * ci->get_global_transform();
  1779. } else {
  1780. xform = ci->get_global_transform_with_canvas();
  1781. }
  1782. // Fallback.
  1783. Rect2 rect = Rect2(Vector2(), Vector2(10, 10));
  1784. if (ci->_edit_use_rect()) {
  1785. rect = ci->_edit_get_rect();
  1786. } else {
  1787. #ifndef PHYSICS_2D_DISABLED
  1788. CollisionShape2D *collision_shape = Object::cast_to<CollisionShape2D>(ci);
  1789. if (collision_shape) {
  1790. Ref<Shape2D> shape = collision_shape->get_shape();
  1791. if (shape.is_valid()) {
  1792. rect = shape->get_rect();
  1793. }
  1794. }
  1795. #endif // PHYSICS_2D_DISABLED
  1796. }
  1797. const Vector2 endpoints[4] = {
  1798. xform.xform(rect.position),
  1799. xform.xform(rect.position + Point2(rect.size.x, 0)),
  1800. xform.xform(rect.position + rect.size),
  1801. xform.xform(rect.position + Point2(0, rect.size.y))
  1802. };
  1803. const Color selection_color_2d = Color(1, 0.6, 0.4, 0.7);
  1804. for (int i = 0; i < 4; i++) {
  1805. RS::get_singleton()->canvas_item_add_line(sbox_2d_ci, endpoints[i], endpoints[(i + 1) % 4], selection_color_2d, 2);
  1806. }
  1807. }
  1808. #ifndef _3D_DISABLED
  1809. for (HashMap<ObjectID, Ref<SelectionBox3D>>::ConstIterator KV = selected_3d_nodes.begin(); KV != selected_3d_nodes.end(); ++KV) {
  1810. ObjectID id = KV->key;
  1811. Node3D *node_3d = ObjectDB::get_instance<Node3D>(id);
  1812. if (!node_3d) {
  1813. selected_3d_nodes.erase(id);
  1814. --KV;
  1815. continue;
  1816. }
  1817. if (!node_3d->is_inside_tree()) {
  1818. continue;
  1819. }
  1820. // Fallback.
  1821. AABB bounds(Vector3(-0.5, -0.5, -0.5), Vector3(1, 1, 1));
  1822. VisualInstance3D *visual_instance = Object::cast_to<VisualInstance3D>(node_3d);
  1823. if (visual_instance) {
  1824. bounds = visual_instance->get_aabb();
  1825. } else {
  1826. #ifndef PHYSICS_2D_DISABLED
  1827. CollisionShape3D *collision_shape = Object::cast_to<CollisionShape3D>(node_3d);
  1828. if (collision_shape) {
  1829. Ref<Shape3D> shape = collision_shape->get_shape();
  1830. if (shape.is_valid()) {
  1831. bounds = shape->get_debug_mesh()->get_aabb();
  1832. }
  1833. }
  1834. #endif // PHYSICS_2D_DISABLED
  1835. }
  1836. Transform3D xform_to_top_level_parent_space = node_3d->get_global_transform().affine_inverse() * node_3d->get_global_transform();
  1837. bounds = xform_to_top_level_parent_space.xform(bounds);
  1838. Transform3D t = node_3d->get_global_transform();
  1839. Ref<SelectionBox3D> sb = KV->value;
  1840. if (t == sb->transform && bounds == sb->bounds) {
  1841. continue; // Nothing changed.
  1842. }
  1843. sb->transform = t;
  1844. sb->bounds = bounds;
  1845. Transform3D t_offset = t;
  1846. // Apply AABB scaling before item's global transform.
  1847. {
  1848. const Vector3 offset(0.005, 0.005, 0.005);
  1849. Basis aabb_s;
  1850. aabb_s.scale(bounds.size + offset);
  1851. t.translate_local(bounds.position - offset / 2);
  1852. t.basis = t.basis * aabb_s;
  1853. }
  1854. {
  1855. const Vector3 offset(0.01, 0.01, 0.01);
  1856. Basis aabb_s;
  1857. aabb_s.scale(bounds.size + offset);
  1858. t_offset.translate_local(bounds.position - offset / 2);
  1859. t_offset.basis = t_offset.basis * aabb_s;
  1860. }
  1861. RS::get_singleton()->instance_set_visible(sb->instance, selection_visible);
  1862. RS::get_singleton()->instance_set_visible(sb->instance_ofs, selection_visible);
  1863. RS::get_singleton()->instance_set_visible(sb->instance_xray, selection_visible);
  1864. RS::get_singleton()->instance_set_visible(sb->instance_xray_ofs, selection_visible);
  1865. RS::get_singleton()->instance_set_transform(sb->instance, t);
  1866. RS::get_singleton()->instance_set_transform(sb->instance_ofs, t_offset);
  1867. RS::get_singleton()->instance_set_transform(sb->instance_xray, t);
  1868. RS::get_singleton()->instance_set_transform(sb->instance_xray_ofs, t_offset);
  1869. }
  1870. #endif // _3D_DISABLED
  1871. }
  1872. void RuntimeNodeSelect::_clear_selection() {
  1873. selected_ci_nodes.clear();
  1874. if (draw_canvas.is_valid()) {
  1875. RS::get_singleton()->canvas_item_clear(sbox_2d_ci);
  1876. }
  1877. #ifndef _3D_DISABLED
  1878. selected_3d_nodes.clear();
  1879. #endif // _3D_DISABLED
  1880. has_selection = false;
  1881. }
  1882. void RuntimeNodeSelect::_update_selection_drag(const Point2 &p_end_pos) {
  1883. RS::get_singleton()->canvas_item_clear(sel_drag_ci);
  1884. if (selection_drag_state != SELECTION_DRAG_MOVE) {
  1885. return;
  1886. }
  1887. selection_drag_area.size = p_end_pos - selection_drag_area.position;
  1888. if (selection_drag_state == SELECTION_DRAG_END) {
  1889. return;
  1890. }
  1891. Window *root = SceneTree::get_singleton()->get_root();
  1892. Rect2 selection_drawing;
  1893. int thickness;
  1894. if (root->is_canvas_transform_override_enabled()) {
  1895. Transform2D xform = root->get_canvas_transform_override();
  1896. RS::get_singleton()->canvas_item_set_transform(sel_drag_ci, xform);
  1897. RS::get_singleton()->canvas_item_reset_physics_interpolation(sel_drag_ci);
  1898. selection_drawing.position = xform.affine_inverse().xform(selection_drag_area.position);
  1899. selection_drawing.size = xform.affine_inverse().xform(p_end_pos);
  1900. thickness = MAX(1, Math::ceil(1 / view_2d_zoom));
  1901. } else {
  1902. RS::get_singleton()->canvas_item_set_transform(sel_drag_ci, Transform2D());
  1903. RS::get_singleton()->canvas_item_reset_physics_interpolation(sel_drag_ci);
  1904. selection_drawing.position = selection_drag_area.position;
  1905. selection_drawing.size = p_end_pos;
  1906. thickness = 1;
  1907. }
  1908. selection_drawing.size -= selection_drawing.position;
  1909. selection_drawing = selection_drawing.abs();
  1910. const Vector2 endpoints[4] = {
  1911. selection_drawing.position,
  1912. selection_drawing.position + Point2(selection_drawing.size.x, 0),
  1913. selection_drawing.position + selection_drawing.size,
  1914. selection_drawing.position + Point2(0, selection_drawing.size.y)
  1915. };
  1916. // Draw fill.
  1917. RS::get_singleton()->canvas_item_add_rect(sel_drag_ci, selection_drawing, selection_area_fill);
  1918. // Draw outline.
  1919. for (int i = 0; i < 4; i++) {
  1920. RS::get_singleton()->canvas_item_add_line(sel_drag_ci, endpoints[i], endpoints[(i + 1) % 4], selection_area_outline, thickness);
  1921. }
  1922. }
  1923. void RuntimeNodeSelect::_open_selection_list(const Vector<SelectResult> &p_items, const Point2 &p_pos) {
  1924. Window *root = SceneTree::get_singleton()->get_root();
  1925. selection_list = memnew(PopupMenu);
  1926. selection_list->set_theme(ThemeDB::get_singleton()->get_default_theme());
  1927. selection_list->set_auto_translate_mode(Node::AUTO_TRANSLATE_MODE_DISABLED);
  1928. selection_list->set_force_native(true);
  1929. selection_list->connect("index_pressed", callable_mp(this, &RuntimeNodeSelect::_items_popup_index_pressed).bind(selection_list));
  1930. selection_list->connect("popup_hide", callable_mp(this, &RuntimeNodeSelect::_close_selection_list));
  1931. root->add_child(selection_list);
  1932. for (const SelectResult &I : p_items) {
  1933. selection_list->add_item(I.item->get_name());
  1934. selection_list->set_item_metadata(-1, I.item);
  1935. }
  1936. selection_list->set_position(selection_list->is_embedded() ? p_pos : (Input::get_singleton()->get_mouse_position() + root->get_position()));
  1937. selection_list->reset_size();
  1938. selection_list->popup();
  1939. // FIXME: Ugly hack that stops the popup from hiding when the button is released.
  1940. selection_list->call_deferred(SNAME("set_position"), selection_list->get_position() + Point2(1, 0));
  1941. }
  1942. void RuntimeNodeSelect::_close_selection_list() {
  1943. selection_list->queue_free();
  1944. selection_list = nullptr;
  1945. }
  1946. void RuntimeNodeSelect::_set_selection_visible(bool p_visible) {
  1947. selection_visible = p_visible;
  1948. if (has_selection) {
  1949. _update_selection();
  1950. }
  1951. }
  1952. // Copied and trimmed from the CanvasItemEditor implementation.
  1953. void RuntimeNodeSelect::_find_canvas_items_at_pos(const Point2 &p_pos, Node *p_node, Vector<SelectResult> &r_items, const Transform2D &p_parent_xform, const Transform2D &p_canvas_xform) {
  1954. if (!p_node || Object::cast_to<Viewport>(p_node)) {
  1955. return;
  1956. }
  1957. CanvasItem *ci = Object::cast_to<CanvasItem>(p_node);
  1958. for (int i = p_node->get_child_count() - 1; i >= 0; i--) {
  1959. if (ci) {
  1960. if (!ci->is_set_as_top_level()) {
  1961. _find_canvas_items_at_pos(p_pos, p_node->get_child(i), r_items, p_parent_xform * ci->get_transform(), p_canvas_xform);
  1962. } else {
  1963. _find_canvas_items_at_pos(p_pos, p_node->get_child(i), r_items, ci->get_transform(), p_canvas_xform);
  1964. }
  1965. } else {
  1966. CanvasLayer *cl = Object::cast_to<CanvasLayer>(p_node);
  1967. _find_canvas_items_at_pos(p_pos, p_node->get_child(i), r_items, Transform2D(), cl ? cl->get_transform() : p_canvas_xform);
  1968. }
  1969. }
  1970. if (!ci || !ci->is_visible_in_tree()) {
  1971. return;
  1972. }
  1973. Transform2D xform = p_canvas_xform;
  1974. if (!ci->is_set_as_top_level()) {
  1975. xform *= p_parent_xform;
  1976. }
  1977. Window *root = SceneTree::get_singleton()->get_root();
  1978. Point2 pos;
  1979. // Cameras (overridden or not) don't affect `CanvasLayer`s.
  1980. if (!ci->get_canvas_layer_node() || ci->get_canvas_layer_node()->is_following_viewport()) {
  1981. pos = (root->is_canvas_transform_override_enabled() ? root->get_canvas_transform_override() : root->get_canvas_transform()).affine_inverse().xform(p_pos);
  1982. } else {
  1983. pos = p_pos;
  1984. }
  1985. xform = (xform * ci->get_transform()).affine_inverse();
  1986. const real_t local_grab_distance = xform.basis_xform(Vector2(sel_2d_grab_dist, 0)).length() / view_2d_zoom;
  1987. if (ci->_edit_is_selected_on_click(xform.xform(pos), local_grab_distance)) {
  1988. SelectResult res;
  1989. res.item = ci;
  1990. res.order = ci->get_effective_z_index() + ci->get_canvas_layer();
  1991. r_items.push_back(res);
  1992. #ifndef PHYSICS_2D_DISABLED
  1993. // If it's a shape, get the collision object it's from.
  1994. // FIXME: If the collision object has multiple shapes, only the topmost will be above it in the list.
  1995. if (Object::cast_to<CollisionShape2D>(ci) || Object::cast_to<CollisionPolygon2D>(ci)) {
  1996. CollisionObject2D *collision_object = Object::cast_to<CollisionObject2D>(ci->get_parent());
  1997. if (collision_object) {
  1998. SelectResult res_col;
  1999. res_col.item = ci->get_parent();
  2000. res_col.order = collision_object->get_z_index() + ci->get_canvas_layer();
  2001. r_items.push_back(res_col);
  2002. }
  2003. }
  2004. #endif // PHYSICS_2D_DISABLED
  2005. }
  2006. }
  2007. // Copied and trimmed from the CanvasItemEditor implementation.
  2008. void RuntimeNodeSelect::_find_canvas_items_at_rect(const Rect2 &p_rect, Node *p_node, Vector<SelectResult> &r_items, const Transform2D &p_parent_xform, const Transform2D &p_canvas_xform) {
  2009. if (!p_node || Object::cast_to<Viewport>(p_node)) {
  2010. return;
  2011. }
  2012. CanvasItem *ci = Object::cast_to<CanvasItem>(p_node);
  2013. for (int i = p_node->get_child_count() - 1; i >= 0; i--) {
  2014. if (ci) {
  2015. if (!ci->is_set_as_top_level()) {
  2016. _find_canvas_items_at_rect(p_rect, p_node->get_child(i), r_items, p_parent_xform * ci->get_transform(), p_canvas_xform);
  2017. } else {
  2018. _find_canvas_items_at_rect(p_rect, p_node->get_child(i), r_items, ci->get_transform(), p_canvas_xform);
  2019. }
  2020. } else {
  2021. CanvasLayer *cl = Object::cast_to<CanvasLayer>(p_node);
  2022. _find_canvas_items_at_rect(p_rect, p_node->get_child(i), r_items, Transform2D(), cl ? cl->get_transform() : p_canvas_xform);
  2023. }
  2024. }
  2025. if (!ci || !ci->is_visible_in_tree()) {
  2026. return;
  2027. }
  2028. Transform2D xform = p_canvas_xform;
  2029. if (!ci->is_set_as_top_level()) {
  2030. xform *= p_parent_xform;
  2031. }
  2032. Window *root = SceneTree::get_singleton()->get_root();
  2033. Rect2 rect;
  2034. // Cameras (overridden or not) don't affect `CanvasLayer`s.
  2035. if (!ci->get_canvas_layer_node() || ci->get_canvas_layer_node()->is_following_viewport()) {
  2036. rect = (root->is_canvas_transform_override_enabled() ? root->get_canvas_transform_override() : root->get_canvas_transform()).affine_inverse().xform(p_rect);
  2037. } else {
  2038. rect = p_rect;
  2039. }
  2040. rect = (xform * ci->get_transform()).affine_inverse().xform(rect);
  2041. bool selected = false;
  2042. if (ci->_edit_use_rect()) {
  2043. Rect2 ci_rect = ci->_edit_get_rect();
  2044. if (rect.has_point(ci_rect.position) &&
  2045. rect.has_point(ci_rect.position + Vector2(ci_rect.size.x, 0)) &&
  2046. rect.has_point(ci_rect.position + Vector2(ci_rect.size.x, ci_rect.size.y)) &&
  2047. rect.has_point(ci_rect.position + Vector2(0, ci_rect.size.y))) {
  2048. selected = true;
  2049. }
  2050. } else if (rect.has_point(Point2())) {
  2051. selected = true;
  2052. }
  2053. if (selected) {
  2054. SelectResult res;
  2055. res.item = ci;
  2056. res.order = ci->get_effective_z_index() + ci->get_canvas_layer();
  2057. r_items.push_back(res);
  2058. }
  2059. }
  2060. void RuntimeNodeSelect::_pan_callback(Vector2 p_scroll_vec, Ref<InputEvent> p_event) {
  2061. Vector2 scroll = SceneTree::get_singleton()->get_root()->get_screen_transform().affine_inverse().xform(p_scroll_vec);
  2062. view_2d_offset.x -= scroll.x / view_2d_zoom;
  2063. view_2d_offset.y -= scroll.y / view_2d_zoom;
  2064. _update_view_2d();
  2065. }
  2066. // A very shallow copy of the same function inside CanvasItemEditor.
  2067. void RuntimeNodeSelect::_zoom_callback(float p_zoom_factor, Vector2 p_origin, Ref<InputEvent> p_event) {
  2068. real_t prev_zoom = view_2d_zoom;
  2069. view_2d_zoom = CLAMP(view_2d_zoom * p_zoom_factor, VIEW_2D_MIN_ZOOM, VIEW_2D_MAX_ZOOM);
  2070. Vector2 pos = SceneTree::get_singleton()->get_root()->get_screen_transform().affine_inverse().xform(p_origin);
  2071. view_2d_offset += pos / prev_zoom - pos / view_2d_zoom;
  2072. // We want to align in-scene pixels to screen pixels, this prevents blurry rendering
  2073. // of small details (texts, lines).
  2074. // This correction adds a jitter movement when zooming, so we correct only when the
  2075. // zoom factor is an integer. (in the other cases, all pixels won't be aligned anyway)
  2076. const real_t closest_zoom_factor = Math::round(view_2d_zoom);
  2077. if (Math::is_zero_approx(view_2d_zoom - closest_zoom_factor)) {
  2078. // Make sure scene pixel at view_offset is aligned on a screen pixel.
  2079. Vector2 view_offset_int = view_2d_offset.floor();
  2080. Vector2 view_offset_frac = view_2d_offset - view_offset_int;
  2081. view_2d_offset = view_offset_int + (view_offset_frac * closest_zoom_factor).round() / closest_zoom_factor;
  2082. }
  2083. _update_view_2d();
  2084. }
  2085. void RuntimeNodeSelect::_reset_camera_2d() {
  2086. view_2d_offset = -SceneTree::get_singleton()->get_root()->get_canvas_transform().get_origin();
  2087. view_2d_zoom = 1;
  2088. _update_view_2d();
  2089. }
  2090. void RuntimeNodeSelect::_update_view_2d() {
  2091. Transform2D transform = Transform2D();
  2092. transform.scale_basis(Size2(view_2d_zoom, view_2d_zoom));
  2093. transform.columns[2] = -view_2d_offset * view_2d_zoom;
  2094. SceneTree::get_singleton()->get_root()->set_canvas_transform_override(transform);
  2095. _queue_selection_update();
  2096. }
  2097. #ifndef _3D_DISABLED
  2098. void RuntimeNodeSelect::_find_3d_items_at_pos(const Point2 &p_pos, Vector<SelectResult> &r_items) {
  2099. Window *root = SceneTree::get_singleton()->get_root();
  2100. Vector3 ray, pos, to;
  2101. if (root->is_camera_3d_override_enabled()) {
  2102. ray = root->camera_3d_override_project_ray_normal(p_pos);
  2103. pos = root->camera_3d_override_project_ray_origin(p_pos);
  2104. to = pos + ray * root->get_camera_3d_override_properties()["z_far"];
  2105. } else {
  2106. Camera3D *camera = root->get_camera_3d();
  2107. if (!camera) {
  2108. return;
  2109. }
  2110. ray = camera->project_ray_normal(p_pos);
  2111. pos = camera->project_ray_origin(p_pos);
  2112. to = pos + ray * camera->get_far();
  2113. }
  2114. #ifndef PHYSICS_3D_DISABLED
  2115. // Start with physical objects.
  2116. PhysicsDirectSpaceState3D *ss = root->get_world_3d()->get_direct_space_state();
  2117. PhysicsDirectSpaceState3D::RayResult result;
  2118. HashSet<RID> excluded;
  2119. PhysicsDirectSpaceState3D::RayParameters ray_params;
  2120. ray_params.from = pos;
  2121. ray_params.to = to;
  2122. ray_params.collide_with_areas = true;
  2123. while (true) {
  2124. ray_params.exclude = excluded;
  2125. if (ss->intersect_ray(ray_params, result)) {
  2126. SelectResult res;
  2127. res.item = Object::cast_to<Node>(result.collider);
  2128. res.order = -pos.distance_to(result.position);
  2129. // Fetch collision shapes.
  2130. CollisionObject3D *collision = Object::cast_to<CollisionObject3D>(result.collider);
  2131. if (collision) {
  2132. List<uint32_t> owners;
  2133. collision->get_shape_owners(&owners);
  2134. for (uint32_t &I : owners) {
  2135. SelectResult res_shape;
  2136. res_shape.item = Object::cast_to<Node>(collision->shape_owner_get_owner(I));
  2137. res_shape.order = res.order;
  2138. r_items.push_back(res_shape);
  2139. }
  2140. }
  2141. r_items.push_back(res);
  2142. excluded.insert(result.rid);
  2143. } else {
  2144. break;
  2145. }
  2146. }
  2147. #endif // PHYSICS_3D_DISABLED
  2148. // Then go for the meshes.
  2149. Vector<ObjectID> items = RS::get_singleton()->instances_cull_ray(pos, to, root->get_world_3d()->get_scenario());
  2150. for (int i = 0; i < items.size(); i++) {
  2151. Object *obj = ObjectDB::get_instance(items[i]);
  2152. GeometryInstance3D *geo_instance = Object::cast_to<GeometryInstance3D>(obj);
  2153. if (geo_instance) {
  2154. Ref<TriangleMesh> mesh_collision = geo_instance->generate_triangle_mesh();
  2155. if (mesh_collision.is_valid()) {
  2156. Transform3D gt = geo_instance->get_global_transform();
  2157. Transform3D ai = gt.affine_inverse();
  2158. Vector3 point, normal;
  2159. if (mesh_collision->intersect_ray(ai.xform(pos), ai.basis.xform(ray).normalized(), point, normal)) {
  2160. SelectResult res;
  2161. res.item = Object::cast_to<Node>(obj);
  2162. res.order = -pos.distance_to(gt.xform(point));
  2163. r_items.push_back(res);
  2164. continue;
  2165. }
  2166. }
  2167. }
  2168. items.remove_at(i);
  2169. i--;
  2170. }
  2171. }
  2172. void RuntimeNodeSelect::_find_3d_items_at_rect(const Rect2 &p_rect, Vector<SelectResult> &r_items) {
  2173. Window *root = SceneTree::get_singleton()->get_root();
  2174. Camera3D *camera = root->get_camera_3d();
  2175. if (!camera) {
  2176. return;
  2177. }
  2178. bool cam_override = root->is_camera_3d_override_enabled();
  2179. Vector3 cam_pos;
  2180. Vector3 dist_pos;
  2181. if (cam_override) {
  2182. cam_pos = root->get_camera_3d_override_transform().origin;
  2183. dist_pos = root->camera_3d_override_project_ray_origin(p_rect.position + p_rect.size / 2);
  2184. } else {
  2185. cam_pos = camera->get_global_position();
  2186. dist_pos = camera->project_ray_origin(p_rect.position + p_rect.size / 2);
  2187. }
  2188. real_t znear, zfar = 0;
  2189. real_t zofs = 5.0;
  2190. if (cam_override) {
  2191. HashMap<StringName, real_t> override_props = root->get_camera_3d_override_properties();
  2192. znear = override_props["z_near"];
  2193. zfar = override_props["z_far"];
  2194. zofs -= znear;
  2195. } else {
  2196. znear = camera->get_near();
  2197. zfar = camera->get_far();
  2198. zofs -= znear;
  2199. }
  2200. zofs = MAX(0.0, zofs);
  2201. const Point2 pos_end = p_rect.position + p_rect.size;
  2202. Vector3 box[4] = {
  2203. Vector3(
  2204. MIN(p_rect.position.x, pos_end.x),
  2205. MIN(p_rect.position.y, pos_end.y),
  2206. zofs),
  2207. Vector3(
  2208. MAX(p_rect.position.x, pos_end.x),
  2209. MIN(p_rect.position.y, pos_end.y),
  2210. zofs),
  2211. Vector3(
  2212. MAX(p_rect.position.x, pos_end.x),
  2213. MAX(p_rect.position.y, pos_end.y),
  2214. zofs),
  2215. Vector3(
  2216. MIN(p_rect.position.x, pos_end.x),
  2217. MAX(p_rect.position.y, pos_end.y),
  2218. zofs)
  2219. };
  2220. Vector<Plane> frustum;
  2221. for (int i = 0; i < 4; i++) {
  2222. Vector3 a = _get_screen_to_space(box[i]);
  2223. Vector3 b = _get_screen_to_space(box[(i + 1) % 4]);
  2224. frustum.push_back(Plane(a, b, cam_pos));
  2225. }
  2226. Plane near_plane;
  2227. // Get the camera normal.
  2228. if (cam_override) {
  2229. near_plane = Plane(root->get_camera_3d_override_transform().basis.get_column(2), cam_pos);
  2230. } else {
  2231. near_plane = Plane(camera->get_global_transform().basis.get_column(2), cam_pos);
  2232. }
  2233. near_plane.d -= znear;
  2234. frustum.push_back(near_plane);
  2235. Plane far_plane = -near_plane;
  2236. far_plane.d += zfar;
  2237. frustum.push_back(far_plane);
  2238. #ifndef PHYSICS_3D_DISABLED
  2239. Vector<Vector3> points = Geometry3D::compute_convex_mesh_points(&frustum[0], frustum.size());
  2240. Ref<ConvexPolygonShape3D> shape;
  2241. shape.instantiate();
  2242. shape->set_points(points);
  2243. // Start with physical objects.
  2244. PhysicsDirectSpaceState3D *ss = root->get_world_3d()->get_direct_space_state();
  2245. PhysicsDirectSpaceState3D::ShapeResult result;
  2246. PhysicsDirectSpaceState3D::ShapeParameters shape_params;
  2247. shape_params.shape_rid = shape->get_rid();
  2248. shape_params.collide_with_areas = true;
  2249. if (ss->intersect_shape(shape_params, &result, 32)) {
  2250. SelectResult res;
  2251. res.item = Object::cast_to<Node>(result.collider);
  2252. res.order = -dist_pos.distance_to(Object::cast_to<Node3D>(res.item)->get_global_transform().origin);
  2253. // Fetch collision shapes.
  2254. CollisionObject3D *collision = Object::cast_to<CollisionObject3D>(result.collider);
  2255. if (collision) {
  2256. List<uint32_t> owners;
  2257. collision->get_shape_owners(&owners);
  2258. for (uint32_t &I : owners) {
  2259. SelectResult res_shape;
  2260. res_shape.item = Object::cast_to<Node>(collision->shape_owner_get_owner(I));
  2261. res_shape.order = res.order;
  2262. r_items.push_back(res_shape);
  2263. }
  2264. }
  2265. r_items.push_back(res);
  2266. }
  2267. #endif // PHYSICS_3D_DISABLED
  2268. // Then go for the meshes.
  2269. Vector<ObjectID> items = RS::get_singleton()->instances_cull_convex(frustum, root->get_world_3d()->get_scenario());
  2270. for (int i = 0; i < items.size(); i++) {
  2271. Object *obj = ObjectDB::get_instance(items[i]);
  2272. GeometryInstance3D *geo_instance = Object::cast_to<GeometryInstance3D>(obj);
  2273. if (geo_instance) {
  2274. Ref<TriangleMesh> mesh_collision = geo_instance->generate_triangle_mesh();
  2275. if (mesh_collision.is_valid()) {
  2276. Transform3D gt = geo_instance->get_global_transform();
  2277. Vector3 mesh_scale = gt.get_basis().get_scale();
  2278. gt.orthonormalize();
  2279. Transform3D it = gt.affine_inverse();
  2280. Vector<Plane> transformed_frustum;
  2281. int plane_count = frustum.size();
  2282. transformed_frustum.resize(plane_count);
  2283. for (int j = 0; j < plane_count; j++) {
  2284. transformed_frustum.write[j] = it.xform(frustum[j]);
  2285. }
  2286. Vector<Vector3> convex_points = Geometry3D::compute_convex_mesh_points(transformed_frustum.ptr(), plane_count);
  2287. if (mesh_collision->inside_convex_shape(transformed_frustum.ptr(), transformed_frustum.size(), convex_points.ptr(), convex_points.size(), mesh_scale)) {
  2288. SelectResult res;
  2289. res.item = Object::cast_to<Node>(obj);
  2290. res.order = -dist_pos.distance_to(gt.origin);
  2291. r_items.push_back(res);
  2292. continue;
  2293. }
  2294. }
  2295. }
  2296. items.remove_at(i);
  2297. i--;
  2298. }
  2299. }
  2300. Vector3 RuntimeNodeSelect::_get_screen_to_space(const Vector3 &p_vector3) {
  2301. Window *root = SceneTree::get_singleton()->get_root();
  2302. Camera3D *camera = root->get_camera_3d();
  2303. Size2 size = root->get_size();
  2304. real_t znear = 0;
  2305. Projection cm;
  2306. Transform3D camera_transform;
  2307. if (root->is_camera_3d_override_enabled()) {
  2308. HashMap<StringName, real_t> override_props = root->get_camera_3d_override_properties();
  2309. znear = override_props["z_near"];
  2310. cm.set_perspective(override_props["fov"], size.aspect(), znear + p_vector3.z, override_props["z_far"]);
  2311. camera_transform.translate_local(cursor.pos);
  2312. camera_transform.basis.rotate(Vector3(1, 0, 0), -cursor.x_rot);
  2313. camera_transform.basis.rotate(Vector3(0, 1, 0), -cursor.y_rot);
  2314. camera_transform.translate_local(0, 0, cursor.distance);
  2315. } else {
  2316. znear = camera->get_near();
  2317. cm.set_perspective(camera->get_fov(), size.aspect(), znear + p_vector3.z, camera->get_far());
  2318. camera_transform = camera->get_camera_transform();
  2319. }
  2320. Vector2 screen_he = cm.get_viewport_half_extents();
  2321. return camera_transform.xform(Vector3(((p_vector3.x / size.width) * 2.0 - 1.0) * screen_he.x, ((1.0 - (p_vector3.y / size.height)) * 2.0 - 1.0) * screen_he.y, -(znear + p_vector3.z)));
  2322. }
  2323. bool RuntimeNodeSelect::_handle_3d_input(const Ref<InputEvent> &p_event) {
  2324. Ref<InputEventMouseButton> b = p_event;
  2325. if (b.is_valid()) {
  2326. const real_t zoom_factor = 1.08 * b->get_factor();
  2327. switch (b->get_button_index()) {
  2328. case MouseButton::WHEEL_UP: {
  2329. if (!camera_freelook) {
  2330. _cursor_scale_distance(1.0 / zoom_factor);
  2331. } else {
  2332. _scale_freelook_speed(zoom_factor);
  2333. }
  2334. return true;
  2335. } break;
  2336. case MouseButton::WHEEL_DOWN: {
  2337. if (!camera_freelook) {
  2338. _cursor_scale_distance(zoom_factor);
  2339. } else {
  2340. _scale_freelook_speed(1.0 / zoom_factor);
  2341. }
  2342. return true;
  2343. } break;
  2344. case MouseButton::RIGHT: {
  2345. _set_camera_freelook_enabled(b->is_pressed());
  2346. return true;
  2347. } break;
  2348. default: {
  2349. }
  2350. }
  2351. }
  2352. Ref<InputEventMouseMotion> m = p_event;
  2353. if (m.is_valid()) {
  2354. if (camera_freelook) {
  2355. _cursor_look(m);
  2356. } else if (m->get_button_mask().has_flag(MouseButtonMask::MIDDLE)) {
  2357. if (m->is_shift_pressed()) {
  2358. _cursor_pan(m);
  2359. } else {
  2360. _cursor_orbit(m);
  2361. }
  2362. }
  2363. return true;
  2364. }
  2365. Ref<InputEventKey> k = p_event;
  2366. if (k.is_valid()) {
  2367. if (k->get_physical_keycode() == Key::ESCAPE) {
  2368. _set_camera_freelook_enabled(false);
  2369. return true;
  2370. } else if (k->is_ctrl_pressed()) {
  2371. switch (k->get_physical_keycode()) {
  2372. case Key::EQUAL: {
  2373. cursor.fov_scale = CLAMP(cursor.fov_scale - 0.05, CAMERA_MIN_FOV_SCALE, CAMERA_MAX_FOV_SCALE);
  2374. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov * cursor.fov_scale, camera_znear, camera_zfar);
  2375. return true;
  2376. } break;
  2377. case Key::MINUS: {
  2378. cursor.fov_scale = CLAMP(cursor.fov_scale + 0.05, CAMERA_MIN_FOV_SCALE, CAMERA_MAX_FOV_SCALE);
  2379. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov * cursor.fov_scale, camera_znear, camera_zfar);
  2380. return true;
  2381. } break;
  2382. case Key::KEY_0: {
  2383. cursor.fov_scale = 1;
  2384. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov, camera_znear, camera_zfar);
  2385. return true;
  2386. } break;
  2387. default: {
  2388. }
  2389. }
  2390. }
  2391. }
  2392. // TODO: Handle magnify and pan input gestures.
  2393. return false;
  2394. }
  2395. void RuntimeNodeSelect::_set_camera_freelook_enabled(bool p_enabled) {
  2396. camera_freelook = p_enabled;
  2397. if (p_enabled) {
  2398. // Make sure eye_pos is synced, because freelook referential is eye pos rather than orbit pos
  2399. Vector3 forward = _get_cursor_transform().basis.xform(Vector3(0, 0, -1));
  2400. cursor.eye_pos = cursor.pos - cursor.distance * forward;
  2401. previous_mouse_position = SceneTree::get_singleton()->get_root()->get_mouse_position();
  2402. // Hide mouse like in an FPS (warping doesn't work).
  2403. Input::get_singleton()->set_mouse_mode_override(Input::MOUSE_MODE_CAPTURED);
  2404. } else {
  2405. // Restore mouse.
  2406. Input::get_singleton()->set_mouse_mode_override(Input::MOUSE_MODE_VISIBLE);
  2407. // Restore the previous mouse position when leaving freelook mode.
  2408. // This is done because leaving `Input.MOUSE_MODE_CAPTURED` will center the cursor
  2409. // due to OS limitations.
  2410. Input::get_singleton()->warp_mouse(previous_mouse_position);
  2411. }
  2412. }
  2413. void RuntimeNodeSelect::_cursor_scale_distance(real_t p_scale) {
  2414. real_t min_distance = MAX(camera_znear * 4, VIEW_3D_MIN_ZOOM);
  2415. real_t max_distance = MIN(camera_zfar / 4, VIEW_3D_MAX_ZOOM);
  2416. cursor.distance = CLAMP(cursor.distance * p_scale, min_distance, max_distance);
  2417. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2418. }
  2419. void RuntimeNodeSelect::_scale_freelook_speed(real_t p_scale) {
  2420. real_t min_speed = MAX(camera_znear * 4, VIEW_3D_MIN_ZOOM);
  2421. real_t max_speed = MIN(camera_zfar / 4, VIEW_3D_MAX_ZOOM);
  2422. if (unlikely(min_speed > max_speed)) {
  2423. freelook_base_speed = (min_speed + max_speed) / 2;
  2424. } else {
  2425. freelook_base_speed = CLAMP(freelook_base_speed * p_scale, min_speed, max_speed);
  2426. }
  2427. }
  2428. void RuntimeNodeSelect::_cursor_look(Ref<InputEventWithModifiers> p_event) {
  2429. Window *root = SceneTree::get_singleton()->get_root();
  2430. const Vector2 relative = _get_warped_mouse_motion(p_event, Rect2(Vector2(), root->get_size()));
  2431. const Transform3D prev_camera_transform = _get_cursor_transform();
  2432. if (invert_y_axis) {
  2433. cursor.x_rot -= relative.y * freelook_sensitivity;
  2434. } else {
  2435. cursor.x_rot += relative.y * freelook_sensitivity;
  2436. }
  2437. // Clamp the Y rotation to roughly -90..90 degrees so the user can't look upside-down and end up disoriented.
  2438. cursor.x_rot = CLAMP(cursor.x_rot, -1.57, 1.57);
  2439. cursor.y_rot += relative.x * freelook_sensitivity;
  2440. // Look is like the opposite of Orbit: the focus point rotates around the camera.
  2441. Transform3D camera_transform = _get_cursor_transform();
  2442. Vector3 pos = camera_transform.xform(Vector3(0, 0, 0));
  2443. Vector3 prev_pos = prev_camera_transform.xform(Vector3(0, 0, 0));
  2444. Vector3 diff = prev_pos - pos;
  2445. cursor.pos += diff;
  2446. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2447. }
  2448. void RuntimeNodeSelect::_cursor_pan(Ref<InputEventWithModifiers> p_event) {
  2449. Window *root = SceneTree::get_singleton()->get_root();
  2450. // Reduce all sides of the area by 1, so warping works when windows are maximized/fullscreen.
  2451. const Vector2 relative = _get_warped_mouse_motion(p_event, Rect2(Vector2(1, 1), root->get_size() - Vector2(2, 2)));
  2452. const real_t pan_speed = translation_sensitivity / 150.0;
  2453. Transform3D camera_transform;
  2454. camera_transform.translate_local(cursor.pos);
  2455. camera_transform.basis.rotate(Vector3(1, 0, 0), -cursor.x_rot);
  2456. camera_transform.basis.rotate(Vector3(0, 1, 0), -cursor.y_rot);
  2457. Vector3 translation(1 * -relative.x * pan_speed, relative.y * pan_speed, 0);
  2458. translation *= cursor.distance / 4;
  2459. camera_transform.translate_local(translation);
  2460. cursor.pos = camera_transform.origin;
  2461. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2462. }
  2463. void RuntimeNodeSelect::_cursor_orbit(Ref<InputEventWithModifiers> p_event) {
  2464. Window *root = SceneTree::get_singleton()->get_root();
  2465. // Reduce all sides of the area by 1, so warping works when windows are maximized/fullscreen.
  2466. const Vector2 relative = _get_warped_mouse_motion(p_event, Rect2(Vector2(1, 1), root->get_size() - Vector2(2, 2)));
  2467. if (invert_y_axis) {
  2468. cursor.x_rot -= relative.y * orbit_sensitivity;
  2469. } else {
  2470. cursor.x_rot += relative.y * orbit_sensitivity;
  2471. }
  2472. // Clamp the Y rotation to roughly -90..90 degrees so the user can't look upside-down and end up disoriented.
  2473. cursor.x_rot = CLAMP(cursor.x_rot, -1.57, 1.57);
  2474. if (invert_x_axis) {
  2475. cursor.y_rot -= relative.x * orbit_sensitivity;
  2476. } else {
  2477. cursor.y_rot += relative.x * orbit_sensitivity;
  2478. }
  2479. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2480. }
  2481. Point2 RuntimeNodeSelect::_get_warped_mouse_motion(const Ref<InputEventMouseMotion> &p_event, Rect2 p_area) const {
  2482. ERR_FAIL_COND_V(p_event.is_null(), Point2());
  2483. if (warped_mouse_panning_3d) {
  2484. return Input::get_singleton()->warp_mouse_motion(p_event, p_area);
  2485. }
  2486. return p_event->get_relative();
  2487. }
  2488. Transform3D RuntimeNodeSelect::_get_cursor_transform() {
  2489. Transform3D camera_transform;
  2490. camera_transform.translate_local(cursor.pos);
  2491. camera_transform.basis.rotate(Vector3(1, 0, 0), -cursor.x_rot);
  2492. camera_transform.basis.rotate(Vector3(0, 1, 0), -cursor.y_rot);
  2493. camera_transform.translate_local(0, 0, cursor.distance);
  2494. return camera_transform;
  2495. }
  2496. void RuntimeNodeSelect::_reset_camera_3d() {
  2497. camera_first_override = true;
  2498. cursor = Cursor();
  2499. Window *root = SceneTree::get_singleton()->get_root();
  2500. Camera3D *camera = root->get_camera_3d();
  2501. if (camera) {
  2502. Transform3D transform = camera->get_global_transform();
  2503. transform.translate_local(0, 0, -cursor.distance);
  2504. cursor.pos = transform.origin;
  2505. cursor.x_rot = -camera->get_global_rotation().x;
  2506. cursor.y_rot = -camera->get_global_rotation().y;
  2507. cursor.fov_scale = CLAMP(camera->get_fov() / camera_fov, CAMERA_MIN_FOV_SCALE, CAMERA_MAX_FOV_SCALE);
  2508. } else {
  2509. cursor.fov_scale = 1.0;
  2510. }
  2511. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2512. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov * cursor.fov_scale, camera_znear, camera_zfar);
  2513. }
  2514. #endif // _3D_DISABLED
  2515. #endif // DEBUG_ENABLED