scene_debugger.cpp 95 KB

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