scene_debugger.cpp 94 KB

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