skeleton_3d_editor_plugin.cpp 67 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822
  1. /**************************************************************************/
  2. /* skeleton_3d_editor_plugin.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 "skeleton_3d_editor_plugin.h"
  31. #include "core/io/resource_saver.h"
  32. #include "editor/editor_node.h"
  33. #include "editor/editor_properties.h"
  34. #include "editor/editor_properties_vector.h"
  35. #include "editor/editor_settings.h"
  36. #include "editor/editor_string_names.h"
  37. #include "editor/editor_undo_redo_manager.h"
  38. #include "editor/plugins/animation_player_editor_plugin.h"
  39. #include "editor/plugins/node_3d_editor_plugin.h"
  40. #include "editor/themes/editor_scale.h"
  41. #include "scene/3d/mesh_instance_3d.h"
  42. #include "scene/3d/physics/collision_shape_3d.h"
  43. #include "scene/3d/physics/joints/joint_3d.h"
  44. #include "scene/3d/physics/physical_bone_3d.h"
  45. #include "scene/3d/physics/physics_body_3d.h"
  46. #include "scene/gui/separator.h"
  47. #include "scene/gui/texture_rect.h"
  48. #include "scene/property_utils.h"
  49. #include "scene/resources/3d/capsule_shape_3d.h"
  50. #include "scene/resources/skeleton_profile.h"
  51. #include "scene/resources/surface_tool.h"
  52. void BonePropertiesEditor::create_editors() {
  53. section = memnew(EditorInspectorSection);
  54. section->setup("trf_properties", label, this, Color(0.0f, 0.0f, 0.0f), true);
  55. section->unfold();
  56. add_child(section);
  57. enabled_checkbox = memnew(EditorPropertyCheck());
  58. enabled_checkbox->set_label("Pose Enabled");
  59. enabled_checkbox->set_selectable(false);
  60. enabled_checkbox->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_value_changed));
  61. section->get_vbox()->add_child(enabled_checkbox);
  62. // Position property.
  63. position_property = memnew(EditorPropertyVector3());
  64. position_property->setup(-10000, 10000, 0.001, true);
  65. position_property->set_label("Position");
  66. position_property->set_selectable(false);
  67. position_property->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_value_changed));
  68. position_property->connect("property_keyed", callable_mp(this, &BonePropertiesEditor::_property_keyed));
  69. section->get_vbox()->add_child(position_property);
  70. // Rotation property.
  71. rotation_property = memnew(EditorPropertyQuaternion());
  72. rotation_property->setup(-10000, 10000, 0.001, true);
  73. rotation_property->set_label("Rotation");
  74. rotation_property->set_selectable(false);
  75. rotation_property->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_value_changed));
  76. rotation_property->connect("property_keyed", callable_mp(this, &BonePropertiesEditor::_property_keyed));
  77. section->get_vbox()->add_child(rotation_property);
  78. // Scale property.
  79. scale_property = memnew(EditorPropertyVector3());
  80. scale_property->setup(-10000, 10000, 0.001, true, true);
  81. scale_property->set_label("Scale");
  82. scale_property->set_selectable(false);
  83. scale_property->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_value_changed));
  84. scale_property->connect("property_keyed", callable_mp(this, &BonePropertiesEditor::_property_keyed));
  85. section->get_vbox()->add_child(scale_property);
  86. // Transform/Matrix section.
  87. rest_section = memnew(EditorInspectorSection);
  88. rest_section->setup("trf_properties_transform", "Rest", this, Color(0.0f, 0.0f, 0.0f), true);
  89. section->get_vbox()->add_child(rest_section);
  90. // Transform/Matrix property.
  91. rest_matrix = memnew(EditorPropertyTransform3D());
  92. rest_matrix->setup(-10000, 10000, 0.001, true);
  93. rest_matrix->set_label("Transform");
  94. rest_matrix->set_selectable(false);
  95. rest_section->get_vbox()->add_child(rest_matrix);
  96. // Bone Metadata property
  97. meta_section = memnew(EditorInspectorSection);
  98. meta_section->setup("bone_meta", TTR("Bone Metadata"), this, Color(.0f, .0f, .0f), true);
  99. section->get_vbox()->add_child(meta_section);
  100. add_metadata_button = EditorInspector::create_inspector_action_button(TTR("Add Bone Metadata"));
  101. add_metadata_button->connect(SceneStringName(pressed), callable_mp(this, &BonePropertiesEditor::_show_add_meta_dialog));
  102. section->get_vbox()->add_child(add_metadata_button);
  103. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  104. undo_redo->connect("version_changed", callable_mp(this, &BonePropertiesEditor::_update_properties));
  105. undo_redo->connect("history_changed", callable_mp(this, &BonePropertiesEditor::_update_properties));
  106. }
  107. void BonePropertiesEditor::_notification(int p_what) {
  108. switch (p_what) {
  109. case NOTIFICATION_THEME_CHANGED: {
  110. const Color section_color = get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor));
  111. section->set_bg_color(section_color);
  112. rest_section->set_bg_color(section_color);
  113. add_metadata_button->set_button_icon(get_editor_theme_icon(SNAME("Add")));
  114. } break;
  115. }
  116. }
  117. void BonePropertiesEditor::_value_changed(const String &p_property, const Variant &p_value, const String &p_name, bool p_changing) {
  118. if (updating || !skeleton) {
  119. return;
  120. }
  121. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  122. undo_redo->create_action(TTR("Set Bone Transform"), UndoRedo::MERGE_ENDS);
  123. undo_redo->add_undo_property(skeleton, p_property, skeleton->get(p_property));
  124. undo_redo->add_do_property(skeleton, p_property, p_value);
  125. Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
  126. if (se) {
  127. undo_redo->add_do_method(se, "update_joint_tree");
  128. undo_redo->add_undo_method(se, "update_joint_tree");
  129. }
  130. undo_redo->commit_action();
  131. }
  132. void BonePropertiesEditor::_meta_changed(const String &p_property, const Variant &p_value, const String &p_name, bool p_changing) {
  133. if (!skeleton || p_property.get_slicec('/', 2) != "bone_meta") {
  134. return;
  135. }
  136. int bone = p_property.get_slicec('/', 1).to_int();
  137. if (bone >= skeleton->get_bone_count()) {
  138. return;
  139. }
  140. String key = p_property.get_slicec('/', 3);
  141. if (!skeleton->has_bone_meta(1, key)) {
  142. return;
  143. }
  144. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  145. undo_redo->create_action(vformat(TTR("Modify metadata '%s' for bone '%s'"), key, skeleton->get_bone_name(bone)));
  146. undo_redo->add_do_property(skeleton, p_property, p_value);
  147. undo_redo->add_do_method(meta_editors[p_property], "update_property");
  148. undo_redo->add_undo_property(skeleton, p_property, skeleton->get_bone_meta(bone, key));
  149. undo_redo->add_undo_method(meta_editors[p_property], "update_property");
  150. undo_redo->commit_action();
  151. }
  152. void BonePropertiesEditor::_meta_deleted(const String &p_property) {
  153. if (!skeleton || p_property.get_slicec('/', 2) != "bone_meta") {
  154. return;
  155. }
  156. int bone = p_property.get_slicec('/', 1).to_int();
  157. if (bone >= skeleton->get_bone_count()) {
  158. return;
  159. }
  160. String key = p_property.get_slicec('/', 3);
  161. if (!skeleton->has_bone_meta(1, key)) {
  162. return;
  163. }
  164. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  165. undo_redo->create_action(vformat(TTR("Remove metadata '%s' from bone '%s'"), key, skeleton->get_bone_name(bone)));
  166. undo_redo->add_do_property(skeleton, p_property, Variant());
  167. undo_redo->add_undo_property(skeleton, p_property, skeleton->get_bone_meta(bone, key));
  168. undo_redo->commit_action();
  169. emit_signal(SNAME("property_deleted"), p_property);
  170. }
  171. void BonePropertiesEditor::_show_add_meta_dialog() {
  172. if (!add_meta_dialog) {
  173. add_meta_dialog = memnew(AddMetadataDialog());
  174. add_meta_dialog->connect(SceneStringName(confirmed), callable_mp(this, &BonePropertiesEditor::_add_meta_confirm));
  175. add_child(add_meta_dialog);
  176. }
  177. int bone = Skeleton3DEditor::get_singleton()->get_selected_bone();
  178. StringName dialog_title = skeleton->get_bone_name(bone);
  179. List<StringName> existing_meta_keys;
  180. skeleton->get_bone_meta_list(bone, &existing_meta_keys);
  181. add_meta_dialog->open(dialog_title, existing_meta_keys);
  182. }
  183. void BonePropertiesEditor::_add_meta_confirm() {
  184. int bone = Skeleton3DEditor::get_singleton()->get_selected_bone();
  185. String name = add_meta_dialog->get_meta_name();
  186. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  187. undo_redo->create_action(vformat(TTR("Add metadata '%s' to bone '%s'"), name, skeleton->get_bone_name(bone)));
  188. undo_redo->add_do_method(skeleton, "set_bone_meta", bone, name, add_meta_dialog->get_meta_defval());
  189. undo_redo->add_undo_method(skeleton, "set_bone_meta", bone, name, Variant());
  190. undo_redo->commit_action();
  191. }
  192. BonePropertiesEditor::BonePropertiesEditor(Skeleton3D *p_skeleton) :
  193. skeleton(p_skeleton) {
  194. create_editors();
  195. }
  196. void BonePropertiesEditor::set_keyable(const bool p_keyable) {
  197. position_property->set_keying(p_keyable);
  198. rotation_property->set_keying(p_keyable);
  199. scale_property->set_keying(p_keyable);
  200. }
  201. void BonePropertiesEditor::set_target(const String &p_prop) {
  202. enabled_checkbox->set_object_and_property(skeleton, p_prop + "enabled");
  203. enabled_checkbox->update_property();
  204. position_property->set_object_and_property(skeleton, p_prop + "position");
  205. position_property->update_property();
  206. rotation_property->set_object_and_property(skeleton, p_prop + "rotation");
  207. rotation_property->update_property();
  208. scale_property->set_object_and_property(skeleton, p_prop + "scale");
  209. scale_property->update_property();
  210. rest_matrix->set_object_and_property(skeleton, p_prop + "rest");
  211. rest_matrix->update_property();
  212. }
  213. void BonePropertiesEditor::_property_keyed(const String &p_path, bool p_advance) {
  214. AnimationTrackEditor *te = AnimationPlayerEditor::get_singleton()->get_track_editor();
  215. if (!te || !te->has_keying()) {
  216. return;
  217. }
  218. te->_clear_selection();
  219. PackedStringArray split = p_path.split("/");
  220. if (split.size() == 3 && split[0] == "bones") {
  221. int bone_idx = split[1].to_int();
  222. if (split[2] == "position") {
  223. te->insert_transform_key(skeleton, skeleton->get_bone_name(bone_idx), Animation::TYPE_POSITION_3D, (Vector3)skeleton->get(p_path) / skeleton->get_motion_scale());
  224. }
  225. if (split[2] == "rotation") {
  226. te->insert_transform_key(skeleton, skeleton->get_bone_name(bone_idx), Animation::TYPE_ROTATION_3D, skeleton->get(p_path));
  227. }
  228. if (split[2] == "scale") {
  229. te->insert_transform_key(skeleton, skeleton->get_bone_name(bone_idx), Animation::TYPE_SCALE_3D, skeleton->get(p_path));
  230. }
  231. }
  232. }
  233. void BonePropertiesEditor::_update_properties() {
  234. if (!skeleton) {
  235. return;
  236. }
  237. int selected = Skeleton3DEditor::get_singleton()->get_selected_bone();
  238. List<PropertyInfo> props;
  239. HashSet<StringName> meta_seen;
  240. skeleton->get_property_list(&props);
  241. for (const PropertyInfo &E : props) {
  242. PackedStringArray split = E.name.split("/");
  243. if (split.size() >= 3 && split[0] == "bones") {
  244. if (split[1].to_int() == selected) {
  245. if (split[2] == "enabled") {
  246. enabled_checkbox->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
  247. enabled_checkbox->update_property();
  248. enabled_checkbox->update_editor_property_status();
  249. enabled_checkbox->queue_redraw();
  250. }
  251. if (split[2] == "position") {
  252. position_property->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
  253. position_property->update_property();
  254. position_property->update_editor_property_status();
  255. position_property->queue_redraw();
  256. }
  257. if (split[2] == "rotation") {
  258. rotation_property->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
  259. rotation_property->update_property();
  260. rotation_property->update_editor_property_status();
  261. rotation_property->queue_redraw();
  262. }
  263. if (split[2] == "scale") {
  264. scale_property->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
  265. scale_property->update_property();
  266. scale_property->update_editor_property_status();
  267. scale_property->queue_redraw();
  268. }
  269. if (split[2] == "rest") {
  270. rest_matrix->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
  271. rest_matrix->update_property();
  272. rest_matrix->update_editor_property_status();
  273. rest_matrix->queue_redraw();
  274. }
  275. if (split[2] == "bone_meta") {
  276. meta_seen.insert(E.name);
  277. if (!meta_editors.find(E.name)) {
  278. EditorProperty *editor = EditorInspectorDefaultPlugin::get_editor_for_property(skeleton, E.type, E.name, PROPERTY_HINT_NONE, "", E.usage);
  279. editor->set_label(split[3]);
  280. editor->set_object_and_property(skeleton, E.name);
  281. editor->set_deletable(true);
  282. editor->set_selectable(false);
  283. editor->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_meta_changed));
  284. editor->connect("property_deleted", callable_mp(this, &BonePropertiesEditor::_meta_deleted));
  285. meta_section->get_vbox()->add_child(editor);
  286. editor->update_property();
  287. editor->update_editor_property_status();
  288. editor->queue_redraw();
  289. meta_editors[E.name] = editor;
  290. }
  291. }
  292. }
  293. }
  294. }
  295. // UI for any bone metadata prop not seen during the iteration has to be deleted
  296. for (KeyValue<StringName, EditorProperty *> iter : meta_editors) {
  297. if (!meta_seen.has(iter.key)) {
  298. callable_mp((Node *)meta_section->get_vbox(), &Node::remove_child).call_deferred(iter.value);
  299. meta_editors.remove(meta_editors.find(iter.key));
  300. }
  301. }
  302. }
  303. Skeleton3DEditor *Skeleton3DEditor::singleton = nullptr;
  304. void Skeleton3DEditor::set_keyable(const bool p_keyable) {
  305. keyable = p_keyable;
  306. if (p_keyable) {
  307. animation_hb->show();
  308. } else {
  309. animation_hb->hide();
  310. }
  311. }
  312. void Skeleton3DEditor::set_bone_options_enabled(const bool p_bone_options_enabled) {
  313. skeleton_options->get_popup()->set_item_disabled(SKELETON_OPTION_RESET_SELECTED_POSES, !p_bone_options_enabled);
  314. skeleton_options->get_popup()->set_item_disabled(SKELETON_OPTION_SELECTED_POSES_TO_RESTS, !p_bone_options_enabled);
  315. }
  316. void Skeleton3DEditor::_bind_methods() {
  317. ClassDB::bind_method(D_METHOD("update_all"), &Skeleton3DEditor::update_all);
  318. ClassDB::bind_method(D_METHOD("update_joint_tree"), &Skeleton3DEditor::update_joint_tree);
  319. }
  320. void Skeleton3DEditor::_on_click_skeleton_option(int p_skeleton_option) {
  321. if (!skeleton) {
  322. return;
  323. }
  324. switch (p_skeleton_option) {
  325. case SKELETON_OPTION_RESET_ALL_POSES: {
  326. reset_pose(true);
  327. break;
  328. }
  329. case SKELETON_OPTION_RESET_SELECTED_POSES: {
  330. reset_pose(false);
  331. break;
  332. }
  333. case SKELETON_OPTION_ALL_POSES_TO_RESTS: {
  334. pose_to_rest(true);
  335. break;
  336. }
  337. case SKELETON_OPTION_SELECTED_POSES_TO_RESTS: {
  338. pose_to_rest(false);
  339. break;
  340. }
  341. case SKELETON_OPTION_CREATE_PHYSICAL_SKELETON: {
  342. create_physical_skeleton();
  343. break;
  344. }
  345. case SKELETON_OPTION_EXPORT_SKELETON_PROFILE: {
  346. export_skeleton_profile();
  347. break;
  348. }
  349. }
  350. }
  351. void Skeleton3DEditor::reset_pose(const bool p_all_bones) {
  352. if (!skeleton) {
  353. return;
  354. }
  355. const int bone_count = skeleton->get_bone_count();
  356. if (!bone_count) {
  357. return;
  358. }
  359. EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
  360. ur->create_action(TTR("Set Bone Transform"), UndoRedo::MERGE_ENDS);
  361. if (p_all_bones) {
  362. for (int i = 0; i < bone_count; i++) {
  363. ur->add_undo_method(skeleton, "set_bone_pose_position", i, skeleton->get_bone_pose_position(i));
  364. ur->add_undo_method(skeleton, "set_bone_pose_rotation", i, skeleton->get_bone_pose_rotation(i));
  365. ur->add_undo_method(skeleton, "set_bone_pose_scale", i, skeleton->get_bone_pose_scale(i));
  366. }
  367. ur->add_do_method(skeleton, "reset_bone_poses");
  368. } else {
  369. // Todo: Do method with multiple bone selection.
  370. if (selected_bone == -1) {
  371. ur->commit_action();
  372. return;
  373. }
  374. ur->add_undo_method(skeleton, "set_bone_pose_position", selected_bone, skeleton->get_bone_pose_position(selected_bone));
  375. ur->add_undo_method(skeleton, "set_bone_pose_rotation", selected_bone, skeleton->get_bone_pose_rotation(selected_bone));
  376. ur->add_undo_method(skeleton, "set_bone_pose_scale", selected_bone, skeleton->get_bone_pose_scale(selected_bone));
  377. ur->add_do_method(skeleton, "reset_bone_pose", selected_bone);
  378. }
  379. ur->add_undo_method(this, "update_joint_tree");
  380. ur->add_do_method(this, "update_joint_tree");
  381. ur->commit_action();
  382. }
  383. void Skeleton3DEditor::insert_keys(const bool p_all_bones) {
  384. if (!skeleton) {
  385. return;
  386. }
  387. bool pos_enabled = key_loc_button->is_pressed();
  388. bool rot_enabled = key_rot_button->is_pressed();
  389. bool scl_enabled = key_scale_button->is_pressed();
  390. int bone_len = skeleton->get_bone_count();
  391. Node *root = EditorNode::get_singleton()->get_tree()->get_root();
  392. String path = root->get_path_to(skeleton);
  393. AnimationTrackEditor *te = AnimationPlayerEditor::get_singleton()->get_track_editor();
  394. te->make_insert_queue();
  395. for (int i = 0; i < bone_len; i++) {
  396. const String name = skeleton->get_bone_name(i);
  397. if (name.is_empty()) {
  398. continue;
  399. }
  400. if (pos_enabled && (p_all_bones || te->has_track(skeleton, name, Animation::TYPE_POSITION_3D))) {
  401. te->insert_transform_key(skeleton, name, Animation::TYPE_POSITION_3D, skeleton->get_bone_pose_position(i) / skeleton->get_motion_scale());
  402. }
  403. if (rot_enabled && (p_all_bones || te->has_track(skeleton, name, Animation::TYPE_ROTATION_3D))) {
  404. te->insert_transform_key(skeleton, name, Animation::TYPE_ROTATION_3D, skeleton->get_bone_pose_rotation(i));
  405. }
  406. if (scl_enabled && (p_all_bones || te->has_track(skeleton, name, Animation::TYPE_SCALE_3D))) {
  407. te->insert_transform_key(skeleton, name, Animation::TYPE_SCALE_3D, skeleton->get_bone_pose_scale(i));
  408. }
  409. }
  410. te->commit_insert_queue();
  411. }
  412. void Skeleton3DEditor::pose_to_rest(const bool p_all_bones) {
  413. if (!skeleton) {
  414. return;
  415. }
  416. const int bone_count = skeleton->get_bone_count();
  417. if (!bone_count) {
  418. return;
  419. }
  420. EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
  421. ur->create_action(TTR("Set Bone Rest"), UndoRedo::MERGE_ENDS);
  422. if (p_all_bones) {
  423. for (int i = 0; i < bone_count; i++) {
  424. ur->add_do_method(skeleton, "set_bone_rest", i, skeleton->get_bone_pose(i));
  425. ur->add_undo_method(skeleton, "set_bone_rest", i, skeleton->get_bone_rest(i));
  426. }
  427. } else {
  428. // Todo: Do method with multiple bone selection.
  429. if (selected_bone == -1) {
  430. ur->commit_action();
  431. return;
  432. }
  433. ur->add_do_method(skeleton, "set_bone_rest", selected_bone, skeleton->get_bone_pose(selected_bone));
  434. ur->add_undo_method(skeleton, "set_bone_rest", selected_bone, skeleton->get_bone_rest(selected_bone));
  435. }
  436. ur->add_undo_method(this, "update_joint_tree");
  437. ur->add_do_method(this, "update_joint_tree");
  438. ur->commit_action();
  439. }
  440. void Skeleton3DEditor::create_physical_skeleton() {
  441. EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
  442. ERR_FAIL_NULL(get_tree());
  443. Node *owner = get_tree()->get_edited_scene_root();
  444. const int bone_count = skeleton->get_bone_count();
  445. if (!bone_count) {
  446. EditorNode::get_singleton()->show_warning(vformat(TTR("Cannot create a physical skeleton for a Skeleton3D node with no bones.")));
  447. return;
  448. }
  449. Vector<BoneInfo> bones_infos;
  450. bones_infos.resize(bone_count);
  451. ur->create_action(TTR("Create physical bones"), UndoRedo::MERGE_ALL);
  452. PhysicalBoneSimulator3D *simulator = memnew(PhysicalBoneSimulator3D);
  453. ur->add_do_method(skeleton, "add_child", simulator);
  454. ur->add_do_method(simulator, "set_owner", owner);
  455. ur->add_do_method(simulator, "set_name", "PhysicalBoneSimulator3D");
  456. for (int bone_id = 0; bone_count > bone_id; ++bone_id) {
  457. const int parent = skeleton->get_bone_parent(bone_id);
  458. if (parent < 0) {
  459. bones_infos.write[bone_id].relative_rest = skeleton->get_bone_rest(bone_id);
  460. } else {
  461. const int parent_parent = skeleton->get_bone_parent(parent);
  462. bones_infos.write[bone_id].relative_rest = bones_infos[parent].relative_rest * skeleton->get_bone_rest(bone_id);
  463. // Create physical bone on parent.
  464. if (!bones_infos[parent].physical_bone) {
  465. PhysicalBone3D *physical_bone = create_physical_bone(parent, bone_id, bones_infos);
  466. if (physical_bone && physical_bone->get_child(0)) {
  467. CollisionShape3D *collision_shape = Object::cast_to<CollisionShape3D>(physical_bone->get_child(0));
  468. if (collision_shape) {
  469. bones_infos.write[parent].physical_bone = physical_bone;
  470. ur->add_do_method(simulator, "add_child", physical_bone);
  471. ur->add_do_method(physical_bone, "set_owner", owner);
  472. ur->add_do_method(collision_shape, "set_owner", owner);
  473. ur->add_do_property(physical_bone, "bone_name", skeleton->get_bone_name(parent));
  474. // Create joint between parent of parent.
  475. if (parent_parent != -1) {
  476. ur->add_do_method(physical_bone, "set_joint_type", PhysicalBone3D::JOINT_TYPE_PIN);
  477. }
  478. ur->add_do_method(Node3DEditor::get_singleton(), SceneStringName(_request_gizmo), physical_bone);
  479. ur->add_do_method(Node3DEditor::get_singleton(), SceneStringName(_request_gizmo), collision_shape);
  480. ur->add_do_reference(physical_bone);
  481. ur->add_undo_method(simulator, "remove_child", physical_bone);
  482. }
  483. }
  484. }
  485. }
  486. }
  487. ur->add_undo_method(skeleton, "remove_child", simulator);
  488. ur->commit_action();
  489. }
  490. PhysicalBone3D *Skeleton3DEditor::create_physical_bone(int bone_id, int bone_child_id, const Vector<BoneInfo> &bones_infos) {
  491. const Transform3D child_rest = skeleton->get_bone_rest(bone_child_id);
  492. const real_t half_height(child_rest.origin.length() * 0.5);
  493. const real_t radius(half_height * 0.2);
  494. CapsuleShape3D *bone_shape_capsule = memnew(CapsuleShape3D);
  495. bone_shape_capsule->set_height(half_height * 2);
  496. bone_shape_capsule->set_radius(radius);
  497. CollisionShape3D *bone_shape = memnew(CollisionShape3D);
  498. bone_shape->set_shape(bone_shape_capsule);
  499. bone_shape->set_name("CollisionShape3D");
  500. Transform3D capsule_transform;
  501. capsule_transform.basis.rows[0] = Vector3(1, 0, 0);
  502. capsule_transform.basis.rows[1] = Vector3(0, 0, 1);
  503. capsule_transform.basis.rows[2] = Vector3(0, -1, 0);
  504. bone_shape->set_transform(capsule_transform);
  505. /// Get an up vector not collinear with child rest origin
  506. Vector3 up = Vector3(0, 1, 0);
  507. if (up.cross(child_rest.origin).is_zero_approx()) {
  508. up = Vector3(0, 0, 1);
  509. }
  510. Transform3D body_transform;
  511. body_transform.basis = Basis::looking_at(child_rest.origin, up);
  512. body_transform.origin = body_transform.basis.xform(Vector3(0, 0, -half_height));
  513. Transform3D joint_transform;
  514. joint_transform.origin = Vector3(0, 0, half_height);
  515. PhysicalBone3D *physical_bone = memnew(PhysicalBone3D);
  516. physical_bone->add_child(bone_shape);
  517. physical_bone->set_name("Physical Bone " + skeleton->get_bone_name(bone_id));
  518. physical_bone->set_body_offset(body_transform);
  519. physical_bone->set_joint_offset(joint_transform);
  520. return physical_bone;
  521. }
  522. void Skeleton3DEditor::export_skeleton_profile() {
  523. if (!skeleton->get_bone_count()) {
  524. EditorNode::get_singleton()->show_warning(vformat(TTR("Cannot export a SkeletonProfile for a Skeleton3D node with no bones.")));
  525. return;
  526. }
  527. file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
  528. file_dialog->set_title(TTR("Export Skeleton Profile As..."));
  529. List<String> exts;
  530. ResourceLoader::get_recognized_extensions_for_type("SkeletonProfile", &exts);
  531. file_dialog->clear_filters();
  532. for (const String &K : exts) {
  533. file_dialog->add_filter("*." + K);
  534. }
  535. file_dialog->popup_file_dialog();
  536. }
  537. void Skeleton3DEditor::_file_selected(const String &p_file) {
  538. // Export SkeletonProfile.
  539. Ref<SkeletonProfile> sp(memnew(SkeletonProfile));
  540. // Build SkeletonProfile.
  541. sp->set_group_size(1);
  542. Vector<Vector2> handle_positions;
  543. Vector2 position_max;
  544. Vector2 position_min;
  545. const int bone_count = skeleton->get_bone_count();
  546. sp->set_bone_size(bone_count);
  547. for (int i = 0; i < bone_count; i++) {
  548. sp->set_bone_name(i, skeleton->get_bone_name(i));
  549. int parent = skeleton->get_bone_parent(i);
  550. if (parent >= 0) {
  551. sp->set_bone_parent(i, skeleton->get_bone_name(parent));
  552. }
  553. sp->set_reference_pose(i, skeleton->get_bone_rest(i));
  554. Transform3D grest = skeleton->get_bone_global_rest(i);
  555. handle_positions.append(Vector2(grest.origin.x, grest.origin.y));
  556. if (i == 0) {
  557. position_max = Vector2(grest.origin.x, grest.origin.y);
  558. position_min = Vector2(grest.origin.x, grest.origin.y);
  559. } else {
  560. position_max = position_max.max(Vector2(grest.origin.x, grest.origin.y));
  561. position_min = position_min.min(Vector2(grest.origin.x, grest.origin.y));
  562. }
  563. }
  564. // Layout handles provisionaly.
  565. Vector2 bound = Vector2(position_max.x - position_min.x, position_max.y - position_min.y);
  566. Vector2 center = Vector2((position_max.x + position_min.x) * 0.5, (position_max.y + position_min.y) * 0.5);
  567. float nrm = MAX(bound.x, bound.y);
  568. if (nrm > 0) {
  569. for (int i = 0; i < bone_count; i++) {
  570. handle_positions.write[i] = (handle_positions[i] - center) / nrm * 0.9;
  571. sp->set_handle_offset(i, Vector2(0.5 + handle_positions[i].x, 0.5 - handle_positions[i].y));
  572. }
  573. }
  574. Error err = ResourceSaver::save(sp, p_file);
  575. if (err != OK) {
  576. EditorNode::get_singleton()->show_warning(vformat(TTR("Error saving file: %s"), p_file));
  577. return;
  578. }
  579. }
  580. Variant Skeleton3DEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  581. TreeItem *selected = joint_tree->get_selected();
  582. if (!selected) {
  583. return Variant();
  584. }
  585. Ref<Texture> icon = selected->get_icon(0);
  586. VBoxContainer *vb = memnew(VBoxContainer);
  587. HBoxContainer *hb = memnew(HBoxContainer);
  588. TextureRect *tf = memnew(TextureRect);
  589. tf->set_texture(icon);
  590. tf->set_stretch_mode(TextureRect::STRETCH_KEEP_CENTERED);
  591. hb->add_child(tf);
  592. Label *label = memnew(Label(selected->get_text(0)));
  593. label->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  594. hb->add_child(label);
  595. vb->add_child(hb);
  596. hb->set_modulate(Color(1, 1, 1, 1));
  597. set_drag_preview(vb);
  598. Dictionary drag_data;
  599. drag_data["type"] = "nodes";
  600. drag_data["node"] = selected;
  601. return drag_data;
  602. }
  603. bool Skeleton3DEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  604. TreeItem *target = joint_tree->get_item_at_position(p_point);
  605. if (!target) {
  606. return false;
  607. }
  608. const String path = target->get_metadata(0);
  609. if (!path.begins_with("bones/")) {
  610. return false;
  611. }
  612. TreeItem *selected = Object::cast_to<TreeItem>(Dictionary(p_data)["node"]);
  613. if (target == selected) {
  614. return false;
  615. }
  616. const String path2 = target->get_metadata(0);
  617. if (!path2.begins_with("bones/")) {
  618. return false;
  619. }
  620. return true;
  621. }
  622. void Skeleton3DEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  623. if (!can_drop_data_fw(p_point, p_data, p_from)) {
  624. return;
  625. }
  626. TreeItem *target = joint_tree->get_item_at_position(p_point);
  627. TreeItem *selected = Object::cast_to<TreeItem>(Dictionary(p_data)["node"]);
  628. const BoneId target_boneidx = String(target->get_metadata(0)).get_slicec('/', 1).to_int();
  629. const BoneId selected_boneidx = String(selected->get_metadata(0)).get_slicec('/', 1).to_int();
  630. move_skeleton_bone(skeleton->get_path(), selected_boneidx, target_boneidx);
  631. }
  632. void Skeleton3DEditor::move_skeleton_bone(NodePath p_skeleton_path, int32_t p_selected_boneidx, int32_t p_target_boneidx) {
  633. Node *node = get_node_or_null(p_skeleton_path);
  634. Skeleton3D *skeleton_node = Object::cast_to<Skeleton3D>(node);
  635. ERR_FAIL_NULL(skeleton_node);
  636. EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
  637. ur->create_action(TTR("Set Bone Parentage"));
  638. // If the target is a child of ourselves, we move only *us* and not our children.
  639. if (skeleton_node->is_bone_parent_of(p_target_boneidx, p_selected_boneidx)) {
  640. const BoneId parent_idx = skeleton_node->get_bone_parent(p_selected_boneidx);
  641. const int bone_count = skeleton_node->get_bone_count();
  642. for (BoneId i = 0; i < bone_count; ++i) {
  643. if (skeleton_node->get_bone_parent(i) == p_selected_boneidx) {
  644. ur->add_undo_method(skeleton_node, "set_bone_parent", i, skeleton_node->get_bone_parent(i));
  645. ur->add_do_method(skeleton_node, "set_bone_parent", i, parent_idx);
  646. skeleton_node->set_bone_parent(i, parent_idx);
  647. }
  648. }
  649. }
  650. ur->add_undo_method(skeleton_node, "set_bone_parent", p_selected_boneidx, skeleton_node->get_bone_parent(p_selected_boneidx));
  651. ur->add_do_method(skeleton_node, "set_bone_parent", p_selected_boneidx, p_target_boneidx);
  652. ur->add_undo_method(this, "update_joint_tree");
  653. ur->add_do_method(this, "update_joint_tree");
  654. skeleton_node->set_bone_parent(p_selected_boneidx, p_target_boneidx);
  655. ur->commit_action();
  656. }
  657. void Skeleton3DEditor::_joint_tree_selection_changed() {
  658. TreeItem *selected = joint_tree->get_selected();
  659. if (selected) {
  660. const String path = selected->get_metadata(0);
  661. if (!path.begins_with("bones/")) {
  662. return;
  663. }
  664. const int b_idx = path.get_slicec('/', 1).to_int();
  665. selected_bone = b_idx;
  666. if (pose_editor) {
  667. const String bone_path = "bones/" + itos(b_idx) + "/";
  668. pose_editor->set_target(bone_path);
  669. pose_editor->set_keyable(keyable);
  670. }
  671. }
  672. if (pose_editor && pose_editor->is_inside_tree()) {
  673. pose_editor->set_visible(selected);
  674. }
  675. set_bone_options_enabled(selected);
  676. _update_properties();
  677. _update_gizmo_visible();
  678. }
  679. // May be not used with single select mode.
  680. void Skeleton3DEditor::_joint_tree_rmb_select(const Vector2 &p_pos, MouseButton p_button) {
  681. }
  682. void Skeleton3DEditor::_joint_tree_button_clicked(Object *p_item, int p_column, int p_id, MouseButton p_button) {
  683. if (!skeleton) {
  684. return;
  685. }
  686. TreeItem *tree_item = Object::cast_to<TreeItem>(p_item);
  687. if (tree_item) {
  688. String tree_item_metadata = tree_item->get_metadata(0);
  689. String bone_enabled_property = tree_item_metadata + "/enabled";
  690. String bone_parent_property = tree_item_metadata + "/parent";
  691. String bone_name_property = tree_item_metadata + "/name";
  692. String bone_position_property = tree_item_metadata + "/position";
  693. String bone_rotation_property = tree_item_metadata + "/rotation";
  694. String bone_scale_property = tree_item_metadata + "/scale";
  695. String bone_rest_property = tree_item_metadata + "/rest";
  696. Variant current_enabled = skeleton->get(bone_enabled_property);
  697. Variant current_parent = skeleton->get(bone_parent_property);
  698. Variant current_name = skeleton->get(bone_name_property);
  699. Variant current_position = skeleton->get(bone_position_property);
  700. Variant current_rotation = skeleton->get(bone_rotation_property);
  701. Variant current_scale = skeleton->get(bone_scale_property);
  702. Variant current_rest = skeleton->get(bone_rest_property);
  703. EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
  704. ur->create_action(TTR("Revert Bone"));
  705. bool can_revert_enabled = EditorPropertyRevert::can_property_revert(skeleton, bone_enabled_property, &current_enabled);
  706. if (can_revert_enabled) {
  707. bool is_valid = false;
  708. Variant new_enabled = EditorPropertyRevert::get_property_revert_value(skeleton, bone_enabled_property, &is_valid);
  709. if (is_valid) {
  710. ur->add_undo_method(skeleton, "set", bone_enabled_property, current_enabled);
  711. ur->add_do_method(skeleton, "set", bone_enabled_property, new_enabled);
  712. }
  713. }
  714. bool can_revert_parent = EditorPropertyRevert::can_property_revert(skeleton, bone_parent_property, &current_parent);
  715. if (can_revert_parent) {
  716. bool is_valid = false;
  717. Variant new_parent = EditorPropertyRevert::get_property_revert_value(skeleton, bone_parent_property, &is_valid);
  718. if (is_valid) {
  719. ur->add_undo_method(skeleton, "set", bone_parent_property, current_parent);
  720. ur->add_do_method(skeleton, "set", bone_parent_property, new_parent);
  721. }
  722. }
  723. bool can_revert_name = EditorPropertyRevert::can_property_revert(skeleton, bone_name_property, &current_name);
  724. if (can_revert_name) {
  725. bool is_valid = false;
  726. Variant new_name = EditorPropertyRevert::get_property_revert_value(skeleton, bone_name_property, &is_valid);
  727. if (is_valid) {
  728. ur->add_undo_method(skeleton, "set", bone_name_property, current_name);
  729. ur->add_do_method(skeleton, "set", bone_name_property, new_name);
  730. }
  731. }
  732. bool can_revert_position = EditorPropertyRevert::can_property_revert(skeleton, bone_position_property, &current_position);
  733. if (can_revert_position) {
  734. bool is_valid = false;
  735. Variant new_position = EditorPropertyRevert::get_property_revert_value(skeleton, bone_position_property, &is_valid);
  736. if (is_valid) {
  737. ur->add_undo_method(skeleton, "set", bone_position_property, current_position);
  738. ur->add_do_method(skeleton, "set", bone_position_property, new_position);
  739. }
  740. }
  741. bool can_revert_rotation = EditorPropertyRevert::can_property_revert(skeleton, bone_rotation_property, &current_rotation);
  742. if (can_revert_rotation) {
  743. bool is_valid = false;
  744. Variant new_rotation = EditorPropertyRevert::get_property_revert_value(skeleton, bone_rotation_property, &is_valid);
  745. if (is_valid) {
  746. ur->add_undo_method(skeleton, "set", bone_rotation_property, current_rotation);
  747. ur->add_do_method(skeleton, "set", bone_rotation_property, new_rotation);
  748. }
  749. }
  750. bool can_revert_scale = EditorPropertyRevert::can_property_revert(skeleton, bone_scale_property, &current_scale);
  751. if (can_revert_scale) {
  752. bool is_valid = false;
  753. Variant new_scale = EditorPropertyRevert::get_property_revert_value(skeleton, bone_scale_property, &is_valid);
  754. if (is_valid) {
  755. ur->add_undo_method(skeleton, "set", bone_scale_property, current_scale);
  756. ur->add_do_method(skeleton, "set", bone_scale_property, new_scale);
  757. }
  758. }
  759. bool can_revert_rest = EditorPropertyRevert::can_property_revert(skeleton, bone_rest_property, &current_rest);
  760. if (can_revert_rest) {
  761. bool is_valid = false;
  762. Variant new_rest = EditorPropertyRevert::get_property_revert_value(skeleton, bone_rest_property, &is_valid);
  763. if (is_valid) {
  764. ur->add_undo_method(skeleton, "set", bone_rest_property, current_rest);
  765. ur->add_do_method(skeleton, "set", bone_rest_property, new_rest);
  766. }
  767. }
  768. ur->add_undo_method(this, "update_all");
  769. ur->add_do_method(this, "update_all");
  770. ur->commit_action();
  771. }
  772. return;
  773. }
  774. void Skeleton3DEditor::_update_properties() {
  775. if (pose_editor) {
  776. pose_editor->_update_properties();
  777. }
  778. Node3DEditor::get_singleton()->update_transform_gizmo();
  779. }
  780. void Skeleton3DEditor::update_joint_tree() {
  781. joint_tree->clear();
  782. if (!skeleton) {
  783. return;
  784. }
  785. TreeItem *root = joint_tree->create_item();
  786. HashMap<int, TreeItem *> items;
  787. items.insert(-1, root);
  788. Ref<Texture> bone_icon = get_editor_theme_icon(SNAME("Bone"));
  789. Vector<int> bones_to_process = skeleton->get_parentless_bones();
  790. while (bones_to_process.size() > 0) {
  791. int current_bone_idx = bones_to_process[0];
  792. bones_to_process.erase(current_bone_idx);
  793. const int parent_idx = skeleton->get_bone_parent(current_bone_idx);
  794. TreeItem *parent_item = items.find(parent_idx)->value;
  795. TreeItem *joint_item = joint_tree->create_item(parent_item);
  796. items.insert(current_bone_idx, joint_item);
  797. joint_item->set_text(0, skeleton->get_bone_name(current_bone_idx));
  798. joint_item->set_icon(0, bone_icon);
  799. joint_item->set_selectable(0, true);
  800. joint_item->set_metadata(0, "bones/" + itos(current_bone_idx));
  801. String bone_enabled_property = "bones/" + itos(current_bone_idx) + "/enabled";
  802. String bone_parent_property = "bones/" + itos(current_bone_idx) + "/parent";
  803. String bone_name_property = "bones/" + itos(current_bone_idx) + "/name";
  804. String bone_position_property = "bones/" + itos(current_bone_idx) + "/position";
  805. String bone_rotation_property = "bones/" + itos(current_bone_idx) + "/rotation";
  806. String bone_scale_property = "bones/" + itos(current_bone_idx) + "/scale";
  807. String bone_rest_property = "bones/" + itos(current_bone_idx) + "/rest";
  808. Variant current_enabled = skeleton->get(bone_enabled_property);
  809. Variant current_parent = skeleton->get(bone_parent_property);
  810. Variant current_name = skeleton->get(bone_name_property);
  811. Variant current_position = skeleton->get(bone_position_property);
  812. Variant current_rotation = skeleton->get(bone_rotation_property);
  813. Variant current_scale = skeleton->get(bone_scale_property);
  814. Variant current_rest = skeleton->get(bone_rest_property);
  815. bool can_revert_enabled = EditorPropertyRevert::can_property_revert(skeleton, bone_enabled_property, &current_enabled);
  816. bool can_revert_parent = EditorPropertyRevert::can_property_revert(skeleton, bone_parent_property, &current_parent);
  817. bool can_revert_name = EditorPropertyRevert::can_property_revert(skeleton, bone_name_property, &current_name);
  818. bool can_revert_position = EditorPropertyRevert::can_property_revert(skeleton, bone_position_property, &current_position);
  819. bool can_revert_rotation = EditorPropertyRevert::can_property_revert(skeleton, bone_rotation_property, &current_rotation);
  820. bool can_revert_scale = EditorPropertyRevert::can_property_revert(skeleton, bone_scale_property, &current_scale);
  821. bool can_revert_rest = EditorPropertyRevert::can_property_revert(skeleton, bone_rest_property, &current_rest);
  822. if (can_revert_enabled || can_revert_parent || can_revert_name || can_revert_position || can_revert_rotation || can_revert_scale || can_revert_rest) {
  823. joint_item->add_button(0, get_editor_theme_icon(SNAME("ReloadSmall")), JOINT_BUTTON_REVERT, false, TTR("Revert"));
  824. }
  825. // Add the bone's children to the list of bones to be processed.
  826. Vector<int> current_bone_child_bones = skeleton->get_bone_children(current_bone_idx);
  827. int child_bone_size = current_bone_child_bones.size();
  828. for (int i = 0; i < child_bone_size; i++) {
  829. bones_to_process.push_back(current_bone_child_bones[i]);
  830. }
  831. if (current_bone_idx == selected_bone) {
  832. joint_item->select(0);
  833. }
  834. }
  835. }
  836. void Skeleton3DEditor::update_all() {
  837. _update_properties();
  838. update_joint_tree();
  839. }
  840. void Skeleton3DEditor::create_editors() {
  841. set_h_size_flags(SIZE_EXPAND_FILL);
  842. set_focus_mode(FOCUS_ALL);
  843. Node3DEditor *ne = Node3DEditor::get_singleton();
  844. AnimationTrackEditor *te = AnimationPlayerEditor::get_singleton()->get_track_editor();
  845. // Create File dialog.
  846. file_dialog = memnew(EditorFileDialog);
  847. file_dialog->connect("file_selected", callable_mp(this, &Skeleton3DEditor::_file_selected));
  848. add_child(file_dialog);
  849. // Create Top Menu Bar.
  850. topmenu_bar = memnew(HBoxContainer);
  851. ne->add_control_to_menu_panel(topmenu_bar);
  852. // Create Skeleton Option in Top Menu Bar.
  853. skeleton_options = memnew(MenuButton);
  854. skeleton_options->set_flat(false);
  855. skeleton_options->set_theme_type_variation("FlatMenuButton");
  856. topmenu_bar->add_child(skeleton_options);
  857. skeleton_options->set_text(TTR("Skeleton3D"));
  858. // Skeleton options.
  859. PopupMenu *p = skeleton_options->get_popup();
  860. p->add_shortcut(ED_SHORTCUT("skeleton_3d_editor/reset_all_poses", TTR("Reset All Bone Poses")), SKELETON_OPTION_RESET_ALL_POSES);
  861. p->add_shortcut(ED_SHORTCUT("skeleton_3d_editor/reset_selected_poses", TTR("Reset Selected Poses")), SKELETON_OPTION_RESET_SELECTED_POSES);
  862. p->add_shortcut(ED_SHORTCUT("skeleton_3d_editor/all_poses_to_rests", TTR("Apply All Poses to Rests")), SKELETON_OPTION_ALL_POSES_TO_RESTS);
  863. p->add_shortcut(ED_SHORTCUT("skeleton_3d_editor/selected_poses_to_rests", TTR("Apply Selected Poses to Rests")), SKELETON_OPTION_SELECTED_POSES_TO_RESTS);
  864. p->add_item(TTR("Create Physical Skeleton"), SKELETON_OPTION_CREATE_PHYSICAL_SKELETON);
  865. p->add_item(TTR("Export Skeleton Profile"), SKELETON_OPTION_EXPORT_SKELETON_PROFILE);
  866. p->connect(SceneStringName(id_pressed), callable_mp(this, &Skeleton3DEditor::_on_click_skeleton_option));
  867. set_bone_options_enabled(false);
  868. Vector<Variant> button_binds;
  869. button_binds.resize(1);
  870. edit_mode_button = memnew(Button);
  871. topmenu_bar->add_child(edit_mode_button);
  872. edit_mode_button->set_theme_type_variation(SceneStringName(FlatButton));
  873. edit_mode_button->set_toggle_mode(true);
  874. edit_mode_button->set_focus_mode(FOCUS_NONE);
  875. edit_mode_button->set_tooltip_text(TTR("Edit Mode\nShow buttons on joints."));
  876. edit_mode_button->connect(SceneStringName(toggled), callable_mp(this, &Skeleton3DEditor::edit_mode_toggled));
  877. edit_mode = false;
  878. if (skeleton) {
  879. skeleton->add_child(handles_mesh_instance);
  880. handles_mesh_instance->set_skeleton_path(NodePath(""));
  881. }
  882. // Keying buttons.
  883. animation_hb = memnew(HBoxContainer);
  884. topmenu_bar->add_child(animation_hb);
  885. animation_hb->add_child(memnew(VSeparator));
  886. animation_hb->hide();
  887. key_loc_button = memnew(Button);
  888. key_loc_button->set_theme_type_variation(SceneStringName(FlatButton));
  889. key_loc_button->set_toggle_mode(true);
  890. key_loc_button->set_pressed(false);
  891. key_loc_button->set_focus_mode(FOCUS_NONE);
  892. key_loc_button->set_tooltip_text(TTR("Translation mask for inserting keys."));
  893. animation_hb->add_child(key_loc_button);
  894. key_rot_button = memnew(Button);
  895. key_rot_button->set_theme_type_variation(SceneStringName(FlatButton));
  896. key_rot_button->set_toggle_mode(true);
  897. key_rot_button->set_pressed(true);
  898. key_rot_button->set_focus_mode(FOCUS_NONE);
  899. key_rot_button->set_tooltip_text(TTR("Rotation mask for inserting keys."));
  900. animation_hb->add_child(key_rot_button);
  901. key_scale_button = memnew(Button);
  902. key_scale_button->set_theme_type_variation(SceneStringName(FlatButton));
  903. key_scale_button->set_toggle_mode(true);
  904. key_scale_button->set_pressed(false);
  905. key_scale_button->set_focus_mode(FOCUS_NONE);
  906. key_scale_button->set_tooltip_text(TTR("Scale mask for inserting keys."));
  907. animation_hb->add_child(key_scale_button);
  908. key_insert_button = memnew(Button);
  909. key_insert_button->set_theme_type_variation(SceneStringName(FlatButton));
  910. key_insert_button->set_focus_mode(FOCUS_NONE);
  911. key_insert_button->connect(SceneStringName(pressed), callable_mp(this, &Skeleton3DEditor::insert_keys).bind(false));
  912. key_insert_button->set_tooltip_text(TTR("Insert key (based on mask) for bones with an existing track."));
  913. key_insert_button->set_shortcut(ED_SHORTCUT("skeleton_3d_editor/insert_key_to_existing_tracks", TTR("Insert Key (Existing Tracks)"), Key::INSERT));
  914. animation_hb->add_child(key_insert_button);
  915. key_insert_all_button = memnew(Button);
  916. key_insert_all_button->set_theme_type_variation(SceneStringName(FlatButton));
  917. key_insert_all_button->set_focus_mode(FOCUS_NONE);
  918. key_insert_all_button->connect(SceneStringName(pressed), callable_mp(this, &Skeleton3DEditor::insert_keys).bind(true));
  919. key_insert_all_button->set_tooltip_text(TTR("Insert key (based on mask) for all bones."));
  920. key_insert_all_button->set_shortcut(ED_SHORTCUT("skeleton_3d_editor/insert_key_of_all_bones", TTR("Insert Key (All Bones)"), KeyModifierMask::CMD_OR_CTRL + Key::INSERT));
  921. animation_hb->add_child(key_insert_all_button);
  922. // Bone tree.
  923. bones_section = memnew(EditorInspectorSection);
  924. bones_section->setup("bones", "Bones", skeleton, Color(0.0f, 0.0, 0.0f), true);
  925. add_child(bones_section);
  926. bones_section->unfold();
  927. ScrollContainer *s_con = memnew(ScrollContainer);
  928. s_con->set_h_size_flags(SIZE_EXPAND_FILL);
  929. s_con->set_custom_minimum_size(Size2(1, 350) * EDSCALE);
  930. bones_section->get_vbox()->add_child(s_con);
  931. joint_tree = memnew(Tree);
  932. joint_tree->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  933. joint_tree->set_columns(1);
  934. joint_tree->set_focus_mode(Control::FOCUS_NONE);
  935. joint_tree->set_select_mode(Tree::SELECT_SINGLE);
  936. joint_tree->set_hide_root(true);
  937. joint_tree->set_v_size_flags(SIZE_EXPAND_FILL);
  938. joint_tree->set_h_size_flags(SIZE_EXPAND_FILL);
  939. joint_tree->set_allow_rmb_select(true);
  940. joint_tree->set_theme_type_variation("TreeSecondary");
  941. SET_DRAG_FORWARDING_GCD(joint_tree, Skeleton3DEditor);
  942. s_con->add_child(joint_tree);
  943. pose_editor = memnew(BonePropertiesEditor(skeleton));
  944. pose_editor->set_label(TTR("Bone Transform"));
  945. pose_editor->set_visible(false);
  946. add_child(pose_editor);
  947. set_keyable(te->has_keying());
  948. }
  949. void Skeleton3DEditor::_notification(int p_what) {
  950. switch (p_what) {
  951. case NOTIFICATION_ENTER_TREE: {
  952. update_joint_tree();
  953. joint_tree->connect(SceneStringName(item_selected), callable_mp(this, &Skeleton3DEditor::_joint_tree_selection_changed));
  954. joint_tree->connect("item_mouse_selected", callable_mp(this, &Skeleton3DEditor::_joint_tree_rmb_select));
  955. joint_tree->connect("button_clicked", callable_mp(this, &Skeleton3DEditor::_joint_tree_button_clicked));
  956. #ifdef TOOLS_ENABLED
  957. skeleton->connect(SceneStringName(pose_updated), callable_mp(this, &Skeleton3DEditor::_draw_gizmo));
  958. skeleton->connect(SceneStringName(pose_updated), callable_mp(this, &Skeleton3DEditor::_update_properties));
  959. skeleton->connect(SceneStringName(bone_enabled_changed), callable_mp(this, &Skeleton3DEditor::_bone_enabled_changed));
  960. skeleton->connect(SceneStringName(show_rest_only_changed), callable_mp(this, &Skeleton3DEditor::_update_gizmo_visible));
  961. #endif
  962. get_tree()->connect("node_removed", callable_mp(this, &Skeleton3DEditor::_node_removed), Object::CONNECT_ONE_SHOT);
  963. } break;
  964. case NOTIFICATION_READY: {
  965. // Will trigger NOTIFICATION_THEME_CHANGED, but won't cause any loops if called here.
  966. add_theme_constant_override("separation", 0);
  967. } break;
  968. case NOTIFICATION_THEME_CHANGED: {
  969. skeleton_options->set_button_icon(get_editor_theme_icon(SNAME("Skeleton3D")));
  970. edit_mode_button->set_button_icon(get_editor_theme_icon(SNAME("ToolBoneSelect")));
  971. key_loc_button->set_button_icon(get_editor_theme_icon(SNAME("KeyPosition")));
  972. key_rot_button->set_button_icon(get_editor_theme_icon(SNAME("KeyRotation")));
  973. key_scale_button->set_button_icon(get_editor_theme_icon(SNAME("KeyScale")));
  974. key_insert_button->set_button_icon(get_editor_theme_icon(SNAME("Key")));
  975. key_insert_all_button->set_button_icon(get_editor_theme_icon(SNAME("NewKey")));
  976. bones_section->set_bg_color(get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor)));
  977. update_joint_tree();
  978. } break;
  979. case NOTIFICATION_PREDELETE: {
  980. if (skeleton) {
  981. select_bone(-1); // Requires that the joint_tree has not been deleted.
  982. #ifdef TOOLS_ENABLED
  983. skeleton->disconnect(SceneStringName(show_rest_only_changed), callable_mp(this, &Skeleton3DEditor::_update_gizmo_visible));
  984. skeleton->disconnect(SceneStringName(bone_enabled_changed), callable_mp(this, &Skeleton3DEditor::_bone_enabled_changed));
  985. skeleton->disconnect(SceneStringName(pose_updated), callable_mp(this, &Skeleton3DEditor::_draw_gizmo));
  986. skeleton->disconnect(SceneStringName(pose_updated), callable_mp(this, &Skeleton3DEditor::_update_properties));
  987. skeleton->set_transform_gizmo_visible(true);
  988. #endif
  989. if (handles_mesh_instance->get_parent()) {
  990. handles_mesh_instance->get_parent()->remove_child(handles_mesh_instance);
  991. }
  992. }
  993. edit_mode_toggled(false);
  994. } break;
  995. }
  996. }
  997. void Skeleton3DEditor::_node_removed(Node *p_node) {
  998. if (skeleton && p_node == skeleton) {
  999. skeleton = nullptr;
  1000. skeleton_options->hide();
  1001. }
  1002. _update_properties();
  1003. }
  1004. void Skeleton3DEditor::edit_mode_toggled(const bool pressed) {
  1005. edit_mode = pressed;
  1006. _update_gizmo_visible();
  1007. }
  1008. Skeleton3DEditor::Skeleton3DEditor(EditorInspectorPluginSkeleton *e_plugin, Skeleton3D *p_skeleton) :
  1009. editor_plugin(e_plugin),
  1010. skeleton(p_skeleton) {
  1011. singleton = this;
  1012. // Handle.
  1013. handle_material.instantiate();
  1014. handle_shader.instantiate();
  1015. handle_shader->set_code(R"(
  1016. // Skeleton 3D gizmo handle shader.
  1017. shader_type spatial;
  1018. render_mode unshaded, shadows_disabled, depth_draw_always, fog_disabled;
  1019. uniform sampler2D texture_albedo : source_color;
  1020. uniform float point_size : hint_range(0, 128) = 32;
  1021. void vertex() {
  1022. if (!OUTPUT_IS_SRGB) {
  1023. COLOR.rgb = mix(pow((COLOR.rgb + vec3(0.055)) * (1.0 / (1.0 + 0.055)), vec3(2.4)), COLOR.rgb * (1.0 / 12.92), lessThan(COLOR.rgb, vec3(0.04045)));
  1024. }
  1025. VERTEX = VERTEX;
  1026. POSITION = PROJECTION_MATRIX * VIEW_MATRIX * MODEL_MATRIX * vec4(VERTEX.xyz, 1.0);
  1027. POSITION.z = mix(POSITION.z, POSITION.w, 0.999);
  1028. POINT_SIZE = point_size;
  1029. }
  1030. void fragment() {
  1031. vec4 albedo_tex = texture(texture_albedo, POINT_COORD);
  1032. vec3 col = albedo_tex.rgb + COLOR.rgb;
  1033. col = vec3(min(col.r, 1.0), min(col.g, 1.0), min(col.b, 1.0));
  1034. ALBEDO = col;
  1035. if (albedo_tex.a < 0.5) {
  1036. discard;
  1037. }
  1038. ALPHA = albedo_tex.a;
  1039. }
  1040. )");
  1041. handle_material->set_shader(handle_shader);
  1042. Ref<Texture2D> handle = EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("EditorBoneHandle"), EditorStringName(EditorIcons));
  1043. handle_material->set_shader_parameter("point_size", handle->get_width());
  1044. handle_material->set_shader_parameter("texture_albedo", handle);
  1045. handles_mesh_instance = memnew(MeshInstance3D);
  1046. handles_mesh_instance->set_cast_shadows_setting(GeometryInstance3D::SHADOW_CASTING_SETTING_OFF);
  1047. handles_mesh.instantiate();
  1048. handles_mesh_instance->set_mesh(handles_mesh);
  1049. create_editors();
  1050. }
  1051. void Skeleton3DEditor::update_bone_original() {
  1052. if (!skeleton) {
  1053. return;
  1054. }
  1055. if (skeleton->get_bone_count() == 0 || selected_bone == -1) {
  1056. return;
  1057. }
  1058. bone_original_position = skeleton->get_bone_pose_position(selected_bone);
  1059. bone_original_rotation = skeleton->get_bone_pose_rotation(selected_bone);
  1060. bone_original_scale = skeleton->get_bone_pose_scale(selected_bone);
  1061. }
  1062. void Skeleton3DEditor::_hide_handles() {
  1063. handles_mesh_instance->hide();
  1064. }
  1065. void Skeleton3DEditor::_draw_gizmo() {
  1066. if (!skeleton) {
  1067. return;
  1068. }
  1069. // If you call get_bone_global_pose() while drawing the surface, such as toggle rest mode,
  1070. // the skeleton update will be done first and
  1071. // the drawing surface will be interrupted once and an error will occur.
  1072. skeleton->force_update_all_dirty_bones();
  1073. // Handles.
  1074. if (edit_mode) {
  1075. _draw_handles();
  1076. } else {
  1077. _hide_handles();
  1078. }
  1079. }
  1080. void Skeleton3DEditor::_draw_handles() {
  1081. const int bone_count = skeleton->get_bone_count();
  1082. handles_mesh->clear_surfaces();
  1083. if (bone_count) {
  1084. handles_mesh_instance->show();
  1085. handles_mesh->surface_begin(Mesh::PRIMITIVE_POINTS);
  1086. for (int i = 0; i < bone_count; i++) {
  1087. Color c;
  1088. if (i == selected_bone) {
  1089. c = Color(1, 1, 0);
  1090. } else {
  1091. c = Color(0.1, 0.25, 0.8);
  1092. }
  1093. Vector3 point = skeleton->get_bone_global_pose(i).origin;
  1094. handles_mesh->surface_set_color(c);
  1095. handles_mesh->surface_add_vertex(point);
  1096. }
  1097. handles_mesh->surface_end();
  1098. handles_mesh->surface_set_material(0, handle_material);
  1099. } else {
  1100. handles_mesh_instance->hide();
  1101. }
  1102. }
  1103. TreeItem *Skeleton3DEditor::_find(TreeItem *p_node, const NodePath &p_path) {
  1104. if (!p_node) {
  1105. return nullptr;
  1106. }
  1107. NodePath np = p_node->get_metadata(0);
  1108. if (np == p_path) {
  1109. return p_node;
  1110. }
  1111. TreeItem *children = p_node->get_first_child();
  1112. while (children) {
  1113. TreeItem *n = _find(children, p_path);
  1114. if (n) {
  1115. return n;
  1116. }
  1117. children = children->get_next();
  1118. }
  1119. return nullptr;
  1120. }
  1121. void Skeleton3DEditor::_subgizmo_selection_change() {
  1122. if (!skeleton) {
  1123. return;
  1124. }
  1125. // Once validated by subgizmos_intersect_ray, but required if through inspector's bones tree.
  1126. if (!edit_mode) {
  1127. skeleton->clear_subgizmo_selection();
  1128. return;
  1129. }
  1130. int selected = -1;
  1131. Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
  1132. if (se) {
  1133. selected = se->get_selected_bone();
  1134. }
  1135. if (selected >= 0) {
  1136. Vector<Ref<Node3DGizmo>> gizmos = skeleton->get_gizmos();
  1137. for (int i = 0; i < gizmos.size(); i++) {
  1138. Ref<EditorNode3DGizmo> gizmo = gizmos[i];
  1139. if (!gizmo.is_valid()) {
  1140. continue;
  1141. }
  1142. Ref<Skeleton3DGizmoPlugin> plugin = gizmo->get_plugin();
  1143. if (!plugin.is_valid()) {
  1144. continue;
  1145. }
  1146. skeleton->set_subgizmo_selection(gizmo, selected, skeleton->get_bone_global_pose(selected));
  1147. break;
  1148. }
  1149. } else {
  1150. skeleton->clear_subgizmo_selection();
  1151. }
  1152. }
  1153. void Skeleton3DEditor::select_bone(int p_idx) {
  1154. if (p_idx >= 0) {
  1155. TreeItem *ti = _find(joint_tree->get_root(), "bones/" + itos(p_idx));
  1156. if (ti) {
  1157. // Make visible when it's collapsed.
  1158. TreeItem *node = ti->get_parent();
  1159. while (node && node != joint_tree->get_root()) {
  1160. node->set_collapsed(false);
  1161. node = node->get_parent();
  1162. }
  1163. ti->select(0);
  1164. joint_tree->scroll_to_item(ti);
  1165. }
  1166. } else {
  1167. selected_bone = -1;
  1168. joint_tree->deselect_all();
  1169. _joint_tree_selection_changed();
  1170. }
  1171. }
  1172. Skeleton3DEditor::~Skeleton3DEditor() {
  1173. singleton = nullptr;
  1174. handles_mesh_instance->queue_free();
  1175. Node3DEditor *ne = Node3DEditor::get_singleton();
  1176. ne->remove_control_from_menu_panel(topmenu_bar);
  1177. memdelete(topmenu_bar);
  1178. }
  1179. bool EditorInspectorPluginSkeleton::can_handle(Object *p_object) {
  1180. return Object::cast_to<Skeleton3D>(p_object) != nullptr;
  1181. }
  1182. void EditorInspectorPluginSkeleton::parse_begin(Object *p_object) {
  1183. Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_object);
  1184. ERR_FAIL_NULL(skeleton);
  1185. skel_editor = memnew(Skeleton3DEditor(this, skeleton));
  1186. add_custom_control(skel_editor);
  1187. }
  1188. Skeleton3DEditorPlugin::Skeleton3DEditorPlugin() {
  1189. skeleton_plugin = memnew(EditorInspectorPluginSkeleton);
  1190. EditorInspector::add_inspector_plugin(skeleton_plugin);
  1191. Ref<Skeleton3DGizmoPlugin> gizmo_plugin = Ref<Skeleton3DGizmoPlugin>(memnew(Skeleton3DGizmoPlugin));
  1192. Node3DEditor::get_singleton()->add_gizmo_plugin(gizmo_plugin);
  1193. }
  1194. EditorPlugin::AfterGUIInput Skeleton3DEditorPlugin::forward_3d_gui_input(Camera3D *p_camera, const Ref<InputEvent> &p_event) {
  1195. Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
  1196. Node3DEditor *ne = Node3DEditor::get_singleton();
  1197. if (se && se->is_edit_mode()) {
  1198. const Ref<InputEventMouseButton> mb = p_event;
  1199. if (mb.is_valid() && mb->get_button_index() == MouseButton::LEFT) {
  1200. if (ne->get_tool_mode() != Node3DEditor::TOOL_MODE_SELECT) {
  1201. if (!ne->is_gizmo_visible()) {
  1202. return EditorPlugin::AFTER_GUI_INPUT_STOP;
  1203. }
  1204. }
  1205. if (mb->is_pressed()) {
  1206. se->update_bone_original();
  1207. }
  1208. }
  1209. return EditorPlugin::AFTER_GUI_INPUT_CUSTOM;
  1210. }
  1211. return EditorPlugin::AFTER_GUI_INPUT_PASS;
  1212. }
  1213. bool Skeleton3DEditorPlugin::handles(Object *p_object) const {
  1214. return p_object->is_class("Skeleton3D");
  1215. }
  1216. void Skeleton3DEditor::_bone_enabled_changed(const int p_bone_id) {
  1217. _update_gizmo_visible();
  1218. }
  1219. void Skeleton3DEditor::_update_gizmo_visible() {
  1220. _subgizmo_selection_change();
  1221. if (edit_mode) {
  1222. if (selected_bone == -1) {
  1223. #ifdef TOOLS_ENABLED
  1224. skeleton->set_transform_gizmo_visible(false);
  1225. #endif
  1226. } else {
  1227. #ifdef TOOLS_ENABLED
  1228. if (skeleton->is_bone_enabled(selected_bone) && !skeleton->is_show_rest_only()) {
  1229. skeleton->set_transform_gizmo_visible(true);
  1230. } else {
  1231. skeleton->set_transform_gizmo_visible(false);
  1232. }
  1233. #endif
  1234. }
  1235. } else {
  1236. #ifdef TOOLS_ENABLED
  1237. skeleton->set_transform_gizmo_visible(true);
  1238. #endif
  1239. }
  1240. _draw_gizmo();
  1241. }
  1242. int Skeleton3DEditor::get_selected_bone() const {
  1243. return selected_bone;
  1244. }
  1245. Skeleton3DGizmoPlugin::SelectionMaterials Skeleton3DGizmoPlugin::selection_materials;
  1246. Skeleton3DGizmoPlugin::Skeleton3DGizmoPlugin() {
  1247. selection_materials.unselected_mat.instantiate();
  1248. selection_materials.unselected_mat->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED);
  1249. selection_materials.unselected_mat->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA);
  1250. selection_materials.unselected_mat->set_flag(StandardMaterial3D::FLAG_ALBEDO_FROM_VERTEX_COLOR, true);
  1251. selection_materials.unselected_mat->set_flag(StandardMaterial3D::FLAG_SRGB_VERTEX_COLOR, true);
  1252. selection_materials.unselected_mat->set_flag(StandardMaterial3D::FLAG_DISABLE_FOG, true);
  1253. selection_materials.selected_mat.instantiate();
  1254. Ref<Shader> selected_sh = Ref<Shader>(memnew(Shader));
  1255. selected_sh->set_code(R"(
  1256. // Skeleton 3D gizmo bones shader.
  1257. shader_type spatial;
  1258. render_mode unshaded, shadows_disabled;
  1259. void vertex() {
  1260. if (!OUTPUT_IS_SRGB) {
  1261. COLOR.rgb = mix( pow((COLOR.rgb + vec3(0.055)) * (1.0 / (1.0 + 0.055)), vec3(2.4)), COLOR.rgb* (1.0 / 12.92), lessThan(COLOR.rgb,vec3(0.04045)) );
  1262. }
  1263. VERTEX = VERTEX;
  1264. POSITION = PROJECTION_MATRIX * VIEW_MATRIX * MODEL_MATRIX * vec4(VERTEX.xyz, 1.0);
  1265. POSITION.z = mix(POSITION.z, POSITION.w, 0.998);
  1266. }
  1267. void fragment() {
  1268. ALBEDO = COLOR.rgb;
  1269. ALPHA = COLOR.a;
  1270. }
  1271. )");
  1272. selection_materials.selected_mat->set_shader(selected_sh);
  1273. }
  1274. Skeleton3DGizmoPlugin::~Skeleton3DGizmoPlugin() {
  1275. selection_materials.unselected_mat.unref();
  1276. selection_materials.selected_mat.unref();
  1277. }
  1278. bool Skeleton3DGizmoPlugin::has_gizmo(Node3D *p_spatial) {
  1279. return Object::cast_to<Skeleton3D>(p_spatial) != nullptr;
  1280. }
  1281. String Skeleton3DGizmoPlugin::get_gizmo_name() const {
  1282. return "Skeleton3D";
  1283. }
  1284. int Skeleton3DGizmoPlugin::get_priority() const {
  1285. return -1;
  1286. }
  1287. int Skeleton3DGizmoPlugin::subgizmos_intersect_ray(const EditorNode3DGizmo *p_gizmo, Camera3D *p_camera, const Vector2 &p_point) const {
  1288. Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
  1289. ERR_FAIL_NULL_V(skeleton, -1);
  1290. Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
  1291. if (!se || !se->is_edit_mode()) {
  1292. return -1;
  1293. }
  1294. if (Node3DEditor::get_singleton()->get_tool_mode() != Node3DEditor::TOOL_MODE_SELECT) {
  1295. return -1;
  1296. }
  1297. // Select bone.
  1298. real_t grab_threshold = 4 * EDSCALE;
  1299. Vector3 ray_from = p_camera->get_global_transform().origin;
  1300. Transform3D gt = skeleton->get_global_transform();
  1301. int closest_idx = -1;
  1302. real_t closest_dist = 1e10;
  1303. const int bone_count = skeleton->get_bone_count();
  1304. for (int i = 0; i < bone_count; i++) {
  1305. Vector3 joint_pos_3d = gt.xform(skeleton->get_bone_global_pose(i).origin);
  1306. Vector2 joint_pos_2d = p_camera->unproject_position(joint_pos_3d);
  1307. real_t dist_3d = ray_from.distance_to(joint_pos_3d);
  1308. real_t dist_2d = p_point.distance_to(joint_pos_2d);
  1309. if (dist_2d < grab_threshold && dist_3d < closest_dist) {
  1310. closest_dist = dist_3d;
  1311. closest_idx = i;
  1312. }
  1313. }
  1314. if (closest_idx >= 0) {
  1315. se->select_bone(closest_idx);
  1316. return closest_idx;
  1317. }
  1318. se->select_bone(-1);
  1319. return -1;
  1320. }
  1321. Transform3D Skeleton3DGizmoPlugin::get_subgizmo_transform(const EditorNode3DGizmo *p_gizmo, int p_id) const {
  1322. Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
  1323. ERR_FAIL_NULL_V(skeleton, Transform3D());
  1324. return skeleton->get_bone_global_pose(p_id);
  1325. }
  1326. void Skeleton3DGizmoPlugin::set_subgizmo_transform(const EditorNode3DGizmo *p_gizmo, int p_id, Transform3D p_transform) {
  1327. Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
  1328. ERR_FAIL_NULL(skeleton);
  1329. // Prepare for global to local.
  1330. Transform3D original_to_local;
  1331. int parent_idx = skeleton->get_bone_parent(p_id);
  1332. if (parent_idx >= 0) {
  1333. original_to_local = skeleton->get_bone_global_pose(parent_idx);
  1334. }
  1335. Basis to_local = original_to_local.get_basis().inverse();
  1336. // Prepare transform.
  1337. Transform3D t;
  1338. // Basis.
  1339. t.basis = to_local * p_transform.get_basis();
  1340. // Origin.
  1341. Vector3 orig = skeleton->get_bone_pose(p_id).origin;
  1342. Vector3 sub = p_transform.origin - skeleton->get_bone_global_pose(p_id).origin;
  1343. t.origin = orig + to_local.xform(sub);
  1344. // Apply transform.
  1345. skeleton->set_bone_pose_position(p_id, t.origin);
  1346. skeleton->set_bone_pose_rotation(p_id, t.basis.get_rotation_quaternion());
  1347. skeleton->set_bone_pose_scale(p_id, t.basis.get_scale());
  1348. }
  1349. void Skeleton3DGizmoPlugin::commit_subgizmos(const EditorNode3DGizmo *p_gizmo, const Vector<int> &p_ids, const Vector<Transform3D> &p_restore, bool p_cancel) {
  1350. Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
  1351. ERR_FAIL_NULL(skeleton);
  1352. Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
  1353. Node3DEditor *ne = Node3DEditor::get_singleton();
  1354. EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
  1355. ur->create_action(TTR("Set Bone Transform"));
  1356. if (ne->get_tool_mode() == Node3DEditor::TOOL_MODE_SELECT || ne->get_tool_mode() == Node3DEditor::TOOL_MODE_MOVE) {
  1357. for (int i = 0; i < p_ids.size(); i++) {
  1358. ur->add_do_method(skeleton, "set_bone_pose_position", p_ids[i], skeleton->get_bone_pose_position(p_ids[i]));
  1359. ur->add_undo_method(skeleton, "set_bone_pose_position", p_ids[i], se->get_bone_original_position());
  1360. }
  1361. }
  1362. if (ne->get_tool_mode() == Node3DEditor::TOOL_MODE_SELECT || ne->get_tool_mode() == Node3DEditor::TOOL_MODE_ROTATE) {
  1363. for (int i = 0; i < p_ids.size(); i++) {
  1364. ur->add_do_method(skeleton, "set_bone_pose_rotation", p_ids[i], skeleton->get_bone_pose_rotation(p_ids[i]));
  1365. ur->add_undo_method(skeleton, "set_bone_pose_rotation", p_ids[i], se->get_bone_original_rotation());
  1366. }
  1367. }
  1368. if (ne->get_tool_mode() == Node3DEditor::TOOL_MODE_SCALE) {
  1369. for (int i = 0; i < p_ids.size(); i++) {
  1370. // If the axis is swapped by scaling, the rotation can be changed.
  1371. ur->add_do_method(skeleton, "set_bone_pose_rotation", p_ids[i], skeleton->get_bone_pose_rotation(p_ids[i]));
  1372. ur->add_undo_method(skeleton, "set_bone_pose_rotation", p_ids[i], se->get_bone_original_rotation());
  1373. ur->add_do_method(skeleton, "set_bone_pose_scale", p_ids[i], skeleton->get_bone_pose_scale(p_ids[i]));
  1374. ur->add_undo_method(skeleton, "set_bone_pose_scale", p_ids[i], se->get_bone_original_scale());
  1375. }
  1376. }
  1377. ur->add_do_method(se, "update_joint_tree");
  1378. ur->add_undo_method(se, "update_joint_tree");
  1379. ur->commit_action();
  1380. }
  1381. void Skeleton3DGizmoPlugin::redraw(EditorNode3DGizmo *p_gizmo) {
  1382. Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
  1383. p_gizmo->clear();
  1384. if (!skeleton->get_bone_count()) {
  1385. return;
  1386. }
  1387. int selected = -1;
  1388. Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
  1389. if (se) {
  1390. selected = se->get_selected_bone();
  1391. }
  1392. Ref<ArrayMesh> m = get_bones_mesh(skeleton, selected, p_gizmo->is_selected());
  1393. p_gizmo->add_mesh(m, Ref<Material>(), Transform3D(), skeleton->register_skin(skeleton->create_skin_from_rest_transforms()));
  1394. }
  1395. Ref<ArrayMesh> Skeleton3DGizmoPlugin::get_bones_mesh(Skeleton3D *p_skeleton, int p_selected, bool p_is_selected) {
  1396. Color bone_color = EDITOR_GET("editors/3d_gizmos/gizmo_colors/skeleton");
  1397. Color selected_bone_color = EDITOR_GET("editors/3d_gizmos/gizmo_colors/selected_bone");
  1398. real_t bone_axis_length = EDITOR_GET("editors/3d_gizmos/gizmo_settings/bone_axis_length");
  1399. int bone_shape = EDITOR_GET("editors/3d_gizmos/gizmo_settings/bone_shape");
  1400. LocalVector<Color> axis_colors;
  1401. axis_colors.push_back(Node3DEditor::get_singleton()->get_theme_color(SNAME("axis_x_color"), EditorStringName(Editor)));
  1402. axis_colors.push_back(Node3DEditor::get_singleton()->get_theme_color(SNAME("axis_y_color"), EditorStringName(Editor)));
  1403. axis_colors.push_back(Node3DEditor::get_singleton()->get_theme_color(SNAME("axis_z_color"), EditorStringName(Editor)));
  1404. Ref<SurfaceTool> surface_tool(memnew(SurfaceTool));
  1405. surface_tool->begin(Mesh::PRIMITIVE_LINES);
  1406. if (p_is_selected) {
  1407. surface_tool->set_material(selection_materials.selected_mat);
  1408. } else {
  1409. selection_materials.unselected_mat->set_albedo(bone_color);
  1410. surface_tool->set_material(selection_materials.unselected_mat);
  1411. }
  1412. LocalVector<int> bones;
  1413. LocalVector<float> weights;
  1414. bones.resize(4);
  1415. weights.resize(4);
  1416. for (int i = 0; i < 4; i++) {
  1417. bones[i] = 0;
  1418. weights[i] = 0;
  1419. }
  1420. weights[0] = 1;
  1421. int current_bone_index = 0;
  1422. Vector<int> bones_to_process = p_skeleton->get_parentless_bones();
  1423. while (bones_to_process.size() > current_bone_index) {
  1424. int current_bone_idx = bones_to_process[current_bone_index];
  1425. current_bone_index++;
  1426. Color current_bone_color = (current_bone_idx == p_selected) ? selected_bone_color : bone_color;
  1427. Vector<int> child_bones_vector;
  1428. child_bones_vector = p_skeleton->get_bone_children(current_bone_idx);
  1429. int child_bones_size = child_bones_vector.size();
  1430. for (int i = 0; i < child_bones_size; i++) {
  1431. // Something wrong.
  1432. if (child_bones_vector[i] < 0) {
  1433. continue;
  1434. }
  1435. int child_bone_idx = child_bones_vector[i];
  1436. Vector3 v0 = p_skeleton->get_bone_global_rest(current_bone_idx).origin;
  1437. Vector3 v1 = p_skeleton->get_bone_global_rest(child_bone_idx).origin;
  1438. Vector3 d = (v1 - v0).normalized();
  1439. real_t dist = v0.distance_to(v1);
  1440. // Find closest axis.
  1441. int closest = -1;
  1442. real_t closest_d = 0.0;
  1443. for (int j = 0; j < 3; j++) {
  1444. real_t dp = Math::abs(p_skeleton->get_bone_global_rest(current_bone_idx).basis[j].normalized().dot(d));
  1445. if (j == 0 || dp > closest_d) {
  1446. closest = j;
  1447. }
  1448. }
  1449. // Draw bone.
  1450. switch (bone_shape) {
  1451. case 0: { // Wire shape.
  1452. surface_tool->set_color(current_bone_color);
  1453. bones[0] = current_bone_idx;
  1454. surface_tool->set_bones(bones);
  1455. surface_tool->set_weights(weights);
  1456. surface_tool->add_vertex(v0);
  1457. bones[0] = child_bone_idx;
  1458. surface_tool->set_bones(bones);
  1459. surface_tool->set_weights(weights);
  1460. surface_tool->add_vertex(v1);
  1461. } break;
  1462. case 1: { // Octahedron shape.
  1463. Vector3 first;
  1464. Vector3 points[6];
  1465. int point_idx = 0;
  1466. for (int j = 0; j < 3; j++) {
  1467. Vector3 axis;
  1468. if (first == Vector3()) {
  1469. axis = d.cross(d.cross(p_skeleton->get_bone_global_rest(current_bone_idx).basis[j])).normalized();
  1470. first = axis;
  1471. } else {
  1472. axis = d.cross(first).normalized();
  1473. }
  1474. surface_tool->set_color(current_bone_color);
  1475. for (int k = 0; k < 2; k++) {
  1476. if (k == 1) {
  1477. axis = -axis;
  1478. }
  1479. Vector3 point = v0 + d * dist * 0.2;
  1480. point += axis * dist * 0.1;
  1481. bones[0] = current_bone_idx;
  1482. surface_tool->set_bones(bones);
  1483. surface_tool->set_weights(weights);
  1484. surface_tool->add_vertex(v0);
  1485. surface_tool->set_bones(bones);
  1486. surface_tool->set_weights(weights);
  1487. surface_tool->add_vertex(point);
  1488. surface_tool->set_bones(bones);
  1489. surface_tool->set_weights(weights);
  1490. surface_tool->add_vertex(point);
  1491. bones[0] = child_bone_idx;
  1492. surface_tool->set_bones(bones);
  1493. surface_tool->set_weights(weights);
  1494. surface_tool->add_vertex(v1);
  1495. points[point_idx++] = point;
  1496. }
  1497. }
  1498. surface_tool->set_color(current_bone_color);
  1499. SWAP(points[1], points[2]);
  1500. bones[0] = current_bone_idx;
  1501. for (int j = 0; j < 6; j++) {
  1502. surface_tool->set_bones(bones);
  1503. surface_tool->set_weights(weights);
  1504. surface_tool->add_vertex(points[j]);
  1505. surface_tool->set_bones(bones);
  1506. surface_tool->set_weights(weights);
  1507. surface_tool->add_vertex(points[(j + 1) % 6]);
  1508. }
  1509. } break;
  1510. }
  1511. // Axis as root of the bone.
  1512. for (int j = 0; j < 3; j++) {
  1513. bones[0] = current_bone_idx;
  1514. surface_tool->set_color(axis_colors[j]);
  1515. surface_tool->set_bones(bones);
  1516. surface_tool->set_weights(weights);
  1517. surface_tool->add_vertex(v0);
  1518. surface_tool->set_bones(bones);
  1519. surface_tool->set_weights(weights);
  1520. surface_tool->add_vertex(v0 + (p_skeleton->get_bone_global_rest(current_bone_idx).basis.inverse())[j].normalized() * dist * bone_axis_length);
  1521. if (j == closest) {
  1522. continue;
  1523. }
  1524. }
  1525. // Axis at the end of the bone children.
  1526. if (i == child_bones_size - 1) {
  1527. for (int j = 0; j < 3; j++) {
  1528. bones[0] = child_bone_idx;
  1529. surface_tool->set_color(axis_colors[j]);
  1530. surface_tool->set_bones(bones);
  1531. surface_tool->set_weights(weights);
  1532. surface_tool->add_vertex(v1);
  1533. surface_tool->set_bones(bones);
  1534. surface_tool->set_weights(weights);
  1535. surface_tool->add_vertex(v1 + (p_skeleton->get_bone_global_rest(child_bone_idx).basis.inverse())[j].normalized() * dist * bone_axis_length);
  1536. if (j == closest) {
  1537. continue;
  1538. }
  1539. }
  1540. }
  1541. // Add the bone's children to the list of bones to be processed.
  1542. bones_to_process.push_back(child_bones_vector[i]);
  1543. }
  1544. }
  1545. return surface_tool->commit();
  1546. }