2
0

spring_bone_simulator_3d.cpp 66 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649
  1. /**************************************************************************/
  2. /* spring_bone_simulator_3d.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 "spring_bone_simulator_3d.h"
  31. #include "scene/3d/spring_bone_collision_3d.h"
  32. // Original VRM Spring Bone movement logic was distributed by (c) VRM Consortium. Licensed under the MIT license.
  33. bool SpringBoneSimulator3D::_set(const StringName &p_path, const Variant &p_value) {
  34. String path = p_path;
  35. if (path.begins_with("settings/")) {
  36. int which = path.get_slicec('/', 1).to_int();
  37. String what = path.get_slicec('/', 2);
  38. ERR_FAIL_INDEX_V(which, settings.size(), false);
  39. if (what == "root_bone_name") {
  40. set_root_bone_name(which, p_value);
  41. } else if (what == "root_bone") {
  42. set_root_bone(which, p_value);
  43. } else if (what == "end_bone_name") {
  44. set_end_bone_name(which, p_value);
  45. } else if (what == "end_bone") {
  46. String opt = path.get_slicec('/', 3);
  47. if (opt.is_empty()) {
  48. set_end_bone(which, p_value);
  49. } else if (opt == "direction") {
  50. set_end_bone_direction(which, static_cast<BoneDirection>((int)p_value));
  51. } else if (opt == "length") {
  52. set_end_bone_length(which, p_value);
  53. } else {
  54. return false;
  55. }
  56. } else if (what == "extend_end_bone") {
  57. set_extend_end_bone(which, p_value);
  58. } else if (what == "center_from") {
  59. set_center_from(which, static_cast<CenterFrom>((int)p_value));
  60. } else if (what == "center_node") {
  61. set_center_node(which, p_value);
  62. } else if (what == "center_bone") {
  63. set_center_bone(which, p_value);
  64. } else if (what == "center_bone_name") {
  65. set_center_bone_name(which, p_value);
  66. } else if (what == "individual_config") {
  67. set_individual_config(which, p_value);
  68. } else if (what == "rotation_axis") {
  69. set_rotation_axis(which, static_cast<RotationAxis>((int)p_value));
  70. } else if (what == "radius") {
  71. String opt = path.get_slicec('/', 3);
  72. if (opt == "value") {
  73. set_radius(which, p_value);
  74. } else if (opt == "damping_curve") {
  75. set_radius_damping_curve(which, p_value);
  76. } else {
  77. return false;
  78. }
  79. } else if (what == "stiffness") {
  80. String opt = path.get_slicec('/', 3);
  81. if (opt == "value") {
  82. set_stiffness(which, p_value);
  83. } else if (opt == "damping_curve") {
  84. set_stiffness_damping_curve(which, p_value);
  85. } else {
  86. return false;
  87. }
  88. } else if (what == "drag") {
  89. String opt = path.get_slicec('/', 3);
  90. if (opt == "value") {
  91. set_drag(which, p_value);
  92. } else if (opt == "damping_curve") {
  93. set_drag_damping_curve(which, p_value);
  94. } else {
  95. return false;
  96. }
  97. } else if (what == "gravity") {
  98. String opt = path.get_slicec('/', 3);
  99. if (opt == "value") {
  100. set_gravity(which, p_value);
  101. } else if (opt == "damping_curve") {
  102. set_gravity_damping_curve(which, p_value);
  103. } else if (opt == "direction") {
  104. set_gravity_direction(which, p_value);
  105. } else {
  106. return false;
  107. }
  108. } else if (what == "enable_all_child_collisions") {
  109. set_enable_all_child_collisions(which, p_value);
  110. } else if (what == "joint_count") {
  111. set_joint_count(which, p_value);
  112. } else if (what == "joints") {
  113. int idx = path.get_slicec('/', 3).to_int();
  114. String prop = path.get_slicec('/', 4);
  115. if (prop == "bone_name") {
  116. set_joint_bone_name(which, idx, p_value);
  117. } else if (prop == "bone") {
  118. set_joint_bone(which, idx, p_value);
  119. } else if (prop == "rotation_axis") {
  120. set_joint_rotation_axis(which, idx, static_cast<RotationAxis>((int)p_value));
  121. } else if (prop == "radius") {
  122. set_joint_radius(which, idx, p_value);
  123. } else if (prop == "stiffness") {
  124. set_joint_stiffness(which, idx, p_value);
  125. } else if (prop == "drag") {
  126. set_joint_drag(which, idx, p_value);
  127. } else if (prop == "gravity") {
  128. set_joint_gravity(which, idx, p_value);
  129. } else if (prop == "gravity_direction") {
  130. set_joint_gravity_direction(which, idx, p_value);
  131. } else {
  132. return false;
  133. }
  134. } else if (what == "exclude_collision_count") {
  135. set_exclude_collision_count(which, p_value);
  136. } else if (what == "exclude_collisions") {
  137. int idx = path.get_slicec('/', 3).to_int();
  138. set_exclude_collision_path(which, idx, p_value);
  139. } else if (what == "collision_count") {
  140. set_collision_count(which, p_value);
  141. } else if (what == "collisions") {
  142. int idx = path.get_slicec('/', 3).to_int();
  143. set_collision_path(which, idx, p_value);
  144. } else {
  145. return false;
  146. }
  147. }
  148. return true;
  149. }
  150. bool SpringBoneSimulator3D::_get(const StringName &p_path, Variant &r_ret) const {
  151. String path = p_path;
  152. if (path.begins_with("settings/")) {
  153. int which = path.get_slicec('/', 1).to_int();
  154. String what = path.get_slicec('/', 2);
  155. ERR_FAIL_INDEX_V(which, settings.size(), false);
  156. if (what == "root_bone_name") {
  157. r_ret = get_root_bone_name(which);
  158. } else if (what == "root_bone") {
  159. r_ret = get_root_bone(which);
  160. } else if (what == "end_bone_name") {
  161. r_ret = get_end_bone_name(which);
  162. } else if (what == "end_bone") {
  163. String opt = path.get_slicec('/', 3);
  164. if (opt.is_empty()) {
  165. r_ret = get_end_bone(which);
  166. } else if (opt == "direction") {
  167. r_ret = (int)get_end_bone_direction(which);
  168. } else if (opt == "length") {
  169. r_ret = get_end_bone_length(which);
  170. } else {
  171. return false;
  172. }
  173. } else if (what == "extend_end_bone") {
  174. r_ret = is_end_bone_extended(which);
  175. } else if (what == "center_from") {
  176. r_ret = (int)get_center_from(which);
  177. } else if (what == "center_node") {
  178. r_ret = get_center_node(which);
  179. } else if (what == "center_bone") {
  180. r_ret = get_center_bone(which);
  181. } else if (what == "center_bone_name") {
  182. r_ret = get_center_bone_name(which);
  183. } else if (what == "individual_config") {
  184. r_ret = is_config_individual(which);
  185. } else if (what == "rotation_axis") {
  186. r_ret = (int)get_rotation_axis(which);
  187. } else if (what == "radius") {
  188. String opt = path.get_slicec('/', 3);
  189. if (opt == "value") {
  190. r_ret = get_radius(which);
  191. } else if (opt == "damping_curve") {
  192. r_ret = get_radius_damping_curve(which);
  193. } else {
  194. return false;
  195. }
  196. } else if (what == "stiffness") {
  197. String opt = path.get_slicec('/', 3);
  198. if (opt == "value") {
  199. r_ret = get_stiffness(which);
  200. } else if (opt == "damping_curve") {
  201. r_ret = get_stiffness_damping_curve(which);
  202. } else {
  203. return false;
  204. }
  205. } else if (what == "drag") {
  206. String opt = path.get_slicec('/', 3);
  207. if (opt == "value") {
  208. r_ret = get_drag(which);
  209. } else if (opt == "damping_curve") {
  210. r_ret = get_drag_damping_curve(which);
  211. } else {
  212. return false;
  213. }
  214. } else if (what == "gravity") {
  215. String opt = path.get_slicec('/', 3);
  216. if (opt == "value") {
  217. r_ret = get_gravity(which);
  218. } else if (opt == "damping_curve") {
  219. r_ret = get_gravity_damping_curve(which);
  220. } else if (opt == "direction") {
  221. r_ret = get_gravity_direction(which);
  222. } else {
  223. return false;
  224. }
  225. } else if (what == "enable_all_child_collisions") {
  226. r_ret = are_all_child_collisions_enabled(which);
  227. } else if (what == "joint_count") {
  228. r_ret = get_joint_count(which);
  229. } else if (what == "joints") {
  230. int idx = path.get_slicec('/', 3).to_int();
  231. String prop = path.get_slicec('/', 4);
  232. if (prop == "bone_name") {
  233. r_ret = get_joint_bone_name(which, idx);
  234. } else if (prop == "bone") {
  235. r_ret = get_joint_bone(which, idx);
  236. } else if (prop == "rotation_axis") {
  237. r_ret = (int)get_joint_rotation_axis(which, idx);
  238. } else if (prop == "radius") {
  239. r_ret = get_joint_radius(which, idx);
  240. } else if (prop == "stiffness") {
  241. r_ret = get_joint_stiffness(which, idx);
  242. } else if (prop == "drag") {
  243. r_ret = get_joint_drag(which, idx);
  244. } else if (prop == "gravity") {
  245. r_ret = get_joint_gravity(which, idx);
  246. } else if (prop == "gravity_direction") {
  247. r_ret = get_joint_gravity_direction(which, idx);
  248. } else {
  249. return false;
  250. }
  251. } else if (what == "exclude_collision_count") {
  252. r_ret = get_exclude_collision_count(which);
  253. } else if (what == "exclude_collisions") {
  254. int idx = path.get_slicec('/', 3).to_int();
  255. r_ret = get_exclude_collision_path(which, idx);
  256. } else if (what == "collision_count") {
  257. r_ret = get_collision_count(which);
  258. } else if (what == "collisions") {
  259. int idx = path.get_slicec('/', 3).to_int();
  260. r_ret = get_collision_path(which, idx);
  261. } else {
  262. return false;
  263. }
  264. }
  265. return true;
  266. }
  267. void SpringBoneSimulator3D::_get_property_list(List<PropertyInfo> *p_list) const {
  268. String enum_hint;
  269. Skeleton3D *skeleton = get_skeleton();
  270. if (skeleton) {
  271. enum_hint = skeleton->get_concatenated_bone_names();
  272. }
  273. for (int i = 0; i < settings.size(); i++) {
  274. String path = "settings/" + itos(i) + "/";
  275. p_list->push_back(PropertyInfo(Variant::STRING, path + "root_bone_name", PROPERTY_HINT_ENUM_SUGGESTION, enum_hint));
  276. p_list->push_back(PropertyInfo(Variant::INT, path + "root_bone", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR));
  277. p_list->push_back(PropertyInfo(Variant::STRING, path + "end_bone_name", PROPERTY_HINT_ENUM_SUGGESTION, enum_hint));
  278. p_list->push_back(PropertyInfo(Variant::INT, path + "end_bone", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR));
  279. p_list->push_back(PropertyInfo(Variant::BOOL, path + "extend_end_bone"));
  280. p_list->push_back(PropertyInfo(Variant::INT, path + "end_bone/direction", PROPERTY_HINT_ENUM, "+X,-X,+Y,-Y,+Z,-Z,FromParent"));
  281. p_list->push_back(PropertyInfo(Variant::FLOAT, path + "end_bone/length", PROPERTY_HINT_RANGE, "0,1,0.001,or_greater,suffix:m"));
  282. p_list->push_back(PropertyInfo(Variant::INT, path + "center_from", PROPERTY_HINT_ENUM, "WorldOrigin,Node,Bone"));
  283. p_list->push_back(PropertyInfo(Variant::NODE_PATH, path + "center_node"));
  284. p_list->push_back(PropertyInfo(Variant::STRING, path + "center_bone_name", PROPERTY_HINT_ENUM_SUGGESTION, enum_hint));
  285. p_list->push_back(PropertyInfo(Variant::INT, path + "center_bone", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR));
  286. p_list->push_back(PropertyInfo(Variant::BOOL, path + "individual_config"));
  287. p_list->push_back(PropertyInfo(Variant::INT, path + "rotation_axis", PROPERTY_HINT_ENUM, "X,Y,Z,All"));
  288. p_list->push_back(PropertyInfo(Variant::FLOAT, path + "radius/value", PROPERTY_HINT_RANGE, "0,1,0.001,or_greater,suffix:m"));
  289. p_list->push_back(PropertyInfo(Variant::OBJECT, path + "radius/damping_curve", PROPERTY_HINT_RESOURCE_TYPE, "Curve"));
  290. p_list->push_back(PropertyInfo(Variant::FLOAT, path + "stiffness/value", PROPERTY_HINT_RANGE, "0,4,0.01,or_greater"));
  291. p_list->push_back(PropertyInfo(Variant::OBJECT, path + "stiffness/damping_curve", PROPERTY_HINT_RESOURCE_TYPE, "Curve"));
  292. p_list->push_back(PropertyInfo(Variant::FLOAT, path + "drag/value", PROPERTY_HINT_RANGE, "0,1,0.01,or_greater"));
  293. p_list->push_back(PropertyInfo(Variant::OBJECT, path + "drag/damping_curve", PROPERTY_HINT_RESOURCE_TYPE, "Curve"));
  294. p_list->push_back(PropertyInfo(Variant::FLOAT, path + "gravity/value", PROPERTY_HINT_RANGE, "0,1,0.01,or_greater,or_less,suffix:m/s"));
  295. p_list->push_back(PropertyInfo(Variant::OBJECT, path + "gravity/damping_curve", PROPERTY_HINT_RESOURCE_TYPE, "Curve"));
  296. p_list->push_back(PropertyInfo(Variant::VECTOR3, path + "gravity/direction"));
  297. p_list->push_back(PropertyInfo(Variant::INT, path + "joint_count", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_ARRAY, "Joints," + path + "joints/,static,const"));
  298. for (int j = 0; j < settings[i]->joints.size(); j++) {
  299. String joint_path = path + "joints/" + itos(j) + "/";
  300. p_list->push_back(PropertyInfo(Variant::STRING, joint_path + "bone_name", PROPERTY_HINT_ENUM_SUGGESTION, enum_hint, PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_READ_ONLY | PROPERTY_USAGE_STORAGE));
  301. p_list->push_back(PropertyInfo(Variant::INT, joint_path + "bone", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_READ_ONLY));
  302. p_list->push_back(PropertyInfo(Variant::INT, joint_path + "rotation_axis", PROPERTY_HINT_ENUM, "X,Y,Z,All"));
  303. p_list->push_back(PropertyInfo(Variant::FLOAT, joint_path + "radius", PROPERTY_HINT_RANGE, "0,1,0.001,or_greater,suffix:m"));
  304. p_list->push_back(PropertyInfo(Variant::FLOAT, joint_path + "stiffness", PROPERTY_HINT_RANGE, "0,4,0.01,or_greater"));
  305. p_list->push_back(PropertyInfo(Variant::FLOAT, joint_path + "drag", PROPERTY_HINT_RANGE, "0,1,0.01,or_greater"));
  306. p_list->push_back(PropertyInfo(Variant::FLOAT, joint_path + "gravity", PROPERTY_HINT_RANGE, "0,1,0.01,or_greater,or_less,suffix:m/s"));
  307. p_list->push_back(PropertyInfo(Variant::VECTOR3, joint_path + "gravity_direction"));
  308. }
  309. p_list->push_back(PropertyInfo(Variant::BOOL, path + "enable_all_child_collisions"));
  310. p_list->push_back(PropertyInfo(Variant::INT, path + "exclude_collision_count", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_ARRAY, "Exclude Collisions," + path + "exclude_collisions/"));
  311. for (int j = 0; j < settings[i]->exclude_collisions.size(); j++) {
  312. String collision_path = path + "exclude_collisions/" + itos(j);
  313. p_list->push_back(PropertyInfo(Variant::NODE_PATH, collision_path, PROPERTY_HINT_NODE_PATH_VALID_TYPES, "SpringBoneCollision3D"));
  314. }
  315. p_list->push_back(PropertyInfo(Variant::INT, path + "collision_count", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_ARRAY, "Collisions," + path + "collisions/"));
  316. for (int j = 0; j < settings[i]->collisions.size(); j++) {
  317. String collision_path = path + "collisions/" + itos(j);
  318. p_list->push_back(PropertyInfo(Variant::NODE_PATH, collision_path, PROPERTY_HINT_NODE_PATH_VALID_TYPES, "SpringBoneCollision3D"));
  319. }
  320. }
  321. for (PropertyInfo &E : *p_list) {
  322. _validate_property(E);
  323. }
  324. }
  325. void SpringBoneSimulator3D::_validate_property(PropertyInfo &p_property) const {
  326. PackedStringArray split = p_property.name.split("/");
  327. if (split.size() > 2 && split[0] == "settings") {
  328. int which = split[1].to_int();
  329. // Extended end bone option.
  330. if (split[2] == "end_bone" && !is_end_bone_extended(which) && split.size() > 3) {
  331. p_property.usage = PROPERTY_USAGE_NONE;
  332. }
  333. // Center option.
  334. if (get_center_from(which) != CENTER_FROM_BONE && (split[2] == "center_bone" || split[2] == "center_bone_name")) {
  335. p_property.usage = PROPERTY_USAGE_NONE;
  336. }
  337. if (get_center_from(which) != CENTER_FROM_NODE && split[2] == "center_node") {
  338. p_property.usage = PROPERTY_USAGE_NONE;
  339. }
  340. // Joints option.
  341. if (is_config_individual(which)) {
  342. if (split[2] == "rotation_axis" || split[2] == "radius" || split[2] == "radius_damping_curve" ||
  343. split[2] == "stiffness" || split[2] == "stiffness_damping_curve" ||
  344. split[2] == "drag" || split[2] == "drag_damping_curve" ||
  345. split[2] == "gravity" || split[2] == "gravity_damping_curve" || split[2] == "gravity_direction") {
  346. p_property.usage = PROPERTY_USAGE_NONE;
  347. }
  348. } else {
  349. if (split[2] == "joints" || split[2] == "joint_count") {
  350. // Don't storage them since they are overridden by _update_joints().
  351. p_property.usage ^= PROPERTY_USAGE_STORAGE;
  352. p_property.usage |= PROPERTY_USAGE_READ_ONLY;
  353. }
  354. }
  355. // Collisions option.
  356. if (are_all_child_collisions_enabled(which)) {
  357. if (split[2] == "collisions" || split[2] == "collision_count") {
  358. p_property.usage = PROPERTY_USAGE_NONE;
  359. }
  360. } else {
  361. if (split[2] == "exclude_collisions" || split[2] == "exclude_collision_count") {
  362. p_property.usage = PROPERTY_USAGE_NONE;
  363. }
  364. }
  365. }
  366. }
  367. void SpringBoneSimulator3D::_notification(int p_what) {
  368. switch (p_what) {
  369. case NOTIFICATION_ENTER_TREE: {
  370. #ifdef TOOLS_ENABLED
  371. if (Engine::get_singleton()->is_editor_hint()) {
  372. set_notify_local_transform(true); // Used for updating gizmo in editor.
  373. }
  374. #endif // TOOLS_ENABLED
  375. _make_collisions_dirty();
  376. _make_all_joints_dirty();
  377. } break;
  378. #ifdef TOOLS_ENABLED
  379. case NOTIFICATION_LOCAL_TRANSFORM_CHANGED: {
  380. update_gizmos();
  381. } break;
  382. case NOTIFICATION_EDITOR_PRE_SAVE: {
  383. saving = true;
  384. } break;
  385. case NOTIFICATION_EDITOR_POST_SAVE: {
  386. saving = false;
  387. } break;
  388. #endif // TOOLS_ENABLED
  389. }
  390. }
  391. // Setting.
  392. void SpringBoneSimulator3D::set_root_bone_name(int p_index, const String &p_bone_name) {
  393. ERR_FAIL_INDEX(p_index, settings.size());
  394. settings[p_index]->root_bone_name = p_bone_name;
  395. Skeleton3D *sk = get_skeleton();
  396. if (sk) {
  397. set_root_bone(p_index, sk->find_bone(settings[p_index]->root_bone_name));
  398. }
  399. }
  400. String SpringBoneSimulator3D::get_root_bone_name(int p_index) const {
  401. ERR_FAIL_INDEX_V(p_index, settings.size(), String());
  402. return settings[p_index]->root_bone_name;
  403. }
  404. void SpringBoneSimulator3D::set_root_bone(int p_index, int p_bone) {
  405. ERR_FAIL_INDEX(p_index, settings.size());
  406. bool changed = settings[p_index]->root_bone != p_bone;
  407. settings[p_index]->root_bone = p_bone;
  408. Skeleton3D *sk = get_skeleton();
  409. if (sk) {
  410. if (settings[p_index]->root_bone <= -1 || settings[p_index]->root_bone >= sk->get_bone_count()) {
  411. WARN_PRINT("Root bone index out of range!");
  412. settings[p_index]->root_bone = -1;
  413. } else {
  414. settings[p_index]->root_bone_name = sk->get_bone_name(settings[p_index]->root_bone);
  415. }
  416. }
  417. if (changed) {
  418. _update_joint_array(p_index);
  419. }
  420. }
  421. int SpringBoneSimulator3D::get_root_bone(int p_index) const {
  422. ERR_FAIL_INDEX_V(p_index, settings.size(), -1);
  423. return settings[p_index]->root_bone;
  424. }
  425. void SpringBoneSimulator3D::set_end_bone_name(int p_index, const String &p_bone_name) {
  426. ERR_FAIL_INDEX(p_index, settings.size());
  427. settings[p_index]->end_bone_name = p_bone_name;
  428. Skeleton3D *sk = get_skeleton();
  429. if (sk) {
  430. set_end_bone(p_index, sk->find_bone(settings[p_index]->end_bone_name));
  431. }
  432. }
  433. String SpringBoneSimulator3D::get_end_bone_name(int p_index) const {
  434. ERR_FAIL_INDEX_V(p_index, settings.size(), String());
  435. return settings[p_index]->end_bone_name;
  436. }
  437. void SpringBoneSimulator3D::set_end_bone(int p_index, int p_bone) {
  438. ERR_FAIL_INDEX(p_index, settings.size());
  439. bool changed = settings[p_index]->end_bone != p_bone;
  440. settings[p_index]->end_bone = p_bone;
  441. Skeleton3D *sk = get_skeleton();
  442. if (sk) {
  443. if (settings[p_index]->end_bone <= -1 || settings[p_index]->end_bone >= sk->get_bone_count()) {
  444. WARN_PRINT("End bone index out of range!");
  445. settings[p_index]->end_bone = -1;
  446. } else {
  447. settings[p_index]->end_bone_name = sk->get_bone_name(settings[p_index]->end_bone);
  448. }
  449. }
  450. if (changed) {
  451. _update_joint_array(p_index);
  452. }
  453. }
  454. int SpringBoneSimulator3D::get_end_bone(int p_index) const {
  455. ERR_FAIL_INDEX_V(p_index, settings.size(), -1);
  456. return settings[p_index]->end_bone;
  457. }
  458. void SpringBoneSimulator3D::set_extend_end_bone(int p_index, bool p_enabled) {
  459. ERR_FAIL_INDEX(p_index, settings.size());
  460. settings[p_index]->extend_end_bone = p_enabled;
  461. _make_joints_dirty(p_index);
  462. notify_property_list_changed();
  463. }
  464. bool SpringBoneSimulator3D::is_end_bone_extended(int p_index) const {
  465. ERR_FAIL_INDEX_V(p_index, settings.size(), false);
  466. return settings[p_index]->extend_end_bone;
  467. }
  468. void SpringBoneSimulator3D::set_end_bone_direction(int p_index, BoneDirection p_bone_direction) {
  469. ERR_FAIL_INDEX(p_index, settings.size());
  470. settings[p_index]->end_bone_direction = p_bone_direction;
  471. _make_joints_dirty(p_index);
  472. }
  473. SpringBoneSimulator3D::BoneDirection SpringBoneSimulator3D::get_end_bone_direction(int p_index) const {
  474. ERR_FAIL_INDEX_V(p_index, settings.size(), BONE_DIRECTION_FROM_PARENT);
  475. return settings[p_index]->end_bone_direction;
  476. }
  477. void SpringBoneSimulator3D::set_end_bone_length(int p_index, float p_length) {
  478. ERR_FAIL_INDEX(p_index, settings.size());
  479. settings[p_index]->end_bone_length = p_length;
  480. _make_joints_dirty(p_index);
  481. }
  482. float SpringBoneSimulator3D::get_end_bone_length(int p_index) const {
  483. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  484. return settings[p_index]->end_bone_length;
  485. }
  486. Vector3 SpringBoneSimulator3D::get_end_bone_axis(int p_end_bone, BoneDirection p_direction) const {
  487. Vector3 axis;
  488. if (p_direction == BONE_DIRECTION_FROM_PARENT) {
  489. Skeleton3D *sk = get_skeleton();
  490. if (sk) {
  491. axis = sk->get_bone_rest(p_end_bone).basis.xform_inv(sk->get_bone_rest(p_end_bone).origin);
  492. axis.normalize();
  493. }
  494. } else {
  495. axis = get_vector_from_bone_axis(static_cast<BoneAxis>((int)p_direction));
  496. }
  497. return axis;
  498. }
  499. void SpringBoneSimulator3D::set_center_from(int p_index, CenterFrom p_center_from) {
  500. ERR_FAIL_INDEX(p_index, settings.size());
  501. bool center_changed = settings[p_index]->center_from != p_center_from;
  502. settings[p_index]->center_from = p_center_from;
  503. if (center_changed) {
  504. reset();
  505. }
  506. notify_property_list_changed();
  507. }
  508. SpringBoneSimulator3D::CenterFrom SpringBoneSimulator3D::get_center_from(int p_index) const {
  509. ERR_FAIL_INDEX_V(p_index, settings.size(), CENTER_FROM_WORLD_ORIGIN);
  510. return settings[p_index]->center_from;
  511. }
  512. void SpringBoneSimulator3D::set_center_node(int p_index, const NodePath &p_node_path) {
  513. ERR_FAIL_INDEX(p_index, settings.size());
  514. bool center_changed = settings[p_index]->center_node != p_node_path;
  515. settings[p_index]->center_node = p_node_path;
  516. if (center_changed) {
  517. reset();
  518. }
  519. }
  520. NodePath SpringBoneSimulator3D::get_center_node(int p_index) const {
  521. ERR_FAIL_INDEX_V(p_index, settings.size(), NodePath());
  522. return settings[p_index]->center_node;
  523. }
  524. void SpringBoneSimulator3D::set_center_bone_name(int p_index, const String &p_bone_name) {
  525. ERR_FAIL_INDEX(p_index, settings.size());
  526. settings[p_index]->center_bone_name = p_bone_name;
  527. Skeleton3D *sk = get_skeleton();
  528. if (sk) {
  529. set_center_bone(p_index, sk->find_bone(settings[p_index]->center_bone_name));
  530. }
  531. }
  532. String SpringBoneSimulator3D::get_center_bone_name(int p_index) const {
  533. ERR_FAIL_INDEX_V(p_index, settings.size(), String());
  534. return settings[p_index]->center_bone_name;
  535. }
  536. void SpringBoneSimulator3D::set_center_bone(int p_index, int p_bone) {
  537. ERR_FAIL_INDEX(p_index, settings.size());
  538. bool center_changed = settings[p_index]->center_bone != p_bone;
  539. settings[p_index]->center_bone = p_bone;
  540. Skeleton3D *sk = get_skeleton();
  541. if (sk) {
  542. if (settings[p_index]->center_bone <= -1 || settings[p_index]->center_bone >= sk->get_bone_count()) {
  543. WARN_PRINT("Center bone index out of range!");
  544. settings[p_index]->center_bone = -1;
  545. } else {
  546. settings[p_index]->center_bone_name = sk->get_bone_name(settings[p_index]->center_bone);
  547. }
  548. }
  549. if (center_changed) {
  550. reset();
  551. }
  552. }
  553. int SpringBoneSimulator3D::get_center_bone(int p_index) const {
  554. ERR_FAIL_INDEX_V(p_index, settings.size(), -1);
  555. return settings[p_index]->center_bone;
  556. }
  557. void SpringBoneSimulator3D::set_radius(int p_index, float p_radius) {
  558. ERR_FAIL_INDEX(p_index, settings.size());
  559. if (is_config_individual(p_index)) {
  560. return; // Joint config is individual mode.
  561. }
  562. settings[p_index]->radius = p_radius;
  563. _make_joints_dirty(p_index);
  564. }
  565. float SpringBoneSimulator3D::get_radius(int p_index) const {
  566. return settings[p_index]->radius;
  567. }
  568. void SpringBoneSimulator3D::set_radius_damping_curve(int p_index, const Ref<Curve> &p_damping_curve) {
  569. ERR_FAIL_INDEX(p_index, settings.size());
  570. if (is_config_individual(p_index)) {
  571. return; // Joint config is individual mode.
  572. }
  573. if (settings[p_index]->radius_damping_curve.is_valid()) {
  574. settings[p_index]->radius_damping_curve->disconnect_changed(callable_mp(this, &SpringBoneSimulator3D::_make_joints_dirty));
  575. }
  576. settings[p_index]->radius_damping_curve = p_damping_curve;
  577. if (settings[p_index]->radius_damping_curve.is_valid()) {
  578. settings[p_index]->radius_damping_curve->connect_changed(callable_mp(this, &SpringBoneSimulator3D::_make_joints_dirty).bind(p_index));
  579. }
  580. _make_joints_dirty(p_index);
  581. }
  582. Ref<Curve> SpringBoneSimulator3D::get_radius_damping_curve(int p_index) const {
  583. ERR_FAIL_INDEX_V(p_index, settings.size(), Ref<Curve>());
  584. return settings[p_index]->radius_damping_curve;
  585. }
  586. void SpringBoneSimulator3D::set_stiffness(int p_index, float p_stiffness) {
  587. ERR_FAIL_INDEX(p_index, settings.size());
  588. if (is_config_individual(p_index)) {
  589. return; // Joint config is individual mode.
  590. }
  591. settings[p_index]->stiffness = p_stiffness;
  592. _make_joints_dirty(p_index);
  593. }
  594. float SpringBoneSimulator3D::get_stiffness(int p_index) const {
  595. return settings[p_index]->stiffness;
  596. }
  597. void SpringBoneSimulator3D::set_stiffness_damping_curve(int p_index, const Ref<Curve> &p_damping_curve) {
  598. ERR_FAIL_INDEX(p_index, settings.size());
  599. if (is_config_individual(p_index)) {
  600. return; // Joint config is individual mode.
  601. }
  602. if (settings[p_index]->stiffness_damping_curve.is_valid()) {
  603. settings[p_index]->stiffness_damping_curve->disconnect_changed(callable_mp(this, &SpringBoneSimulator3D::_make_joints_dirty));
  604. }
  605. settings[p_index]->stiffness_damping_curve = p_damping_curve;
  606. if (settings[p_index]->stiffness_damping_curve.is_valid()) {
  607. settings[p_index]->stiffness_damping_curve->connect_changed(callable_mp(this, &SpringBoneSimulator3D::_make_joints_dirty).bind(p_index));
  608. }
  609. _make_joints_dirty(p_index);
  610. }
  611. Ref<Curve> SpringBoneSimulator3D::get_stiffness_damping_curve(int p_index) const {
  612. ERR_FAIL_INDEX_V(p_index, settings.size(), Ref<Curve>());
  613. return settings[p_index]->stiffness_damping_curve;
  614. }
  615. void SpringBoneSimulator3D::set_drag(int p_index, float p_drag) {
  616. ERR_FAIL_INDEX(p_index, settings.size());
  617. if (is_config_individual(p_index)) {
  618. return; // Joint config is individual mode.
  619. }
  620. settings[p_index]->drag = p_drag;
  621. _make_joints_dirty(p_index);
  622. }
  623. float SpringBoneSimulator3D::get_drag(int p_index) const {
  624. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  625. return settings[p_index]->drag;
  626. }
  627. void SpringBoneSimulator3D::set_drag_damping_curve(int p_index, const Ref<Curve> &p_damping_curve) {
  628. ERR_FAIL_INDEX(p_index, settings.size());
  629. if (is_config_individual(p_index)) {
  630. return; // Joint config is individual mode.
  631. }
  632. if (settings[p_index]->drag_damping_curve.is_valid()) {
  633. settings[p_index]->drag_damping_curve->disconnect_changed(callable_mp(this, &SpringBoneSimulator3D::_make_joints_dirty));
  634. }
  635. settings[p_index]->drag_damping_curve = p_damping_curve;
  636. if (settings[p_index]->drag_damping_curve.is_valid()) {
  637. settings[p_index]->drag_damping_curve->connect_changed(callable_mp(this, &SpringBoneSimulator3D::_make_joints_dirty).bind(p_index));
  638. }
  639. _make_joints_dirty(p_index);
  640. }
  641. Ref<Curve> SpringBoneSimulator3D::get_drag_damping_curve(int p_index) const {
  642. ERR_FAIL_INDEX_V(p_index, settings.size(), Ref<Curve>());
  643. return settings[p_index]->drag_damping_curve;
  644. }
  645. void SpringBoneSimulator3D::set_gravity(int p_index, float p_gravity) {
  646. ERR_FAIL_INDEX(p_index, settings.size());
  647. if (is_config_individual(p_index)) {
  648. return; // Joint config is individual mode.
  649. }
  650. settings[p_index]->gravity = p_gravity;
  651. _make_joints_dirty(p_index);
  652. }
  653. float SpringBoneSimulator3D::get_gravity(int p_index) const {
  654. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  655. return settings[p_index]->gravity;
  656. }
  657. void SpringBoneSimulator3D::set_gravity_damping_curve(int p_index, const Ref<Curve> &p_damping_curve) {
  658. ERR_FAIL_INDEX(p_index, settings.size());
  659. if (is_config_individual(p_index)) {
  660. return; // Joint config is individual mode.
  661. }
  662. if (settings[p_index]->gravity_damping_curve.is_valid()) {
  663. settings[p_index]->gravity_damping_curve->disconnect_changed(callable_mp(this, &SpringBoneSimulator3D::_make_joints_dirty));
  664. }
  665. settings[p_index]->gravity_damping_curve = p_damping_curve;
  666. if (settings[p_index]->gravity_damping_curve.is_valid()) {
  667. settings[p_index]->gravity_damping_curve->connect_changed(callable_mp(this, &SpringBoneSimulator3D::_make_joints_dirty).bind(p_index));
  668. }
  669. _make_joints_dirty(p_index);
  670. }
  671. Ref<Curve> SpringBoneSimulator3D::get_gravity_damping_curve(int p_index) const {
  672. ERR_FAIL_INDEX_V(p_index, settings.size(), Ref<Curve>());
  673. return settings[p_index]->gravity_damping_curve;
  674. }
  675. void SpringBoneSimulator3D::set_gravity_direction(int p_index, const Vector3 &p_gravity_direction) {
  676. ERR_FAIL_INDEX(p_index, settings.size());
  677. ERR_FAIL_COND(p_gravity_direction.is_zero_approx());
  678. if (is_config_individual(p_index)) {
  679. return; // Joint config is individual mode.
  680. }
  681. settings[p_index]->gravity_direction = p_gravity_direction;
  682. _make_joints_dirty(p_index);
  683. }
  684. Vector3 SpringBoneSimulator3D::get_gravity_direction(int p_index) const {
  685. ERR_FAIL_INDEX_V(p_index, settings.size(), Vector3(0, -1, 0));
  686. return settings[p_index]->gravity_direction;
  687. }
  688. void SpringBoneSimulator3D::set_rotation_axis(int p_index, RotationAxis p_axis) {
  689. ERR_FAIL_INDEX(p_index, settings.size());
  690. if (is_config_individual(p_index)) {
  691. return; // Joint config is individual mode.
  692. }
  693. settings[p_index]->rotation_axis = p_axis;
  694. _make_joints_dirty(p_index);
  695. }
  696. SpringBoneSimulator3D::RotationAxis SpringBoneSimulator3D::get_rotation_axis(int p_index) const {
  697. ERR_FAIL_INDEX_V(p_index, settings.size(), ROTATION_AXIS_ALL);
  698. return settings[p_index]->rotation_axis;
  699. }
  700. void SpringBoneSimulator3D::set_setting_count(int p_count) {
  701. ERR_FAIL_COND(p_count < 0);
  702. int delta = p_count - settings.size() + 1;
  703. settings.resize(p_count);
  704. if (delta > 1) {
  705. for (int i = 1; i < delta; i++) {
  706. settings.write[p_count - i] = memnew(SpringBone3DSetting);
  707. }
  708. }
  709. notify_property_list_changed();
  710. }
  711. int SpringBoneSimulator3D::get_setting_count() const {
  712. return settings.size();
  713. }
  714. void SpringBoneSimulator3D::clear_settings() {
  715. set_setting_count(0);
  716. }
  717. // Individual joints.
  718. void SpringBoneSimulator3D::set_individual_config(int p_index, bool p_enabled) {
  719. ERR_FAIL_INDEX(p_index, settings.size());
  720. settings[p_index]->individual_config = p_enabled;
  721. _make_joints_dirty(p_index);
  722. notify_property_list_changed();
  723. }
  724. bool SpringBoneSimulator3D::is_config_individual(int p_index) const {
  725. ERR_FAIL_INDEX_V(p_index, settings.size(), false);
  726. return settings[p_index]->individual_config;
  727. }
  728. void SpringBoneSimulator3D::set_joint_bone_name(int p_index, int p_joint, const String &p_bone_name) {
  729. ERR_FAIL_INDEX(p_index, settings.size());
  730. Vector<SpringBone3DJointSetting *> &joints = settings[p_index]->joints;
  731. ERR_FAIL_INDEX(p_joint, joints.size());
  732. joints[p_joint]->bone_name = p_bone_name;
  733. Skeleton3D *sk = get_skeleton();
  734. if (sk) {
  735. set_joint_bone(p_index, p_joint, sk->find_bone(joints[p_joint]->bone_name));
  736. }
  737. }
  738. String SpringBoneSimulator3D::get_joint_bone_name(int p_index, int p_joint) const {
  739. ERR_FAIL_INDEX_V(p_index, settings.size(), String());
  740. Vector<SpringBone3DJointSetting *> joints = settings[p_index]->joints;
  741. ERR_FAIL_INDEX_V(p_joint, joints.size(), String());
  742. return joints[p_joint]->bone_name;
  743. }
  744. void SpringBoneSimulator3D::set_joint_bone(int p_index, int p_joint, int p_bone) {
  745. ERR_FAIL_INDEX(p_index, settings.size());
  746. Vector<SpringBone3DJointSetting *> &joints = settings[p_index]->joints;
  747. ERR_FAIL_INDEX(p_joint, joints.size());
  748. joints[p_joint]->bone = p_bone;
  749. Skeleton3D *sk = get_skeleton();
  750. if (sk) {
  751. if (joints[p_joint]->bone <= -1 || joints[p_joint]->bone >= sk->get_bone_count()) {
  752. WARN_PRINT("Joint bone index out of range!");
  753. joints[p_joint]->bone = -1;
  754. } else {
  755. joints[p_joint]->bone_name = sk->get_bone_name(joints[p_joint]->bone);
  756. }
  757. }
  758. }
  759. int SpringBoneSimulator3D::get_joint_bone(int p_index, int p_joint) const {
  760. ERR_FAIL_INDEX_V(p_index, settings.size(), -1);
  761. Vector<SpringBone3DJointSetting *> joints = settings[p_index]->joints;
  762. ERR_FAIL_INDEX_V(p_joint, joints.size(), -1);
  763. return joints[p_joint]->bone;
  764. }
  765. void SpringBoneSimulator3D::set_joint_radius(int p_index, int p_joint, float p_radius) {
  766. ERR_FAIL_INDEX(p_index, settings.size());
  767. if (!is_config_individual(p_index)) {
  768. return; // Joints are read-only.
  769. }
  770. Vector<SpringBone3DJointSetting *> &joints = settings[p_index]->joints;
  771. ERR_FAIL_INDEX(p_joint, joints.size());
  772. joints[p_joint]->radius = p_radius;
  773. #ifdef TOOLS_ENABLED
  774. update_gizmos();
  775. #endif // TOOLS_ENABLED
  776. }
  777. float SpringBoneSimulator3D::get_joint_radius(int p_index, int p_joint) const {
  778. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  779. Vector<SpringBone3DJointSetting *> joints = settings[p_index]->joints;
  780. ERR_FAIL_INDEX_V(p_joint, joints.size(), 0);
  781. return joints[p_joint]->radius;
  782. }
  783. void SpringBoneSimulator3D::set_joint_stiffness(int p_index, int p_joint, float p_stiffness) {
  784. ERR_FAIL_INDEX(p_index, settings.size());
  785. if (!is_config_individual(p_index)) {
  786. return; // Joints are read-only.
  787. }
  788. Vector<SpringBone3DJointSetting *> &joints = settings[p_index]->joints;
  789. ERR_FAIL_INDEX(p_joint, joints.size());
  790. joints[p_joint]->stiffness = p_stiffness;
  791. }
  792. float SpringBoneSimulator3D::get_joint_stiffness(int p_index, int p_joint) const {
  793. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  794. Vector<SpringBone3DJointSetting *> joints = settings[p_index]->joints;
  795. ERR_FAIL_INDEX_V(p_joint, joints.size(), 0);
  796. return joints[p_joint]->stiffness;
  797. }
  798. void SpringBoneSimulator3D::set_joint_drag(int p_index, int p_joint, float p_drag) {
  799. ERR_FAIL_INDEX(p_index, settings.size());
  800. if (!is_config_individual(p_index)) {
  801. return; // Joints are read-only.
  802. }
  803. Vector<SpringBone3DJointSetting *> &joints = settings[p_index]->joints;
  804. ERR_FAIL_INDEX(p_joint, joints.size());
  805. joints[p_joint]->drag = p_drag;
  806. }
  807. float SpringBoneSimulator3D::get_joint_drag(int p_index, int p_joint) const {
  808. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  809. Vector<SpringBone3DJointSetting *> joints = settings[p_index]->joints;
  810. ERR_FAIL_INDEX_V(p_joint, joints.size(), 0);
  811. return joints[p_joint]->drag;
  812. }
  813. void SpringBoneSimulator3D::set_joint_gravity(int p_index, int p_joint, float p_gravity) {
  814. ERR_FAIL_INDEX(p_index, settings.size());
  815. if (!is_config_individual(p_index)) {
  816. return; // Joints are read-only.
  817. }
  818. Vector<SpringBone3DJointSetting *> &joints = settings[p_index]->joints;
  819. ERR_FAIL_INDEX(p_joint, joints.size());
  820. joints[p_joint]->gravity = p_gravity;
  821. }
  822. float SpringBoneSimulator3D::get_joint_gravity(int p_index, int p_joint) const {
  823. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  824. Vector<SpringBone3DJointSetting *> joints = settings[p_index]->joints;
  825. ERR_FAIL_INDEX_V(p_joint, joints.size(), 0);
  826. return joints[p_joint]->gravity;
  827. }
  828. void SpringBoneSimulator3D::set_joint_gravity_direction(int p_index, int p_joint, const Vector3 &p_gravity_direction) {
  829. ERR_FAIL_INDEX(p_index, settings.size());
  830. ERR_FAIL_COND(p_gravity_direction.is_zero_approx());
  831. if (!is_config_individual(p_index)) {
  832. return; // Joints are read-only.
  833. }
  834. Vector<SpringBone3DJointSetting *> &joints = settings[p_index]->joints;
  835. ERR_FAIL_INDEX(p_joint, joints.size());
  836. joints[p_joint]->gravity_direction = p_gravity_direction;
  837. }
  838. Vector3 SpringBoneSimulator3D::get_joint_gravity_direction(int p_index, int p_joint) const {
  839. ERR_FAIL_INDEX_V(p_index, settings.size(), Vector3(0, -1, 0));
  840. Vector<SpringBone3DJointSetting *> joints = settings[p_index]->joints;
  841. ERR_FAIL_INDEX_V(p_joint, joints.size(), Vector3(0, -1, 0));
  842. return joints[p_joint]->gravity_direction;
  843. }
  844. void SpringBoneSimulator3D::set_joint_rotation_axis(int p_index, int p_joint, RotationAxis p_axis) {
  845. ERR_FAIL_INDEX(p_index, settings.size());
  846. if (!is_config_individual(p_index)) {
  847. return; // Joints are read-only.
  848. }
  849. Vector<SpringBone3DJointSetting *> &joints = settings[p_index]->joints;
  850. ERR_FAIL_INDEX(p_joint, joints.size());
  851. joints[p_joint]->rotation_axis = p_axis;
  852. Skeleton3D *sk = get_skeleton();
  853. if (sk) {
  854. _validate_rotation_axis(sk, p_index, p_joint);
  855. }
  856. }
  857. SpringBoneSimulator3D::RotationAxis SpringBoneSimulator3D::get_joint_rotation_axis(int p_index, int p_joint) const {
  858. ERR_FAIL_INDEX_V(p_index, settings.size(), ROTATION_AXIS_ALL);
  859. Vector<SpringBone3DJointSetting *> joints = settings[p_index]->joints;
  860. ERR_FAIL_INDEX_V(p_joint, joints.size(), ROTATION_AXIS_ALL);
  861. return joints[p_joint]->rotation_axis;
  862. }
  863. void SpringBoneSimulator3D::set_joint_count(int p_index, int p_count) {
  864. ERR_FAIL_INDEX(p_index, settings.size());
  865. ERR_FAIL_COND(p_count < 0);
  866. Vector<SpringBone3DJointSetting *> &joints = settings[p_index]->joints;
  867. int delta = p_count - joints.size() + 1;
  868. joints.resize(p_count);
  869. if (delta > 1) {
  870. for (int i = 1; i < delta; i++) {
  871. joints.write[p_count - i] = memnew(SpringBone3DJointSetting);
  872. }
  873. }
  874. notify_property_list_changed();
  875. }
  876. int SpringBoneSimulator3D::get_joint_count(int p_index) const {
  877. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  878. Vector<SpringBone3DJointSetting *> joints = settings[p_index]->joints;
  879. return joints.size();
  880. }
  881. // Individual collisions.
  882. void SpringBoneSimulator3D::set_enable_all_child_collisions(int p_index, bool p_enabled) {
  883. ERR_FAIL_INDEX(p_index, settings.size());
  884. settings[p_index]->enable_all_child_collisions = p_enabled;
  885. notify_property_list_changed();
  886. }
  887. bool SpringBoneSimulator3D::are_all_child_collisions_enabled(int p_index) const {
  888. ERR_FAIL_INDEX_V(p_index, settings.size(), false);
  889. return settings[p_index]->enable_all_child_collisions;
  890. }
  891. void SpringBoneSimulator3D::set_exclude_collision_path(int p_index, int p_collision, const NodePath &p_node_path) {
  892. ERR_FAIL_INDEX(p_index, settings.size());
  893. if (!are_all_child_collisions_enabled(p_index)) {
  894. return; // Exclude collision list is disabled.
  895. }
  896. Vector<NodePath> &setting_exclude_collisions = settings[p_index]->exclude_collisions;
  897. ERR_FAIL_INDEX(p_collision, setting_exclude_collisions.size());
  898. setting_exclude_collisions.write[p_collision] = NodePath(); // Reset first.
  899. if (is_inside_tree()) {
  900. Node *node = get_node_or_null(p_node_path);
  901. if (!node) {
  902. _make_collisions_dirty();
  903. return;
  904. }
  905. node = node->get_parent();
  906. if (!node || node != this) {
  907. _make_collisions_dirty();
  908. ERR_FAIL_EDMSG("Collision must be child of current SpringBoneSimulator3D.");
  909. }
  910. }
  911. setting_exclude_collisions.write[p_collision] = p_node_path;
  912. _make_collisions_dirty();
  913. }
  914. NodePath SpringBoneSimulator3D::get_exclude_collision_path(int p_index, int p_collision) const {
  915. ERR_FAIL_INDEX_V(p_index, settings.size(), NodePath());
  916. Vector<NodePath> setting_exclude_collisions = settings[p_index]->exclude_collisions;
  917. ERR_FAIL_INDEX_V(p_collision, setting_exclude_collisions.size(), NodePath());
  918. return setting_exclude_collisions[p_collision];
  919. }
  920. void SpringBoneSimulator3D::set_exclude_collision_count(int p_index, int p_count) {
  921. ERR_FAIL_INDEX(p_index, settings.size());
  922. if (!are_all_child_collisions_enabled(p_index)) {
  923. return; // Exclude collision list is disabled.
  924. }
  925. Vector<NodePath> &setting_exclude_collisions = settings[p_index]->exclude_collisions;
  926. setting_exclude_collisions.resize(p_count);
  927. _make_collisions_dirty();
  928. notify_property_list_changed();
  929. }
  930. int SpringBoneSimulator3D::get_exclude_collision_count(int p_index) const {
  931. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  932. Vector<NodePath> setting_exclude_collisions = settings[p_index]->exclude_collisions;
  933. return setting_exclude_collisions.size();
  934. }
  935. void SpringBoneSimulator3D::clear_exclude_collisions(int p_index) {
  936. ERR_FAIL_INDEX(p_index, settings.size());
  937. if (!are_all_child_collisions_enabled(p_index)) {
  938. return; // Exclude collision list is disabled.
  939. }
  940. set_exclude_collision_count(p_index, 0);
  941. }
  942. void SpringBoneSimulator3D::set_collision_path(int p_index, int p_collision, const NodePath &p_node_path) {
  943. ERR_FAIL_INDEX(p_index, settings.size());
  944. if (are_all_child_collisions_enabled(p_index)) {
  945. return; // Collision list is disabled.
  946. }
  947. Vector<NodePath> &setting_collisions = settings[p_index]->collisions;
  948. ERR_FAIL_INDEX(p_collision, setting_collisions.size());
  949. setting_collisions.write[p_collision] = NodePath(); // Reset first.
  950. if (is_inside_tree()) {
  951. Node *node = get_node_or_null(p_node_path);
  952. if (!node) {
  953. _make_collisions_dirty();
  954. return;
  955. }
  956. node = node->get_parent();
  957. if (!node || node != this) {
  958. _make_collisions_dirty();
  959. ERR_FAIL_EDMSG("Collision must be child of current SpringBoneSimulator3D.");
  960. }
  961. }
  962. setting_collisions.write[p_collision] = p_node_path;
  963. _make_collisions_dirty();
  964. }
  965. NodePath SpringBoneSimulator3D::get_collision_path(int p_index, int p_collision) const {
  966. ERR_FAIL_INDEX_V(p_index, settings.size(), NodePath());
  967. Vector<NodePath> setting_collisions = settings[p_index]->collisions;
  968. ERR_FAIL_INDEX_V(p_collision, setting_collisions.size(), NodePath());
  969. return setting_collisions[p_collision];
  970. }
  971. void SpringBoneSimulator3D::set_collision_count(int p_index, int p_count) {
  972. ERR_FAIL_INDEX(p_index, settings.size());
  973. if (are_all_child_collisions_enabled(p_index)) {
  974. return; // Collision list is disabled.
  975. }
  976. Vector<NodePath> &setting_collisions = settings[p_index]->collisions;
  977. setting_collisions.resize(p_count);
  978. _make_collisions_dirty();
  979. notify_property_list_changed();
  980. }
  981. int SpringBoneSimulator3D::get_collision_count(int p_index) const {
  982. ERR_FAIL_INDEX_V(p_index, settings.size(), 0);
  983. Vector<NodePath> setting_collisions = settings[p_index]->collisions;
  984. return setting_collisions.size();
  985. }
  986. void SpringBoneSimulator3D::clear_collisions(int p_index) {
  987. ERR_FAIL_INDEX(p_index, settings.size());
  988. if (are_all_child_collisions_enabled(p_index)) {
  989. return; // Collision list is disabled.
  990. }
  991. set_collision_count(p_index, 0);
  992. }
  993. LocalVector<ObjectID> SpringBoneSimulator3D::get_valid_collision_instance_ids(int p_index) {
  994. ERR_FAIL_INDEX_V(p_index, settings.size(), LocalVector<ObjectID>());
  995. if (collisions_dirty) {
  996. _find_collisions();
  997. }
  998. return settings[p_index]->cached_collisions;
  999. }
  1000. void SpringBoneSimulator3D::_bind_methods() {
  1001. // Setting.
  1002. ClassDB::bind_method(D_METHOD("set_root_bone_name", "index", "bone_name"), &SpringBoneSimulator3D::set_root_bone_name);
  1003. ClassDB::bind_method(D_METHOD("get_root_bone_name", "index"), &SpringBoneSimulator3D::get_root_bone_name);
  1004. ClassDB::bind_method(D_METHOD("set_root_bone", "index", "bone"), &SpringBoneSimulator3D::set_root_bone);
  1005. ClassDB::bind_method(D_METHOD("get_root_bone", "index"), &SpringBoneSimulator3D::get_root_bone);
  1006. ClassDB::bind_method(D_METHOD("set_end_bone_name", "index", "bone_name"), &SpringBoneSimulator3D::set_end_bone_name);
  1007. ClassDB::bind_method(D_METHOD("get_end_bone_name", "index"), &SpringBoneSimulator3D::get_end_bone_name);
  1008. ClassDB::bind_method(D_METHOD("set_end_bone", "index", "bone"), &SpringBoneSimulator3D::set_end_bone);
  1009. ClassDB::bind_method(D_METHOD("get_end_bone", "index"), &SpringBoneSimulator3D::get_end_bone);
  1010. ClassDB::bind_method(D_METHOD("set_extend_end_bone", "index", "enabled"), &SpringBoneSimulator3D::set_extend_end_bone);
  1011. ClassDB::bind_method(D_METHOD("is_end_bone_extended", "index"), &SpringBoneSimulator3D::is_end_bone_extended);
  1012. ClassDB::bind_method(D_METHOD("set_end_bone_direction", "index", "bone_direction"), &SpringBoneSimulator3D::set_end_bone_direction);
  1013. ClassDB::bind_method(D_METHOD("get_end_bone_direction", "index"), &SpringBoneSimulator3D::get_end_bone_direction);
  1014. ClassDB::bind_method(D_METHOD("set_end_bone_length", "index", "length"), &SpringBoneSimulator3D::set_end_bone_length);
  1015. ClassDB::bind_method(D_METHOD("get_end_bone_length", "index"), &SpringBoneSimulator3D::get_end_bone_length);
  1016. ClassDB::bind_method(D_METHOD("set_center_from", "index", "center_from"), &SpringBoneSimulator3D::set_center_from);
  1017. ClassDB::bind_method(D_METHOD("get_center_from", "index"), &SpringBoneSimulator3D::get_center_from);
  1018. ClassDB::bind_method(D_METHOD("set_center_node", "index", "node_path"), &SpringBoneSimulator3D::set_center_node);
  1019. ClassDB::bind_method(D_METHOD("get_center_node", "index"), &SpringBoneSimulator3D::get_center_node);
  1020. ClassDB::bind_method(D_METHOD("set_center_bone_name", "index", "bone_name"), &SpringBoneSimulator3D::set_center_bone_name);
  1021. ClassDB::bind_method(D_METHOD("get_center_bone_name", "index"), &SpringBoneSimulator3D::get_center_bone_name);
  1022. ClassDB::bind_method(D_METHOD("set_center_bone", "index", "bone"), &SpringBoneSimulator3D::set_center_bone);
  1023. ClassDB::bind_method(D_METHOD("get_center_bone", "index"), &SpringBoneSimulator3D::get_center_bone);
  1024. ClassDB::bind_method(D_METHOD("set_radius", "index", "radius"), &SpringBoneSimulator3D::set_radius);
  1025. ClassDB::bind_method(D_METHOD("get_radius", "index"), &SpringBoneSimulator3D::get_radius);
  1026. ClassDB::bind_method(D_METHOD("set_rotation_axis", "index", "axis"), &SpringBoneSimulator3D::set_rotation_axis);
  1027. ClassDB::bind_method(D_METHOD("get_rotation_axis", "index"), &SpringBoneSimulator3D::get_rotation_axis);
  1028. ClassDB::bind_method(D_METHOD("set_radius_damping_curve", "index", "curve"), &SpringBoneSimulator3D::set_radius_damping_curve);
  1029. ClassDB::bind_method(D_METHOD("get_radius_damping_curve", "index"), &SpringBoneSimulator3D::get_radius_damping_curve);
  1030. ClassDB::bind_method(D_METHOD("set_stiffness", "index", "stiffness"), &SpringBoneSimulator3D::set_stiffness);
  1031. ClassDB::bind_method(D_METHOD("get_stiffness", "index"), &SpringBoneSimulator3D::get_stiffness);
  1032. ClassDB::bind_method(D_METHOD("set_stiffness_damping_curve", "index", "curve"), &SpringBoneSimulator3D::set_stiffness_damping_curve);
  1033. ClassDB::bind_method(D_METHOD("get_stiffness_damping_curve", "index"), &SpringBoneSimulator3D::get_stiffness_damping_curve);
  1034. ClassDB::bind_method(D_METHOD("set_drag", "index", "drag"), &SpringBoneSimulator3D::set_drag);
  1035. ClassDB::bind_method(D_METHOD("get_drag", "index"), &SpringBoneSimulator3D::get_drag);
  1036. ClassDB::bind_method(D_METHOD("set_drag_damping_curve", "index", "curve"), &SpringBoneSimulator3D::set_drag_damping_curve);
  1037. ClassDB::bind_method(D_METHOD("get_drag_damping_curve", "index"), &SpringBoneSimulator3D::get_drag_damping_curve);
  1038. ClassDB::bind_method(D_METHOD("set_gravity", "index", "gravity"), &SpringBoneSimulator3D::set_gravity);
  1039. ClassDB::bind_method(D_METHOD("get_gravity", "index"), &SpringBoneSimulator3D::get_gravity);
  1040. ClassDB::bind_method(D_METHOD("set_gravity_damping_curve", "index", "curve"), &SpringBoneSimulator3D::set_gravity_damping_curve);
  1041. ClassDB::bind_method(D_METHOD("get_gravity_damping_curve", "index"), &SpringBoneSimulator3D::get_gravity_damping_curve);
  1042. ClassDB::bind_method(D_METHOD("set_gravity_direction", "index", "gravity_direction"), &SpringBoneSimulator3D::set_gravity_direction);
  1043. ClassDB::bind_method(D_METHOD("get_gravity_direction", "index"), &SpringBoneSimulator3D::get_gravity_direction);
  1044. ClassDB::bind_method(D_METHOD("set_setting_count", "count"), &SpringBoneSimulator3D::set_setting_count);
  1045. ClassDB::bind_method(D_METHOD("get_setting_count"), &SpringBoneSimulator3D::get_setting_count);
  1046. ClassDB::bind_method(D_METHOD("clear_settings"), &SpringBoneSimulator3D::clear_settings);
  1047. // Individual joints.
  1048. ClassDB::bind_method(D_METHOD("set_individual_config", "index", "enabled"), &SpringBoneSimulator3D::set_individual_config);
  1049. ClassDB::bind_method(D_METHOD("is_config_individual", "index"), &SpringBoneSimulator3D::is_config_individual);
  1050. ClassDB::bind_method(D_METHOD("get_joint_bone_name", "index", "joint"), &SpringBoneSimulator3D::get_joint_bone_name);
  1051. ClassDB::bind_method(D_METHOD("get_joint_bone", "index", "joint"), &SpringBoneSimulator3D::get_joint_bone);
  1052. ClassDB::bind_method(D_METHOD("set_joint_rotation_axis", "index", "joint", "axis"), &SpringBoneSimulator3D::set_joint_rotation_axis);
  1053. ClassDB::bind_method(D_METHOD("get_joint_rotation_axis", "index", "joint"), &SpringBoneSimulator3D::get_joint_rotation_axis);
  1054. ClassDB::bind_method(D_METHOD("set_joint_radius", "index", "joint", "radius"), &SpringBoneSimulator3D::set_joint_radius);
  1055. ClassDB::bind_method(D_METHOD("get_joint_radius", "index", "joint"), &SpringBoneSimulator3D::get_joint_radius);
  1056. ClassDB::bind_method(D_METHOD("set_joint_stiffness", "index", "joint", "stiffness"), &SpringBoneSimulator3D::set_joint_stiffness);
  1057. ClassDB::bind_method(D_METHOD("get_joint_stiffness", "index", "joint"), &SpringBoneSimulator3D::get_joint_stiffness);
  1058. ClassDB::bind_method(D_METHOD("set_joint_drag", "index", "joint", "drag"), &SpringBoneSimulator3D::set_joint_drag);
  1059. ClassDB::bind_method(D_METHOD("get_joint_drag", "index", "joint"), &SpringBoneSimulator3D::get_joint_drag);
  1060. ClassDB::bind_method(D_METHOD("set_joint_gravity", "index", "joint", "gravity"), &SpringBoneSimulator3D::set_joint_gravity);
  1061. ClassDB::bind_method(D_METHOD("get_joint_gravity", "index", "joint"), &SpringBoneSimulator3D::get_joint_gravity);
  1062. ClassDB::bind_method(D_METHOD("set_joint_gravity_direction", "index", "joint", "gravity_direction"), &SpringBoneSimulator3D::set_joint_gravity_direction);
  1063. ClassDB::bind_method(D_METHOD("get_joint_gravity_direction", "index", "joint"), &SpringBoneSimulator3D::get_joint_gravity_direction);
  1064. ClassDB::bind_method(D_METHOD("get_joint_count", "index"), &SpringBoneSimulator3D::get_joint_count);
  1065. // Individual collisions.
  1066. ClassDB::bind_method(D_METHOD("set_enable_all_child_collisions", "index", "enabled"), &SpringBoneSimulator3D::set_enable_all_child_collisions);
  1067. ClassDB::bind_method(D_METHOD("are_all_child_collisions_enabled", "index"), &SpringBoneSimulator3D::are_all_child_collisions_enabled);
  1068. ClassDB::bind_method(D_METHOD("set_exclude_collision_path", "index", "collision", "node_path"), &SpringBoneSimulator3D::set_exclude_collision_path);
  1069. ClassDB::bind_method(D_METHOD("get_exclude_collision_path", "index", "collision"), &SpringBoneSimulator3D::get_exclude_collision_path);
  1070. ClassDB::bind_method(D_METHOD("set_exclude_collision_count", "index", "count"), &SpringBoneSimulator3D::set_exclude_collision_count);
  1071. ClassDB::bind_method(D_METHOD("get_exclude_collision_count", "index"), &SpringBoneSimulator3D::get_exclude_collision_count);
  1072. ClassDB::bind_method(D_METHOD("clear_exclude_collisions", "index"), &SpringBoneSimulator3D::clear_exclude_collisions);
  1073. ClassDB::bind_method(D_METHOD("set_collision_path", "index", "collision", "node_path"), &SpringBoneSimulator3D::set_collision_path);
  1074. ClassDB::bind_method(D_METHOD("get_collision_path", "index", "collision"), &SpringBoneSimulator3D::get_collision_path);
  1075. ClassDB::bind_method(D_METHOD("set_collision_count", "index", "count"), &SpringBoneSimulator3D::set_collision_count);
  1076. ClassDB::bind_method(D_METHOD("get_collision_count", "index"), &SpringBoneSimulator3D::get_collision_count);
  1077. ClassDB::bind_method(D_METHOD("clear_collisions", "index"), &SpringBoneSimulator3D::clear_collisions);
  1078. // To process manually.
  1079. ClassDB::bind_method(D_METHOD("reset"), &SpringBoneSimulator3D::reset);
  1080. ADD_ARRAY_COUNT("Settings", "setting_count", "set_setting_count", "get_setting_count", "settings/");
  1081. BIND_ENUM_CONSTANT(BONE_DIRECTION_PLUS_X);
  1082. BIND_ENUM_CONSTANT(BONE_DIRECTION_MINUS_X);
  1083. BIND_ENUM_CONSTANT(BONE_DIRECTION_PLUS_Y);
  1084. BIND_ENUM_CONSTANT(BONE_DIRECTION_MINUS_Y);
  1085. BIND_ENUM_CONSTANT(BONE_DIRECTION_PLUS_Z);
  1086. BIND_ENUM_CONSTANT(BONE_DIRECTION_MINUS_Z);
  1087. BIND_ENUM_CONSTANT(BONE_DIRECTION_FROM_PARENT);
  1088. BIND_ENUM_CONSTANT(CENTER_FROM_WORLD_ORIGIN);
  1089. BIND_ENUM_CONSTANT(CENTER_FROM_NODE);
  1090. BIND_ENUM_CONSTANT(CENTER_FROM_BONE);
  1091. BIND_ENUM_CONSTANT(ROTATION_AXIS_X);
  1092. BIND_ENUM_CONSTANT(ROTATION_AXIS_Y);
  1093. BIND_ENUM_CONSTANT(ROTATION_AXIS_Z);
  1094. BIND_ENUM_CONSTANT(ROTATION_AXIS_ALL);
  1095. }
  1096. void SpringBoneSimulator3D::_make_joints_dirty(int p_index) {
  1097. ERR_FAIL_INDEX(p_index, settings.size());
  1098. settings[p_index]->joints_dirty = true;
  1099. if (joints_dirty) {
  1100. return;
  1101. }
  1102. joints_dirty = true;
  1103. callable_mp(this, &SpringBoneSimulator3D::_update_joints).call_deferred();
  1104. }
  1105. void SpringBoneSimulator3D::_make_all_joints_dirty() {
  1106. for (int i = 0; i < settings.size(); i++) {
  1107. _update_joint_array(i);
  1108. }
  1109. }
  1110. void SpringBoneSimulator3D::add_child_notify(Node *p_child) {
  1111. if (Object::cast_to<SpringBoneCollision3D>(p_child)) {
  1112. _make_collisions_dirty();
  1113. }
  1114. }
  1115. void SpringBoneSimulator3D::move_child_notify(Node *p_child) {
  1116. if (Object::cast_to<SpringBoneCollision3D>(p_child)) {
  1117. _make_collisions_dirty();
  1118. }
  1119. }
  1120. void SpringBoneSimulator3D::remove_child_notify(Node *p_child) {
  1121. if (Object::cast_to<SpringBoneCollision3D>(p_child)) {
  1122. _make_collisions_dirty();
  1123. }
  1124. }
  1125. void SpringBoneSimulator3D::_validate_rotation_axes(Skeleton3D *p_skeleton) const {
  1126. for (int i = 0; i < settings.size(); i++) {
  1127. for (int j = 0; j < settings[i]->joints.size(); j++) {
  1128. _validate_rotation_axis(p_skeleton, i, j);
  1129. }
  1130. }
  1131. }
  1132. void SpringBoneSimulator3D::_validate_rotation_axis(Skeleton3D *p_skeleton, int p_index, int p_joint) const {
  1133. RotationAxis axis = settings[p_index]->joints[p_joint]->rotation_axis;
  1134. if (axis == ROTATION_AXIS_ALL) {
  1135. return;
  1136. }
  1137. Vector3 rot = get_vector_from_axis(static_cast<Vector3::Axis>((int)axis));
  1138. Vector3 fwd;
  1139. if (p_joint < settings[p_index]->joints.size() - 1) {
  1140. fwd = p_skeleton->get_bone_rest(settings[p_index]->joints[p_joint + 1]->bone).origin;
  1141. } else if (settings[p_index]->extend_end_bone) {
  1142. fwd = get_end_bone_axis(settings[p_index]->end_bone, settings[p_index]->end_bone_direction);
  1143. if (fwd.is_zero_approx()) {
  1144. return;
  1145. }
  1146. }
  1147. fwd.normalize();
  1148. if (Math::is_equal_approx(Math::absf(rot.dot(fwd)), 1.0f)) {
  1149. WARN_PRINT_ED("Setting: " + itos(p_index) + " Joint: " + itos(p_joint) + ": Rotation axis and forward vectors are colinear. This is not advised as it may cause unwanted rotation.");
  1150. }
  1151. }
  1152. void SpringBoneSimulator3D::_find_collisions() {
  1153. if (!collisions_dirty) {
  1154. return;
  1155. }
  1156. collisions.clear();
  1157. for (int i = 0; i < get_child_count(); i++) {
  1158. SpringBoneCollision3D *c = Object::cast_to<SpringBoneCollision3D>(get_child(i));
  1159. if (c) {
  1160. collisions.push_back(c->get_instance_id());
  1161. }
  1162. }
  1163. bool setting_updated = false;
  1164. for (int i = 0; i < settings.size(); i++) {
  1165. LocalVector<ObjectID> &cache = settings[i]->cached_collisions;
  1166. cache.clear();
  1167. if (!settings[i]->enable_all_child_collisions) {
  1168. // Allow list.
  1169. Vector<NodePath> &setting_collisions = settings[i]->collisions;
  1170. for (int j = 0; j < setting_collisions.size(); j++) {
  1171. Node *n = get_node_or_null(setting_collisions[j]);
  1172. if (!n) {
  1173. continue;
  1174. }
  1175. ObjectID id = n->get_instance_id();
  1176. if (!collisions.has(id)) {
  1177. setting_collisions.write[j] = NodePath(); // Clear path if not found.
  1178. } else {
  1179. cache.push_back(id);
  1180. }
  1181. }
  1182. } else {
  1183. // Deny list.
  1184. LocalVector<uint32_t> masks;
  1185. Vector<NodePath> &setting_exclude_collisions = settings[i]->exclude_collisions;
  1186. for (int j = 0; j < setting_exclude_collisions.size(); j++) {
  1187. Node *n = get_node_or_null(setting_exclude_collisions[j]);
  1188. if (!n) {
  1189. continue;
  1190. }
  1191. ObjectID id = n->get_instance_id();
  1192. int find = collisions.find(id);
  1193. if (find < 0) {
  1194. setting_exclude_collisions.write[j] = NodePath(); // Clear path if not found.
  1195. } else {
  1196. masks.push_back((uint32_t)find);
  1197. }
  1198. }
  1199. uint32_t mask_index = 0;
  1200. for (uint32_t j = 0; j < collisions.size(); j++) {
  1201. if (mask_index < masks.size() && j == masks[mask_index]) {
  1202. mask_index++;
  1203. continue;
  1204. }
  1205. cache.push_back(collisions[j]);
  1206. }
  1207. }
  1208. }
  1209. collisions_dirty = false;
  1210. if (setting_updated) {
  1211. notify_property_list_changed();
  1212. }
  1213. }
  1214. void SpringBoneSimulator3D::_process_collisions() {
  1215. for (const ObjectID &oid : collisions) {
  1216. Object *t_obj = ObjectDB::get_instance(oid);
  1217. if (!t_obj) {
  1218. continue;
  1219. }
  1220. SpringBoneCollision3D *col = Object::cast_to<SpringBoneCollision3D>(t_obj);
  1221. if (!col) {
  1222. continue;
  1223. }
  1224. col->sync_pose();
  1225. }
  1226. }
  1227. void SpringBoneSimulator3D::_make_collisions_dirty() {
  1228. collisions_dirty = true;
  1229. }
  1230. void SpringBoneSimulator3D::_update_joint_array(int p_index) {
  1231. _make_joints_dirty(p_index);
  1232. Skeleton3D *sk = get_skeleton();
  1233. int current_bone = settings[p_index]->end_bone;
  1234. int root_bone = settings[p_index]->root_bone;
  1235. if (!sk || current_bone < 0 || root_bone < 0) {
  1236. set_joint_count(p_index, 0);
  1237. return;
  1238. }
  1239. // Validation.
  1240. bool valid = false;
  1241. while (current_bone >= 0) {
  1242. if (current_bone == root_bone) {
  1243. valid = true;
  1244. break;
  1245. }
  1246. current_bone = sk->get_bone_parent(current_bone);
  1247. }
  1248. if (!valid) {
  1249. set_joint_count(p_index, 0);
  1250. ERR_FAIL_EDMSG("End bone must be the same as or a child of root bone.");
  1251. }
  1252. Vector<int> new_joints;
  1253. current_bone = settings[p_index]->end_bone;
  1254. while (current_bone != root_bone) {
  1255. new_joints.push_back(current_bone);
  1256. current_bone = sk->get_bone_parent(current_bone);
  1257. }
  1258. new_joints.push_back(current_bone);
  1259. new_joints.reverse();
  1260. set_joint_count(p_index, new_joints.size());
  1261. for (int i = 0; i < new_joints.size(); i++) {
  1262. set_joint_bone(p_index, i, new_joints[i]);
  1263. }
  1264. }
  1265. void SpringBoneSimulator3D::_update_joints() {
  1266. if (!joints_dirty) {
  1267. return;
  1268. }
  1269. for (int i = 0; i < settings.size(); i++) {
  1270. if (!settings[i]->joints_dirty) {
  1271. continue;
  1272. }
  1273. if (settings[i]->individual_config) {
  1274. settings[i]->simulation_dirty = true;
  1275. settings[i]->joints_dirty = false;
  1276. continue; // Abort.
  1277. }
  1278. Vector<SpringBone3DJointSetting *> &joints = settings[i]->joints;
  1279. float unit = joints.size() > 0 ? (1.0 / float(joints.size() - 1)) : 0.0;
  1280. for (int j = 0; j < joints.size(); j++) {
  1281. float offset = j * unit;
  1282. if (settings[i]->radius_damping_curve.is_valid()) {
  1283. joints[j]->radius = settings[i]->radius * settings[i]->radius_damping_curve->sample_baked(offset);
  1284. } else {
  1285. joints[j]->radius = settings[i]->radius;
  1286. }
  1287. if (settings[i]->stiffness_damping_curve.is_valid()) {
  1288. joints[j]->stiffness = settings[i]->stiffness * settings[i]->stiffness_damping_curve->sample_baked(offset);
  1289. } else {
  1290. joints[j]->stiffness = settings[i]->stiffness;
  1291. }
  1292. if (settings[i]->drag_damping_curve.is_valid()) {
  1293. joints[j]->drag = settings[i]->drag * settings[i]->drag_damping_curve->sample_baked(offset);
  1294. } else {
  1295. joints[j]->drag = settings[i]->drag;
  1296. }
  1297. if (settings[i]->gravity_damping_curve.is_valid()) {
  1298. joints[j]->gravity = settings[i]->gravity * settings[i]->gravity_damping_curve->sample_baked(offset);
  1299. } else {
  1300. joints[j]->gravity = settings[i]->gravity;
  1301. }
  1302. joints[j]->gravity_direction = settings[i]->gravity_direction;
  1303. joints[j]->rotation_axis = settings[i]->rotation_axis;
  1304. }
  1305. settings[i]->simulation_dirty = true;
  1306. settings[i]->joints_dirty = false;
  1307. }
  1308. joints_dirty = false;
  1309. Skeleton3D *sk = get_skeleton();
  1310. if (sk) {
  1311. _validate_rotation_axes(sk);
  1312. }
  1313. #ifdef TOOLS_ENABLED
  1314. update_gizmos();
  1315. #endif // TOOLS_ENABLED
  1316. }
  1317. void SpringBoneSimulator3D::_set_active(bool p_active) {
  1318. if (p_active) {
  1319. reset();
  1320. }
  1321. }
  1322. void SpringBoneSimulator3D::_process_modification() {
  1323. Skeleton3D *skeleton = get_skeleton();
  1324. if (!skeleton) {
  1325. return;
  1326. }
  1327. _find_collisions();
  1328. _process_collisions();
  1329. #ifdef TOOLS_ENABLED
  1330. if (saving) {
  1331. return; // Collision position has been reset but we don't want to process simulating on saving. Abort.
  1332. }
  1333. #endif //TOOLS_ENABLED
  1334. double delta = skeleton->get_modifier_callback_mode_process() == Skeleton3D::MODIFIER_CALLBACK_MODE_PROCESS_IDLE ? skeleton->get_process_delta_time() : skeleton->get_physics_process_delta_time();
  1335. for (int i = 0; i < settings.size(); i++) {
  1336. _init_joints(skeleton, settings[i]);
  1337. _process_joints(delta, skeleton, settings[i]->joints, get_valid_collision_instance_ids(i), settings[i]->cached_center, settings[i]->cached_inverted_center, settings[i]->cached_inverted_center.basis.get_rotation_quaternion());
  1338. }
  1339. }
  1340. void SpringBoneSimulator3D::reset() {
  1341. Skeleton3D *skeleton = get_skeleton();
  1342. if (!skeleton) {
  1343. return;
  1344. }
  1345. _find_collisions();
  1346. _process_collisions();
  1347. for (int i = 0; i < settings.size(); i++) {
  1348. settings[i]->simulation_dirty = true;
  1349. _init_joints(skeleton, settings[i]);
  1350. }
  1351. }
  1352. void SpringBoneSimulator3D::_init_joints(Skeleton3D *p_skeleton, SpringBone3DSetting *setting) {
  1353. if (setting->center_from == CENTER_FROM_WORLD_ORIGIN) {
  1354. setting->cached_center = p_skeleton->get_global_transform();
  1355. } else if (setting->center_from == CENTER_FROM_NODE) {
  1356. if (setting->center_node == NodePath()) {
  1357. setting->cached_center = Transform3D();
  1358. } else {
  1359. Node3D *nd = Object::cast_to<Node3D>(get_node_or_null(setting->center_node));
  1360. if (!nd) {
  1361. setting->cached_center = Transform3D();
  1362. } else {
  1363. setting->cached_center = nd->get_global_transform().affine_inverse() * p_skeleton->get_global_transform();
  1364. }
  1365. }
  1366. } else {
  1367. if (setting->center_bone >= 0) {
  1368. setting->cached_center = p_skeleton->get_bone_global_pose(setting->center_bone);
  1369. } else {
  1370. setting->cached_center = Transform3D();
  1371. }
  1372. }
  1373. setting->cached_inverted_center = setting->cached_center.affine_inverse();
  1374. if (!setting->simulation_dirty) {
  1375. return;
  1376. }
  1377. for (int i = 0; i < setting->joints.size(); i++) {
  1378. if (setting->joints[i]->verlet) {
  1379. memdelete(setting->joints[i]->verlet);
  1380. setting->joints[i]->verlet = nullptr;
  1381. }
  1382. if (i < setting->joints.size() - 1) {
  1383. setting->joints[i]->verlet = memnew(SpringBone3DVerletInfo);
  1384. Vector3 axis = p_skeleton->get_bone_rest(setting->joints[i + 1]->bone).origin;
  1385. setting->joints[i]->verlet->current_tail = setting->cached_center.xform(p_skeleton->get_bone_global_pose(setting->joints[i]->bone).xform(axis));
  1386. setting->joints[i]->verlet->prev_tail = setting->joints[i]->verlet->current_tail;
  1387. setting->joints[i]->verlet->forward_vector = axis.normalized();
  1388. setting->joints[i]->verlet->length = axis.length();
  1389. setting->joints[i]->verlet->current_rot = Quaternion(0, 0, 0, 1);
  1390. } else if (setting->extend_end_bone && setting->end_bone_length > 0) {
  1391. Vector3 axis = get_end_bone_axis(setting->end_bone, setting->end_bone_direction);
  1392. if (axis.is_zero_approx()) {
  1393. continue;
  1394. }
  1395. setting->joints[i]->verlet = memnew(SpringBone3DVerletInfo);
  1396. setting->joints[i]->verlet->forward_vector = axis;
  1397. setting->joints[i]->verlet->length = setting->end_bone_length;
  1398. setting->joints[i]->verlet->current_tail = setting->cached_center.xform(p_skeleton->get_bone_global_pose(setting->joints[i]->bone).xform(axis * setting->end_bone_length));
  1399. setting->joints[i]->verlet->prev_tail = setting->joints[i]->verlet->current_tail;
  1400. setting->joints[i]->verlet->current_rot = Quaternion(0, 0, 0, 1);
  1401. }
  1402. }
  1403. setting->simulation_dirty = false;
  1404. }
  1405. Vector3 SpringBoneSimulator3D::snap_position_to_plane(const Transform3D &p_rest, RotationAxis p_axis, const Vector3 &p_position) {
  1406. if (p_axis == ROTATION_AXIS_ALL) {
  1407. return p_position;
  1408. }
  1409. Vector3 result = p_position;
  1410. result = p_rest.affine_inverse().xform(result);
  1411. result[(int)p_axis] = 0;
  1412. result = p_rest.xform(result);
  1413. return result;
  1414. }
  1415. Vector3 SpringBoneSimulator3D::limit_length(const Vector3 &p_origin, const Vector3 &p_destination, float p_length) {
  1416. return p_origin + (p_destination - p_origin).normalized() * p_length;
  1417. }
  1418. void SpringBoneSimulator3D::_process_joints(double p_delta, Skeleton3D *p_skeleton, Vector<SpringBone3DJointSetting *> &p_joints, const LocalVector<ObjectID> &p_collisions, const Transform3D &p_center_transform, const Transform3D &p_inverted_center_transform, const Quaternion &p_inverted_center_rotation) {
  1419. for (int i = 0; i < p_joints.size(); i++) {
  1420. SpringBone3DVerletInfo *verlet = p_joints[i]->verlet;
  1421. if (!verlet) {
  1422. continue; // Means not extended end bone.
  1423. }
  1424. Transform3D current_global_pose = p_skeleton->get_bone_global_pose(p_joints[i]->bone);
  1425. Transform3D current_world_pose = p_center_transform * current_global_pose;
  1426. Quaternion current_rot = current_global_pose.basis.get_rotation_quaternion();
  1427. Vector3 current_origin = p_center_transform.xform(current_global_pose.origin);
  1428. Vector3 external = p_inverted_center_rotation.xform(p_joints[i]->gravity_direction * p_joints[i]->gravity * p_delta);
  1429. // Integration of velocity by verlet.
  1430. Vector3 next_tail = verlet->current_tail +
  1431. (verlet->current_tail - verlet->prev_tail) * (1.0 - p_joints[i]->drag) +
  1432. p_center_transform.basis.get_rotation_quaternion().xform(current_rot.xform(verlet->forward_vector * (p_joints[i]->stiffness * p_delta)) + external);
  1433. // Snap to plane if axis locked.
  1434. next_tail = snap_position_to_plane(current_world_pose, p_joints[i]->rotation_axis, next_tail);
  1435. // Limit bone length.
  1436. next_tail = limit_length(current_origin, next_tail, verlet->length);
  1437. // Collision movement.
  1438. for (uint32_t j = 0; j < p_collisions.size(); j++) {
  1439. Object *obj = ObjectDB::get_instance(p_collisions[j]);
  1440. if (!obj) {
  1441. continue;
  1442. }
  1443. SpringBoneCollision3D *col = Object::cast_to<SpringBoneCollision3D>(obj);
  1444. if (col) {
  1445. // Collider movement should separate from the effect of the center.
  1446. next_tail = col->collide(p_center_transform, p_joints[i]->radius, verlet->length, next_tail);
  1447. // Snap to plane if axis locked.
  1448. next_tail = snap_position_to_plane(current_world_pose, p_joints[i]->rotation_axis, next_tail);
  1449. // Limit bone length.
  1450. next_tail = limit_length(current_origin, next_tail, verlet->length);
  1451. }
  1452. }
  1453. // Store current tails for next process.
  1454. verlet->prev_tail = verlet->current_tail;
  1455. verlet->current_tail = next_tail;
  1456. // Convert position to rotation.
  1457. Vector3 from = current_rot.xform(verlet->forward_vector);
  1458. Vector3 to = p_inverted_center_transform.basis.xform(next_tail - current_origin).normalized();
  1459. Quaternion from_to = get_from_to_rotation(from, to, verlet->current_rot);
  1460. verlet->current_rot = from_to;
  1461. // Apply rotation.
  1462. from_to *= current_rot;
  1463. from_to = get_local_pose_rotation(p_skeleton, p_joints[i]->bone, from_to);
  1464. p_skeleton->set_bone_pose_rotation(p_joints[i]->bone, from_to);
  1465. }
  1466. }
  1467. Quaternion SpringBoneSimulator3D::get_local_pose_rotation(Skeleton3D *p_skeleton, int p_bone, const Quaternion &p_global_pose_rotation) {
  1468. int parent = p_skeleton->get_bone_parent(p_bone);
  1469. if (parent < 0) {
  1470. return p_global_pose_rotation;
  1471. }
  1472. return p_skeleton->get_bone_global_pose(parent).basis.orthonormalized().inverse() * p_global_pose_rotation;
  1473. }
  1474. Quaternion SpringBoneSimulator3D::get_from_to_rotation(const Vector3 &p_from, const Vector3 &p_to, const Quaternion &p_prev_rot) {
  1475. if (Math::is_equal_approx((float)p_from.dot(p_to), -1.0f)) {
  1476. return p_prev_rot; // For preventing to glitch, checking dot for detecting flip is more accurate than checking cross.
  1477. }
  1478. Vector3 axis = p_from.cross(p_to);
  1479. if (axis.is_zero_approx()) {
  1480. return p_prev_rot;
  1481. }
  1482. float angle = p_from.angle_to(p_to);
  1483. if (Math::is_zero_approx(angle)) {
  1484. angle = 0.0;
  1485. }
  1486. return Quaternion(axis.normalized(), angle);
  1487. }