class_generic6dofjoint.rst 73 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Generic6DOFJoint.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Generic6DOFJoint:
  6. Generic6DOFJoint
  7. ================
  8. **Inherits:** :ref:`Joint<class_Joint>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. The generic 6-degrees-of-freedom joint can implement a variety of joint types by locking certain axes' rotation or translation.
  10. Description
  11. -----------
  12. The first 3 DOF axes are linear axes, which represent translation of Bodies, and the latter 3 DOF axes represent the angular motion. Each axis can be either locked, or limited.
  13. Properties
  14. ----------
  15. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  16. | :ref:`float<class_float>` | :ref:`angular_limit_x/damping<class_Generic6DOFJoint_property_angular_limit_x/damping>` | ``1.0`` |
  17. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  18. | :ref:`bool<class_bool>` | :ref:`angular_limit_x/enabled<class_Generic6DOFJoint_property_angular_limit_x/enabled>` | ``true`` |
  19. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  20. | :ref:`float<class_float>` | :ref:`angular_limit_x/erp<class_Generic6DOFJoint_property_angular_limit_x/erp>` | ``0.5`` |
  21. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  22. | :ref:`float<class_float>` | :ref:`angular_limit_x/force_limit<class_Generic6DOFJoint_property_angular_limit_x/force_limit>` | ``0.0`` |
  23. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  24. | :ref:`float<class_float>` | :ref:`angular_limit_x/lower_angle<class_Generic6DOFJoint_property_angular_limit_x/lower_angle>` | ``0.0`` |
  25. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  26. | :ref:`float<class_float>` | :ref:`angular_limit_x/restitution<class_Generic6DOFJoint_property_angular_limit_x/restitution>` | ``0.0`` |
  27. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  28. | :ref:`float<class_float>` | :ref:`angular_limit_x/softness<class_Generic6DOFJoint_property_angular_limit_x/softness>` | ``0.5`` |
  29. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  30. | :ref:`float<class_float>` | :ref:`angular_limit_x/upper_angle<class_Generic6DOFJoint_property_angular_limit_x/upper_angle>` | ``0.0`` |
  31. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  32. | :ref:`float<class_float>` | :ref:`angular_limit_y/damping<class_Generic6DOFJoint_property_angular_limit_y/damping>` | ``1.0`` |
  33. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  34. | :ref:`bool<class_bool>` | :ref:`angular_limit_y/enabled<class_Generic6DOFJoint_property_angular_limit_y/enabled>` | ``true`` |
  35. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  36. | :ref:`float<class_float>` | :ref:`angular_limit_y/erp<class_Generic6DOFJoint_property_angular_limit_y/erp>` | ``0.5`` |
  37. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  38. | :ref:`float<class_float>` | :ref:`angular_limit_y/force_limit<class_Generic6DOFJoint_property_angular_limit_y/force_limit>` | ``0.0`` |
  39. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  40. | :ref:`float<class_float>` | :ref:`angular_limit_y/lower_angle<class_Generic6DOFJoint_property_angular_limit_y/lower_angle>` | ``0.0`` |
  41. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  42. | :ref:`float<class_float>` | :ref:`angular_limit_y/restitution<class_Generic6DOFJoint_property_angular_limit_y/restitution>` | ``0.0`` |
  43. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  44. | :ref:`float<class_float>` | :ref:`angular_limit_y/softness<class_Generic6DOFJoint_property_angular_limit_y/softness>` | ``0.5`` |
  45. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  46. | :ref:`float<class_float>` | :ref:`angular_limit_y/upper_angle<class_Generic6DOFJoint_property_angular_limit_y/upper_angle>` | ``0.0`` |
  47. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  48. | :ref:`float<class_float>` | :ref:`angular_limit_z/damping<class_Generic6DOFJoint_property_angular_limit_z/damping>` | ``1.0`` |
  49. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  50. | :ref:`bool<class_bool>` | :ref:`angular_limit_z/enabled<class_Generic6DOFJoint_property_angular_limit_z/enabled>` | ``true`` |
  51. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  52. | :ref:`float<class_float>` | :ref:`angular_limit_z/erp<class_Generic6DOFJoint_property_angular_limit_z/erp>` | ``0.5`` |
  53. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  54. | :ref:`float<class_float>` | :ref:`angular_limit_z/force_limit<class_Generic6DOFJoint_property_angular_limit_z/force_limit>` | ``0.0`` |
  55. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  56. | :ref:`float<class_float>` | :ref:`angular_limit_z/lower_angle<class_Generic6DOFJoint_property_angular_limit_z/lower_angle>` | ``0.0`` |
  57. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  58. | :ref:`float<class_float>` | :ref:`angular_limit_z/restitution<class_Generic6DOFJoint_property_angular_limit_z/restitution>` | ``0.0`` |
  59. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  60. | :ref:`float<class_float>` | :ref:`angular_limit_z/softness<class_Generic6DOFJoint_property_angular_limit_z/softness>` | ``0.5`` |
  61. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  62. | :ref:`float<class_float>` | :ref:`angular_limit_z/upper_angle<class_Generic6DOFJoint_property_angular_limit_z/upper_angle>` | ``0.0`` |
  63. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  64. | :ref:`bool<class_bool>` | :ref:`angular_motor_x/enabled<class_Generic6DOFJoint_property_angular_motor_x/enabled>` | ``false`` |
  65. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  66. | :ref:`float<class_float>` | :ref:`angular_motor_x/force_limit<class_Generic6DOFJoint_property_angular_motor_x/force_limit>` | ``300.0`` |
  67. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  68. | :ref:`float<class_float>` | :ref:`angular_motor_x/target_velocity<class_Generic6DOFJoint_property_angular_motor_x/target_velocity>` | ``0.0`` |
  69. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  70. | :ref:`bool<class_bool>` | :ref:`angular_motor_y/enabled<class_Generic6DOFJoint_property_angular_motor_y/enabled>` | ``false`` |
  71. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  72. | :ref:`float<class_float>` | :ref:`angular_motor_y/force_limit<class_Generic6DOFJoint_property_angular_motor_y/force_limit>` | ``300.0`` |
  73. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  74. | :ref:`float<class_float>` | :ref:`angular_motor_y/target_velocity<class_Generic6DOFJoint_property_angular_motor_y/target_velocity>` | ``0.0`` |
  75. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  76. | :ref:`bool<class_bool>` | :ref:`angular_motor_z/enabled<class_Generic6DOFJoint_property_angular_motor_z/enabled>` | ``false`` |
  77. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  78. | :ref:`float<class_float>` | :ref:`angular_motor_z/force_limit<class_Generic6DOFJoint_property_angular_motor_z/force_limit>` | ``300.0`` |
  79. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  80. | :ref:`float<class_float>` | :ref:`angular_motor_z/target_velocity<class_Generic6DOFJoint_property_angular_motor_z/target_velocity>` | ``0.0`` |
  81. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  82. | :ref:`float<class_float>` | :ref:`angular_spring_x/damping<class_Generic6DOFJoint_property_angular_spring_x/damping>` | ``0.0`` |
  83. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  84. | :ref:`bool<class_bool>` | :ref:`angular_spring_x/enabled<class_Generic6DOFJoint_property_angular_spring_x/enabled>` | ``false`` |
  85. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  86. | :ref:`float<class_float>` | :ref:`angular_spring_x/equilibrium_point<class_Generic6DOFJoint_property_angular_spring_x/equilibrium_point>` | ``0.0`` |
  87. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  88. | :ref:`float<class_float>` | :ref:`angular_spring_x/stiffness<class_Generic6DOFJoint_property_angular_spring_x/stiffness>` | ``0.0`` |
  89. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  90. | :ref:`float<class_float>` | :ref:`angular_spring_y/damping<class_Generic6DOFJoint_property_angular_spring_y/damping>` | ``0.0`` |
  91. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  92. | :ref:`bool<class_bool>` | :ref:`angular_spring_y/enabled<class_Generic6DOFJoint_property_angular_spring_y/enabled>` | ``false`` |
  93. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  94. | :ref:`float<class_float>` | :ref:`angular_spring_y/equilibrium_point<class_Generic6DOFJoint_property_angular_spring_y/equilibrium_point>` | ``0.0`` |
  95. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  96. | :ref:`float<class_float>` | :ref:`angular_spring_y/stiffness<class_Generic6DOFJoint_property_angular_spring_y/stiffness>` | ``0.0`` |
  97. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  98. | :ref:`float<class_float>` | :ref:`angular_spring_z/damping<class_Generic6DOFJoint_property_angular_spring_z/damping>` | ``0.0`` |
  99. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  100. | :ref:`bool<class_bool>` | :ref:`angular_spring_z/enabled<class_Generic6DOFJoint_property_angular_spring_z/enabled>` | ``false`` |
  101. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  102. | :ref:`float<class_float>` | :ref:`angular_spring_z/equilibrium_point<class_Generic6DOFJoint_property_angular_spring_z/equilibrium_point>` | ``0.0`` |
  103. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  104. | :ref:`float<class_float>` | :ref:`angular_spring_z/stiffness<class_Generic6DOFJoint_property_angular_spring_z/stiffness>` | ``0.0`` |
  105. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  106. | :ref:`float<class_float>` | :ref:`linear_limit_x/damping<class_Generic6DOFJoint_property_linear_limit_x/damping>` | ``1.0`` |
  107. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  108. | :ref:`bool<class_bool>` | :ref:`linear_limit_x/enabled<class_Generic6DOFJoint_property_linear_limit_x/enabled>` | ``true`` |
  109. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  110. | :ref:`float<class_float>` | :ref:`linear_limit_x/lower_distance<class_Generic6DOFJoint_property_linear_limit_x/lower_distance>` | ``0.0`` |
  111. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  112. | :ref:`float<class_float>` | :ref:`linear_limit_x/restitution<class_Generic6DOFJoint_property_linear_limit_x/restitution>` | ``0.5`` |
  113. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  114. | :ref:`float<class_float>` | :ref:`linear_limit_x/softness<class_Generic6DOFJoint_property_linear_limit_x/softness>` | ``0.7`` |
  115. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  116. | :ref:`float<class_float>` | :ref:`linear_limit_x/upper_distance<class_Generic6DOFJoint_property_linear_limit_x/upper_distance>` | ``0.0`` |
  117. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  118. | :ref:`float<class_float>` | :ref:`linear_limit_y/damping<class_Generic6DOFJoint_property_linear_limit_y/damping>` | ``1.0`` |
  119. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  120. | :ref:`bool<class_bool>` | :ref:`linear_limit_y/enabled<class_Generic6DOFJoint_property_linear_limit_y/enabled>` | ``true`` |
  121. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  122. | :ref:`float<class_float>` | :ref:`linear_limit_y/lower_distance<class_Generic6DOFJoint_property_linear_limit_y/lower_distance>` | ``0.0`` |
  123. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  124. | :ref:`float<class_float>` | :ref:`linear_limit_y/restitution<class_Generic6DOFJoint_property_linear_limit_y/restitution>` | ``0.5`` |
  125. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  126. | :ref:`float<class_float>` | :ref:`linear_limit_y/softness<class_Generic6DOFJoint_property_linear_limit_y/softness>` | ``0.7`` |
  127. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  128. | :ref:`float<class_float>` | :ref:`linear_limit_y/upper_distance<class_Generic6DOFJoint_property_linear_limit_y/upper_distance>` | ``0.0`` |
  129. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  130. | :ref:`float<class_float>` | :ref:`linear_limit_z/damping<class_Generic6DOFJoint_property_linear_limit_z/damping>` | ``1.0`` |
  131. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  132. | :ref:`bool<class_bool>` | :ref:`linear_limit_z/enabled<class_Generic6DOFJoint_property_linear_limit_z/enabled>` | ``true`` |
  133. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  134. | :ref:`float<class_float>` | :ref:`linear_limit_z/lower_distance<class_Generic6DOFJoint_property_linear_limit_z/lower_distance>` | ``0.0`` |
  135. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  136. | :ref:`float<class_float>` | :ref:`linear_limit_z/restitution<class_Generic6DOFJoint_property_linear_limit_z/restitution>` | ``0.5`` |
  137. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  138. | :ref:`float<class_float>` | :ref:`linear_limit_z/softness<class_Generic6DOFJoint_property_linear_limit_z/softness>` | ``0.7`` |
  139. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  140. | :ref:`float<class_float>` | :ref:`linear_limit_z/upper_distance<class_Generic6DOFJoint_property_linear_limit_z/upper_distance>` | ``0.0`` |
  141. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  142. | :ref:`bool<class_bool>` | :ref:`linear_motor_x/enabled<class_Generic6DOFJoint_property_linear_motor_x/enabled>` | ``false`` |
  143. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  144. | :ref:`float<class_float>` | :ref:`linear_motor_x/force_limit<class_Generic6DOFJoint_property_linear_motor_x/force_limit>` | ``0.0`` |
  145. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  146. | :ref:`float<class_float>` | :ref:`linear_motor_x/target_velocity<class_Generic6DOFJoint_property_linear_motor_x/target_velocity>` | ``0.0`` |
  147. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  148. | :ref:`bool<class_bool>` | :ref:`linear_motor_y/enabled<class_Generic6DOFJoint_property_linear_motor_y/enabled>` | ``false`` |
  149. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  150. | :ref:`float<class_float>` | :ref:`linear_motor_y/force_limit<class_Generic6DOFJoint_property_linear_motor_y/force_limit>` | ``0.0`` |
  151. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  152. | :ref:`float<class_float>` | :ref:`linear_motor_y/target_velocity<class_Generic6DOFJoint_property_linear_motor_y/target_velocity>` | ``0.0`` |
  153. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  154. | :ref:`bool<class_bool>` | :ref:`linear_motor_z/enabled<class_Generic6DOFJoint_property_linear_motor_z/enabled>` | ``false`` |
  155. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  156. | :ref:`float<class_float>` | :ref:`linear_motor_z/force_limit<class_Generic6DOFJoint_property_linear_motor_z/force_limit>` | ``0.0`` |
  157. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  158. | :ref:`float<class_float>` | :ref:`linear_motor_z/target_velocity<class_Generic6DOFJoint_property_linear_motor_z/target_velocity>` | ``0.0`` |
  159. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  160. | :ref:`float<class_float>` | :ref:`linear_spring_x/damping<class_Generic6DOFJoint_property_linear_spring_x/damping>` | ``0.01`` |
  161. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  162. | :ref:`bool<class_bool>` | :ref:`linear_spring_x/enabled<class_Generic6DOFJoint_property_linear_spring_x/enabled>` | ``false`` |
  163. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  164. | :ref:`float<class_float>` | :ref:`linear_spring_x/equilibrium_point<class_Generic6DOFJoint_property_linear_spring_x/equilibrium_point>` | ``0.0`` |
  165. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  166. | :ref:`float<class_float>` | :ref:`linear_spring_x/stiffness<class_Generic6DOFJoint_property_linear_spring_x/stiffness>` | ``0.01`` |
  167. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  168. | :ref:`float<class_float>` | :ref:`linear_spring_y/damping<class_Generic6DOFJoint_property_linear_spring_y/damping>` | ``0.01`` |
  169. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  170. | :ref:`bool<class_bool>` | :ref:`linear_spring_y/enabled<class_Generic6DOFJoint_property_linear_spring_y/enabled>` | ``false`` |
  171. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  172. | :ref:`float<class_float>` | :ref:`linear_spring_y/equilibrium_point<class_Generic6DOFJoint_property_linear_spring_y/equilibrium_point>` | ``0.0`` |
  173. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  174. | :ref:`float<class_float>` | :ref:`linear_spring_y/stiffness<class_Generic6DOFJoint_property_linear_spring_y/stiffness>` | ``0.01`` |
  175. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  176. | :ref:`float<class_float>` | :ref:`linear_spring_z/damping<class_Generic6DOFJoint_property_linear_spring_z/damping>` | ``0.01`` |
  177. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  178. | :ref:`bool<class_bool>` | :ref:`linear_spring_z/enabled<class_Generic6DOFJoint_property_linear_spring_z/enabled>` | ``false`` |
  179. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  180. | :ref:`float<class_float>` | :ref:`linear_spring_z/equilibrium_point<class_Generic6DOFJoint_property_linear_spring_z/equilibrium_point>` | ``0.0`` |
  181. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  182. | :ref:`float<class_float>` | :ref:`linear_spring_z/stiffness<class_Generic6DOFJoint_property_linear_spring_z/stiffness>` | ``0.01`` |
  183. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  184. | :ref:`int<class_int>` | :ref:`precision<class_Generic6DOFJoint_property_precision>` | ``1`` |
  185. +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+
  186. Methods
  187. -------
  188. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | :ref:`bool<class_bool>` | :ref:`get_flag_x<class_Generic6DOFJoint_method_get_flag_x>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** |const| |
  190. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`bool<class_bool>` | :ref:`get_flag_y<class_Generic6DOFJoint_method_get_flag_y>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** |const| |
  192. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | :ref:`bool<class_bool>` | :ref:`get_flag_z<class_Generic6DOFJoint_method_get_flag_z>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** |const| |
  194. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | :ref:`float<class_float>` | :ref:`get_param_x<class_Generic6DOFJoint_method_get_param_x>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** |const| |
  196. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :ref:`float<class_float>` | :ref:`get_param_y<class_Generic6DOFJoint_method_get_param_y>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** |const| |
  198. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | :ref:`float<class_float>` | :ref:`get_param_z<class_Generic6DOFJoint_method_get_param_z>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** |const| |
  200. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | void | :ref:`set_flag_x<class_Generic6DOFJoint_method_set_flag_x>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)** |
  202. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | void | :ref:`set_flag_y<class_Generic6DOFJoint_method_set_flag_y>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)** |
  204. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | void | :ref:`set_flag_z<class_Generic6DOFJoint_method_set_flag_z>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)** |
  206. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | void | :ref:`set_param_x<class_Generic6DOFJoint_method_set_param_x>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)** |
  208. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | void | :ref:`set_param_y<class_Generic6DOFJoint_method_set_param_y>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)** |
  210. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | void | :ref:`set_param_z<class_Generic6DOFJoint_method_set_param_z>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)** |
  212. +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. Enumerations
  214. ------------
  215. .. _enum_Generic6DOFJoint_Param:
  216. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LOWER_LIMIT:
  217. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_UPPER_LIMIT:
  218. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LIMIT_SOFTNESS:
  219. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_RESTITUTION:
  220. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_DAMPING:
  221. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_TARGET_VELOCITY:
  222. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_FORCE_LIMIT:
  223. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_SPRING_STIFFNESS:
  224. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_SPRING_DAMPING:
  225. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_SPRING_EQUILIBRIUM_POINT:
  226. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LOWER_LIMIT:
  227. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_UPPER_LIMIT:
  228. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LIMIT_SOFTNESS:
  229. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_DAMPING:
  230. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_RESTITUTION:
  231. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_FORCE_LIMIT:
  232. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_ERP:
  233. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_TARGET_VELOCITY:
  234. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_FORCE_LIMIT:
  235. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_SPRING_STIFFNESS:
  236. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_SPRING_DAMPING:
  237. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT:
  238. .. _class_Generic6DOFJoint_constant_PARAM_MAX:
  239. enum **Param**:
  240. - **PARAM_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes.
  241. - **PARAM_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes.
  242. - **PARAM_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor applied to the movement across the axes. The lower, the slower the movement.
  243. - **PARAM_LINEAR_RESTITUTION** = **3** --- The amount of restitution on the axes' movement. The lower, the more momentum gets lost.
  244. - **PARAM_LINEAR_DAMPING** = **4** --- The amount of damping that happens at the linear motion across the axes.
  245. - **PARAM_LINEAR_MOTOR_TARGET_VELOCITY** = **5** --- The velocity the linear motor will try to reach.
  246. - **PARAM_LINEAR_MOTOR_FORCE_LIMIT** = **6** --- The maximum force the linear motor will apply while trying to reach the velocity target.
  247. - **PARAM_LINEAR_SPRING_STIFFNESS** = **7**
  248. - **PARAM_LINEAR_SPRING_DAMPING** = **8**
  249. - **PARAM_LINEAR_SPRING_EQUILIBRIUM_POINT** = **9**
  250. - **PARAM_ANGULAR_LOWER_LIMIT** = **10** --- The minimum rotation in negative direction to break loose and rotate around the axes.
  251. - **PARAM_ANGULAR_UPPER_LIMIT** = **11** --- The minimum rotation in positive direction to break loose and rotate around the axes.
  252. - **PARAM_ANGULAR_LIMIT_SOFTNESS** = **12** --- The speed of all rotations across the axes.
  253. - **PARAM_ANGULAR_DAMPING** = **13** --- The amount of rotational damping across the axes. The lower, the more dampening occurs.
  254. - **PARAM_ANGULAR_RESTITUTION** = **14** --- The amount of rotational restitution across the axes. The lower, the more restitution occurs.
  255. - **PARAM_ANGULAR_FORCE_LIMIT** = **15** --- The maximum amount of force that can occur, when rotating around the axes.
  256. - **PARAM_ANGULAR_ERP** = **16** --- When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
  257. - **PARAM_ANGULAR_MOTOR_TARGET_VELOCITY** = **17** --- Target speed for the motor at the axes.
  258. - **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = **18** --- Maximum acceleration for the motor at the axes.
  259. - **PARAM_ANGULAR_SPRING_STIFFNESS** = **19**
  260. - **PARAM_ANGULAR_SPRING_DAMPING** = **20**
  261. - **PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT** = **21**
  262. - **PARAM_MAX** = **22** --- Represents the size of the :ref:`Param<enum_Generic6DOFJoint_Param>` enum.
  263. ----
  264. .. _enum_Generic6DOFJoint_Flag:
  265. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_LIMIT:
  266. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_LIMIT:
  267. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_SPRING:
  268. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_SPRING:
  269. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_MOTOR:
  270. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_MOTOR:
  271. .. _class_Generic6DOFJoint_constant_FLAG_MAX:
  272. enum **Flag**:
  273. - **FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If enabled, linear motion is possible within the given limits.
  274. - **FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If enabled, rotational motion is possible within the given limits.
  275. - **FLAG_ENABLE_LINEAR_SPRING** = **3**
  276. - **FLAG_ENABLE_ANGULAR_SPRING** = **2**
  277. - **FLAG_ENABLE_MOTOR** = **4** --- If enabled, there is a rotational motor across these axes.
  278. - **FLAG_ENABLE_LINEAR_MOTOR** = **5** --- If enabled, there is a linear motor across these axes.
  279. - **FLAG_MAX** = **6** --- Represents the size of the :ref:`Flag<enum_Generic6DOFJoint_Flag>` enum.
  280. Property Descriptions
  281. ---------------------
  282. .. _class_Generic6DOFJoint_property_angular_limit_x/damping:
  283. - :ref:`float<class_float>` **angular_limit_x/damping**
  284. +-----------+--------------------+
  285. | *Default* | ``1.0`` |
  286. +-----------+--------------------+
  287. | *Setter* | set_param_x(value) |
  288. +-----------+--------------------+
  289. | *Getter* | get_param_x() |
  290. +-----------+--------------------+
  291. The amount of rotational damping across the X axis.
  292. The lower, the longer an impulse from one side takes to travel to the other side.
  293. ----
  294. .. _class_Generic6DOFJoint_property_angular_limit_x/enabled:
  295. - :ref:`bool<class_bool>` **angular_limit_x/enabled**
  296. +-----------+-------------------+
  297. | *Default* | ``true`` |
  298. +-----------+-------------------+
  299. | *Setter* | set_flag_x(value) |
  300. +-----------+-------------------+
  301. | *Getter* | get_flag_x() |
  302. +-----------+-------------------+
  303. If ``true``, rotation across the X axis is limited.
  304. ----
  305. .. _class_Generic6DOFJoint_property_angular_limit_x/erp:
  306. - :ref:`float<class_float>` **angular_limit_x/erp**
  307. +-----------+--------------------+
  308. | *Default* | ``0.5`` |
  309. +-----------+--------------------+
  310. | *Setter* | set_param_x(value) |
  311. +-----------+--------------------+
  312. | *Getter* | get_param_x() |
  313. +-----------+--------------------+
  314. When rotating across the X axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
  315. ----
  316. .. _class_Generic6DOFJoint_property_angular_limit_x/force_limit:
  317. - :ref:`float<class_float>` **angular_limit_x/force_limit**
  318. +-----------+--------------------+
  319. | *Default* | ``0.0`` |
  320. +-----------+--------------------+
  321. | *Setter* | set_param_x(value) |
  322. +-----------+--------------------+
  323. | *Getter* | get_param_x() |
  324. +-----------+--------------------+
  325. The maximum amount of force that can occur, when rotating around the X axis.
  326. ----
  327. .. _class_Generic6DOFJoint_property_angular_limit_x/lower_angle:
  328. - :ref:`float<class_float>` **angular_limit_x/lower_angle**
  329. +-----------+---------+
  330. | *Default* | ``0.0`` |
  331. +-----------+---------+
  332. The minimum rotation in negative direction to break loose and rotate around the X axis.
  333. ----
  334. .. _class_Generic6DOFJoint_property_angular_limit_x/restitution:
  335. - :ref:`float<class_float>` **angular_limit_x/restitution**
  336. +-----------+--------------------+
  337. | *Default* | ``0.0`` |
  338. +-----------+--------------------+
  339. | *Setter* | set_param_x(value) |
  340. +-----------+--------------------+
  341. | *Getter* | get_param_x() |
  342. +-----------+--------------------+
  343. The amount of rotational restitution across the X axis. The lower, the more restitution occurs.
  344. ----
  345. .. _class_Generic6DOFJoint_property_angular_limit_x/softness:
  346. - :ref:`float<class_float>` **angular_limit_x/softness**
  347. +-----------+--------------------+
  348. | *Default* | ``0.5`` |
  349. +-----------+--------------------+
  350. | *Setter* | set_param_x(value) |
  351. +-----------+--------------------+
  352. | *Getter* | get_param_x() |
  353. +-----------+--------------------+
  354. The speed of all rotations across the X axis.
  355. ----
  356. .. _class_Generic6DOFJoint_property_angular_limit_x/upper_angle:
  357. - :ref:`float<class_float>` **angular_limit_x/upper_angle**
  358. +-----------+---------+
  359. | *Default* | ``0.0`` |
  360. +-----------+---------+
  361. The minimum rotation in positive direction to break loose and rotate around the X axis.
  362. ----
  363. .. _class_Generic6DOFJoint_property_angular_limit_y/damping:
  364. - :ref:`float<class_float>` **angular_limit_y/damping**
  365. +-----------+--------------------+
  366. | *Default* | ``1.0`` |
  367. +-----------+--------------------+
  368. | *Setter* | set_param_y(value) |
  369. +-----------+--------------------+
  370. | *Getter* | get_param_y() |
  371. +-----------+--------------------+
  372. The amount of rotational damping across the Y axis. The lower, the more dampening occurs.
  373. ----
  374. .. _class_Generic6DOFJoint_property_angular_limit_y/enabled:
  375. - :ref:`bool<class_bool>` **angular_limit_y/enabled**
  376. +-----------+-------------------+
  377. | *Default* | ``true`` |
  378. +-----------+-------------------+
  379. | *Setter* | set_flag_y(value) |
  380. +-----------+-------------------+
  381. | *Getter* | get_flag_y() |
  382. +-----------+-------------------+
  383. If ``true``, rotation across the Y axis is limited.
  384. ----
  385. .. _class_Generic6DOFJoint_property_angular_limit_y/erp:
  386. - :ref:`float<class_float>` **angular_limit_y/erp**
  387. +-----------+--------------------+
  388. | *Default* | ``0.5`` |
  389. +-----------+--------------------+
  390. | *Setter* | set_param_y(value) |
  391. +-----------+--------------------+
  392. | *Getter* | get_param_y() |
  393. +-----------+--------------------+
  394. When rotating across the Y axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
  395. ----
  396. .. _class_Generic6DOFJoint_property_angular_limit_y/force_limit:
  397. - :ref:`float<class_float>` **angular_limit_y/force_limit**
  398. +-----------+--------------------+
  399. | *Default* | ``0.0`` |
  400. +-----------+--------------------+
  401. | *Setter* | set_param_y(value) |
  402. +-----------+--------------------+
  403. | *Getter* | get_param_y() |
  404. +-----------+--------------------+
  405. The maximum amount of force that can occur, when rotating around the Y axis.
  406. ----
  407. .. _class_Generic6DOFJoint_property_angular_limit_y/lower_angle:
  408. - :ref:`float<class_float>` **angular_limit_y/lower_angle**
  409. +-----------+---------+
  410. | *Default* | ``0.0`` |
  411. +-----------+---------+
  412. The minimum rotation in negative direction to break loose and rotate around the Y axis.
  413. ----
  414. .. _class_Generic6DOFJoint_property_angular_limit_y/restitution:
  415. - :ref:`float<class_float>` **angular_limit_y/restitution**
  416. +-----------+--------------------+
  417. | *Default* | ``0.0`` |
  418. +-----------+--------------------+
  419. | *Setter* | set_param_y(value) |
  420. +-----------+--------------------+
  421. | *Getter* | get_param_y() |
  422. +-----------+--------------------+
  423. The amount of rotational restitution across the Y axis. The lower, the more restitution occurs.
  424. ----
  425. .. _class_Generic6DOFJoint_property_angular_limit_y/softness:
  426. - :ref:`float<class_float>` **angular_limit_y/softness**
  427. +-----------+--------------------+
  428. | *Default* | ``0.5`` |
  429. +-----------+--------------------+
  430. | *Setter* | set_param_y(value) |
  431. +-----------+--------------------+
  432. | *Getter* | get_param_y() |
  433. +-----------+--------------------+
  434. The speed of all rotations across the Y axis.
  435. ----
  436. .. _class_Generic6DOFJoint_property_angular_limit_y/upper_angle:
  437. - :ref:`float<class_float>` **angular_limit_y/upper_angle**
  438. +-----------+---------+
  439. | *Default* | ``0.0`` |
  440. +-----------+---------+
  441. The minimum rotation in positive direction to break loose and rotate around the Y axis.
  442. ----
  443. .. _class_Generic6DOFJoint_property_angular_limit_z/damping:
  444. - :ref:`float<class_float>` **angular_limit_z/damping**
  445. +-----------+--------------------+
  446. | *Default* | ``1.0`` |
  447. +-----------+--------------------+
  448. | *Setter* | set_param_z(value) |
  449. +-----------+--------------------+
  450. | *Getter* | get_param_z() |
  451. +-----------+--------------------+
  452. The amount of rotational damping across the Z axis. The lower, the more dampening occurs.
  453. ----
  454. .. _class_Generic6DOFJoint_property_angular_limit_z/enabled:
  455. - :ref:`bool<class_bool>` **angular_limit_z/enabled**
  456. +-----------+-------------------+
  457. | *Default* | ``true`` |
  458. +-----------+-------------------+
  459. | *Setter* | set_flag_z(value) |
  460. +-----------+-------------------+
  461. | *Getter* | get_flag_z() |
  462. +-----------+-------------------+
  463. If ``true``, rotation across the Z axis is limited.
  464. ----
  465. .. _class_Generic6DOFJoint_property_angular_limit_z/erp:
  466. - :ref:`float<class_float>` **angular_limit_z/erp**
  467. +-----------+--------------------+
  468. | *Default* | ``0.5`` |
  469. +-----------+--------------------+
  470. | *Setter* | set_param_z(value) |
  471. +-----------+--------------------+
  472. | *Getter* | get_param_z() |
  473. +-----------+--------------------+
  474. When rotating across the Z axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
  475. ----
  476. .. _class_Generic6DOFJoint_property_angular_limit_z/force_limit:
  477. - :ref:`float<class_float>` **angular_limit_z/force_limit**
  478. +-----------+--------------------+
  479. | *Default* | ``0.0`` |
  480. +-----------+--------------------+
  481. | *Setter* | set_param_z(value) |
  482. +-----------+--------------------+
  483. | *Getter* | get_param_z() |
  484. +-----------+--------------------+
  485. The maximum amount of force that can occur, when rotating around the Z axis.
  486. ----
  487. .. _class_Generic6DOFJoint_property_angular_limit_z/lower_angle:
  488. - :ref:`float<class_float>` **angular_limit_z/lower_angle**
  489. +-----------+---------+
  490. | *Default* | ``0.0`` |
  491. +-----------+---------+
  492. The minimum rotation in negative direction to break loose and rotate around the Z axis.
  493. ----
  494. .. _class_Generic6DOFJoint_property_angular_limit_z/restitution:
  495. - :ref:`float<class_float>` **angular_limit_z/restitution**
  496. +-----------+--------------------+
  497. | *Default* | ``0.0`` |
  498. +-----------+--------------------+
  499. | *Setter* | set_param_z(value) |
  500. +-----------+--------------------+
  501. | *Getter* | get_param_z() |
  502. +-----------+--------------------+
  503. The amount of rotational restitution across the Z axis. The lower, the more restitution occurs.
  504. ----
  505. .. _class_Generic6DOFJoint_property_angular_limit_z/softness:
  506. - :ref:`float<class_float>` **angular_limit_z/softness**
  507. +-----------+--------------------+
  508. | *Default* | ``0.5`` |
  509. +-----------+--------------------+
  510. | *Setter* | set_param_z(value) |
  511. +-----------+--------------------+
  512. | *Getter* | get_param_z() |
  513. +-----------+--------------------+
  514. The speed of all rotations across the Z axis.
  515. ----
  516. .. _class_Generic6DOFJoint_property_angular_limit_z/upper_angle:
  517. - :ref:`float<class_float>` **angular_limit_z/upper_angle**
  518. +-----------+---------+
  519. | *Default* | ``0.0`` |
  520. +-----------+---------+
  521. The minimum rotation in positive direction to break loose and rotate around the Z axis.
  522. ----
  523. .. _class_Generic6DOFJoint_property_angular_motor_x/enabled:
  524. - :ref:`bool<class_bool>` **angular_motor_x/enabled**
  525. +-----------+-------------------+
  526. | *Default* | ``false`` |
  527. +-----------+-------------------+
  528. | *Setter* | set_flag_x(value) |
  529. +-----------+-------------------+
  530. | *Getter* | get_flag_x() |
  531. +-----------+-------------------+
  532. If ``true``, a rotating motor at the X axis is enabled.
  533. ----
  534. .. _class_Generic6DOFJoint_property_angular_motor_x/force_limit:
  535. - :ref:`float<class_float>` **angular_motor_x/force_limit**
  536. +-----------+--------------------+
  537. | *Default* | ``300.0`` |
  538. +-----------+--------------------+
  539. | *Setter* | set_param_x(value) |
  540. +-----------+--------------------+
  541. | *Getter* | get_param_x() |
  542. +-----------+--------------------+
  543. Maximum acceleration for the motor at the X axis.
  544. ----
  545. .. _class_Generic6DOFJoint_property_angular_motor_x/target_velocity:
  546. - :ref:`float<class_float>` **angular_motor_x/target_velocity**
  547. +-----------+--------------------+
  548. | *Default* | ``0.0`` |
  549. +-----------+--------------------+
  550. | *Setter* | set_param_x(value) |
  551. +-----------+--------------------+
  552. | *Getter* | get_param_x() |
  553. +-----------+--------------------+
  554. Target speed for the motor at the X axis.
  555. ----
  556. .. _class_Generic6DOFJoint_property_angular_motor_y/enabled:
  557. - :ref:`bool<class_bool>` **angular_motor_y/enabled**
  558. +-----------+-------------------+
  559. | *Default* | ``false`` |
  560. +-----------+-------------------+
  561. | *Setter* | set_flag_y(value) |
  562. +-----------+-------------------+
  563. | *Getter* | get_flag_y() |
  564. +-----------+-------------------+
  565. If ``true``, a rotating motor at the Y axis is enabled.
  566. ----
  567. .. _class_Generic6DOFJoint_property_angular_motor_y/force_limit:
  568. - :ref:`float<class_float>` **angular_motor_y/force_limit**
  569. +-----------+--------------------+
  570. | *Default* | ``300.0`` |
  571. +-----------+--------------------+
  572. | *Setter* | set_param_y(value) |
  573. +-----------+--------------------+
  574. | *Getter* | get_param_y() |
  575. +-----------+--------------------+
  576. Maximum acceleration for the motor at the Y axis.
  577. ----
  578. .. _class_Generic6DOFJoint_property_angular_motor_y/target_velocity:
  579. - :ref:`float<class_float>` **angular_motor_y/target_velocity**
  580. +-----------+--------------------+
  581. | *Default* | ``0.0`` |
  582. +-----------+--------------------+
  583. | *Setter* | set_param_y(value) |
  584. +-----------+--------------------+
  585. | *Getter* | get_param_y() |
  586. +-----------+--------------------+
  587. Target speed for the motor at the Y axis.
  588. ----
  589. .. _class_Generic6DOFJoint_property_angular_motor_z/enabled:
  590. - :ref:`bool<class_bool>` **angular_motor_z/enabled**
  591. +-----------+-------------------+
  592. | *Default* | ``false`` |
  593. +-----------+-------------------+
  594. | *Setter* | set_flag_z(value) |
  595. +-----------+-------------------+
  596. | *Getter* | get_flag_z() |
  597. +-----------+-------------------+
  598. If ``true``, a rotating motor at the Z axis is enabled.
  599. ----
  600. .. _class_Generic6DOFJoint_property_angular_motor_z/force_limit:
  601. - :ref:`float<class_float>` **angular_motor_z/force_limit**
  602. +-----------+--------------------+
  603. | *Default* | ``300.0`` |
  604. +-----------+--------------------+
  605. | *Setter* | set_param_z(value) |
  606. +-----------+--------------------+
  607. | *Getter* | get_param_z() |
  608. +-----------+--------------------+
  609. Maximum acceleration for the motor at the Z axis.
  610. ----
  611. .. _class_Generic6DOFJoint_property_angular_motor_z/target_velocity:
  612. - :ref:`float<class_float>` **angular_motor_z/target_velocity**
  613. +-----------+--------------------+
  614. | *Default* | ``0.0`` |
  615. +-----------+--------------------+
  616. | *Setter* | set_param_z(value) |
  617. +-----------+--------------------+
  618. | *Getter* | get_param_z() |
  619. +-----------+--------------------+
  620. Target speed for the motor at the Z axis.
  621. ----
  622. .. _class_Generic6DOFJoint_property_angular_spring_x/damping:
  623. - :ref:`float<class_float>` **angular_spring_x/damping**
  624. +-----------+--------------------+
  625. | *Default* | ``0.0`` |
  626. +-----------+--------------------+
  627. | *Setter* | set_param_x(value) |
  628. +-----------+--------------------+
  629. | *Getter* | get_param_x() |
  630. +-----------+--------------------+
  631. ----
  632. .. _class_Generic6DOFJoint_property_angular_spring_x/enabled:
  633. - :ref:`bool<class_bool>` **angular_spring_x/enabled**
  634. +-----------+-------------------+
  635. | *Default* | ``false`` |
  636. +-----------+-------------------+
  637. | *Setter* | set_flag_x(value) |
  638. +-----------+-------------------+
  639. | *Getter* | get_flag_x() |
  640. +-----------+-------------------+
  641. ----
  642. .. _class_Generic6DOFJoint_property_angular_spring_x/equilibrium_point:
  643. - :ref:`float<class_float>` **angular_spring_x/equilibrium_point**
  644. +-----------+--------------------+
  645. | *Default* | ``0.0`` |
  646. +-----------+--------------------+
  647. | *Setter* | set_param_x(value) |
  648. +-----------+--------------------+
  649. | *Getter* | get_param_x() |
  650. +-----------+--------------------+
  651. ----
  652. .. _class_Generic6DOFJoint_property_angular_spring_x/stiffness:
  653. - :ref:`float<class_float>` **angular_spring_x/stiffness**
  654. +-----------+--------------------+
  655. | *Default* | ``0.0`` |
  656. +-----------+--------------------+
  657. | *Setter* | set_param_x(value) |
  658. +-----------+--------------------+
  659. | *Getter* | get_param_x() |
  660. +-----------+--------------------+
  661. ----
  662. .. _class_Generic6DOFJoint_property_angular_spring_y/damping:
  663. - :ref:`float<class_float>` **angular_spring_y/damping**
  664. +-----------+--------------------+
  665. | *Default* | ``0.0`` |
  666. +-----------+--------------------+
  667. | *Setter* | set_param_y(value) |
  668. +-----------+--------------------+
  669. | *Getter* | get_param_y() |
  670. +-----------+--------------------+
  671. ----
  672. .. _class_Generic6DOFJoint_property_angular_spring_y/enabled:
  673. - :ref:`bool<class_bool>` **angular_spring_y/enabled**
  674. +-----------+-------------------+
  675. | *Default* | ``false`` |
  676. +-----------+-------------------+
  677. | *Setter* | set_flag_y(value) |
  678. +-----------+-------------------+
  679. | *Getter* | get_flag_y() |
  680. +-----------+-------------------+
  681. ----
  682. .. _class_Generic6DOFJoint_property_angular_spring_y/equilibrium_point:
  683. - :ref:`float<class_float>` **angular_spring_y/equilibrium_point**
  684. +-----------+--------------------+
  685. | *Default* | ``0.0`` |
  686. +-----------+--------------------+
  687. | *Setter* | set_param_y(value) |
  688. +-----------+--------------------+
  689. | *Getter* | get_param_y() |
  690. +-----------+--------------------+
  691. ----
  692. .. _class_Generic6DOFJoint_property_angular_spring_y/stiffness:
  693. - :ref:`float<class_float>` **angular_spring_y/stiffness**
  694. +-----------+--------------------+
  695. | *Default* | ``0.0`` |
  696. +-----------+--------------------+
  697. | *Setter* | set_param_y(value) |
  698. +-----------+--------------------+
  699. | *Getter* | get_param_y() |
  700. +-----------+--------------------+
  701. ----
  702. .. _class_Generic6DOFJoint_property_angular_spring_z/damping:
  703. - :ref:`float<class_float>` **angular_spring_z/damping**
  704. +-----------+--------------------+
  705. | *Default* | ``0.0`` |
  706. +-----------+--------------------+
  707. | *Setter* | set_param_z(value) |
  708. +-----------+--------------------+
  709. | *Getter* | get_param_z() |
  710. +-----------+--------------------+
  711. ----
  712. .. _class_Generic6DOFJoint_property_angular_spring_z/enabled:
  713. - :ref:`bool<class_bool>` **angular_spring_z/enabled**
  714. +-----------+-------------------+
  715. | *Default* | ``false`` |
  716. +-----------+-------------------+
  717. | *Setter* | set_flag_z(value) |
  718. +-----------+-------------------+
  719. | *Getter* | get_flag_z() |
  720. +-----------+-------------------+
  721. ----
  722. .. _class_Generic6DOFJoint_property_angular_spring_z/equilibrium_point:
  723. - :ref:`float<class_float>` **angular_spring_z/equilibrium_point**
  724. +-----------+--------------------+
  725. | *Default* | ``0.0`` |
  726. +-----------+--------------------+
  727. | *Setter* | set_param_z(value) |
  728. +-----------+--------------------+
  729. | *Getter* | get_param_z() |
  730. +-----------+--------------------+
  731. ----
  732. .. _class_Generic6DOFJoint_property_angular_spring_z/stiffness:
  733. - :ref:`float<class_float>` **angular_spring_z/stiffness**
  734. +-----------+--------------------+
  735. | *Default* | ``0.0`` |
  736. +-----------+--------------------+
  737. | *Setter* | set_param_z(value) |
  738. +-----------+--------------------+
  739. | *Getter* | get_param_z() |
  740. +-----------+--------------------+
  741. ----
  742. .. _class_Generic6DOFJoint_property_linear_limit_x/damping:
  743. - :ref:`float<class_float>` **linear_limit_x/damping**
  744. +-----------+--------------------+
  745. | *Default* | ``1.0`` |
  746. +-----------+--------------------+
  747. | *Setter* | set_param_x(value) |
  748. +-----------+--------------------+
  749. | *Getter* | get_param_x() |
  750. +-----------+--------------------+
  751. The amount of damping that happens at the X motion.
  752. ----
  753. .. _class_Generic6DOFJoint_property_linear_limit_x/enabled:
  754. - :ref:`bool<class_bool>` **linear_limit_x/enabled**
  755. +-----------+-------------------+
  756. | *Default* | ``true`` |
  757. +-----------+-------------------+
  758. | *Setter* | set_flag_x(value) |
  759. +-----------+-------------------+
  760. | *Getter* | get_flag_x() |
  761. +-----------+-------------------+
  762. If ``true``, the linear motion across the X axis is limited.
  763. ----
  764. .. _class_Generic6DOFJoint_property_linear_limit_x/lower_distance:
  765. - :ref:`float<class_float>` **linear_limit_x/lower_distance**
  766. +-----------+--------------------+
  767. | *Default* | ``0.0`` |
  768. +-----------+--------------------+
  769. | *Setter* | set_param_x(value) |
  770. +-----------+--------------------+
  771. | *Getter* | get_param_x() |
  772. +-----------+--------------------+
  773. The minimum difference between the pivot points' X axis.
  774. ----
  775. .. _class_Generic6DOFJoint_property_linear_limit_x/restitution:
  776. - :ref:`float<class_float>` **linear_limit_x/restitution**
  777. +-----------+--------------------+
  778. | *Default* | ``0.5`` |
  779. +-----------+--------------------+
  780. | *Setter* | set_param_x(value) |
  781. +-----------+--------------------+
  782. | *Getter* | get_param_x() |
  783. +-----------+--------------------+
  784. The amount of restitution on the X axis movement. The lower, the more momentum gets lost.
  785. ----
  786. .. _class_Generic6DOFJoint_property_linear_limit_x/softness:
  787. - :ref:`float<class_float>` **linear_limit_x/softness**
  788. +-----------+--------------------+
  789. | *Default* | ``0.7`` |
  790. +-----------+--------------------+
  791. | *Setter* | set_param_x(value) |
  792. +-----------+--------------------+
  793. | *Getter* | get_param_x() |
  794. +-----------+--------------------+
  795. A factor applied to the movement across the X axis. The lower, the slower the movement.
  796. ----
  797. .. _class_Generic6DOFJoint_property_linear_limit_x/upper_distance:
  798. - :ref:`float<class_float>` **linear_limit_x/upper_distance**
  799. +-----------+--------------------+
  800. | *Default* | ``0.0`` |
  801. +-----------+--------------------+
  802. | *Setter* | set_param_x(value) |
  803. +-----------+--------------------+
  804. | *Getter* | get_param_x() |
  805. +-----------+--------------------+
  806. The maximum difference between the pivot points' X axis.
  807. ----
  808. .. _class_Generic6DOFJoint_property_linear_limit_y/damping:
  809. - :ref:`float<class_float>` **linear_limit_y/damping**
  810. +-----------+--------------------+
  811. | *Default* | ``1.0`` |
  812. +-----------+--------------------+
  813. | *Setter* | set_param_y(value) |
  814. +-----------+--------------------+
  815. | *Getter* | get_param_y() |
  816. +-----------+--------------------+
  817. The amount of damping that happens at the Y motion.
  818. ----
  819. .. _class_Generic6DOFJoint_property_linear_limit_y/enabled:
  820. - :ref:`bool<class_bool>` **linear_limit_y/enabled**
  821. +-----------+-------------------+
  822. | *Default* | ``true`` |
  823. +-----------+-------------------+
  824. | *Setter* | set_flag_y(value) |
  825. +-----------+-------------------+
  826. | *Getter* | get_flag_y() |
  827. +-----------+-------------------+
  828. If ``true``, the linear motion across the Y axis is limited.
  829. ----
  830. .. _class_Generic6DOFJoint_property_linear_limit_y/lower_distance:
  831. - :ref:`float<class_float>` **linear_limit_y/lower_distance**
  832. +-----------+--------------------+
  833. | *Default* | ``0.0`` |
  834. +-----------+--------------------+
  835. | *Setter* | set_param_y(value) |
  836. +-----------+--------------------+
  837. | *Getter* | get_param_y() |
  838. +-----------+--------------------+
  839. The minimum difference between the pivot points' Y axis.
  840. ----
  841. .. _class_Generic6DOFJoint_property_linear_limit_y/restitution:
  842. - :ref:`float<class_float>` **linear_limit_y/restitution**
  843. +-----------+--------------------+
  844. | *Default* | ``0.5`` |
  845. +-----------+--------------------+
  846. | *Setter* | set_param_y(value) |
  847. +-----------+--------------------+
  848. | *Getter* | get_param_y() |
  849. +-----------+--------------------+
  850. The amount of restitution on the Y axis movement. The lower, the more momentum gets lost.
  851. ----
  852. .. _class_Generic6DOFJoint_property_linear_limit_y/softness:
  853. - :ref:`float<class_float>` **linear_limit_y/softness**
  854. +-----------+--------------------+
  855. | *Default* | ``0.7`` |
  856. +-----------+--------------------+
  857. | *Setter* | set_param_y(value) |
  858. +-----------+--------------------+
  859. | *Getter* | get_param_y() |
  860. +-----------+--------------------+
  861. A factor applied to the movement across the Y axis. The lower, the slower the movement.
  862. ----
  863. .. _class_Generic6DOFJoint_property_linear_limit_y/upper_distance:
  864. - :ref:`float<class_float>` **linear_limit_y/upper_distance**
  865. +-----------+--------------------+
  866. | *Default* | ``0.0`` |
  867. +-----------+--------------------+
  868. | *Setter* | set_param_y(value) |
  869. +-----------+--------------------+
  870. | *Getter* | get_param_y() |
  871. +-----------+--------------------+
  872. The maximum difference between the pivot points' Y axis.
  873. ----
  874. .. _class_Generic6DOFJoint_property_linear_limit_z/damping:
  875. - :ref:`float<class_float>` **linear_limit_z/damping**
  876. +-----------+--------------------+
  877. | *Default* | ``1.0`` |
  878. +-----------+--------------------+
  879. | *Setter* | set_param_z(value) |
  880. +-----------+--------------------+
  881. | *Getter* | get_param_z() |
  882. +-----------+--------------------+
  883. The amount of damping that happens at the Z motion.
  884. ----
  885. .. _class_Generic6DOFJoint_property_linear_limit_z/enabled:
  886. - :ref:`bool<class_bool>` **linear_limit_z/enabled**
  887. +-----------+-------------------+
  888. | *Default* | ``true`` |
  889. +-----------+-------------------+
  890. | *Setter* | set_flag_z(value) |
  891. +-----------+-------------------+
  892. | *Getter* | get_flag_z() |
  893. +-----------+-------------------+
  894. If ``true``, the linear motion across the Z axis is limited.
  895. ----
  896. .. _class_Generic6DOFJoint_property_linear_limit_z/lower_distance:
  897. - :ref:`float<class_float>` **linear_limit_z/lower_distance**
  898. +-----------+--------------------+
  899. | *Default* | ``0.0`` |
  900. +-----------+--------------------+
  901. | *Setter* | set_param_z(value) |
  902. +-----------+--------------------+
  903. | *Getter* | get_param_z() |
  904. +-----------+--------------------+
  905. The minimum difference between the pivot points' Z axis.
  906. ----
  907. .. _class_Generic6DOFJoint_property_linear_limit_z/restitution:
  908. - :ref:`float<class_float>` **linear_limit_z/restitution**
  909. +-----------+--------------------+
  910. | *Default* | ``0.5`` |
  911. +-----------+--------------------+
  912. | *Setter* | set_param_z(value) |
  913. +-----------+--------------------+
  914. | *Getter* | get_param_z() |
  915. +-----------+--------------------+
  916. The amount of restitution on the Z axis movement. The lower, the more momentum gets lost.
  917. ----
  918. .. _class_Generic6DOFJoint_property_linear_limit_z/softness:
  919. - :ref:`float<class_float>` **linear_limit_z/softness**
  920. +-----------+--------------------+
  921. | *Default* | ``0.7`` |
  922. +-----------+--------------------+
  923. | *Setter* | set_param_z(value) |
  924. +-----------+--------------------+
  925. | *Getter* | get_param_z() |
  926. +-----------+--------------------+
  927. A factor applied to the movement across the Z axis. The lower, the slower the movement.
  928. ----
  929. .. _class_Generic6DOFJoint_property_linear_limit_z/upper_distance:
  930. - :ref:`float<class_float>` **linear_limit_z/upper_distance**
  931. +-----------+--------------------+
  932. | *Default* | ``0.0`` |
  933. +-----------+--------------------+
  934. | *Setter* | set_param_z(value) |
  935. +-----------+--------------------+
  936. | *Getter* | get_param_z() |
  937. +-----------+--------------------+
  938. The maximum difference between the pivot points' Z axis.
  939. ----
  940. .. _class_Generic6DOFJoint_property_linear_motor_x/enabled:
  941. - :ref:`bool<class_bool>` **linear_motor_x/enabled**
  942. +-----------+-------------------+
  943. | *Default* | ``false`` |
  944. +-----------+-------------------+
  945. | *Setter* | set_flag_x(value) |
  946. +-----------+-------------------+
  947. | *Getter* | get_flag_x() |
  948. +-----------+-------------------+
  949. If ``true``, then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits.
  950. ----
  951. .. _class_Generic6DOFJoint_property_linear_motor_x/force_limit:
  952. - :ref:`float<class_float>` **linear_motor_x/force_limit**
  953. +-----------+--------------------+
  954. | *Default* | ``0.0`` |
  955. +-----------+--------------------+
  956. | *Setter* | set_param_x(value) |
  957. +-----------+--------------------+
  958. | *Getter* | get_param_x() |
  959. +-----------+--------------------+
  960. The maximum force the linear motor can apply on the X axis while trying to reach the target velocity.
  961. ----
  962. .. _class_Generic6DOFJoint_property_linear_motor_x/target_velocity:
  963. - :ref:`float<class_float>` **linear_motor_x/target_velocity**
  964. +-----------+--------------------+
  965. | *Default* | ``0.0`` |
  966. +-----------+--------------------+
  967. | *Setter* | set_param_x(value) |
  968. +-----------+--------------------+
  969. | *Getter* | get_param_x() |
  970. +-----------+--------------------+
  971. The speed that the linear motor will attempt to reach on the X axis.
  972. ----
  973. .. _class_Generic6DOFJoint_property_linear_motor_y/enabled:
  974. - :ref:`bool<class_bool>` **linear_motor_y/enabled**
  975. +-----------+-------------------+
  976. | *Default* | ``false`` |
  977. +-----------+-------------------+
  978. | *Setter* | set_flag_y(value) |
  979. +-----------+-------------------+
  980. | *Getter* | get_flag_y() |
  981. +-----------+-------------------+
  982. If ``true``, then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits.
  983. ----
  984. .. _class_Generic6DOFJoint_property_linear_motor_y/force_limit:
  985. - :ref:`float<class_float>` **linear_motor_y/force_limit**
  986. +-----------+--------------------+
  987. | *Default* | ``0.0`` |
  988. +-----------+--------------------+
  989. | *Setter* | set_param_y(value) |
  990. +-----------+--------------------+
  991. | *Getter* | get_param_y() |
  992. +-----------+--------------------+
  993. The maximum force the linear motor can apply on the Y axis while trying to reach the target velocity.
  994. ----
  995. .. _class_Generic6DOFJoint_property_linear_motor_y/target_velocity:
  996. - :ref:`float<class_float>` **linear_motor_y/target_velocity**
  997. +-----------+--------------------+
  998. | *Default* | ``0.0`` |
  999. +-----------+--------------------+
  1000. | *Setter* | set_param_y(value) |
  1001. +-----------+--------------------+
  1002. | *Getter* | get_param_y() |
  1003. +-----------+--------------------+
  1004. The speed that the linear motor will attempt to reach on the Y axis.
  1005. ----
  1006. .. _class_Generic6DOFJoint_property_linear_motor_z/enabled:
  1007. - :ref:`bool<class_bool>` **linear_motor_z/enabled**
  1008. +-----------+-------------------+
  1009. | *Default* | ``false`` |
  1010. +-----------+-------------------+
  1011. | *Setter* | set_flag_z(value) |
  1012. +-----------+-------------------+
  1013. | *Getter* | get_flag_z() |
  1014. +-----------+-------------------+
  1015. If ``true``, then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits.
  1016. ----
  1017. .. _class_Generic6DOFJoint_property_linear_motor_z/force_limit:
  1018. - :ref:`float<class_float>` **linear_motor_z/force_limit**
  1019. +-----------+--------------------+
  1020. | *Default* | ``0.0`` |
  1021. +-----------+--------------------+
  1022. | *Setter* | set_param_z(value) |
  1023. +-----------+--------------------+
  1024. | *Getter* | get_param_z() |
  1025. +-----------+--------------------+
  1026. The maximum force the linear motor can apply on the Z axis while trying to reach the target velocity.
  1027. ----
  1028. .. _class_Generic6DOFJoint_property_linear_motor_z/target_velocity:
  1029. - :ref:`float<class_float>` **linear_motor_z/target_velocity**
  1030. +-----------+--------------------+
  1031. | *Default* | ``0.0`` |
  1032. +-----------+--------------------+
  1033. | *Setter* | set_param_z(value) |
  1034. +-----------+--------------------+
  1035. | *Getter* | get_param_z() |
  1036. +-----------+--------------------+
  1037. The speed that the linear motor will attempt to reach on the Z axis.
  1038. ----
  1039. .. _class_Generic6DOFJoint_property_linear_spring_x/damping:
  1040. - :ref:`float<class_float>` **linear_spring_x/damping**
  1041. +-----------+--------------------+
  1042. | *Default* | ``0.01`` |
  1043. +-----------+--------------------+
  1044. | *Setter* | set_param_x(value) |
  1045. +-----------+--------------------+
  1046. | *Getter* | get_param_x() |
  1047. +-----------+--------------------+
  1048. ----
  1049. .. _class_Generic6DOFJoint_property_linear_spring_x/enabled:
  1050. - :ref:`bool<class_bool>` **linear_spring_x/enabled**
  1051. +-----------+-------------------+
  1052. | *Default* | ``false`` |
  1053. +-----------+-------------------+
  1054. | *Setter* | set_flag_x(value) |
  1055. +-----------+-------------------+
  1056. | *Getter* | get_flag_x() |
  1057. +-----------+-------------------+
  1058. ----
  1059. .. _class_Generic6DOFJoint_property_linear_spring_x/equilibrium_point:
  1060. - :ref:`float<class_float>` **linear_spring_x/equilibrium_point**
  1061. +-----------+--------------------+
  1062. | *Default* | ``0.0`` |
  1063. +-----------+--------------------+
  1064. | *Setter* | set_param_x(value) |
  1065. +-----------+--------------------+
  1066. | *Getter* | get_param_x() |
  1067. +-----------+--------------------+
  1068. ----
  1069. .. _class_Generic6DOFJoint_property_linear_spring_x/stiffness:
  1070. - :ref:`float<class_float>` **linear_spring_x/stiffness**
  1071. +-----------+--------------------+
  1072. | *Default* | ``0.01`` |
  1073. +-----------+--------------------+
  1074. | *Setter* | set_param_x(value) |
  1075. +-----------+--------------------+
  1076. | *Getter* | get_param_x() |
  1077. +-----------+--------------------+
  1078. ----
  1079. .. _class_Generic6DOFJoint_property_linear_spring_y/damping:
  1080. - :ref:`float<class_float>` **linear_spring_y/damping**
  1081. +-----------+--------------------+
  1082. | *Default* | ``0.01`` |
  1083. +-----------+--------------------+
  1084. | *Setter* | set_param_y(value) |
  1085. +-----------+--------------------+
  1086. | *Getter* | get_param_y() |
  1087. +-----------+--------------------+
  1088. ----
  1089. .. _class_Generic6DOFJoint_property_linear_spring_y/enabled:
  1090. - :ref:`bool<class_bool>` **linear_spring_y/enabled**
  1091. +-----------+-------------------+
  1092. | *Default* | ``false`` |
  1093. +-----------+-------------------+
  1094. | *Setter* | set_flag_y(value) |
  1095. +-----------+-------------------+
  1096. | *Getter* | get_flag_y() |
  1097. +-----------+-------------------+
  1098. ----
  1099. .. _class_Generic6DOFJoint_property_linear_spring_y/equilibrium_point:
  1100. - :ref:`float<class_float>` **linear_spring_y/equilibrium_point**
  1101. +-----------+--------------------+
  1102. | *Default* | ``0.0`` |
  1103. +-----------+--------------------+
  1104. | *Setter* | set_param_y(value) |
  1105. +-----------+--------------------+
  1106. | *Getter* | get_param_y() |
  1107. +-----------+--------------------+
  1108. ----
  1109. .. _class_Generic6DOFJoint_property_linear_spring_y/stiffness:
  1110. - :ref:`float<class_float>` **linear_spring_y/stiffness**
  1111. +-----------+--------------------+
  1112. | *Default* | ``0.01`` |
  1113. +-----------+--------------------+
  1114. | *Setter* | set_param_y(value) |
  1115. +-----------+--------------------+
  1116. | *Getter* | get_param_y() |
  1117. +-----------+--------------------+
  1118. ----
  1119. .. _class_Generic6DOFJoint_property_linear_spring_z/damping:
  1120. - :ref:`float<class_float>` **linear_spring_z/damping**
  1121. +-----------+--------------------+
  1122. | *Default* | ``0.01`` |
  1123. +-----------+--------------------+
  1124. | *Setter* | set_param_z(value) |
  1125. +-----------+--------------------+
  1126. | *Getter* | get_param_z() |
  1127. +-----------+--------------------+
  1128. ----
  1129. .. _class_Generic6DOFJoint_property_linear_spring_z/enabled:
  1130. - :ref:`bool<class_bool>` **linear_spring_z/enabled**
  1131. +-----------+-------------------+
  1132. | *Default* | ``false`` |
  1133. +-----------+-------------------+
  1134. | *Setter* | set_flag_z(value) |
  1135. +-----------+-------------------+
  1136. | *Getter* | get_flag_z() |
  1137. +-----------+-------------------+
  1138. ----
  1139. .. _class_Generic6DOFJoint_property_linear_spring_z/equilibrium_point:
  1140. - :ref:`float<class_float>` **linear_spring_z/equilibrium_point**
  1141. +-----------+--------------------+
  1142. | *Default* | ``0.0`` |
  1143. +-----------+--------------------+
  1144. | *Setter* | set_param_z(value) |
  1145. +-----------+--------------------+
  1146. | *Getter* | get_param_z() |
  1147. +-----------+--------------------+
  1148. ----
  1149. .. _class_Generic6DOFJoint_property_linear_spring_z/stiffness:
  1150. - :ref:`float<class_float>` **linear_spring_z/stiffness**
  1151. +-----------+--------------------+
  1152. | *Default* | ``0.01`` |
  1153. +-----------+--------------------+
  1154. | *Setter* | set_param_z(value) |
  1155. +-----------+--------------------+
  1156. | *Getter* | get_param_z() |
  1157. +-----------+--------------------+
  1158. ----
  1159. .. _class_Generic6DOFJoint_property_precision:
  1160. - :ref:`int<class_int>` **precision**
  1161. +-----------+----------------------+
  1162. | *Default* | ``1`` |
  1163. +-----------+----------------------+
  1164. | *Setter* | set_precision(value) |
  1165. +-----------+----------------------+
  1166. | *Getter* | get_precision() |
  1167. +-----------+----------------------+
  1168. Method Descriptions
  1169. -------------------
  1170. .. _class_Generic6DOFJoint_method_get_flag_x:
  1171. - :ref:`bool<class_bool>` **get_flag_x** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** |const|
  1172. ----
  1173. .. _class_Generic6DOFJoint_method_get_flag_y:
  1174. - :ref:`bool<class_bool>` **get_flag_y** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** |const|
  1175. ----
  1176. .. _class_Generic6DOFJoint_method_get_flag_z:
  1177. - :ref:`bool<class_bool>` **get_flag_z** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** |const|
  1178. ----
  1179. .. _class_Generic6DOFJoint_method_get_param_x:
  1180. - :ref:`float<class_float>` **get_param_x** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** |const|
  1181. ----
  1182. .. _class_Generic6DOFJoint_method_get_param_y:
  1183. - :ref:`float<class_float>` **get_param_y** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** |const|
  1184. ----
  1185. .. _class_Generic6DOFJoint_method_get_param_z:
  1186. - :ref:`float<class_float>` **get_param_z** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** |const|
  1187. ----
  1188. .. _class_Generic6DOFJoint_method_set_flag_x:
  1189. - void **set_flag_x** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)**
  1190. ----
  1191. .. _class_Generic6DOFJoint_method_set_flag_y:
  1192. - void **set_flag_y** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)**
  1193. ----
  1194. .. _class_Generic6DOFJoint_method_set_flag_z:
  1195. - void **set_flag_z** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)**
  1196. ----
  1197. .. _class_Generic6DOFJoint_method_set_param_x:
  1198. - void **set_param_x** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)**
  1199. ----
  1200. .. _class_Generic6DOFJoint_method_set_param_y:
  1201. - void **set_param_y** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)**
  1202. ----
  1203. .. _class_Generic6DOFJoint_method_set_param_z:
  1204. - void **set_param_z** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)**
  1205. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1206. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1207. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`