scene_debugger.cpp 95 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010
  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(Vector<Node *>(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;
  557. if (p_property.begins_with("Members/")) {
  558. prop_name = p_property.get_slicec('/', p_property.get_slice_count("/") - 1);
  559. } else {
  560. prop_name = p_property;
  561. }
  562. Variant value;
  563. if (p_field.is_empty()) {
  564. // Whole value.
  565. value = p_value;
  566. } else {
  567. // Only one field.
  568. value = fieldwise_assign(obj->get(prop_name), p_value, p_field);
  569. }
  570. obj->set(prop_name, value);
  571. }
  572. void SceneDebugger::_next_frame() {
  573. SceneTree *scene_tree = SceneTree::get_singleton();
  574. if (!scene_tree->is_suspended()) {
  575. return;
  576. }
  577. scene_tree->set_suspend(false);
  578. RenderingServer::get_singleton()->connect("frame_post_draw", callable_mp(scene_tree, &SceneTree::set_suspend).bind(true), Object::CONNECT_ONE_SHOT);
  579. }
  580. void SceneDebugger::add_to_cache(const String &p_filename, Node *p_node) {
  581. LiveEditor *debugger = LiveEditor::get_singleton();
  582. if (!debugger) {
  583. return;
  584. }
  585. if (EngineDebugger::get_script_debugger() && !p_filename.is_empty()) {
  586. debugger->live_scene_edit_cache[p_filename].insert(p_node);
  587. }
  588. }
  589. void SceneDebugger::remove_from_cache(const String &p_filename, Node *p_node) {
  590. LiveEditor *debugger = LiveEditor::get_singleton();
  591. if (!debugger) {
  592. return;
  593. }
  594. HashMap<String, HashSet<Node *>> &edit_cache = debugger->live_scene_edit_cache;
  595. HashMap<String, HashSet<Node *>>::Iterator E = edit_cache.find(p_filename);
  596. if (E) {
  597. E->value.erase(p_node);
  598. if (E->value.is_empty()) {
  599. edit_cache.remove(E);
  600. }
  601. }
  602. HashMap<Node *, HashMap<ObjectID, Node *>> &remove_list = debugger->live_edit_remove_list;
  603. HashMap<Node *, HashMap<ObjectID, Node *>>::Iterator F = remove_list.find(p_node);
  604. if (F) {
  605. for (const KeyValue<ObjectID, Node *> &G : F->value) {
  606. memdelete(G.value);
  607. }
  608. remove_list.remove(F);
  609. }
  610. }
  611. void SceneDebugger::reload_cached_files(const PackedStringArray &p_files) {
  612. for (const String &file : p_files) {
  613. Ref<Resource> res = ResourceCache::get_ref(file);
  614. if (res.is_valid()) {
  615. res->reload_from_file();
  616. }
  617. }
  618. }
  619. /// SceneDebuggerObject
  620. SceneDebuggerObject::SceneDebuggerObject(ObjectID p_id) {
  621. id = ObjectID();
  622. Object *obj = ObjectDB::get_instance(p_id);
  623. if (!obj) {
  624. return;
  625. }
  626. id = p_id;
  627. class_name = obj->get_class();
  628. if (ScriptInstance *si = obj->get_script_instance()) {
  629. // Read script instance constants and variables
  630. if (!si->get_script().is_null()) {
  631. Script *s = si->get_script().ptr();
  632. _parse_script_properties(s, si);
  633. }
  634. }
  635. if (Node *node = Object::cast_to<Node>(obj)) {
  636. // For debugging multiplayer.
  637. {
  638. PropertyInfo pi(Variant::INT, String("Node/multiplayer_authority"), PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_READ_ONLY);
  639. properties.push_back(SceneDebuggerProperty(pi, node->get_multiplayer_authority()));
  640. }
  641. // Add specialized NodePath info (if inside tree).
  642. if (node->is_inside_tree()) {
  643. PropertyInfo pi(Variant::NODE_PATH, String("Node/path"));
  644. properties.push_back(SceneDebuggerProperty(pi, node->get_path()));
  645. } else { // Can't ask for path if a node is not in tree.
  646. PropertyInfo pi(Variant::STRING, String("Node/path"));
  647. properties.push_back(SceneDebuggerProperty(pi, "[Orphan]"));
  648. }
  649. } else if (Script *s = Object::cast_to<Script>(obj)) {
  650. // Add script constants (no instance).
  651. _parse_script_properties(s, nullptr);
  652. }
  653. // Add base object properties.
  654. List<PropertyInfo> pinfo;
  655. obj->get_property_list(&pinfo, true);
  656. for (const PropertyInfo &E : pinfo) {
  657. if (E.usage & (PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_CATEGORY)) {
  658. properties.push_back(SceneDebuggerProperty(E, obj->get(E.name)));
  659. }
  660. }
  661. }
  662. void SceneDebuggerObject::_parse_script_properties(Script *p_script, ScriptInstance *p_instance) {
  663. typedef HashMap<const Script *, HashSet<StringName>> ScriptMemberMap;
  664. typedef HashMap<const Script *, HashMap<StringName, Variant>> ScriptConstantsMap;
  665. ScriptMemberMap members;
  666. if (p_instance) {
  667. members[p_script] = HashSet<StringName>();
  668. p_script->get_members(&(members[p_script]));
  669. }
  670. ScriptConstantsMap constants;
  671. constants[p_script] = HashMap<StringName, Variant>();
  672. p_script->get_constants(&(constants[p_script]));
  673. Ref<Script> base = p_script->get_base_script();
  674. while (base.is_valid()) {
  675. if (p_instance) {
  676. members[base.ptr()] = HashSet<StringName>();
  677. base->get_members(&(members[base.ptr()]));
  678. }
  679. constants[base.ptr()] = HashMap<StringName, Variant>();
  680. base->get_constants(&(constants[base.ptr()]));
  681. base = base->get_base_script();
  682. }
  683. // Members
  684. for (KeyValue<const Script *, HashSet<StringName>> sm : members) {
  685. for (const StringName &E : sm.value) {
  686. Variant m;
  687. if (p_instance->get(E, m)) {
  688. String script_path = sm.key == p_script ? "" : sm.key->get_path().get_file() + "/";
  689. PropertyInfo pi(m.get_type(), "Members/" + script_path + E);
  690. properties.push_back(SceneDebuggerProperty(pi, m));
  691. }
  692. }
  693. }
  694. // Constants
  695. for (KeyValue<const Script *, HashMap<StringName, Variant>> &sc : constants) {
  696. for (const KeyValue<StringName, Variant> &E : sc.value) {
  697. String script_path = sc.key == p_script ? "" : sc.key->get_path().get_file() + "/";
  698. if (E.value.get_type() == Variant::OBJECT) {
  699. Variant inst_id = ((Object *)E.value)->get_instance_id();
  700. PropertyInfo pi(inst_id.get_type(), "Constants/" + E.key, PROPERTY_HINT_OBJECT_ID, "Object");
  701. properties.push_back(SceneDebuggerProperty(pi, inst_id));
  702. } else {
  703. PropertyInfo pi(E.value.get_type(), "Constants/" + script_path + E.key);
  704. properties.push_back(SceneDebuggerProperty(pi, E.value));
  705. }
  706. }
  707. }
  708. }
  709. void SceneDebuggerObject::serialize(Array &r_arr, int p_max_size) {
  710. Array send_props;
  711. for (SceneDebuggerObject::SceneDebuggerProperty &property : properties) {
  712. const PropertyInfo &pi = property.first;
  713. Variant &var = property.second;
  714. Ref<Resource> res = var;
  715. Array prop = { pi.name, pi.type };
  716. PropertyHint hint = pi.hint;
  717. String hint_string = pi.hint_string;
  718. if (res.is_valid() && !res->get_path().is_empty()) {
  719. var = res->get_path();
  720. } else { //only send information that can be sent..
  721. int len = 0; //test how big is this to encode
  722. encode_variant(var, nullptr, len);
  723. if (len > p_max_size) { //limit to max size
  724. hint = PROPERTY_HINT_OBJECT_TOO_BIG;
  725. hint_string = "";
  726. var = Variant();
  727. }
  728. }
  729. prop.push_back(hint);
  730. prop.push_back(hint_string);
  731. prop.push_back(pi.usage);
  732. prop.push_back(var);
  733. send_props.push_back(prop);
  734. }
  735. r_arr.push_back(uint64_t(id));
  736. r_arr.push_back(class_name);
  737. r_arr.push_back(send_props);
  738. }
  739. void SceneDebuggerObject::deserialize(const Array &p_arr) {
  740. #define CHECK_TYPE(p_what, p_type) ERR_FAIL_COND(p_what.get_type() != Variant::p_type);
  741. ERR_FAIL_COND(p_arr.size() < 3);
  742. CHECK_TYPE(p_arr[0], INT);
  743. CHECK_TYPE(p_arr[1], STRING);
  744. CHECK_TYPE(p_arr[2], ARRAY);
  745. id = uint64_t(p_arr[0]);
  746. class_name = p_arr[1];
  747. Array props = p_arr[2];
  748. for (int i = 0; i < props.size(); i++) {
  749. CHECK_TYPE(props[i], ARRAY);
  750. Array prop = props[i];
  751. ERR_FAIL_COND(prop.size() != 6);
  752. CHECK_TYPE(prop[0], STRING);
  753. CHECK_TYPE(prop[1], INT);
  754. CHECK_TYPE(prop[2], INT);
  755. CHECK_TYPE(prop[3], STRING);
  756. CHECK_TYPE(prop[4], INT);
  757. PropertyInfo pinfo;
  758. pinfo.name = prop[0];
  759. pinfo.type = Variant::Type(int(prop[1]));
  760. pinfo.hint = PropertyHint(int(prop[2]));
  761. pinfo.hint_string = prop[3];
  762. pinfo.usage = PropertyUsageFlags(int(prop[4]));
  763. Variant var = prop[5];
  764. if (pinfo.type == Variant::OBJECT) {
  765. if (var.is_zero()) {
  766. var = Ref<Resource>();
  767. } else if (var.get_type() == Variant::OBJECT) {
  768. if (((Object *)var)->is_class("EncodedObjectAsID")) {
  769. var = Object::cast_to<EncodedObjectAsID>(var)->get_object_id();
  770. pinfo.type = var.get_type();
  771. pinfo.hint = PROPERTY_HINT_OBJECT_ID;
  772. pinfo.hint_string = "Object";
  773. }
  774. }
  775. }
  776. properties.push_back(SceneDebuggerProperty(pinfo, var));
  777. }
  778. }
  779. /// SceneDebuggerTree
  780. SceneDebuggerTree::SceneDebuggerTree(Node *p_root) {
  781. // Flatten tree into list, depth first, use stack to avoid recursion.
  782. List<Node *> stack;
  783. stack.push_back(p_root);
  784. bool is_root = true;
  785. const StringName &is_visible_sn = SNAME("is_visible");
  786. const StringName &is_visible_in_tree_sn = SNAME("is_visible_in_tree");
  787. while (stack.size()) {
  788. Node *n = stack.front()->get();
  789. stack.pop_front();
  790. int count = n->get_child_count();
  791. for (int i = 0; i < count; i++) {
  792. stack.push_front(n->get_child(count - i - 1));
  793. }
  794. int view_flags = 0;
  795. if (is_root) {
  796. // Prevent root window visibility from being changed.
  797. is_root = false;
  798. } else if (n->has_method(is_visible_sn)) {
  799. const Variant visible = n->call(is_visible_sn);
  800. if (visible.get_type() == Variant::BOOL) {
  801. view_flags = RemoteNode::VIEW_HAS_VISIBLE_METHOD;
  802. view_flags |= uint8_t(visible) * RemoteNode::VIEW_VISIBLE;
  803. }
  804. if (n->has_method(is_visible_in_tree_sn)) {
  805. const Variant visible_in_tree = n->call(is_visible_in_tree_sn);
  806. if (visible_in_tree.get_type() == Variant::BOOL) {
  807. view_flags |= uint8_t(visible_in_tree) * RemoteNode::VIEW_VISIBLE_IN_TREE;
  808. }
  809. }
  810. }
  811. String class_name;
  812. ScriptInstance *script_instance = n->get_script_instance();
  813. if (script_instance) {
  814. Ref<Script> script = script_instance->get_script();
  815. if (script.is_valid()) {
  816. class_name = script->get_global_name();
  817. if (class_name.is_empty()) {
  818. // If there is no class_name in this script we just take the script path.
  819. class_name = script->get_path();
  820. }
  821. }
  822. }
  823. 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));
  824. }
  825. }
  826. void SceneDebuggerTree::serialize(Array &p_arr) {
  827. for (const RemoteNode &n : nodes) {
  828. p_arr.push_back(n.child_count);
  829. p_arr.push_back(n.name);
  830. p_arr.push_back(n.type_name);
  831. p_arr.push_back(n.id);
  832. p_arr.push_back(n.scene_file_path);
  833. p_arr.push_back(n.view_flags);
  834. }
  835. }
  836. void SceneDebuggerTree::deserialize(const Array &p_arr) {
  837. int idx = 0;
  838. while (p_arr.size() > idx) {
  839. ERR_FAIL_COND(p_arr.size() < 6);
  840. CHECK_TYPE(p_arr[idx], INT); // child_count.
  841. CHECK_TYPE(p_arr[idx + 1], STRING); // name.
  842. CHECK_TYPE(p_arr[idx + 2], STRING); // type_name.
  843. CHECK_TYPE(p_arr[idx + 3], INT); // id.
  844. CHECK_TYPE(p_arr[idx + 4], STRING); // scene_file_path.
  845. CHECK_TYPE(p_arr[idx + 5], INT); // view_flags.
  846. 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]));
  847. idx += 6;
  848. }
  849. }
  850. /// LiveEditor
  851. LiveEditor *LiveEditor::get_singleton() {
  852. return singleton;
  853. }
  854. void LiveEditor::_send_tree() {
  855. SceneTree *scene_tree = SceneTree::get_singleton();
  856. if (!scene_tree) {
  857. return;
  858. }
  859. Array arr;
  860. // Encoded as a flat list depth first.
  861. SceneDebuggerTree tree(scene_tree->root);
  862. tree.serialize(arr);
  863. EngineDebugger::get_singleton()->send_message("scene:scene_tree", arr);
  864. }
  865. void LiveEditor::_node_path_func(const NodePath &p_path, int p_id) {
  866. live_edit_node_path_cache[p_id] = p_path;
  867. }
  868. void LiveEditor::_res_path_func(const String &p_path, int p_id) {
  869. live_edit_resource_cache[p_id] = p_path;
  870. }
  871. void LiveEditor::_node_set_func(int p_id, const StringName &p_prop, const Variant &p_value) {
  872. SceneTree *scene_tree = SceneTree::get_singleton();
  873. if (!scene_tree) {
  874. return;
  875. }
  876. if (!live_edit_node_path_cache.has(p_id)) {
  877. return;
  878. }
  879. NodePath np = live_edit_node_path_cache[p_id];
  880. Node *base = nullptr;
  881. if (scene_tree->root->has_node(live_edit_root)) {
  882. base = scene_tree->root->get_node(live_edit_root);
  883. }
  884. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  885. if (!E) {
  886. return; //scene not editable
  887. }
  888. for (Node *F : E->value) {
  889. Node *n = F;
  890. if (base && !base->is_ancestor_of(n)) {
  891. continue;
  892. }
  893. if (!n->has_node(np)) {
  894. continue;
  895. }
  896. Node *n2 = n->get_node(np);
  897. // Do not change transform of edited scene root, unless it's the scene being played.
  898. // See GH-86659 for additional context.
  899. bool keep_transform = (n2 == n) && (n2->get_parent() != scene_tree->root);
  900. Variant orig_tf;
  901. if (keep_transform) {
  902. if (n2->is_class("Node3D")) {
  903. orig_tf = n2->call("get_transform");
  904. } else if (n2->is_class("CanvasItem")) {
  905. orig_tf = n2->call("_edit_get_state");
  906. }
  907. }
  908. n2->set(p_prop, p_value);
  909. if (keep_transform) {
  910. if (n2->is_class("Node3D")) {
  911. Variant new_tf = n2->call("get_transform");
  912. if (new_tf != orig_tf) {
  913. n2->call("set_transform", orig_tf);
  914. }
  915. } else if (n2->is_class("CanvasItem")) {
  916. Variant new_tf = n2->call("_edit_get_state");
  917. if (new_tf != orig_tf) {
  918. n2->call("_edit_set_state", orig_tf);
  919. }
  920. }
  921. }
  922. }
  923. }
  924. void LiveEditor::_node_set_res_func(int p_id, const StringName &p_prop, const String &p_value) {
  925. Ref<Resource> r = ResourceLoader::load(p_value);
  926. if (r.is_null()) {
  927. return;
  928. }
  929. _node_set_func(p_id, p_prop, r);
  930. }
  931. void LiveEditor::_node_call_func(int p_id, const StringName &p_method, const Variant **p_args, int p_argcount) {
  932. SceneTree *scene_tree = SceneTree::get_singleton();
  933. if (!scene_tree) {
  934. return;
  935. }
  936. if (!live_edit_node_path_cache.has(p_id)) {
  937. return;
  938. }
  939. NodePath np = live_edit_node_path_cache[p_id];
  940. Node *base = nullptr;
  941. if (scene_tree->root->has_node(live_edit_root)) {
  942. base = scene_tree->root->get_node(live_edit_root);
  943. }
  944. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  945. if (!E) {
  946. return; //scene not editable
  947. }
  948. for (Node *F : E->value) {
  949. Node *n = F;
  950. if (base && !base->is_ancestor_of(n)) {
  951. continue;
  952. }
  953. if (!n->has_node(np)) {
  954. continue;
  955. }
  956. Node *n2 = n->get_node(np);
  957. // Do not change transform of edited scene root, unless it's the scene being played.
  958. // See GH-86659 for additional context.
  959. bool keep_transform = (n2 == n) && (n2->get_parent() != scene_tree->root);
  960. Variant orig_tf;
  961. if (keep_transform) {
  962. if (n2->is_class("Node3D")) {
  963. orig_tf = n2->call("get_transform");
  964. } else if (n2->is_class("CanvasItem")) {
  965. orig_tf = n2->call("_edit_get_state");
  966. }
  967. }
  968. Callable::CallError ce;
  969. n2->callp(p_method, p_args, p_argcount, ce);
  970. if (keep_transform) {
  971. if (n2->is_class("Node3D")) {
  972. Variant new_tf = n2->call("get_transform");
  973. if (new_tf != orig_tf) {
  974. n2->call("set_transform", orig_tf);
  975. }
  976. } else if (n2->is_class("CanvasItem")) {
  977. Variant new_tf = n2->call("_edit_get_state");
  978. if (new_tf != orig_tf) {
  979. n2->call("_edit_set_state", orig_tf);
  980. }
  981. }
  982. }
  983. }
  984. }
  985. void LiveEditor::_res_set_func(int p_id, const StringName &p_prop, const Variant &p_value) {
  986. if (!live_edit_resource_cache.has(p_id)) {
  987. return;
  988. }
  989. String resp = live_edit_resource_cache[p_id];
  990. if (!ResourceCache::has(resp)) {
  991. return;
  992. }
  993. Ref<Resource> r = ResourceCache::get_ref(resp);
  994. if (r.is_null()) {
  995. return;
  996. }
  997. r->set(p_prop, p_value);
  998. }
  999. void LiveEditor::_res_set_res_func(int p_id, const StringName &p_prop, const String &p_value) {
  1000. Ref<Resource> r = ResourceLoader::load(p_value);
  1001. if (r.is_null()) {
  1002. return;
  1003. }
  1004. _res_set_func(p_id, p_prop, r);
  1005. }
  1006. void LiveEditor::_res_call_func(int p_id, const StringName &p_method, const Variant **p_args, int p_argcount) {
  1007. if (!live_edit_resource_cache.has(p_id)) {
  1008. return;
  1009. }
  1010. String resp = live_edit_resource_cache[p_id];
  1011. if (!ResourceCache::has(resp)) {
  1012. return;
  1013. }
  1014. Ref<Resource> r = ResourceCache::get_ref(resp);
  1015. if (r.is_null()) {
  1016. return;
  1017. }
  1018. Callable::CallError ce;
  1019. r->callp(p_method, p_args, p_argcount, ce);
  1020. }
  1021. void LiveEditor::_root_func(const NodePath &p_scene_path, const String &p_scene_from) {
  1022. live_edit_root = p_scene_path;
  1023. live_edit_scene = p_scene_from;
  1024. }
  1025. void LiveEditor::_create_node_func(const NodePath &p_parent, const String &p_type, const String &p_name) {
  1026. SceneTree *scene_tree = SceneTree::get_singleton();
  1027. if (!scene_tree) {
  1028. return;
  1029. }
  1030. Node *base = nullptr;
  1031. if (scene_tree->root->has_node(live_edit_root)) {
  1032. base = scene_tree->root->get_node(live_edit_root);
  1033. }
  1034. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1035. if (!E) {
  1036. return; //scene not editable
  1037. }
  1038. for (Node *F : E->value) {
  1039. Node *n = F;
  1040. if (base && !base->is_ancestor_of(n)) {
  1041. continue;
  1042. }
  1043. if (!n->has_node(p_parent)) {
  1044. continue;
  1045. }
  1046. Node *n2 = n->get_node(p_parent);
  1047. Node *no = Object::cast_to<Node>(ClassDB::instantiate(p_type));
  1048. if (!no) {
  1049. continue;
  1050. }
  1051. no->set_name(p_name);
  1052. n2->add_child(no);
  1053. }
  1054. }
  1055. void LiveEditor::_instance_node_func(const NodePath &p_parent, const String &p_path, const String &p_name) {
  1056. SceneTree *scene_tree = SceneTree::get_singleton();
  1057. if (!scene_tree) {
  1058. return;
  1059. }
  1060. Ref<PackedScene> ps = ResourceLoader::load(p_path);
  1061. if (ps.is_null()) {
  1062. return;
  1063. }
  1064. Node *base = nullptr;
  1065. if (scene_tree->root->has_node(live_edit_root)) {
  1066. base = scene_tree->root->get_node(live_edit_root);
  1067. }
  1068. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1069. if (!E) {
  1070. return; //scene not editable
  1071. }
  1072. for (Node *F : E->value) {
  1073. Node *n = F;
  1074. if (base && !base->is_ancestor_of(n)) {
  1075. continue;
  1076. }
  1077. if (!n->has_node(p_parent)) {
  1078. continue;
  1079. }
  1080. Node *n2 = n->get_node(p_parent);
  1081. Node *no = ps->instantiate();
  1082. if (!no) {
  1083. continue;
  1084. }
  1085. no->set_name(p_name);
  1086. n2->add_child(no);
  1087. }
  1088. }
  1089. void LiveEditor::_remove_node_func(const NodePath &p_at) {
  1090. SceneTree *scene_tree = SceneTree::get_singleton();
  1091. if (!scene_tree) {
  1092. return;
  1093. }
  1094. Node *base = nullptr;
  1095. if (scene_tree->root->has_node(live_edit_root)) {
  1096. base = scene_tree->root->get_node(live_edit_root);
  1097. }
  1098. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1099. if (!E) {
  1100. return; //scene not editable
  1101. }
  1102. LocalVector<Node *> to_delete;
  1103. for (const Node *n : E->value) {
  1104. if (base && !base->is_ancestor_of(n)) {
  1105. continue;
  1106. }
  1107. if (!n->has_node(p_at)) {
  1108. continue;
  1109. }
  1110. Node *n2 = n->get_node(p_at);
  1111. to_delete.push_back(n2);
  1112. }
  1113. for (Node *node : to_delete) {
  1114. memdelete(node);
  1115. }
  1116. }
  1117. void LiveEditor::_remove_and_keep_node_func(const NodePath &p_at, ObjectID p_keep_id) {
  1118. SceneTree *scene_tree = SceneTree::get_singleton();
  1119. if (!scene_tree) {
  1120. return;
  1121. }
  1122. Node *base = nullptr;
  1123. if (scene_tree->root->has_node(live_edit_root)) {
  1124. base = scene_tree->root->get_node(live_edit_root);
  1125. }
  1126. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1127. if (!E) {
  1128. return; //scene not editable
  1129. }
  1130. LocalVector<Node *> to_remove;
  1131. for (Node *n : E->value) {
  1132. if (base && !base->is_ancestor_of(n)) {
  1133. continue;
  1134. }
  1135. if (!n->has_node(p_at)) {
  1136. continue;
  1137. }
  1138. to_remove.push_back(n);
  1139. }
  1140. for (Node *n : to_remove) {
  1141. Node *n2 = n->get_node(p_at);
  1142. n2->get_parent()->remove_child(n2);
  1143. live_edit_remove_list[n][p_keep_id] = n2;
  1144. }
  1145. }
  1146. void LiveEditor::_restore_node_func(ObjectID p_id, const NodePath &p_at, int p_at_pos) {
  1147. SceneTree *scene_tree = SceneTree::get_singleton();
  1148. if (!scene_tree) {
  1149. return;
  1150. }
  1151. Node *base = nullptr;
  1152. if (scene_tree->root->has_node(live_edit_root)) {
  1153. base = scene_tree->root->get_node(live_edit_root);
  1154. }
  1155. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1156. if (!E) {
  1157. return; //scene not editable
  1158. }
  1159. for (HashSet<Node *>::Iterator F = E->value.begin(); F;) {
  1160. HashSet<Node *>::Iterator N = F;
  1161. ++N;
  1162. Node *n = *F;
  1163. if (base && !base->is_ancestor_of(n)) {
  1164. continue;
  1165. }
  1166. if (!n->has_node(p_at)) {
  1167. continue;
  1168. }
  1169. Node *n2 = n->get_node(p_at);
  1170. HashMap<Node *, HashMap<ObjectID, Node *>>::Iterator EN = live_edit_remove_list.find(n);
  1171. if (!EN) {
  1172. continue;
  1173. }
  1174. HashMap<ObjectID, Node *>::Iterator FN = EN->value.find(p_id);
  1175. if (!FN) {
  1176. continue;
  1177. }
  1178. n2->add_child(FN->value);
  1179. EN->value.remove(FN);
  1180. if (EN->value.is_empty()) {
  1181. live_edit_remove_list.remove(EN);
  1182. }
  1183. F = N;
  1184. }
  1185. }
  1186. void LiveEditor::_duplicate_node_func(const NodePath &p_at, const String &p_new_name) {
  1187. SceneTree *scene_tree = SceneTree::get_singleton();
  1188. if (!scene_tree) {
  1189. return;
  1190. }
  1191. Node *base = nullptr;
  1192. if (scene_tree->root->has_node(live_edit_root)) {
  1193. base = scene_tree->root->get_node(live_edit_root);
  1194. }
  1195. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1196. if (!E) {
  1197. return; //scene not editable
  1198. }
  1199. for (Node *F : E->value) {
  1200. Node *n = F;
  1201. if (base && !base->is_ancestor_of(n)) {
  1202. continue;
  1203. }
  1204. if (!n->has_node(p_at)) {
  1205. continue;
  1206. }
  1207. Node *n2 = n->get_node(p_at);
  1208. Node *dup = n2->duplicate(Node::DUPLICATE_SIGNALS | Node::DUPLICATE_GROUPS | Node::DUPLICATE_SCRIPTS);
  1209. if (!dup) {
  1210. continue;
  1211. }
  1212. dup->set_name(p_new_name);
  1213. n2->get_parent()->add_child(dup);
  1214. }
  1215. }
  1216. void LiveEditor::_reparent_node_func(const NodePath &p_at, const NodePath &p_new_place, const String &p_new_name, int p_at_pos) {
  1217. SceneTree *scene_tree = SceneTree::get_singleton();
  1218. if (!scene_tree) {
  1219. return;
  1220. }
  1221. Node *base = nullptr;
  1222. if (scene_tree->root->has_node(live_edit_root)) {
  1223. base = scene_tree->root->get_node(live_edit_root);
  1224. }
  1225. HashMap<String, HashSet<Node *>>::Iterator E = live_scene_edit_cache.find(live_edit_scene);
  1226. if (!E) {
  1227. return; //scene not editable
  1228. }
  1229. for (Node *F : E->value) {
  1230. Node *n = F;
  1231. if (base && !base->is_ancestor_of(n)) {
  1232. continue;
  1233. }
  1234. if (!n->has_node(p_at)) {
  1235. continue;
  1236. }
  1237. Node *nfrom = n->get_node(p_at);
  1238. if (!n->has_node(p_new_place)) {
  1239. continue;
  1240. }
  1241. Node *nto = n->get_node(p_new_place);
  1242. nfrom->get_parent()->remove_child(nfrom);
  1243. nfrom->set_name(p_new_name);
  1244. nto->add_child(nfrom);
  1245. if (p_at_pos >= 0) {
  1246. nto->move_child(nfrom, p_at_pos);
  1247. }
  1248. }
  1249. }
  1250. /// RuntimeNodeSelect
  1251. RuntimeNodeSelect *RuntimeNodeSelect::get_singleton() {
  1252. return singleton;
  1253. }
  1254. RuntimeNodeSelect::~RuntimeNodeSelect() {
  1255. if (selection_list && !selection_list->is_visible()) {
  1256. memdelete(selection_list);
  1257. }
  1258. if (draw_canvas.is_valid()) {
  1259. RS::get_singleton()->free(sel_drag_ci);
  1260. RS::get_singleton()->free(sbox_2d_ci);
  1261. RS::get_singleton()->free(draw_canvas);
  1262. }
  1263. }
  1264. void RuntimeNodeSelect::_setup(const Dictionary &p_settings) {
  1265. Window *root = SceneTree::get_singleton()->get_root();
  1266. ERR_FAIL_COND(root->is_connected(SceneStringName(window_input), callable_mp(this, &RuntimeNodeSelect::_root_window_input)));
  1267. root->connect(SceneStringName(window_input), callable_mp(this, &RuntimeNodeSelect::_root_window_input));
  1268. root->connect("size_changed", callable_mp(this, &RuntimeNodeSelect::_queue_selection_update), CONNECT_DEFERRED);
  1269. max_selection = p_settings.get("debugger/max_node_selection", 1);
  1270. panner.instantiate();
  1271. panner->set_callbacks(callable_mp(this, &RuntimeNodeSelect::_pan_callback), callable_mp(this, &RuntimeNodeSelect::_zoom_callback));
  1272. ViewPanner::ControlScheme panning_scheme = (ViewPanner::ControlScheme)p_settings.get("editors/panning/2d_editor_panning_scheme", 0).operator int();
  1273. bool simple_panning = p_settings.get("editors/panning/simple_panning", false);
  1274. int pan_speed = p_settings.get("editors/panning/2d_editor_pan_speed", 20);
  1275. Array keys = p_settings.get("canvas_item_editor/pan_view", Array()).operator Array();
  1276. panner->setup(panning_scheme, DebuggerMarshalls::deserialize_key_shortcut(keys), simple_panning);
  1277. panner->setup_warped_panning(root, p_settings.get("editors/panning/warped_mouse_panning", true));
  1278. panner->set_scroll_speed(pan_speed);
  1279. sel_2d_grab_dist = p_settings.get("editors/polygon_editor/point_grab_radius", 0);
  1280. selection_area_fill = p_settings.get("box_selection_fill_color", Color());
  1281. selection_area_outline = p_settings.get("box_selection_stroke_color", Color());
  1282. draw_canvas = RS::get_singleton()->canvas_create();
  1283. sel_drag_ci = RS::get_singleton()->canvas_item_create();
  1284. /// 2D Selection Box Generation
  1285. sbox_2d_ci = RS::get_singleton()->canvas_item_create();
  1286. RS::get_singleton()->viewport_attach_canvas(root->get_viewport_rid(), draw_canvas);
  1287. RS::get_singleton()->canvas_item_set_parent(sel_drag_ci, draw_canvas);
  1288. RS::get_singleton()->canvas_item_set_parent(sbox_2d_ci, draw_canvas);
  1289. #ifndef _3D_DISABLED
  1290. cursor = Cursor();
  1291. camera_fov = p_settings.get("editors/3d/default_fov", 70);
  1292. camera_znear = p_settings.get("editors/3d/default_z_near", 0.05);
  1293. camera_zfar = p_settings.get("editors/3d/default_z_far", 4'000);
  1294. invert_x_axis = p_settings.get("editors/3d/navigation/invert_x_axis", false);
  1295. invert_y_axis = p_settings.get("editors/3d/navigation/invert_y_axis", false);
  1296. warped_mouse_panning_3d = p_settings.get("editors/3d/navigation/warped_mouse_panning", true);
  1297. freelook_base_speed = p_settings.get("editors/3d/freelook/freelook_base_speed", 5);
  1298. freelook_sensitivity = Math::deg_to_rad((real_t)p_settings.get("editors/3d/freelook/freelook_sensitivity", 0.25));
  1299. orbit_sensitivity = Math::deg_to_rad((real_t)p_settings.get("editors/3d/navigation_feel/orbit_sensitivity", 0.004));
  1300. translation_sensitivity = p_settings.get("editors/3d/navigation_feel/translation_sensitivity", 1);
  1301. /// 3D Selection Box Generation
  1302. // Copied from the Node3DEditor implementation.
  1303. sbox_3d_color = p_settings.get("editors/3d/selection_box_color", Color());
  1304. // Use two AABBs to create the illusion of a slightly thicker line.
  1305. AABB aabb(Vector3(), Vector3(1, 1, 1));
  1306. // Create a x-ray (visible through solid surfaces) and standard version of the selection box.
  1307. // Both will be drawn at the same position, but with different opacity.
  1308. // This lets the user see where the selection is while still having a sense of depth.
  1309. Ref<SurfaceTool> st = memnew(SurfaceTool);
  1310. Ref<SurfaceTool> st_xray = memnew(SurfaceTool);
  1311. st->begin(Mesh::PRIMITIVE_LINES);
  1312. st_xray->begin(Mesh::PRIMITIVE_LINES);
  1313. for (int i = 0; i < 12; i++) {
  1314. Vector3 a, b;
  1315. aabb.get_edge(i, a, b);
  1316. st->add_vertex(a);
  1317. st->add_vertex(b);
  1318. st_xray->add_vertex(a);
  1319. st_xray->add_vertex(b);
  1320. }
  1321. Ref<StandardMaterial3D> mat = memnew(StandardMaterial3D);
  1322. mat->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED);
  1323. mat->set_flag(StandardMaterial3D::FLAG_DISABLE_FOG, true);
  1324. mat->set_albedo(sbox_3d_color);
  1325. mat->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA);
  1326. st->set_material(mat);
  1327. sbox_3d_mesh = st->commit();
  1328. Ref<StandardMaterial3D> mat_xray = memnew(StandardMaterial3D);
  1329. mat_xray->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED);
  1330. mat_xray->set_flag(StandardMaterial3D::FLAG_DISABLE_FOG, true);
  1331. mat_xray->set_flag(StandardMaterial3D::FLAG_DISABLE_DEPTH_TEST, true);
  1332. mat_xray->set_albedo(sbox_3d_color * Color(1, 1, 1, 0.15));
  1333. mat_xray->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA);
  1334. st_xray->set_material(mat_xray);
  1335. sbox_3d_mesh_xray = st_xray->commit();
  1336. #endif // _3D_DISABLED
  1337. SceneTree::get_singleton()->connect("process_frame", callable_mp(this, &RuntimeNodeSelect::_process_frame));
  1338. SceneTree::get_singleton()->connect("physics_frame", callable_mp(this, &RuntimeNodeSelect::_physics_frame));
  1339. // This function will be called before the root enters the tree at first when the Game view is passing its settings to
  1340. // the debugger, so queue the update for after it enters.
  1341. root->connect(SceneStringName(tree_entered), callable_mp(this, &RuntimeNodeSelect::_update_input_state), Object::CONNECT_ONE_SHOT);
  1342. }
  1343. void RuntimeNodeSelect::_node_set_type(NodeType p_type) {
  1344. node_select_type = p_type;
  1345. _update_input_state();
  1346. }
  1347. void RuntimeNodeSelect::_select_set_mode(SelectMode p_mode) {
  1348. node_select_mode = p_mode;
  1349. }
  1350. void RuntimeNodeSelect::_set_camera_override_enabled(bool p_enabled) {
  1351. camera_override = p_enabled;
  1352. if (p_enabled) {
  1353. _update_view_2d();
  1354. }
  1355. #ifndef _3D_DISABLED
  1356. if (camera_first_override) {
  1357. _reset_camera_2d();
  1358. _reset_camera_3d();
  1359. camera_first_override = false;
  1360. } else if (p_enabled) {
  1361. _update_view_2d();
  1362. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  1363. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov * cursor.fov_scale, camera_znear, camera_zfar);
  1364. }
  1365. #endif // _3D_DISABLED
  1366. }
  1367. void RuntimeNodeSelect::_root_window_input(const Ref<InputEvent> &p_event) {
  1368. Window *root = SceneTree::get_singleton()->get_root();
  1369. if (node_select_type == NODE_TYPE_NONE || (selection_list && selection_list->is_visible())) {
  1370. // Workaround for platforms that don't allow subwindows.
  1371. if (selection_list && selection_list->is_visible() && selection_list->is_embedded()) {
  1372. root->set_disable_input_override(false);
  1373. selection_list->push_input(p_event);
  1374. callable_mp(root->get_viewport(), &Viewport::set_disable_input_override).call_deferred(true);
  1375. }
  1376. return;
  1377. }
  1378. bool is_dragging_camera = false;
  1379. if (camera_override) {
  1380. if (node_select_type == NODE_TYPE_2D) {
  1381. is_dragging_camera = panner->gui_input(p_event, Rect2(Vector2(), root->get_visible_rect().get_size()));
  1382. #ifndef _3D_DISABLED
  1383. } else if (node_select_type == NODE_TYPE_3D && selection_drag_state == SELECTION_DRAG_NONE) {
  1384. if (_handle_3d_input(p_event)) {
  1385. return;
  1386. }
  1387. #endif // _3D_DISABLED
  1388. }
  1389. }
  1390. Ref<InputEventMouseButton> b = p_event;
  1391. if (selection_drag_state == SELECTION_DRAG_MOVE) {
  1392. Ref<InputEventMouseMotion> m = p_event;
  1393. if (m.is_valid()) {
  1394. _update_selection_drag(root->get_screen_transform().affine_inverse().xform(m->get_position()));
  1395. return;
  1396. } else if (b.is_valid()) {
  1397. // Account for actions like zooming.
  1398. _update_selection_drag(root->get_screen_transform().affine_inverse().xform(b->get_position()));
  1399. }
  1400. }
  1401. if (b.is_null()) {
  1402. return;
  1403. }
  1404. // Ignore mouse wheel inputs.
  1405. if (b->get_button_index() != MouseButton::LEFT && b->get_button_index() != MouseButton::RIGHT) {
  1406. return;
  1407. }
  1408. if (selection_drag_state == SELECTION_DRAG_MOVE && !b->is_pressed() && b->get_button_index() == MouseButton::LEFT) {
  1409. selection_drag_state = SELECTION_DRAG_END;
  1410. selection_drag_area = selection_drag_area.abs();
  1411. _update_selection_drag();
  1412. // Trigger a selection in the position on release.
  1413. if (multi_shortcut_pressed) {
  1414. selection_position = root->get_screen_transform().affine_inverse().xform(b->get_position());
  1415. }
  1416. }
  1417. if (!is_dragging_camera && b->is_pressed()) {
  1418. multi_shortcut_pressed = b->is_shift_pressed();
  1419. list_shortcut_pressed = node_select_mode == SELECT_MODE_SINGLE && b->get_button_index() == MouseButton::RIGHT && b->is_alt_pressed();
  1420. if (list_shortcut_pressed || b->get_button_index() == MouseButton::LEFT) {
  1421. selection_position = root->get_screen_transform().affine_inverse().xform(b->get_position());
  1422. }
  1423. }
  1424. }
  1425. void RuntimeNodeSelect::_items_popup_index_pressed(int p_index, PopupMenu *p_popup) {
  1426. Object *obj = p_popup->get_item_metadata(p_index).get_validated_object();
  1427. if (obj) {
  1428. Vector<Node *> node;
  1429. node.append(Object::cast_to<Node>(obj));
  1430. _send_ids(node);
  1431. }
  1432. }
  1433. void RuntimeNodeSelect::_update_input_state() {
  1434. SceneTree *scene_tree = SceneTree::get_singleton();
  1435. // This function can be called at the very beginning, when the root hasn't entered the tree yet.
  1436. // So check first to avoid a crash.
  1437. if (!scene_tree->get_root()->is_inside_tree()) {
  1438. return;
  1439. }
  1440. bool disable_input = scene_tree->is_suspended() || node_select_type != RuntimeNodeSelect::NODE_TYPE_NONE;
  1441. Input::get_singleton()->set_disable_input(disable_input);
  1442. Input::get_singleton()->set_mouse_mode_override_enabled(disable_input);
  1443. scene_tree->get_root()->set_disable_input_override(disable_input);
  1444. }
  1445. void RuntimeNodeSelect::_process_frame() {
  1446. #ifndef _3D_DISABLED
  1447. if (camera_freelook) {
  1448. Transform3D transform = _get_cursor_transform();
  1449. Vector3 forward = transform.basis.xform(Vector3(0, 0, -1));
  1450. const Vector3 right = transform.basis.xform(Vector3(1, 0, 0));
  1451. Vector3 up = transform.basis.xform(Vector3(0, 1, 0));
  1452. Vector3 direction;
  1453. Input *input = Input::get_singleton();
  1454. bool was_input_disabled = input->is_input_disabled();
  1455. if (was_input_disabled) {
  1456. input->set_disable_input(false);
  1457. }
  1458. if (input->is_physical_key_pressed(Key::A)) {
  1459. direction -= right;
  1460. }
  1461. if (input->is_physical_key_pressed(Key::D)) {
  1462. direction += right;
  1463. }
  1464. if (input->is_physical_key_pressed(Key::W)) {
  1465. direction += forward;
  1466. }
  1467. if (input->is_physical_key_pressed(Key::S)) {
  1468. direction -= forward;
  1469. }
  1470. if (input->is_physical_key_pressed(Key::E)) {
  1471. direction += up;
  1472. }
  1473. if (input->is_physical_key_pressed(Key::Q)) {
  1474. direction -= up;
  1475. }
  1476. real_t speed = freelook_base_speed;
  1477. if (input->is_physical_key_pressed(Key::SHIFT)) {
  1478. speed *= 3.0;
  1479. }
  1480. if (input->is_physical_key_pressed(Key::ALT)) {
  1481. speed *= 0.333333;
  1482. }
  1483. if (was_input_disabled) {
  1484. input->set_disable_input(true);
  1485. }
  1486. if (direction != Vector3()) {
  1487. // Calculate the process time manually, as the time scale is frozen.
  1488. const double process_time = (1.0 / Engine::get_singleton()->get_frames_per_second()) * Engine::get_singleton()->get_unfrozen_time_scale();
  1489. const Vector3 motion = direction * speed * process_time;
  1490. cursor.pos += motion;
  1491. cursor.eye_pos += motion;
  1492. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  1493. }
  1494. }
  1495. #endif // _3D_DISABLED
  1496. if (selection_update_queued || !SceneTree::get_singleton()->is_suspended()) {
  1497. selection_update_queued = false;
  1498. if (has_selection) {
  1499. _update_selection();
  1500. }
  1501. }
  1502. }
  1503. void RuntimeNodeSelect::_physics_frame() {
  1504. if (selection_drag_state != SELECTION_DRAG_END && (selection_drag_state == SELECTION_DRAG_MOVE || Math::is_inf(selection_position.x))) {
  1505. return;
  1506. }
  1507. Window *root = SceneTree::get_singleton()->get_root();
  1508. bool selection_drag_valid = selection_drag_state == SELECTION_DRAG_END && selection_drag_area.get_area() > SELECTION_MIN_AREA;
  1509. Vector<SelectResult> items;
  1510. if (node_select_type == NODE_TYPE_2D) {
  1511. if (selection_drag_valid) {
  1512. for (int i = 0; i < root->get_child_count(); i++) {
  1513. _find_canvas_items_at_rect(selection_drag_area, root->get_child(i), items);
  1514. }
  1515. } else if (!Math::is_inf(selection_position.x)) {
  1516. for (int i = 0; i < root->get_child_count(); i++) {
  1517. _find_canvas_items_at_pos(selection_position, root->get_child(i), items);
  1518. }
  1519. }
  1520. // Remove possible duplicates.
  1521. for (int i = 0; i < items.size(); i++) {
  1522. Node *item = items[i].item;
  1523. for (int j = 0; j < i; j++) {
  1524. if (items[j].item == item) {
  1525. items.remove_at(i);
  1526. i--;
  1527. break;
  1528. }
  1529. }
  1530. }
  1531. #ifndef _3D_DISABLED
  1532. } else if (node_select_type == NODE_TYPE_3D) {
  1533. if (selection_drag_valid) {
  1534. _find_3d_items_at_rect(selection_drag_area, items);
  1535. } else {
  1536. _find_3d_items_at_pos(selection_position, items);
  1537. }
  1538. #endif // _3D_DISABLED
  1539. }
  1540. items.sort();
  1541. switch (selection_drag_state) {
  1542. case SELECTION_DRAG_END: {
  1543. selection_position = Point2(Math::INF, Math::INF);
  1544. selection_drag_state = SELECTION_DRAG_NONE;
  1545. if (selection_drag_area.get_area() > SELECTION_MIN_AREA) {
  1546. if (!items.is_empty()) {
  1547. Vector<Node *> nodes;
  1548. for (const SelectResult item : items) {
  1549. nodes.append(item.item);
  1550. }
  1551. _send_ids(nodes, false);
  1552. }
  1553. _update_selection_drag();
  1554. return;
  1555. }
  1556. _update_selection_drag();
  1557. } break;
  1558. case SELECTION_DRAG_NONE: {
  1559. if (node_select_mode == SELECT_MODE_LIST) {
  1560. break;
  1561. }
  1562. if (multi_shortcut_pressed) {
  1563. // Allow forcing box selection when an item was clicked.
  1564. selection_drag_state = SELECTION_DRAG_MOVE;
  1565. } else if (items.is_empty()) {
  1566. #ifdef _3D_DISABLED
  1567. if (!selected_ci_nodes.is_empty()) {
  1568. #else
  1569. if (!selected_ci_nodes.is_empty() || !selected_3d_nodes.is_empty()) {
  1570. #endif // _3D_DISABLED
  1571. EngineDebugger::get_singleton()->send_message("remote_nothing_selected", Array());
  1572. _clear_selection();
  1573. }
  1574. selection_drag_state = SELECTION_DRAG_MOVE;
  1575. } else {
  1576. break;
  1577. }
  1578. [[fallthrough]];
  1579. }
  1580. case SELECTION_DRAG_MOVE: {
  1581. selection_drag_area.position = selection_position;
  1582. // Stop selection on click, so it can happen on release if the selection area doesn't pass the threshold.
  1583. if (multi_shortcut_pressed) {
  1584. return;
  1585. }
  1586. }
  1587. }
  1588. if (items.is_empty()) {
  1589. selection_position = Point2(Math::INF, Math::INF);
  1590. return;
  1591. }
  1592. if ((!list_shortcut_pressed && node_select_mode == SELECT_MODE_SINGLE) || items.size() == 1) {
  1593. selection_position = Point2(Math::INF, Math::INF);
  1594. Vector<Node *> node;
  1595. node.append(items[0].item);
  1596. _send_ids(node);
  1597. return;
  1598. }
  1599. if (!selection_list && (list_shortcut_pressed || node_select_mode == SELECT_MODE_LIST)) {
  1600. _open_selection_list(items, selection_position);
  1601. }
  1602. selection_position = Point2(Math::INF, Math::INF);
  1603. }
  1604. void RuntimeNodeSelect::_send_ids(const Vector<Node *> &p_picked_nodes, bool p_invert_new_selections) {
  1605. ERR_FAIL_COND(p_picked_nodes.is_empty());
  1606. Vector<Node *> picked_nodes = p_picked_nodes;
  1607. Array message;
  1608. if (!multi_shortcut_pressed) {
  1609. if (picked_nodes.size() > max_selection) {
  1610. picked_nodes.resize(max_selection);
  1611. EngineDebugger::get_singleton()->send_message("show_selection_limit_warning", Array());
  1612. }
  1613. for (const Node *node : picked_nodes) {
  1614. SceneDebuggerObject obj(node->get_instance_id());
  1615. Array arr;
  1616. obj.serialize(arr);
  1617. message.append(arr);
  1618. }
  1619. EngineDebugger::get_singleton()->send_message("remote_objects_selected", message);
  1620. _set_selected_nodes(picked_nodes);
  1621. return;
  1622. }
  1623. LocalVector<Node *> nodes;
  1624. LocalVector<ObjectID> ids;
  1625. for (Node *node : picked_nodes) {
  1626. ObjectID id = node->get_instance_id();
  1627. if (CanvasItem *ci = Object::cast_to<CanvasItem>(node)) {
  1628. if (selected_ci_nodes.has(id)) {
  1629. if (p_invert_new_selections) {
  1630. selected_ci_nodes.erase(id);
  1631. }
  1632. } else {
  1633. ids.push_back(id);
  1634. nodes.push_back(ci);
  1635. }
  1636. } else {
  1637. #ifndef _3D_DISABLED
  1638. if (Node3D *node3d = Object::cast_to<Node3D>(node)) {
  1639. if (selected_3d_nodes.has(id)) {
  1640. if (p_invert_new_selections) {
  1641. selected_3d_nodes.erase(id);
  1642. }
  1643. } else {
  1644. ids.push_back(id);
  1645. nodes.push_back(node3d);
  1646. }
  1647. }
  1648. #endif // _3D_DISABLED
  1649. }
  1650. }
  1651. uint32_t limit = max_selection - selected_ci_nodes.size();
  1652. #ifndef _3D_DISABLED
  1653. limit -= selected_3d_nodes.size();
  1654. #endif // _3D_DISABLED
  1655. if (ids.size() > limit) {
  1656. ids.resize(limit);
  1657. nodes.resize(limit);
  1658. EngineDebugger::get_singleton()->send_message("show_selection_limit_warning", Array());
  1659. }
  1660. for (ObjectID id : selected_ci_nodes) {
  1661. ids.push_back(id);
  1662. nodes.push_back(ObjectDB::get_instance<Node>(id));
  1663. }
  1664. #ifndef _3D_DISABLED
  1665. for (const KeyValue<ObjectID, Ref<SelectionBox3D>> &KV : selected_3d_nodes) {
  1666. ids.push_back(KV.key);
  1667. nodes.push_back(ObjectDB::get_instance<Node>(KV.key));
  1668. }
  1669. #endif // _3D_DISABLED
  1670. if (ids.is_empty()) {
  1671. EngineDebugger::get_singleton()->send_message("remote_nothing_selected", message);
  1672. } else {
  1673. for (const ObjectID &id : ids) {
  1674. SceneDebuggerObject obj(id);
  1675. Array arr;
  1676. obj.serialize(arr);
  1677. message.append(arr);
  1678. }
  1679. EngineDebugger::get_singleton()->send_message("remote_objects_selected", message);
  1680. }
  1681. _set_selected_nodes(Vector<Node *>(nodes));
  1682. }
  1683. void RuntimeNodeSelect::_set_selected_nodes(const Vector<Node *> &p_nodes) {
  1684. if (p_nodes.is_empty()) {
  1685. _clear_selection();
  1686. return;
  1687. }
  1688. bool changed = false;
  1689. LocalVector<ObjectID> nodes_ci;
  1690. #ifndef _3D_DISABLED
  1691. HashMap<ObjectID, Ref<SelectionBox3D>> nodes_3d;
  1692. #endif // _3D_DISABLED
  1693. for (Node *node : p_nodes) {
  1694. ObjectID id = node->get_instance_id();
  1695. if (Object::cast_to<CanvasItem>(node)) {
  1696. if (!changed || !selected_ci_nodes.has(id)) {
  1697. changed = true;
  1698. }
  1699. nodes_ci.push_back(id);
  1700. } else {
  1701. #ifndef _3D_DISABLED
  1702. Node3D *node_3d = Object::cast_to<Node3D>(node);
  1703. if (!node_3d || !node_3d->is_inside_world()) {
  1704. continue;
  1705. }
  1706. if (!changed || !selected_3d_nodes.has(id)) {
  1707. changed = true;
  1708. }
  1709. if (selected_3d_nodes.has(id)) {
  1710. // Assign an already available visual instance.
  1711. nodes_3d[id] = selected_3d_nodes.get(id);
  1712. continue;
  1713. }
  1714. if (sbox_3d_mesh.is_null() || sbox_3d_mesh_xray.is_null()) {
  1715. continue;
  1716. }
  1717. Ref<SelectionBox3D> sb;
  1718. sb.instantiate();
  1719. nodes_3d[id] = sb;
  1720. RID scenario = node_3d->get_world_3d()->get_scenario();
  1721. sb->instance = RS::get_singleton()->instance_create2(sbox_3d_mesh->get_rid(), scenario);
  1722. sb->instance_ofs = RS::get_singleton()->instance_create2(sbox_3d_mesh->get_rid(), scenario);
  1723. RS::get_singleton()->instance_geometry_set_cast_shadows_setting(sb->instance, RS::SHADOW_CASTING_SETTING_OFF);
  1724. RS::get_singleton()->instance_geometry_set_cast_shadows_setting(sb->instance_ofs, RS::SHADOW_CASTING_SETTING_OFF);
  1725. RS::get_singleton()->instance_geometry_set_flag(sb->instance, RS::INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING, true);
  1726. RS::get_singleton()->instance_geometry_set_flag(sb->instance, RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  1727. RS::get_singleton()->instance_geometry_set_flag(sb->instance_ofs, RS::INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING, true);
  1728. RS::get_singleton()->instance_geometry_set_flag(sb->instance_ofs, RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  1729. sb->instance_xray = RS::get_singleton()->instance_create2(sbox_3d_mesh_xray->get_rid(), scenario);
  1730. sb->instance_xray_ofs = RS::get_singleton()->instance_create2(sbox_3d_mesh_xray->get_rid(), scenario);
  1731. RS::get_singleton()->instance_geometry_set_cast_shadows_setting(sb->instance_xray, RS::SHADOW_CASTING_SETTING_OFF);
  1732. RS::get_singleton()->instance_geometry_set_cast_shadows_setting(sb->instance_xray_ofs, RS::SHADOW_CASTING_SETTING_OFF);
  1733. RS::get_singleton()->instance_geometry_set_flag(sb->instance_xray, RS::INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING, true);
  1734. RS::get_singleton()->instance_geometry_set_flag(sb->instance_xray, RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  1735. RS::get_singleton()->instance_geometry_set_flag(sb->instance_xray_ofs, RS::INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING, true);
  1736. RS::get_singleton()->instance_geometry_set_flag(sb->instance_xray_ofs, RS::INSTANCE_FLAG_USE_BAKED_LIGHT, false);
  1737. #endif // _3D_DISABLED
  1738. }
  1739. }
  1740. #ifdef _3D_DISABLED
  1741. if (!changed && nodes_ci.size() == selected_ci_nodes.size()) {
  1742. return;
  1743. }
  1744. #else
  1745. if (!changed && nodes_ci.size() == selected_ci_nodes.size() && nodes_3d.size() == selected_3d_nodes.size()) {
  1746. return;
  1747. }
  1748. #endif // _3D_DISABLED
  1749. _clear_selection();
  1750. selected_ci_nodes = nodes_ci;
  1751. has_selection = !nodes_ci.is_empty();
  1752. #ifndef _3D_DISABLED
  1753. if (!nodes_3d.is_empty()) {
  1754. selected_3d_nodes = nodes_3d;
  1755. has_selection = true;
  1756. }
  1757. #endif // _3D_DISABLED
  1758. _queue_selection_update();
  1759. }
  1760. void RuntimeNodeSelect::_queue_selection_update() {
  1761. if (has_selection && selection_visible) {
  1762. if (SceneTree::get_singleton()->is_suspended()) {
  1763. _update_selection();
  1764. } else {
  1765. selection_update_queued = true;
  1766. }
  1767. }
  1768. }
  1769. void RuntimeNodeSelect::_update_selection() {
  1770. Window *root = SceneTree::get_singleton()->get_root();
  1771. RS::get_singleton()->canvas_item_clear(sbox_2d_ci);
  1772. RS::get_singleton()->canvas_item_set_visible(sbox_2d_ci, selection_visible);
  1773. for (LocalVector<ObjectID>::Iterator E = selected_ci_nodes.begin(); E != selected_ci_nodes.end(); ++E) {
  1774. ObjectID id = *E;
  1775. CanvasItem *ci = ObjectDB::get_instance<CanvasItem>(id);
  1776. if (!ci) {
  1777. selected_ci_nodes.erase(id);
  1778. --E;
  1779. continue;
  1780. }
  1781. if (!ci->is_inside_tree()) {
  1782. continue;
  1783. }
  1784. Transform2D xform;
  1785. // Cameras (overridden or not) don't affect `CanvasLayer`s.
  1786. if (root->is_canvas_transform_override_enabled() && !(ci->get_canvas_layer_node() && !ci->get_canvas_layer_node()->is_following_viewport())) {
  1787. xform = root->get_canvas_transform_override() * ci->get_global_transform();
  1788. } else {
  1789. xform = ci->get_global_transform_with_canvas();
  1790. }
  1791. // Fallback.
  1792. Rect2 rect = Rect2(Vector2(), Vector2(10, 10));
  1793. if (ci->_edit_use_rect()) {
  1794. rect = ci->_edit_get_rect();
  1795. } else {
  1796. #ifndef PHYSICS_2D_DISABLED
  1797. CollisionShape2D *collision_shape = Object::cast_to<CollisionShape2D>(ci);
  1798. if (collision_shape) {
  1799. Ref<Shape2D> shape = collision_shape->get_shape();
  1800. if (shape.is_valid()) {
  1801. rect = shape->get_rect();
  1802. }
  1803. }
  1804. #endif // PHYSICS_2D_DISABLED
  1805. }
  1806. const Vector2 endpoints[4] = {
  1807. xform.xform(rect.position),
  1808. xform.xform(rect.position + Point2(rect.size.x, 0)),
  1809. xform.xform(rect.position + rect.size),
  1810. xform.xform(rect.position + Point2(0, rect.size.y))
  1811. };
  1812. const Color selection_color_2d = Color(1, 0.6, 0.4, 0.7);
  1813. for (int i = 0; i < 4; i++) {
  1814. RS::get_singleton()->canvas_item_add_line(sbox_2d_ci, endpoints[i], endpoints[(i + 1) % 4], selection_color_2d, 2);
  1815. }
  1816. }
  1817. #ifndef _3D_DISABLED
  1818. for (HashMap<ObjectID, Ref<SelectionBox3D>>::ConstIterator KV = selected_3d_nodes.begin(); KV != selected_3d_nodes.end(); ++KV) {
  1819. ObjectID id = KV->key;
  1820. Node3D *node_3d = ObjectDB::get_instance<Node3D>(id);
  1821. if (!node_3d) {
  1822. selected_3d_nodes.erase(id);
  1823. --KV;
  1824. continue;
  1825. }
  1826. if (!node_3d->is_inside_tree()) {
  1827. continue;
  1828. }
  1829. // Fallback.
  1830. AABB bounds(Vector3(-0.5, -0.5, -0.5), Vector3(1, 1, 1));
  1831. VisualInstance3D *visual_instance = Object::cast_to<VisualInstance3D>(node_3d);
  1832. if (visual_instance) {
  1833. bounds = visual_instance->get_aabb();
  1834. } else {
  1835. #ifndef PHYSICS_3D_DISABLED
  1836. CollisionShape3D *collision_shape = Object::cast_to<CollisionShape3D>(node_3d);
  1837. if (collision_shape) {
  1838. Ref<Shape3D> shape = collision_shape->get_shape();
  1839. if (shape.is_valid()) {
  1840. bounds = shape->get_debug_mesh()->get_aabb();
  1841. }
  1842. }
  1843. #endif // PHYSICS_3D_DISABLED
  1844. }
  1845. Transform3D xform_to_top_level_parent_space = node_3d->get_global_transform().affine_inverse() * node_3d->get_global_transform();
  1846. bounds = xform_to_top_level_parent_space.xform(bounds);
  1847. Transform3D t = node_3d->get_global_transform();
  1848. Ref<SelectionBox3D> sb = KV->value;
  1849. if (t == sb->transform && bounds == sb->bounds) {
  1850. continue; // Nothing changed.
  1851. }
  1852. sb->transform = t;
  1853. sb->bounds = bounds;
  1854. Transform3D t_offset = t;
  1855. // Apply AABB scaling before item's global transform.
  1856. {
  1857. const Vector3 offset(0.005, 0.005, 0.005);
  1858. Basis aabb_s;
  1859. aabb_s.scale(bounds.size + offset);
  1860. t.translate_local(bounds.position - offset / 2);
  1861. t.basis = t.basis * aabb_s;
  1862. }
  1863. {
  1864. const Vector3 offset(0.01, 0.01, 0.01);
  1865. Basis aabb_s;
  1866. aabb_s.scale(bounds.size + offset);
  1867. t_offset.translate_local(bounds.position - offset / 2);
  1868. t_offset.basis = t_offset.basis * aabb_s;
  1869. }
  1870. RS::get_singleton()->instance_set_visible(sb->instance, selection_visible);
  1871. RS::get_singleton()->instance_set_visible(sb->instance_ofs, selection_visible);
  1872. RS::get_singleton()->instance_set_visible(sb->instance_xray, selection_visible);
  1873. RS::get_singleton()->instance_set_visible(sb->instance_xray_ofs, selection_visible);
  1874. RS::get_singleton()->instance_set_transform(sb->instance, t);
  1875. RS::get_singleton()->instance_set_transform(sb->instance_ofs, t_offset);
  1876. RS::get_singleton()->instance_set_transform(sb->instance_xray, t);
  1877. RS::get_singleton()->instance_set_transform(sb->instance_xray_ofs, t_offset);
  1878. }
  1879. #endif // _3D_DISABLED
  1880. }
  1881. void RuntimeNodeSelect::_clear_selection() {
  1882. selected_ci_nodes.clear();
  1883. if (draw_canvas.is_valid()) {
  1884. RS::get_singleton()->canvas_item_clear(sbox_2d_ci);
  1885. }
  1886. #ifndef _3D_DISABLED
  1887. selected_3d_nodes.clear();
  1888. #endif // _3D_DISABLED
  1889. has_selection = false;
  1890. }
  1891. void RuntimeNodeSelect::_update_selection_drag(const Point2 &p_end_pos) {
  1892. RS::get_singleton()->canvas_item_clear(sel_drag_ci);
  1893. if (selection_drag_state != SELECTION_DRAG_MOVE) {
  1894. return;
  1895. }
  1896. selection_drag_area.size = p_end_pos - selection_drag_area.position;
  1897. if (selection_drag_state == SELECTION_DRAG_END) {
  1898. return;
  1899. }
  1900. Window *root = SceneTree::get_singleton()->get_root();
  1901. Rect2 selection_drawing;
  1902. int thickness;
  1903. if (root->is_canvas_transform_override_enabled()) {
  1904. Transform2D xform = root->get_canvas_transform_override();
  1905. RS::get_singleton()->canvas_item_set_transform(sel_drag_ci, xform);
  1906. RS::get_singleton()->canvas_item_reset_physics_interpolation(sel_drag_ci);
  1907. selection_drawing.position = xform.affine_inverse().xform(selection_drag_area.position);
  1908. selection_drawing.size = xform.affine_inverse().xform(p_end_pos);
  1909. thickness = MAX(1, Math::ceil(1 / view_2d_zoom));
  1910. } else {
  1911. RS::get_singleton()->canvas_item_set_transform(sel_drag_ci, Transform2D());
  1912. RS::get_singleton()->canvas_item_reset_physics_interpolation(sel_drag_ci);
  1913. selection_drawing.position = selection_drag_area.position;
  1914. selection_drawing.size = p_end_pos;
  1915. thickness = 1;
  1916. }
  1917. selection_drawing.size -= selection_drawing.position;
  1918. selection_drawing = selection_drawing.abs();
  1919. const Vector2 endpoints[4] = {
  1920. selection_drawing.position,
  1921. selection_drawing.position + Point2(selection_drawing.size.x, 0),
  1922. selection_drawing.position + selection_drawing.size,
  1923. selection_drawing.position + Point2(0, selection_drawing.size.y)
  1924. };
  1925. // Draw fill.
  1926. RS::get_singleton()->canvas_item_add_rect(sel_drag_ci, selection_drawing, selection_area_fill);
  1927. // Draw outline.
  1928. for (int i = 0; i < 4; i++) {
  1929. RS::get_singleton()->canvas_item_add_line(sel_drag_ci, endpoints[i], endpoints[(i + 1) % 4], selection_area_outline, thickness);
  1930. }
  1931. }
  1932. void RuntimeNodeSelect::_open_selection_list(const Vector<SelectResult> &p_items, const Point2 &p_pos) {
  1933. Window *root = SceneTree::get_singleton()->get_root();
  1934. selection_list = memnew(PopupMenu);
  1935. selection_list->set_theme(ThemeDB::get_singleton()->get_default_theme());
  1936. selection_list->set_auto_translate_mode(Node::AUTO_TRANSLATE_MODE_DISABLED);
  1937. selection_list->set_force_native(true);
  1938. selection_list->connect("index_pressed", callable_mp(this, &RuntimeNodeSelect::_items_popup_index_pressed).bind(selection_list));
  1939. selection_list->connect("popup_hide", callable_mp(this, &RuntimeNodeSelect::_close_selection_list));
  1940. root->add_child(selection_list);
  1941. for (const SelectResult &I : p_items) {
  1942. selection_list->add_item(I.item->get_name());
  1943. selection_list->set_item_metadata(-1, I.item);
  1944. }
  1945. selection_list->set_position(selection_list->is_embedded() ? p_pos : (Input::get_singleton()->get_mouse_position() + root->get_position()));
  1946. selection_list->reset_size();
  1947. selection_list->popup();
  1948. // FIXME: Ugly hack that stops the popup from hiding when the button is released.
  1949. selection_list->call_deferred(SNAME("set_position"), selection_list->get_position() + Point2(1, 0));
  1950. }
  1951. void RuntimeNodeSelect::_close_selection_list() {
  1952. selection_list->queue_free();
  1953. selection_list = nullptr;
  1954. }
  1955. void RuntimeNodeSelect::_set_selection_visible(bool p_visible) {
  1956. selection_visible = p_visible;
  1957. if (has_selection) {
  1958. _update_selection();
  1959. }
  1960. }
  1961. // Copied and trimmed from the CanvasItemEditor implementation.
  1962. 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) {
  1963. if (!p_node || Object::cast_to<Viewport>(p_node)) {
  1964. return;
  1965. }
  1966. CanvasItem *ci = Object::cast_to<CanvasItem>(p_node);
  1967. for (int i = p_node->get_child_count() - 1; i >= 0; i--) {
  1968. if (ci) {
  1969. if (!ci->is_set_as_top_level()) {
  1970. _find_canvas_items_at_pos(p_pos, p_node->get_child(i), r_items, p_parent_xform * ci->get_transform(), p_canvas_xform);
  1971. } else {
  1972. _find_canvas_items_at_pos(p_pos, p_node->get_child(i), r_items, ci->get_transform(), p_canvas_xform);
  1973. }
  1974. } else {
  1975. CanvasLayer *cl = Object::cast_to<CanvasLayer>(p_node);
  1976. _find_canvas_items_at_pos(p_pos, p_node->get_child(i), r_items, Transform2D(), cl ? cl->get_transform() : p_canvas_xform);
  1977. }
  1978. }
  1979. if (!ci || !ci->is_visible_in_tree()) {
  1980. return;
  1981. }
  1982. Transform2D xform = p_canvas_xform;
  1983. if (!ci->is_set_as_top_level()) {
  1984. xform *= p_parent_xform;
  1985. }
  1986. Window *root = SceneTree::get_singleton()->get_root();
  1987. Point2 pos;
  1988. // Cameras (overridden or not) don't affect `CanvasLayer`s.
  1989. if (!ci->get_canvas_layer_node() || ci->get_canvas_layer_node()->is_following_viewport()) {
  1990. pos = (root->is_canvas_transform_override_enabled() ? root->get_canvas_transform_override() : root->get_canvas_transform()).affine_inverse().xform(p_pos);
  1991. } else {
  1992. pos = p_pos;
  1993. }
  1994. xform = (xform * ci->get_transform()).affine_inverse();
  1995. const real_t local_grab_distance = xform.basis_xform(Vector2(sel_2d_grab_dist, 0)).length() / view_2d_zoom;
  1996. if (ci->_edit_is_selected_on_click(xform.xform(pos), local_grab_distance)) {
  1997. SelectResult res;
  1998. res.item = ci;
  1999. res.order = ci->get_effective_z_index() + ci->get_canvas_layer();
  2000. r_items.push_back(res);
  2001. #ifndef PHYSICS_2D_DISABLED
  2002. // If it's a shape, get the collision object it's from.
  2003. // FIXME: If the collision object has multiple shapes, only the topmost will be above it in the list.
  2004. if (Object::cast_to<CollisionShape2D>(ci) || Object::cast_to<CollisionPolygon2D>(ci)) {
  2005. CollisionObject2D *collision_object = Object::cast_to<CollisionObject2D>(ci->get_parent());
  2006. if (collision_object) {
  2007. SelectResult res_col;
  2008. res_col.item = ci->get_parent();
  2009. res_col.order = collision_object->get_z_index() + ci->get_canvas_layer();
  2010. r_items.push_back(res_col);
  2011. }
  2012. }
  2013. #endif // PHYSICS_2D_DISABLED
  2014. }
  2015. }
  2016. // Copied and trimmed from the CanvasItemEditor implementation.
  2017. 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) {
  2018. if (!p_node || Object::cast_to<Viewport>(p_node)) {
  2019. return;
  2020. }
  2021. CanvasItem *ci = Object::cast_to<CanvasItem>(p_node);
  2022. for (int i = p_node->get_child_count() - 1; i >= 0; i--) {
  2023. if (ci) {
  2024. if (!ci->is_set_as_top_level()) {
  2025. _find_canvas_items_at_rect(p_rect, p_node->get_child(i), r_items, p_parent_xform * ci->get_transform(), p_canvas_xform);
  2026. } else {
  2027. _find_canvas_items_at_rect(p_rect, p_node->get_child(i), r_items, ci->get_transform(), p_canvas_xform);
  2028. }
  2029. } else {
  2030. CanvasLayer *cl = Object::cast_to<CanvasLayer>(p_node);
  2031. _find_canvas_items_at_rect(p_rect, p_node->get_child(i), r_items, Transform2D(), cl ? cl->get_transform() : p_canvas_xform);
  2032. }
  2033. }
  2034. if (!ci || !ci->is_visible_in_tree()) {
  2035. return;
  2036. }
  2037. Transform2D xform = p_canvas_xform;
  2038. if (!ci->is_set_as_top_level()) {
  2039. xform *= p_parent_xform;
  2040. }
  2041. Window *root = SceneTree::get_singleton()->get_root();
  2042. Rect2 rect;
  2043. // Cameras (overridden or not) don't affect `CanvasLayer`s.
  2044. if (!ci->get_canvas_layer_node() || ci->get_canvas_layer_node()->is_following_viewport()) {
  2045. rect = (root->is_canvas_transform_override_enabled() ? root->get_canvas_transform_override() : root->get_canvas_transform()).affine_inverse().xform(p_rect);
  2046. } else {
  2047. rect = p_rect;
  2048. }
  2049. rect = (xform * ci->get_transform()).affine_inverse().xform(rect);
  2050. bool selected = false;
  2051. if (ci->_edit_use_rect()) {
  2052. Rect2 ci_rect = ci->_edit_get_rect();
  2053. if (rect.has_point(ci_rect.position) &&
  2054. rect.has_point(ci_rect.position + Vector2(ci_rect.size.x, 0)) &&
  2055. rect.has_point(ci_rect.position + Vector2(ci_rect.size.x, ci_rect.size.y)) &&
  2056. rect.has_point(ci_rect.position + Vector2(0, ci_rect.size.y))) {
  2057. selected = true;
  2058. }
  2059. } else if (rect.has_point(Point2())) {
  2060. selected = true;
  2061. }
  2062. if (selected) {
  2063. SelectResult res;
  2064. res.item = ci;
  2065. res.order = ci->get_effective_z_index() + ci->get_canvas_layer();
  2066. r_items.push_back(res);
  2067. }
  2068. }
  2069. void RuntimeNodeSelect::_pan_callback(Vector2 p_scroll_vec, Ref<InputEvent> p_event) {
  2070. Vector2 scroll = SceneTree::get_singleton()->get_root()->get_screen_transform().affine_inverse().xform(p_scroll_vec);
  2071. view_2d_offset.x -= scroll.x / view_2d_zoom;
  2072. view_2d_offset.y -= scroll.y / view_2d_zoom;
  2073. _update_view_2d();
  2074. }
  2075. // A very shallow copy of the same function inside CanvasItemEditor.
  2076. void RuntimeNodeSelect::_zoom_callback(float p_zoom_factor, Vector2 p_origin, Ref<InputEvent> p_event) {
  2077. real_t prev_zoom = view_2d_zoom;
  2078. view_2d_zoom = CLAMP(view_2d_zoom * p_zoom_factor, VIEW_2D_MIN_ZOOM, VIEW_2D_MAX_ZOOM);
  2079. Vector2 pos = SceneTree::get_singleton()->get_root()->get_screen_transform().affine_inverse().xform(p_origin);
  2080. view_2d_offset += pos / prev_zoom - pos / view_2d_zoom;
  2081. // We want to align in-scene pixels to screen pixels, this prevents blurry rendering
  2082. // of small details (texts, lines).
  2083. // This correction adds a jitter movement when zooming, so we correct only when the
  2084. // zoom factor is an integer. (in the other cases, all pixels won't be aligned anyway)
  2085. const real_t closest_zoom_factor = Math::round(view_2d_zoom);
  2086. if (Math::is_zero_approx(view_2d_zoom - closest_zoom_factor)) {
  2087. // Make sure scene pixel at view_offset is aligned on a screen pixel.
  2088. Vector2 view_offset_int = view_2d_offset.floor();
  2089. Vector2 view_offset_frac = view_2d_offset - view_offset_int;
  2090. view_2d_offset = view_offset_int + (view_offset_frac * closest_zoom_factor).round() / closest_zoom_factor;
  2091. }
  2092. _update_view_2d();
  2093. }
  2094. void RuntimeNodeSelect::_reset_camera_2d() {
  2095. view_2d_offset = -SceneTree::get_singleton()->get_root()->get_canvas_transform().get_origin();
  2096. view_2d_zoom = 1;
  2097. _update_view_2d();
  2098. }
  2099. void RuntimeNodeSelect::_update_view_2d() {
  2100. Transform2D transform = Transform2D();
  2101. transform.scale_basis(Size2(view_2d_zoom, view_2d_zoom));
  2102. transform.columns[2] = -view_2d_offset * view_2d_zoom;
  2103. SceneTree::get_singleton()->get_root()->set_canvas_transform_override(transform);
  2104. _queue_selection_update();
  2105. }
  2106. #ifndef _3D_DISABLED
  2107. void RuntimeNodeSelect::_find_3d_items_at_pos(const Point2 &p_pos, Vector<SelectResult> &r_items) {
  2108. Window *root = SceneTree::get_singleton()->get_root();
  2109. Vector3 ray, pos, to;
  2110. if (root->is_camera_3d_override_enabled()) {
  2111. ray = root->camera_3d_override_project_ray_normal(p_pos);
  2112. pos = root->camera_3d_override_project_ray_origin(p_pos);
  2113. to = pos + ray * root->get_camera_3d_override_properties()["z_far"];
  2114. } else {
  2115. Camera3D *camera = root->get_camera_3d();
  2116. if (!camera) {
  2117. return;
  2118. }
  2119. ray = camera->project_ray_normal(p_pos);
  2120. pos = camera->project_ray_origin(p_pos);
  2121. to = pos + ray * camera->get_far();
  2122. }
  2123. #ifndef PHYSICS_3D_DISABLED
  2124. // Start with physical objects.
  2125. PhysicsDirectSpaceState3D *ss = root->get_world_3d()->get_direct_space_state();
  2126. PhysicsDirectSpaceState3D::RayResult result;
  2127. HashSet<RID> excluded;
  2128. PhysicsDirectSpaceState3D::RayParameters ray_params;
  2129. ray_params.from = pos;
  2130. ray_params.to = to;
  2131. ray_params.collide_with_areas = true;
  2132. while (true) {
  2133. ray_params.exclude = excluded;
  2134. if (ss->intersect_ray(ray_params, result)) {
  2135. SelectResult res;
  2136. res.item = Object::cast_to<Node>(result.collider);
  2137. res.order = -pos.distance_to(result.position);
  2138. // Fetch collision shapes.
  2139. CollisionObject3D *collision = Object::cast_to<CollisionObject3D>(result.collider);
  2140. if (collision) {
  2141. List<uint32_t> owners;
  2142. collision->get_shape_owners(&owners);
  2143. for (uint32_t &I : owners) {
  2144. SelectResult res_shape;
  2145. res_shape.item = Object::cast_to<Node>(collision->shape_owner_get_owner(I));
  2146. res_shape.order = res.order;
  2147. r_items.push_back(res_shape);
  2148. }
  2149. }
  2150. r_items.push_back(res);
  2151. excluded.insert(result.rid);
  2152. } else {
  2153. break;
  2154. }
  2155. }
  2156. #endif // PHYSICS_3D_DISABLED
  2157. // Then go for the meshes.
  2158. Vector<ObjectID> items = RS::get_singleton()->instances_cull_ray(pos, to, root->get_world_3d()->get_scenario());
  2159. for (int i = 0; i < items.size(); i++) {
  2160. Object *obj = ObjectDB::get_instance(items[i]);
  2161. GeometryInstance3D *geo_instance = Object::cast_to<GeometryInstance3D>(obj);
  2162. if (geo_instance) {
  2163. Ref<TriangleMesh> mesh_collision = geo_instance->generate_triangle_mesh();
  2164. if (mesh_collision.is_valid()) {
  2165. Transform3D gt = geo_instance->get_global_transform();
  2166. Transform3D ai = gt.affine_inverse();
  2167. Vector3 point, normal;
  2168. if (mesh_collision->intersect_ray(ai.xform(pos), ai.basis.xform(ray).normalized(), point, normal)) {
  2169. SelectResult res;
  2170. res.item = Object::cast_to<Node>(obj);
  2171. res.order = -pos.distance_to(gt.xform(point));
  2172. r_items.push_back(res);
  2173. continue;
  2174. }
  2175. }
  2176. }
  2177. items.remove_at(i);
  2178. i--;
  2179. }
  2180. }
  2181. void RuntimeNodeSelect::_find_3d_items_at_rect(const Rect2 &p_rect, Vector<SelectResult> &r_items) {
  2182. Window *root = SceneTree::get_singleton()->get_root();
  2183. Camera3D *camera = root->get_camera_3d();
  2184. if (!camera) {
  2185. return;
  2186. }
  2187. bool cam_override = root->is_camera_3d_override_enabled();
  2188. Vector3 cam_pos;
  2189. Vector3 dist_pos;
  2190. if (cam_override) {
  2191. cam_pos = root->get_camera_3d_override_transform().origin;
  2192. dist_pos = root->camera_3d_override_project_ray_origin(p_rect.position + p_rect.size / 2);
  2193. } else {
  2194. cam_pos = camera->get_global_position();
  2195. dist_pos = camera->project_ray_origin(p_rect.position + p_rect.size / 2);
  2196. }
  2197. real_t znear, zfar = 0;
  2198. real_t zofs = 5.0;
  2199. if (cam_override) {
  2200. HashMap<StringName, real_t> override_props = root->get_camera_3d_override_properties();
  2201. znear = override_props["z_near"];
  2202. zfar = override_props["z_far"];
  2203. zofs -= znear;
  2204. } else {
  2205. znear = camera->get_near();
  2206. zfar = camera->get_far();
  2207. zofs -= znear;
  2208. }
  2209. zofs = MAX(0.0, zofs);
  2210. const Point2 pos_end = p_rect.position + p_rect.size;
  2211. Vector3 box[4] = {
  2212. Vector3(
  2213. MIN(p_rect.position.x, pos_end.x),
  2214. MIN(p_rect.position.y, pos_end.y),
  2215. zofs),
  2216. Vector3(
  2217. MAX(p_rect.position.x, pos_end.x),
  2218. MIN(p_rect.position.y, pos_end.y),
  2219. zofs),
  2220. Vector3(
  2221. MAX(p_rect.position.x, pos_end.x),
  2222. MAX(p_rect.position.y, pos_end.y),
  2223. zofs),
  2224. Vector3(
  2225. MIN(p_rect.position.x, pos_end.x),
  2226. MAX(p_rect.position.y, pos_end.y),
  2227. zofs)
  2228. };
  2229. Vector<Plane> frustum;
  2230. for (int i = 0; i < 4; i++) {
  2231. Vector3 a = _get_screen_to_space(box[i]);
  2232. Vector3 b = _get_screen_to_space(box[(i + 1) % 4]);
  2233. frustum.push_back(Plane(a, b, cam_pos));
  2234. }
  2235. Plane near_plane;
  2236. // Get the camera normal.
  2237. if (cam_override) {
  2238. near_plane = Plane(root->get_camera_3d_override_transform().basis.get_column(2), cam_pos);
  2239. } else {
  2240. near_plane = Plane(camera->get_global_transform().basis.get_column(2), cam_pos);
  2241. }
  2242. near_plane.d -= znear;
  2243. frustum.push_back(near_plane);
  2244. Plane far_plane = -near_plane;
  2245. far_plane.d += zfar;
  2246. frustum.push_back(far_plane);
  2247. #ifndef PHYSICS_3D_DISABLED
  2248. Vector<Vector3> points = Geometry3D::compute_convex_mesh_points(&frustum[0], frustum.size());
  2249. Ref<ConvexPolygonShape3D> shape;
  2250. shape.instantiate();
  2251. shape->set_points(points);
  2252. // Start with physical objects.
  2253. PhysicsDirectSpaceState3D *ss = root->get_world_3d()->get_direct_space_state();
  2254. PhysicsDirectSpaceState3D::ShapeResult result;
  2255. PhysicsDirectSpaceState3D::ShapeParameters shape_params;
  2256. shape_params.shape_rid = shape->get_rid();
  2257. shape_params.collide_with_areas = true;
  2258. if (ss->intersect_shape(shape_params, &result, 32)) {
  2259. SelectResult res;
  2260. res.item = Object::cast_to<Node>(result.collider);
  2261. res.order = -dist_pos.distance_to(Object::cast_to<Node3D>(res.item)->get_global_transform().origin);
  2262. // Fetch collision shapes.
  2263. CollisionObject3D *collision = Object::cast_to<CollisionObject3D>(result.collider);
  2264. if (collision) {
  2265. List<uint32_t> owners;
  2266. collision->get_shape_owners(&owners);
  2267. for (uint32_t &I : owners) {
  2268. SelectResult res_shape;
  2269. res_shape.item = Object::cast_to<Node>(collision->shape_owner_get_owner(I));
  2270. res_shape.order = res.order;
  2271. r_items.push_back(res_shape);
  2272. }
  2273. }
  2274. r_items.push_back(res);
  2275. }
  2276. #endif // PHYSICS_3D_DISABLED
  2277. // Then go for the meshes.
  2278. Vector<ObjectID> items = RS::get_singleton()->instances_cull_convex(frustum, root->get_world_3d()->get_scenario());
  2279. for (int i = 0; i < items.size(); i++) {
  2280. Object *obj = ObjectDB::get_instance(items[i]);
  2281. GeometryInstance3D *geo_instance = Object::cast_to<GeometryInstance3D>(obj);
  2282. if (geo_instance) {
  2283. Ref<TriangleMesh> mesh_collision = geo_instance->generate_triangle_mesh();
  2284. if (mesh_collision.is_valid()) {
  2285. Transform3D gt = geo_instance->get_global_transform();
  2286. Vector3 mesh_scale = gt.get_basis().get_scale();
  2287. gt.orthonormalize();
  2288. Transform3D it = gt.affine_inverse();
  2289. Vector<Plane> transformed_frustum;
  2290. int plane_count = frustum.size();
  2291. transformed_frustum.resize(plane_count);
  2292. for (int j = 0; j < plane_count; j++) {
  2293. transformed_frustum.write[j] = it.xform(frustum[j]);
  2294. }
  2295. Vector<Vector3> convex_points = Geometry3D::compute_convex_mesh_points(transformed_frustum.ptr(), plane_count);
  2296. if (mesh_collision->inside_convex_shape(transformed_frustum.ptr(), transformed_frustum.size(), convex_points.ptr(), convex_points.size(), mesh_scale)) {
  2297. SelectResult res;
  2298. res.item = Object::cast_to<Node>(obj);
  2299. res.order = -dist_pos.distance_to(gt.origin);
  2300. r_items.push_back(res);
  2301. continue;
  2302. }
  2303. }
  2304. }
  2305. items.remove_at(i);
  2306. i--;
  2307. }
  2308. }
  2309. Vector3 RuntimeNodeSelect::_get_screen_to_space(const Vector3 &p_vector3) {
  2310. Window *root = SceneTree::get_singleton()->get_root();
  2311. Camera3D *camera = root->get_camera_3d();
  2312. Size2 size = root->get_size();
  2313. real_t znear = 0;
  2314. Projection cm;
  2315. Transform3D camera_transform;
  2316. if (root->is_camera_3d_override_enabled()) {
  2317. HashMap<StringName, real_t> override_props = root->get_camera_3d_override_properties();
  2318. znear = override_props["z_near"];
  2319. cm.set_perspective(override_props["fov"], size.aspect(), znear + p_vector3.z, override_props["z_far"]);
  2320. camera_transform.translate_local(cursor.pos);
  2321. camera_transform.basis.rotate(Vector3(1, 0, 0), -cursor.x_rot);
  2322. camera_transform.basis.rotate(Vector3(0, 1, 0), -cursor.y_rot);
  2323. camera_transform.translate_local(0, 0, cursor.distance);
  2324. } else {
  2325. znear = camera->get_near();
  2326. cm.set_perspective(camera->get_fov(), size.aspect(), znear + p_vector3.z, camera->get_far());
  2327. camera_transform = camera->get_camera_transform();
  2328. }
  2329. Vector2 screen_he = cm.get_viewport_half_extents();
  2330. 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)));
  2331. }
  2332. bool RuntimeNodeSelect::_handle_3d_input(const Ref<InputEvent> &p_event) {
  2333. Ref<InputEventMouseButton> b = p_event;
  2334. if (b.is_valid()) {
  2335. const real_t zoom_factor = 1.08 * b->get_factor();
  2336. switch (b->get_button_index()) {
  2337. case MouseButton::WHEEL_UP: {
  2338. if (!camera_freelook) {
  2339. _cursor_scale_distance(1.0 / zoom_factor);
  2340. } else {
  2341. _scale_freelook_speed(zoom_factor);
  2342. }
  2343. return true;
  2344. } break;
  2345. case MouseButton::WHEEL_DOWN: {
  2346. if (!camera_freelook) {
  2347. _cursor_scale_distance(zoom_factor);
  2348. } else {
  2349. _scale_freelook_speed(1.0 / zoom_factor);
  2350. }
  2351. return true;
  2352. } break;
  2353. case MouseButton::RIGHT: {
  2354. _set_camera_freelook_enabled(b->is_pressed());
  2355. return true;
  2356. } break;
  2357. default: {
  2358. }
  2359. }
  2360. }
  2361. Ref<InputEventMouseMotion> m = p_event;
  2362. if (m.is_valid()) {
  2363. if (camera_freelook) {
  2364. _cursor_look(m);
  2365. } else if (m->get_button_mask().has_flag(MouseButtonMask::MIDDLE)) {
  2366. if (m->is_shift_pressed()) {
  2367. _cursor_pan(m);
  2368. } else {
  2369. _cursor_orbit(m);
  2370. }
  2371. }
  2372. return true;
  2373. }
  2374. Ref<InputEventKey> k = p_event;
  2375. if (k.is_valid()) {
  2376. if (k->get_physical_keycode() == Key::ESCAPE) {
  2377. _set_camera_freelook_enabled(false);
  2378. return true;
  2379. } else if (k->is_ctrl_pressed()) {
  2380. switch (k->get_physical_keycode()) {
  2381. case Key::EQUAL: {
  2382. cursor.fov_scale = CLAMP(cursor.fov_scale - 0.05, CAMERA_MIN_FOV_SCALE, CAMERA_MAX_FOV_SCALE);
  2383. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov * cursor.fov_scale, camera_znear, camera_zfar);
  2384. return true;
  2385. } break;
  2386. case Key::MINUS: {
  2387. cursor.fov_scale = CLAMP(cursor.fov_scale + 0.05, CAMERA_MIN_FOV_SCALE, CAMERA_MAX_FOV_SCALE);
  2388. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov * cursor.fov_scale, camera_znear, camera_zfar);
  2389. return true;
  2390. } break;
  2391. case Key::KEY_0: {
  2392. cursor.fov_scale = 1;
  2393. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov, camera_znear, camera_zfar);
  2394. return true;
  2395. } break;
  2396. default: {
  2397. }
  2398. }
  2399. }
  2400. }
  2401. // TODO: Handle magnify and pan input gestures.
  2402. return false;
  2403. }
  2404. void RuntimeNodeSelect::_set_camera_freelook_enabled(bool p_enabled) {
  2405. camera_freelook = p_enabled;
  2406. if (p_enabled) {
  2407. // Make sure eye_pos is synced, because freelook referential is eye pos rather than orbit pos
  2408. Vector3 forward = _get_cursor_transform().basis.xform(Vector3(0, 0, -1));
  2409. cursor.eye_pos = cursor.pos - cursor.distance * forward;
  2410. previous_mouse_position = SceneTree::get_singleton()->get_root()->get_mouse_position();
  2411. // Hide mouse like in an FPS (warping doesn't work).
  2412. Input::get_singleton()->set_mouse_mode_override(Input::MOUSE_MODE_CAPTURED);
  2413. } else {
  2414. // Restore mouse.
  2415. Input::get_singleton()->set_mouse_mode_override(Input::MOUSE_MODE_VISIBLE);
  2416. // Restore the previous mouse position when leaving freelook mode.
  2417. // This is done because leaving `Input.MOUSE_MODE_CAPTURED` will center the cursor
  2418. // due to OS limitations.
  2419. Input::get_singleton()->warp_mouse(previous_mouse_position);
  2420. }
  2421. }
  2422. void RuntimeNodeSelect::_cursor_scale_distance(real_t p_scale) {
  2423. real_t min_distance = MAX(camera_znear * 4, VIEW_3D_MIN_ZOOM);
  2424. real_t max_distance = MIN(camera_zfar / 4, VIEW_3D_MAX_ZOOM);
  2425. cursor.distance = CLAMP(cursor.distance * p_scale, min_distance, max_distance);
  2426. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2427. }
  2428. void RuntimeNodeSelect::_scale_freelook_speed(real_t p_scale) {
  2429. real_t min_speed = MAX(camera_znear * 4, VIEW_3D_MIN_ZOOM);
  2430. real_t max_speed = MIN(camera_zfar / 4, VIEW_3D_MAX_ZOOM);
  2431. if (unlikely(min_speed > max_speed)) {
  2432. freelook_base_speed = (min_speed + max_speed) / 2;
  2433. } else {
  2434. freelook_base_speed = CLAMP(freelook_base_speed * p_scale, min_speed, max_speed);
  2435. }
  2436. }
  2437. void RuntimeNodeSelect::_cursor_look(Ref<InputEventWithModifiers> p_event) {
  2438. Window *root = SceneTree::get_singleton()->get_root();
  2439. const Vector2 relative = _get_warped_mouse_motion(p_event, Rect2(Vector2(), root->get_size()));
  2440. const Transform3D prev_camera_transform = _get_cursor_transform();
  2441. if (invert_y_axis) {
  2442. cursor.x_rot -= relative.y * freelook_sensitivity;
  2443. } else {
  2444. cursor.x_rot += relative.y * freelook_sensitivity;
  2445. }
  2446. // Clamp the Y rotation to roughly -90..90 degrees so the user can't look upside-down and end up disoriented.
  2447. cursor.x_rot = CLAMP(cursor.x_rot, -1.57, 1.57);
  2448. cursor.y_rot += relative.x * freelook_sensitivity;
  2449. // Look is like the opposite of Orbit: the focus point rotates around the camera.
  2450. Transform3D camera_transform = _get_cursor_transform();
  2451. Vector3 pos = camera_transform.xform(Vector3(0, 0, 0));
  2452. Vector3 prev_pos = prev_camera_transform.xform(Vector3(0, 0, 0));
  2453. Vector3 diff = prev_pos - pos;
  2454. cursor.pos += diff;
  2455. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2456. }
  2457. void RuntimeNodeSelect::_cursor_pan(Ref<InputEventWithModifiers> p_event) {
  2458. Window *root = SceneTree::get_singleton()->get_root();
  2459. // Reduce all sides of the area by 1, so warping works when windows are maximized/fullscreen.
  2460. const Vector2 relative = _get_warped_mouse_motion(p_event, Rect2(Vector2(1, 1), root->get_size() - Vector2(2, 2)));
  2461. const real_t pan_speed = translation_sensitivity / 150.0;
  2462. Transform3D camera_transform;
  2463. camera_transform.translate_local(cursor.pos);
  2464. camera_transform.basis.rotate(Vector3(1, 0, 0), -cursor.x_rot);
  2465. camera_transform.basis.rotate(Vector3(0, 1, 0), -cursor.y_rot);
  2466. Vector3 translation(1 * -relative.x * pan_speed, relative.y * pan_speed, 0);
  2467. translation *= cursor.distance / 4;
  2468. camera_transform.translate_local(translation);
  2469. cursor.pos = camera_transform.origin;
  2470. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2471. }
  2472. void RuntimeNodeSelect::_cursor_orbit(Ref<InputEventWithModifiers> p_event) {
  2473. Window *root = SceneTree::get_singleton()->get_root();
  2474. // Reduce all sides of the area by 1, so warping works when windows are maximized/fullscreen.
  2475. const Vector2 relative = _get_warped_mouse_motion(p_event, Rect2(Vector2(1, 1), root->get_size() - Vector2(2, 2)));
  2476. if (invert_y_axis) {
  2477. cursor.x_rot -= relative.y * orbit_sensitivity;
  2478. } else {
  2479. cursor.x_rot += relative.y * orbit_sensitivity;
  2480. }
  2481. // Clamp the Y rotation to roughly -90..90 degrees so the user can't look upside-down and end up disoriented.
  2482. cursor.x_rot = CLAMP(cursor.x_rot, -1.57, 1.57);
  2483. if (invert_x_axis) {
  2484. cursor.y_rot -= relative.x * orbit_sensitivity;
  2485. } else {
  2486. cursor.y_rot += relative.x * orbit_sensitivity;
  2487. }
  2488. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2489. }
  2490. Point2 RuntimeNodeSelect::_get_warped_mouse_motion(const Ref<InputEventMouseMotion> &p_event, Rect2 p_area) const {
  2491. ERR_FAIL_COND_V(p_event.is_null(), Point2());
  2492. if (warped_mouse_panning_3d) {
  2493. return Input::get_singleton()->warp_mouse_motion(p_event, p_area);
  2494. }
  2495. return p_event->get_relative();
  2496. }
  2497. Transform3D RuntimeNodeSelect::_get_cursor_transform() {
  2498. Transform3D camera_transform;
  2499. camera_transform.translate_local(cursor.pos);
  2500. camera_transform.basis.rotate(Vector3(1, 0, 0), -cursor.x_rot);
  2501. camera_transform.basis.rotate(Vector3(0, 1, 0), -cursor.y_rot);
  2502. camera_transform.translate_local(0, 0, cursor.distance);
  2503. return camera_transform;
  2504. }
  2505. void RuntimeNodeSelect::_reset_camera_3d() {
  2506. camera_first_override = true;
  2507. cursor = Cursor();
  2508. Window *root = SceneTree::get_singleton()->get_root();
  2509. Camera3D *camera = root->get_camera_3d();
  2510. if (camera) {
  2511. Transform3D transform = camera->get_global_transform();
  2512. transform.translate_local(0, 0, -cursor.distance);
  2513. cursor.pos = transform.origin;
  2514. cursor.x_rot = -camera->get_global_rotation().x;
  2515. cursor.y_rot = -camera->get_global_rotation().y;
  2516. cursor.fov_scale = CLAMP(camera->get_fov() / camera_fov, CAMERA_MIN_FOV_SCALE, CAMERA_MAX_FOV_SCALE);
  2517. } else {
  2518. cursor.fov_scale = 1.0;
  2519. }
  2520. SceneTree::get_singleton()->get_root()->set_camera_3d_override_transform(_get_cursor_transform());
  2521. SceneTree::get_singleton()->get_root()->set_camera_3d_override_perspective(camera_fov * cursor.fov_scale, camera_znear, camera_zfar);
  2522. }
  2523. #endif // _3D_DISABLED
  2524. #endif // DEBUG_ENABLED