class_generic6dofjoint.rst 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416
  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. **Category:** Core
  10. Brief Description
  11. -----------------
  12. The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation.
  13. Properties
  14. ----------
  15. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`angular_limit_x/damping<class_Generic6DOFJoint_property_angular_limit_x/damping>` |
  17. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`angular_limit_x/enabled<class_Generic6DOFJoint_property_angular_limit_x/enabled>` |
  19. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`angular_limit_x/erp<class_Generic6DOFJoint_property_angular_limit_x/erp>` |
  21. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`angular_limit_x/force_limit<class_Generic6DOFJoint_property_angular_limit_x/force_limit>` |
  23. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  24. | :ref:`float<class_float>` | :ref:`angular_limit_x/lower_angle<class_Generic6DOFJoint_property_angular_limit_x/lower_angle>` |
  25. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  26. | :ref:`float<class_float>` | :ref:`angular_limit_x/restitution<class_Generic6DOFJoint_property_angular_limit_x/restitution>` |
  27. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  28. | :ref:`float<class_float>` | :ref:`angular_limit_x/softness<class_Generic6DOFJoint_property_angular_limit_x/softness>` |
  29. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  30. | :ref:`float<class_float>` | :ref:`angular_limit_x/upper_angle<class_Generic6DOFJoint_property_angular_limit_x/upper_angle>` |
  31. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  32. | :ref:`float<class_float>` | :ref:`angular_limit_y/damping<class_Generic6DOFJoint_property_angular_limit_y/damping>` |
  33. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  34. | :ref:`bool<class_bool>` | :ref:`angular_limit_y/enabled<class_Generic6DOFJoint_property_angular_limit_y/enabled>` |
  35. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  36. | :ref:`float<class_float>` | :ref:`angular_limit_y/erp<class_Generic6DOFJoint_property_angular_limit_y/erp>` |
  37. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  38. | :ref:`float<class_float>` | :ref:`angular_limit_y/force_limit<class_Generic6DOFJoint_property_angular_limit_y/force_limit>` |
  39. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  40. | :ref:`float<class_float>` | :ref:`angular_limit_y/lower_angle<class_Generic6DOFJoint_property_angular_limit_y/lower_angle>` |
  41. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  42. | :ref:`float<class_float>` | :ref:`angular_limit_y/restitution<class_Generic6DOFJoint_property_angular_limit_y/restitution>` |
  43. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  44. | :ref:`float<class_float>` | :ref:`angular_limit_y/softness<class_Generic6DOFJoint_property_angular_limit_y/softness>` |
  45. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  46. | :ref:`float<class_float>` | :ref:`angular_limit_y/upper_angle<class_Generic6DOFJoint_property_angular_limit_y/upper_angle>` |
  47. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  48. | :ref:`float<class_float>` | :ref:`angular_limit_z/damping<class_Generic6DOFJoint_property_angular_limit_z/damping>` |
  49. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  50. | :ref:`bool<class_bool>` | :ref:`angular_limit_z/enabled<class_Generic6DOFJoint_property_angular_limit_z/enabled>` |
  51. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  52. | :ref:`float<class_float>` | :ref:`angular_limit_z/erp<class_Generic6DOFJoint_property_angular_limit_z/erp>` |
  53. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  54. | :ref:`float<class_float>` | :ref:`angular_limit_z/force_limit<class_Generic6DOFJoint_property_angular_limit_z/force_limit>` |
  55. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  56. | :ref:`float<class_float>` | :ref:`angular_limit_z/lower_angle<class_Generic6DOFJoint_property_angular_limit_z/lower_angle>` |
  57. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  58. | :ref:`float<class_float>` | :ref:`angular_limit_z/restitution<class_Generic6DOFJoint_property_angular_limit_z/restitution>` |
  59. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  60. | :ref:`float<class_float>` | :ref:`angular_limit_z/softness<class_Generic6DOFJoint_property_angular_limit_z/softness>` |
  61. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  62. | :ref:`float<class_float>` | :ref:`angular_limit_z/upper_angle<class_Generic6DOFJoint_property_angular_limit_z/upper_angle>` |
  63. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`angular_motor_x/enabled<class_Generic6DOFJoint_property_angular_motor_x/enabled>` |
  65. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  66. | :ref:`float<class_float>` | :ref:`angular_motor_x/force_limit<class_Generic6DOFJoint_property_angular_motor_x/force_limit>` |
  67. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  68. | :ref:`float<class_float>` | :ref:`angular_motor_x/target_velocity<class_Generic6DOFJoint_property_angular_motor_x/target_velocity>` |
  69. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  70. | :ref:`bool<class_bool>` | :ref:`angular_motor_y/enabled<class_Generic6DOFJoint_property_angular_motor_y/enabled>` |
  71. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  72. | :ref:`float<class_float>` | :ref:`angular_motor_y/force_limit<class_Generic6DOFJoint_property_angular_motor_y/force_limit>` |
  73. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  74. | :ref:`float<class_float>` | :ref:`angular_motor_y/target_velocity<class_Generic6DOFJoint_property_angular_motor_y/target_velocity>` |
  75. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  76. | :ref:`bool<class_bool>` | :ref:`angular_motor_z/enabled<class_Generic6DOFJoint_property_angular_motor_z/enabled>` |
  77. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  78. | :ref:`float<class_float>` | :ref:`angular_motor_z/force_limit<class_Generic6DOFJoint_property_angular_motor_z/force_limit>` |
  79. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  80. | :ref:`float<class_float>` | :ref:`angular_motor_z/target_velocity<class_Generic6DOFJoint_property_angular_motor_z/target_velocity>` |
  81. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  82. | :ref:`float<class_float>` | :ref:`angular_spring_x/damping<class_Generic6DOFJoint_property_angular_spring_x/damping>` |
  83. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  84. | :ref:`bool<class_bool>` | :ref:`angular_spring_x/enabled<class_Generic6DOFJoint_property_angular_spring_x/enabled>` |
  85. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  86. | :ref:`float<class_float>` | :ref:`angular_spring_x/equilibrium_point<class_Generic6DOFJoint_property_angular_spring_x/equilibrium_point>` |
  87. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  88. | :ref:`float<class_float>` | :ref:`angular_spring_x/stiffness<class_Generic6DOFJoint_property_angular_spring_x/stiffness>` |
  89. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  90. | :ref:`float<class_float>` | :ref:`angular_spring_y/damping<class_Generic6DOFJoint_property_angular_spring_y/damping>` |
  91. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  92. | :ref:`bool<class_bool>` | :ref:`angular_spring_y/enabled<class_Generic6DOFJoint_property_angular_spring_y/enabled>` |
  93. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  94. | :ref:`float<class_float>` | :ref:`angular_spring_y/equilibrium_point<class_Generic6DOFJoint_property_angular_spring_y/equilibrium_point>` |
  95. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  96. | :ref:`float<class_float>` | :ref:`angular_spring_y/stiffness<class_Generic6DOFJoint_property_angular_spring_y/stiffness>` |
  97. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  98. | :ref:`float<class_float>` | :ref:`angular_spring_z/damping<class_Generic6DOFJoint_property_angular_spring_z/damping>` |
  99. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  100. | :ref:`bool<class_bool>` | :ref:`angular_spring_z/enabled<class_Generic6DOFJoint_property_angular_spring_z/enabled>` |
  101. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  102. | :ref:`float<class_float>` | :ref:`angular_spring_z/equilibrium_point<class_Generic6DOFJoint_property_angular_spring_z/equilibrium_point>` |
  103. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  104. | :ref:`float<class_float>` | :ref:`angular_spring_z/stiffness<class_Generic6DOFJoint_property_angular_spring_z/stiffness>` |
  105. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  106. | :ref:`float<class_float>` | :ref:`linear_limit_x/damping<class_Generic6DOFJoint_property_linear_limit_x/damping>` |
  107. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  108. | :ref:`bool<class_bool>` | :ref:`linear_limit_x/enabled<class_Generic6DOFJoint_property_linear_limit_x/enabled>` |
  109. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  110. | :ref:`float<class_float>` | :ref:`linear_limit_x/lower_distance<class_Generic6DOFJoint_property_linear_limit_x/lower_distance>` |
  111. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  112. | :ref:`float<class_float>` | :ref:`linear_limit_x/restitution<class_Generic6DOFJoint_property_linear_limit_x/restitution>` |
  113. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  114. | :ref:`float<class_float>` | :ref:`linear_limit_x/softness<class_Generic6DOFJoint_property_linear_limit_x/softness>` |
  115. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  116. | :ref:`float<class_float>` | :ref:`linear_limit_x/upper_distance<class_Generic6DOFJoint_property_linear_limit_x/upper_distance>` |
  117. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  118. | :ref:`float<class_float>` | :ref:`linear_limit_y/damping<class_Generic6DOFJoint_property_linear_limit_y/damping>` |
  119. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  120. | :ref:`bool<class_bool>` | :ref:`linear_limit_y/enabled<class_Generic6DOFJoint_property_linear_limit_y/enabled>` |
  121. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  122. | :ref:`float<class_float>` | :ref:`linear_limit_y/lower_distance<class_Generic6DOFJoint_property_linear_limit_y/lower_distance>` |
  123. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  124. | :ref:`float<class_float>` | :ref:`linear_limit_y/restitution<class_Generic6DOFJoint_property_linear_limit_y/restitution>` |
  125. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  126. | :ref:`float<class_float>` | :ref:`linear_limit_y/softness<class_Generic6DOFJoint_property_linear_limit_y/softness>` |
  127. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  128. | :ref:`float<class_float>` | :ref:`linear_limit_y/upper_distance<class_Generic6DOFJoint_property_linear_limit_y/upper_distance>` |
  129. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  130. | :ref:`float<class_float>` | :ref:`linear_limit_z/damping<class_Generic6DOFJoint_property_linear_limit_z/damping>` |
  131. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  132. | :ref:`bool<class_bool>` | :ref:`linear_limit_z/enabled<class_Generic6DOFJoint_property_linear_limit_z/enabled>` |
  133. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  134. | :ref:`float<class_float>` | :ref:`linear_limit_z/lower_distance<class_Generic6DOFJoint_property_linear_limit_z/lower_distance>` |
  135. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  136. | :ref:`float<class_float>` | :ref:`linear_limit_z/restitution<class_Generic6DOFJoint_property_linear_limit_z/restitution>` |
  137. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  138. | :ref:`float<class_float>` | :ref:`linear_limit_z/softness<class_Generic6DOFJoint_property_linear_limit_z/softness>` |
  139. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  140. | :ref:`float<class_float>` | :ref:`linear_limit_z/upper_distance<class_Generic6DOFJoint_property_linear_limit_z/upper_distance>` |
  141. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  142. | :ref:`bool<class_bool>` | :ref:`linear_motor_x/enabled<class_Generic6DOFJoint_property_linear_motor_x/enabled>` |
  143. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  144. | :ref:`float<class_float>` | :ref:`linear_motor_x/force_limit<class_Generic6DOFJoint_property_linear_motor_x/force_limit>` |
  145. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  146. | :ref:`float<class_float>` | :ref:`linear_motor_x/target_velocity<class_Generic6DOFJoint_property_linear_motor_x/target_velocity>` |
  147. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  148. | :ref:`bool<class_bool>` | :ref:`linear_motor_y/enabled<class_Generic6DOFJoint_property_linear_motor_y/enabled>` |
  149. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  150. | :ref:`float<class_float>` | :ref:`linear_motor_y/force_limit<class_Generic6DOFJoint_property_linear_motor_y/force_limit>` |
  151. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  152. | :ref:`float<class_float>` | :ref:`linear_motor_y/target_velocity<class_Generic6DOFJoint_property_linear_motor_y/target_velocity>` |
  153. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  154. | :ref:`bool<class_bool>` | :ref:`linear_motor_z/enabled<class_Generic6DOFJoint_property_linear_motor_z/enabled>` |
  155. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  156. | :ref:`float<class_float>` | :ref:`linear_motor_z/force_limit<class_Generic6DOFJoint_property_linear_motor_z/force_limit>` |
  157. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  158. | :ref:`float<class_float>` | :ref:`linear_motor_z/target_velocity<class_Generic6DOFJoint_property_linear_motor_z/target_velocity>` |
  159. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  160. | :ref:`float<class_float>` | :ref:`linear_spring_x/damping<class_Generic6DOFJoint_property_linear_spring_x/damping>` |
  161. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  162. | :ref:`bool<class_bool>` | :ref:`linear_spring_x/enabled<class_Generic6DOFJoint_property_linear_spring_x/enabled>` |
  163. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  164. | :ref:`float<class_float>` | :ref:`linear_spring_x/equilibrium_point<class_Generic6DOFJoint_property_linear_spring_x/equilibrium_point>` |
  165. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  166. | :ref:`float<class_float>` | :ref:`linear_spring_x/stiffness<class_Generic6DOFJoint_property_linear_spring_x/stiffness>` |
  167. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  168. | :ref:`float<class_float>` | :ref:`linear_spring_y/damping<class_Generic6DOFJoint_property_linear_spring_y/damping>` |
  169. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  170. | :ref:`bool<class_bool>` | :ref:`linear_spring_y/enabled<class_Generic6DOFJoint_property_linear_spring_y/enabled>` |
  171. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  172. | :ref:`float<class_float>` | :ref:`linear_spring_y/equilibrium_point<class_Generic6DOFJoint_property_linear_spring_y/equilibrium_point>` |
  173. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  174. | :ref:`float<class_float>` | :ref:`linear_spring_y/stiffness<class_Generic6DOFJoint_property_linear_spring_y/stiffness>` |
  175. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  176. | :ref:`float<class_float>` | :ref:`linear_spring_z/damping<class_Generic6DOFJoint_property_linear_spring_z/damping>` |
  177. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  178. | :ref:`bool<class_bool>` | :ref:`linear_spring_z/enabled<class_Generic6DOFJoint_property_linear_spring_z/enabled>` |
  179. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  180. | :ref:`float<class_float>` | :ref:`linear_spring_z/equilibrium_point<class_Generic6DOFJoint_property_linear_spring_z/equilibrium_point>` |
  181. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  182. | :ref:`float<class_float>` | :ref:`linear_spring_z/stiffness<class_Generic6DOFJoint_property_linear_spring_z/stiffness>` |
  183. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  184. | :ref:`int<class_int>` | :ref:`precision<class_Generic6DOFJoint_property_precision>` |
  185. +---------------------------+---------------------------------------------------------------------------------------------------------------+
  186. Enumerations
  187. ------------
  188. .. _enum_Generic6DOFJoint_Param:
  189. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LOWER_LIMIT:
  190. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_UPPER_LIMIT:
  191. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LIMIT_SOFTNESS:
  192. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_RESTITUTION:
  193. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_DAMPING:
  194. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_TARGET_VELOCITY:
  195. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_FORCE_LIMIT:
  196. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LOWER_LIMIT:
  197. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_UPPER_LIMIT:
  198. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LIMIT_SOFTNESS:
  199. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_DAMPING:
  200. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_RESTITUTION:
  201. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_FORCE_LIMIT:
  202. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_ERP:
  203. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_TARGET_VELOCITY:
  204. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_FORCE_LIMIT:
  205. .. _class_Generic6DOFJoint_constant_PARAM_MAX:
  206. enum **Param**:
  207. - **PARAM_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes.
  208. - **PARAM_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes.
  209. - **PARAM_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor applied to the movement across the axes The lower, the slower the movement.
  210. - **PARAM_LINEAR_RESTITUTION** = **3** --- The amount of restitution on the axes movement The lower, the more momentum gets lost.
  211. - **PARAM_LINEAR_DAMPING** = **4** --- The amount of damping that happens at the linear motion across the axes.
  212. - **PARAM_LINEAR_MOTOR_TARGET_VELOCITY** = **5** --- The velocity the linear motor will try to reach.
  213. - **PARAM_LINEAR_MOTOR_FORCE_LIMIT** = **6** --- The maximum force the linear motor will apply while trying to reach the velocity target.
  214. - **PARAM_ANGULAR_LOWER_LIMIT** = **10** --- The minimum rotation in negative direction to break loose and rotate around the axes.
  215. - **PARAM_ANGULAR_UPPER_LIMIT** = **11** --- The minimum rotation in positive direction to break loose and rotate around the axes.
  216. - **PARAM_ANGULAR_LIMIT_SOFTNESS** = **12** --- The speed of all rotations across the axes.
  217. - **PARAM_ANGULAR_DAMPING** = **13** --- The amount of rotational damping across the axes. The lower, the more dampening occurs.
  218. - **PARAM_ANGULAR_RESTITUTION** = **14** --- The amount of rotational restitution across the axes. The lower, the more restitution occurs.
  219. - **PARAM_ANGULAR_FORCE_LIMIT** = **15** --- The maximum amount of force that can occur, when rotating around the axes.
  220. - **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.
  221. - **PARAM_ANGULAR_MOTOR_TARGET_VELOCITY** = **17** --- Target speed for the motor at the axes.
  222. - **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = **18** --- Maximum acceleration for the motor at the axes.
  223. - **PARAM_MAX** = **22** --- Represents the size of the :ref:`Param<enum_Generic6DOFJoint_Param>` enum.
  224. ----
  225. .. _enum_Generic6DOFJoint_Flag:
  226. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_LIMIT:
  227. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_LIMIT:
  228. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_SPRING:
  229. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_SPRING:
  230. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_MOTOR:
  231. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_MOTOR:
  232. .. _class_Generic6DOFJoint_constant_FLAG_MAX:
  233. enum **Flag**:
  234. - **FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits.
  235. - **FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible.
  236. - **FLAG_ENABLE_LINEAR_SPRING** = **3**
  237. - **FLAG_ENABLE_ANGULAR_SPRING** = **2**
  238. - **FLAG_ENABLE_MOTOR** = **4** --- If ``set`` there is a rotational motor across these axes.
  239. - **FLAG_ENABLE_LINEAR_MOTOR** = **5**
  240. - **FLAG_MAX** = **6** --- Represents the size of the :ref:`Flag<enum_Generic6DOFJoint_Flag>` enum.
  241. Description
  242. -----------
  243. 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.
  244. Property Descriptions
  245. ---------------------
  246. .. _class_Generic6DOFJoint_property_angular_limit_x/damping:
  247. - :ref:`float<class_float>` **angular_limit_x/damping**
  248. +----------+--------------------+
  249. | *Setter* | set_param_x(value) |
  250. +----------+--------------------+
  251. | *Getter* | get_param_x() |
  252. +----------+--------------------+
  253. The amount of rotational damping across the x-axis.
  254. The lower, the longer an impulse from one side takes to travel to the other side.
  255. ----
  256. .. _class_Generic6DOFJoint_property_angular_limit_x/enabled:
  257. - :ref:`bool<class_bool>` **angular_limit_x/enabled**
  258. +----------+-------------------+
  259. | *Setter* | set_flag_x(value) |
  260. +----------+-------------------+
  261. | *Getter* | get_flag_x() |
  262. +----------+-------------------+
  263. If ``true``, rotation across the x-axis is limited.
  264. ----
  265. .. _class_Generic6DOFJoint_property_angular_limit_x/erp:
  266. - :ref:`float<class_float>` **angular_limit_x/erp**
  267. +----------+--------------------+
  268. | *Setter* | set_param_x(value) |
  269. +----------+--------------------+
  270. | *Getter* | get_param_x() |
  271. +----------+--------------------+
  272. When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
  273. ----
  274. .. _class_Generic6DOFJoint_property_angular_limit_x/force_limit:
  275. - :ref:`float<class_float>` **angular_limit_x/force_limit**
  276. +----------+--------------------+
  277. | *Setter* | set_param_x(value) |
  278. +----------+--------------------+
  279. | *Getter* | get_param_x() |
  280. +----------+--------------------+
  281. The maximum amount of force that can occur, when rotating around x-axis.
  282. ----
  283. .. _class_Generic6DOFJoint_property_angular_limit_x/lower_angle:
  284. - :ref:`float<class_float>` **angular_limit_x/lower_angle**
  285. The minimum rotation in negative direction to break loose and rotate around the x-axis.
  286. ----
  287. .. _class_Generic6DOFJoint_property_angular_limit_x/restitution:
  288. - :ref:`float<class_float>` **angular_limit_x/restitution**
  289. +----------+--------------------+
  290. | *Setter* | set_param_x(value) |
  291. +----------+--------------------+
  292. | *Getter* | get_param_x() |
  293. +----------+--------------------+
  294. The amount of rotational restitution across the x-axis. The lower, the more restitution occurs.
  295. ----
  296. .. _class_Generic6DOFJoint_property_angular_limit_x/softness:
  297. - :ref:`float<class_float>` **angular_limit_x/softness**
  298. +----------+--------------------+
  299. | *Setter* | set_param_x(value) |
  300. +----------+--------------------+
  301. | *Getter* | get_param_x() |
  302. +----------+--------------------+
  303. The speed of all rotations across the x-axis.
  304. ----
  305. .. _class_Generic6DOFJoint_property_angular_limit_x/upper_angle:
  306. - :ref:`float<class_float>` **angular_limit_x/upper_angle**
  307. The minimum rotation in positive direction to break loose and rotate around the x-axis.
  308. ----
  309. .. _class_Generic6DOFJoint_property_angular_limit_y/damping:
  310. - :ref:`float<class_float>` **angular_limit_y/damping**
  311. +----------+--------------------+
  312. | *Setter* | set_param_y(value) |
  313. +----------+--------------------+
  314. | *Getter* | get_param_y() |
  315. +----------+--------------------+
  316. The amount of rotational damping across the y-axis. The lower, the more dampening occurs.
  317. ----
  318. .. _class_Generic6DOFJoint_property_angular_limit_y/enabled:
  319. - :ref:`bool<class_bool>` **angular_limit_y/enabled**
  320. +----------+-------------------+
  321. | *Setter* | set_flag_y(value) |
  322. +----------+-------------------+
  323. | *Getter* | get_flag_y() |
  324. +----------+-------------------+
  325. If ``true``, rotation across the y-axis is limited.
  326. ----
  327. .. _class_Generic6DOFJoint_property_angular_limit_y/erp:
  328. - :ref:`float<class_float>` **angular_limit_y/erp**
  329. +----------+--------------------+
  330. | *Setter* | set_param_y(value) |
  331. +----------+--------------------+
  332. | *Getter* | get_param_y() |
  333. +----------+--------------------+
  334. When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
  335. ----
  336. .. _class_Generic6DOFJoint_property_angular_limit_y/force_limit:
  337. - :ref:`float<class_float>` **angular_limit_y/force_limit**
  338. +----------+--------------------+
  339. | *Setter* | set_param_y(value) |
  340. +----------+--------------------+
  341. | *Getter* | get_param_y() |
  342. +----------+--------------------+
  343. The maximum amount of force that can occur, when rotating around y-axis.
  344. ----
  345. .. _class_Generic6DOFJoint_property_angular_limit_y/lower_angle:
  346. - :ref:`float<class_float>` **angular_limit_y/lower_angle**
  347. The minimum rotation in negative direction to break loose and rotate around the y-axis.
  348. ----
  349. .. _class_Generic6DOFJoint_property_angular_limit_y/restitution:
  350. - :ref:`float<class_float>` **angular_limit_y/restitution**
  351. +----------+--------------------+
  352. | *Setter* | set_param_y(value) |
  353. +----------+--------------------+
  354. | *Getter* | get_param_y() |
  355. +----------+--------------------+
  356. The amount of rotational restitution across the y-axis. The lower, the more restitution occurs.
  357. ----
  358. .. _class_Generic6DOFJoint_property_angular_limit_y/softness:
  359. - :ref:`float<class_float>` **angular_limit_y/softness**
  360. +----------+--------------------+
  361. | *Setter* | set_param_y(value) |
  362. +----------+--------------------+
  363. | *Getter* | get_param_y() |
  364. +----------+--------------------+
  365. The speed of all rotations across the y-axis.
  366. ----
  367. .. _class_Generic6DOFJoint_property_angular_limit_y/upper_angle:
  368. - :ref:`float<class_float>` **angular_limit_y/upper_angle**
  369. The minimum rotation in positive direction to break loose and rotate around the y-axis.
  370. ----
  371. .. _class_Generic6DOFJoint_property_angular_limit_z/damping:
  372. - :ref:`float<class_float>` **angular_limit_z/damping**
  373. +----------+--------------------+
  374. | *Setter* | set_param_z(value) |
  375. +----------+--------------------+
  376. | *Getter* | get_param_z() |
  377. +----------+--------------------+
  378. The amount of rotational damping across the z-axis. The lower, the more dampening occurs.
  379. ----
  380. .. _class_Generic6DOFJoint_property_angular_limit_z/enabled:
  381. - :ref:`bool<class_bool>` **angular_limit_z/enabled**
  382. +----------+-------------------+
  383. | *Setter* | set_flag_z(value) |
  384. +----------+-------------------+
  385. | *Getter* | get_flag_z() |
  386. +----------+-------------------+
  387. If ``true``, rotation across the z-axis is limited.
  388. ----
  389. .. _class_Generic6DOFJoint_property_angular_limit_z/erp:
  390. - :ref:`float<class_float>` **angular_limit_z/erp**
  391. +----------+--------------------+
  392. | *Setter* | set_param_z(value) |
  393. +----------+--------------------+
  394. | *Getter* | get_param_z() |
  395. +----------+--------------------+
  396. When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
  397. ----
  398. .. _class_Generic6DOFJoint_property_angular_limit_z/force_limit:
  399. - :ref:`float<class_float>` **angular_limit_z/force_limit**
  400. +----------+--------------------+
  401. | *Setter* | set_param_z(value) |
  402. +----------+--------------------+
  403. | *Getter* | get_param_z() |
  404. +----------+--------------------+
  405. The maximum amount of force that can occur, when rotating around z-axis.
  406. ----
  407. .. _class_Generic6DOFJoint_property_angular_limit_z/lower_angle:
  408. - :ref:`float<class_float>` **angular_limit_z/lower_angle**
  409. The minimum rotation in negative direction to break loose and rotate around the z-axis.
  410. ----
  411. .. _class_Generic6DOFJoint_property_angular_limit_z/restitution:
  412. - :ref:`float<class_float>` **angular_limit_z/restitution**
  413. +----------+--------------------+
  414. | *Setter* | set_param_z(value) |
  415. +----------+--------------------+
  416. | *Getter* | get_param_z() |
  417. +----------+--------------------+
  418. The amount of rotational restitution across the z-axis. The lower, the more restitution occurs.
  419. ----
  420. .. _class_Generic6DOFJoint_property_angular_limit_z/softness:
  421. - :ref:`float<class_float>` **angular_limit_z/softness**
  422. +----------+--------------------+
  423. | *Setter* | set_param_z(value) |
  424. +----------+--------------------+
  425. | *Getter* | get_param_z() |
  426. +----------+--------------------+
  427. The speed of all rotations across the z-axis.
  428. ----
  429. .. _class_Generic6DOFJoint_property_angular_limit_z/upper_angle:
  430. - :ref:`float<class_float>` **angular_limit_z/upper_angle**
  431. The minimum rotation in positive direction to break loose and rotate around the z-axis.
  432. ----
  433. .. _class_Generic6DOFJoint_property_angular_motor_x/enabled:
  434. - :ref:`bool<class_bool>` **angular_motor_x/enabled**
  435. +----------+-------------------+
  436. | *Setter* | set_flag_x(value) |
  437. +----------+-------------------+
  438. | *Getter* | get_flag_x() |
  439. +----------+-------------------+
  440. If ``true``, a rotating motor at the x-axis is enabled.
  441. ----
  442. .. _class_Generic6DOFJoint_property_angular_motor_x/force_limit:
  443. - :ref:`float<class_float>` **angular_motor_x/force_limit**
  444. +----------+--------------------+
  445. | *Setter* | set_param_x(value) |
  446. +----------+--------------------+
  447. | *Getter* | get_param_x() |
  448. +----------+--------------------+
  449. Maximum acceleration for the motor at the x-axis.
  450. ----
  451. .. _class_Generic6DOFJoint_property_angular_motor_x/target_velocity:
  452. - :ref:`float<class_float>` **angular_motor_x/target_velocity**
  453. +----------+--------------------+
  454. | *Setter* | set_param_x(value) |
  455. +----------+--------------------+
  456. | *Getter* | get_param_x() |
  457. +----------+--------------------+
  458. Target speed for the motor at the x-axis.
  459. ----
  460. .. _class_Generic6DOFJoint_property_angular_motor_y/enabled:
  461. - :ref:`bool<class_bool>` **angular_motor_y/enabled**
  462. +----------+-------------------+
  463. | *Setter* | set_flag_y(value) |
  464. +----------+-------------------+
  465. | *Getter* | get_flag_y() |
  466. +----------+-------------------+
  467. If ``true``, a rotating motor at the y-axis is enabled.
  468. ----
  469. .. _class_Generic6DOFJoint_property_angular_motor_y/force_limit:
  470. - :ref:`float<class_float>` **angular_motor_y/force_limit**
  471. +----------+--------------------+
  472. | *Setter* | set_param_y(value) |
  473. +----------+--------------------+
  474. | *Getter* | get_param_y() |
  475. +----------+--------------------+
  476. Maximum acceleration for the motor at the y-axis.
  477. ----
  478. .. _class_Generic6DOFJoint_property_angular_motor_y/target_velocity:
  479. - :ref:`float<class_float>` **angular_motor_y/target_velocity**
  480. +----------+--------------------+
  481. | *Setter* | set_param_y(value) |
  482. +----------+--------------------+
  483. | *Getter* | get_param_y() |
  484. +----------+--------------------+
  485. Target speed for the motor at the y-axis.
  486. ----
  487. .. _class_Generic6DOFJoint_property_angular_motor_z/enabled:
  488. - :ref:`bool<class_bool>` **angular_motor_z/enabled**
  489. +----------+-------------------+
  490. | *Setter* | set_flag_z(value) |
  491. +----------+-------------------+
  492. | *Getter* | get_flag_z() |
  493. +----------+-------------------+
  494. If ``true``, a rotating motor at the z-axis is enabled.
  495. ----
  496. .. _class_Generic6DOFJoint_property_angular_motor_z/force_limit:
  497. - :ref:`float<class_float>` **angular_motor_z/force_limit**
  498. +----------+--------------------+
  499. | *Setter* | set_param_z(value) |
  500. +----------+--------------------+
  501. | *Getter* | get_param_z() |
  502. +----------+--------------------+
  503. Maximum acceleration for the motor at the z-axis.
  504. ----
  505. .. _class_Generic6DOFJoint_property_angular_motor_z/target_velocity:
  506. - :ref:`float<class_float>` **angular_motor_z/target_velocity**
  507. +----------+--------------------+
  508. | *Setter* | set_param_z(value) |
  509. +----------+--------------------+
  510. | *Getter* | get_param_z() |
  511. +----------+--------------------+
  512. Target speed for the motor at the z-axis.
  513. ----
  514. .. _class_Generic6DOFJoint_property_angular_spring_x/damping:
  515. - :ref:`float<class_float>` **angular_spring_x/damping**
  516. +----------+--------------------+
  517. | *Setter* | set_param_x(value) |
  518. +----------+--------------------+
  519. | *Getter* | get_param_x() |
  520. +----------+--------------------+
  521. ----
  522. .. _class_Generic6DOFJoint_property_angular_spring_x/enabled:
  523. - :ref:`bool<class_bool>` **angular_spring_x/enabled**
  524. +----------+-------------------+
  525. | *Setter* | set_flag_x(value) |
  526. +----------+-------------------+
  527. | *Getter* | get_flag_x() |
  528. +----------+-------------------+
  529. ----
  530. .. _class_Generic6DOFJoint_property_angular_spring_x/equilibrium_point:
  531. - :ref:`float<class_float>` **angular_spring_x/equilibrium_point**
  532. +----------+--------------------+
  533. | *Setter* | set_param_x(value) |
  534. +----------+--------------------+
  535. | *Getter* | get_param_x() |
  536. +----------+--------------------+
  537. ----
  538. .. _class_Generic6DOFJoint_property_angular_spring_x/stiffness:
  539. - :ref:`float<class_float>` **angular_spring_x/stiffness**
  540. +----------+--------------------+
  541. | *Setter* | set_param_x(value) |
  542. +----------+--------------------+
  543. | *Getter* | get_param_x() |
  544. +----------+--------------------+
  545. ----
  546. .. _class_Generic6DOFJoint_property_angular_spring_y/damping:
  547. - :ref:`float<class_float>` **angular_spring_y/damping**
  548. +----------+--------------------+
  549. | *Setter* | set_param_y(value) |
  550. +----------+--------------------+
  551. | *Getter* | get_param_y() |
  552. +----------+--------------------+
  553. ----
  554. .. _class_Generic6DOFJoint_property_angular_spring_y/enabled:
  555. - :ref:`bool<class_bool>` **angular_spring_y/enabled**
  556. +----------+-------------------+
  557. | *Setter* | set_flag_y(value) |
  558. +----------+-------------------+
  559. | *Getter* | get_flag_y() |
  560. +----------+-------------------+
  561. ----
  562. .. _class_Generic6DOFJoint_property_angular_spring_y/equilibrium_point:
  563. - :ref:`float<class_float>` **angular_spring_y/equilibrium_point**
  564. +----------+--------------------+
  565. | *Setter* | set_param_y(value) |
  566. +----------+--------------------+
  567. | *Getter* | get_param_y() |
  568. +----------+--------------------+
  569. ----
  570. .. _class_Generic6DOFJoint_property_angular_spring_y/stiffness:
  571. - :ref:`float<class_float>` **angular_spring_y/stiffness**
  572. +----------+--------------------+
  573. | *Setter* | set_param_y(value) |
  574. +----------+--------------------+
  575. | *Getter* | get_param_y() |
  576. +----------+--------------------+
  577. ----
  578. .. _class_Generic6DOFJoint_property_angular_spring_z/damping:
  579. - :ref:`float<class_float>` **angular_spring_z/damping**
  580. +----------+--------------------+
  581. | *Setter* | set_param_z(value) |
  582. +----------+--------------------+
  583. | *Getter* | get_param_z() |
  584. +----------+--------------------+
  585. ----
  586. .. _class_Generic6DOFJoint_property_angular_spring_z/enabled:
  587. - :ref:`bool<class_bool>` **angular_spring_z/enabled**
  588. +----------+-------------------+
  589. | *Setter* | set_flag_z(value) |
  590. +----------+-------------------+
  591. | *Getter* | get_flag_z() |
  592. +----------+-------------------+
  593. ----
  594. .. _class_Generic6DOFJoint_property_angular_spring_z/equilibrium_point:
  595. - :ref:`float<class_float>` **angular_spring_z/equilibrium_point**
  596. +----------+--------------------+
  597. | *Setter* | set_param_z(value) |
  598. +----------+--------------------+
  599. | *Getter* | get_param_z() |
  600. +----------+--------------------+
  601. ----
  602. .. _class_Generic6DOFJoint_property_angular_spring_z/stiffness:
  603. - :ref:`float<class_float>` **angular_spring_z/stiffness**
  604. +----------+--------------------+
  605. | *Setter* | set_param_z(value) |
  606. +----------+--------------------+
  607. | *Getter* | get_param_z() |
  608. +----------+--------------------+
  609. ----
  610. .. _class_Generic6DOFJoint_property_linear_limit_x/damping:
  611. - :ref:`float<class_float>` **linear_limit_x/damping**
  612. +----------+--------------------+
  613. | *Setter* | set_param_x(value) |
  614. +----------+--------------------+
  615. | *Getter* | get_param_x() |
  616. +----------+--------------------+
  617. The amount of damping that happens at the x-motion.
  618. ----
  619. .. _class_Generic6DOFJoint_property_linear_limit_x/enabled:
  620. - :ref:`bool<class_bool>` **linear_limit_x/enabled**
  621. +----------+-------------------+
  622. | *Setter* | set_flag_x(value) |
  623. +----------+-------------------+
  624. | *Getter* | get_flag_x() |
  625. +----------+-------------------+
  626. If ``true``, the linear motion across the x-axis is limited.
  627. ----
  628. .. _class_Generic6DOFJoint_property_linear_limit_x/lower_distance:
  629. - :ref:`float<class_float>` **linear_limit_x/lower_distance**
  630. +----------+--------------------+
  631. | *Setter* | set_param_x(value) |
  632. +----------+--------------------+
  633. | *Getter* | get_param_x() |
  634. +----------+--------------------+
  635. The minimum difference between the pivot points' x-axis.
  636. ----
  637. .. _class_Generic6DOFJoint_property_linear_limit_x/restitution:
  638. - :ref:`float<class_float>` **linear_limit_x/restitution**
  639. +----------+--------------------+
  640. | *Setter* | set_param_x(value) |
  641. +----------+--------------------+
  642. | *Getter* | get_param_x() |
  643. +----------+--------------------+
  644. The amount of restitution on the x-axis movement The lower, the more momentum gets lost.
  645. ----
  646. .. _class_Generic6DOFJoint_property_linear_limit_x/softness:
  647. - :ref:`float<class_float>` **linear_limit_x/softness**
  648. +----------+--------------------+
  649. | *Setter* | set_param_x(value) |
  650. +----------+--------------------+
  651. | *Getter* | get_param_x() |
  652. +----------+--------------------+
  653. A factor applied to the movement across the x-axis The lower, the slower the movement.
  654. ----
  655. .. _class_Generic6DOFJoint_property_linear_limit_x/upper_distance:
  656. - :ref:`float<class_float>` **linear_limit_x/upper_distance**
  657. +----------+--------------------+
  658. | *Setter* | set_param_x(value) |
  659. +----------+--------------------+
  660. | *Getter* | get_param_x() |
  661. +----------+--------------------+
  662. The maximum difference between the pivot points' x-axis.
  663. ----
  664. .. _class_Generic6DOFJoint_property_linear_limit_y/damping:
  665. - :ref:`float<class_float>` **linear_limit_y/damping**
  666. +----------+--------------------+
  667. | *Setter* | set_param_y(value) |
  668. +----------+--------------------+
  669. | *Getter* | get_param_y() |
  670. +----------+--------------------+
  671. The amount of damping that happens at the y-motion.
  672. ----
  673. .. _class_Generic6DOFJoint_property_linear_limit_y/enabled:
  674. - :ref:`bool<class_bool>` **linear_limit_y/enabled**
  675. +----------+-------------------+
  676. | *Setter* | set_flag_y(value) |
  677. +----------+-------------------+
  678. | *Getter* | get_flag_y() |
  679. +----------+-------------------+
  680. If ``true``, the linear motion across the y-axis is limited.
  681. ----
  682. .. _class_Generic6DOFJoint_property_linear_limit_y/lower_distance:
  683. - :ref:`float<class_float>` **linear_limit_y/lower_distance**
  684. +----------+--------------------+
  685. | *Setter* | set_param_y(value) |
  686. +----------+--------------------+
  687. | *Getter* | get_param_y() |
  688. +----------+--------------------+
  689. The minimum difference between the pivot points' y-axis.
  690. ----
  691. .. _class_Generic6DOFJoint_property_linear_limit_y/restitution:
  692. - :ref:`float<class_float>` **linear_limit_y/restitution**
  693. +----------+--------------------+
  694. | *Setter* | set_param_y(value) |
  695. +----------+--------------------+
  696. | *Getter* | get_param_y() |
  697. +----------+--------------------+
  698. The amount of restitution on the y-axis movement The lower, the more momentum gets lost.
  699. ----
  700. .. _class_Generic6DOFJoint_property_linear_limit_y/softness:
  701. - :ref:`float<class_float>` **linear_limit_y/softness**
  702. +----------+--------------------+
  703. | *Setter* | set_param_y(value) |
  704. +----------+--------------------+
  705. | *Getter* | get_param_y() |
  706. +----------+--------------------+
  707. A factor applied to the movement across the y-axis The lower, the slower the movement.
  708. ----
  709. .. _class_Generic6DOFJoint_property_linear_limit_y/upper_distance:
  710. - :ref:`float<class_float>` **linear_limit_y/upper_distance**
  711. +----------+--------------------+
  712. | *Setter* | set_param_y(value) |
  713. +----------+--------------------+
  714. | *Getter* | get_param_y() |
  715. +----------+--------------------+
  716. The maximum difference between the pivot points' y-axis.
  717. ----
  718. .. _class_Generic6DOFJoint_property_linear_limit_z/damping:
  719. - :ref:`float<class_float>` **linear_limit_z/damping**
  720. +----------+--------------------+
  721. | *Setter* | set_param_z(value) |
  722. +----------+--------------------+
  723. | *Getter* | get_param_z() |
  724. +----------+--------------------+
  725. The amount of damping that happens at the z-motion.
  726. ----
  727. .. _class_Generic6DOFJoint_property_linear_limit_z/enabled:
  728. - :ref:`bool<class_bool>` **linear_limit_z/enabled**
  729. +----------+-------------------+
  730. | *Setter* | set_flag_z(value) |
  731. +----------+-------------------+
  732. | *Getter* | get_flag_z() |
  733. +----------+-------------------+
  734. If ``true``, the linear motion across the z-axis is limited.
  735. ----
  736. .. _class_Generic6DOFJoint_property_linear_limit_z/lower_distance:
  737. - :ref:`float<class_float>` **linear_limit_z/lower_distance**
  738. +----------+--------------------+
  739. | *Setter* | set_param_z(value) |
  740. +----------+--------------------+
  741. | *Getter* | get_param_z() |
  742. +----------+--------------------+
  743. The minimum difference between the pivot points' z-axis.
  744. ----
  745. .. _class_Generic6DOFJoint_property_linear_limit_z/restitution:
  746. - :ref:`float<class_float>` **linear_limit_z/restitution**
  747. +----------+--------------------+
  748. | *Setter* | set_param_z(value) |
  749. +----------+--------------------+
  750. | *Getter* | get_param_z() |
  751. +----------+--------------------+
  752. The amount of restitution on the z-axis movement The lower, the more momentum gets lost.
  753. ----
  754. .. _class_Generic6DOFJoint_property_linear_limit_z/softness:
  755. - :ref:`float<class_float>` **linear_limit_z/softness**
  756. +----------+--------------------+
  757. | *Setter* | set_param_z(value) |
  758. +----------+--------------------+
  759. | *Getter* | get_param_z() |
  760. +----------+--------------------+
  761. A factor applied to the movement across the z-axis The lower, the slower the movement.
  762. ----
  763. .. _class_Generic6DOFJoint_property_linear_limit_z/upper_distance:
  764. - :ref:`float<class_float>` **linear_limit_z/upper_distance**
  765. +----------+--------------------+
  766. | *Setter* | set_param_z(value) |
  767. +----------+--------------------+
  768. | *Getter* | get_param_z() |
  769. +----------+--------------------+
  770. The maximum difference between the pivot points' z-axis.
  771. ----
  772. .. _class_Generic6DOFJoint_property_linear_motor_x/enabled:
  773. - :ref:`bool<class_bool>` **linear_motor_x/enabled**
  774. +----------+-------------------+
  775. | *Setter* | set_flag_x(value) |
  776. +----------+-------------------+
  777. | *Getter* | get_flag_x() |
  778. +----------+-------------------+
  779. 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.
  780. ----
  781. .. _class_Generic6DOFJoint_property_linear_motor_x/force_limit:
  782. - :ref:`float<class_float>` **linear_motor_x/force_limit**
  783. +----------+--------------------+
  784. | *Setter* | set_param_x(value) |
  785. +----------+--------------------+
  786. | *Getter* | get_param_x() |
  787. +----------+--------------------+
  788. The maximum force the linear motor can apply on the x-axis while trying to reach the target velocity.
  789. ----
  790. .. _class_Generic6DOFJoint_property_linear_motor_x/target_velocity:
  791. - :ref:`float<class_float>` **linear_motor_x/target_velocity**
  792. +----------+--------------------+
  793. | *Setter* | set_param_x(value) |
  794. +----------+--------------------+
  795. | *Getter* | get_param_x() |
  796. +----------+--------------------+
  797. The speed that the linear motor will attempt to reach on the x-axis.
  798. ----
  799. .. _class_Generic6DOFJoint_property_linear_motor_y/enabled:
  800. - :ref:`bool<class_bool>` **linear_motor_y/enabled**
  801. +----------+-------------------+
  802. | *Setter* | set_flag_y(value) |
  803. +----------+-------------------+
  804. | *Getter* | get_flag_y() |
  805. +----------+-------------------+
  806. 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.
  807. ----
  808. .. _class_Generic6DOFJoint_property_linear_motor_y/force_limit:
  809. - :ref:`float<class_float>` **linear_motor_y/force_limit**
  810. +----------+--------------------+
  811. | *Setter* | set_param_y(value) |
  812. +----------+--------------------+
  813. | *Getter* | get_param_y() |
  814. +----------+--------------------+
  815. The maximum force the linear motor can apply on the y-axis while trying to reach the target velocity.
  816. ----
  817. .. _class_Generic6DOFJoint_property_linear_motor_y/target_velocity:
  818. - :ref:`float<class_float>` **linear_motor_y/target_velocity**
  819. +----------+--------------------+
  820. | *Setter* | set_param_y(value) |
  821. +----------+--------------------+
  822. | *Getter* | get_param_y() |
  823. +----------+--------------------+
  824. The speed that the linear motor will attempt to reach on the y-axis.
  825. ----
  826. .. _class_Generic6DOFJoint_property_linear_motor_z/enabled:
  827. - :ref:`bool<class_bool>` **linear_motor_z/enabled**
  828. +----------+-------------------+
  829. | *Setter* | set_flag_z(value) |
  830. +----------+-------------------+
  831. | *Getter* | get_flag_z() |
  832. +----------+-------------------+
  833. 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.
  834. ----
  835. .. _class_Generic6DOFJoint_property_linear_motor_z/force_limit:
  836. - :ref:`float<class_float>` **linear_motor_z/force_limit**
  837. +----------+--------------------+
  838. | *Setter* | set_param_z(value) |
  839. +----------+--------------------+
  840. | *Getter* | get_param_z() |
  841. +----------+--------------------+
  842. The maximum force the linear motor can apply on the z-axis while trying to reach the target velocity.
  843. ----
  844. .. _class_Generic6DOFJoint_property_linear_motor_z/target_velocity:
  845. - :ref:`float<class_float>` **linear_motor_z/target_velocity**
  846. +----------+--------------------+
  847. | *Setter* | set_param_z(value) |
  848. +----------+--------------------+
  849. | *Getter* | get_param_z() |
  850. +----------+--------------------+
  851. The speed that the linear motor will attempt to reach on the z-axis.
  852. ----
  853. .. _class_Generic6DOFJoint_property_linear_spring_x/damping:
  854. - :ref:`float<class_float>` **linear_spring_x/damping**
  855. +----------+--------------------+
  856. | *Setter* | set_param_x(value) |
  857. +----------+--------------------+
  858. | *Getter* | get_param_x() |
  859. +----------+--------------------+
  860. ----
  861. .. _class_Generic6DOFJoint_property_linear_spring_x/enabled:
  862. - :ref:`bool<class_bool>` **linear_spring_x/enabled**
  863. +----------+-------------------+
  864. | *Setter* | set_flag_x(value) |
  865. +----------+-------------------+
  866. | *Getter* | get_flag_x() |
  867. +----------+-------------------+
  868. ----
  869. .. _class_Generic6DOFJoint_property_linear_spring_x/equilibrium_point:
  870. - :ref:`float<class_float>` **linear_spring_x/equilibrium_point**
  871. +----------+--------------------+
  872. | *Setter* | set_param_x(value) |
  873. +----------+--------------------+
  874. | *Getter* | get_param_x() |
  875. +----------+--------------------+
  876. ----
  877. .. _class_Generic6DOFJoint_property_linear_spring_x/stiffness:
  878. - :ref:`float<class_float>` **linear_spring_x/stiffness**
  879. +----------+--------------------+
  880. | *Setter* | set_param_x(value) |
  881. +----------+--------------------+
  882. | *Getter* | get_param_x() |
  883. +----------+--------------------+
  884. ----
  885. .. _class_Generic6DOFJoint_property_linear_spring_y/damping:
  886. - :ref:`float<class_float>` **linear_spring_y/damping**
  887. +----------+--------------------+
  888. | *Setter* | set_param_y(value) |
  889. +----------+--------------------+
  890. | *Getter* | get_param_y() |
  891. +----------+--------------------+
  892. ----
  893. .. _class_Generic6DOFJoint_property_linear_spring_y/enabled:
  894. - :ref:`bool<class_bool>` **linear_spring_y/enabled**
  895. +----------+-------------------+
  896. | *Setter* | set_flag_y(value) |
  897. +----------+-------------------+
  898. | *Getter* | get_flag_y() |
  899. +----------+-------------------+
  900. ----
  901. .. _class_Generic6DOFJoint_property_linear_spring_y/equilibrium_point:
  902. - :ref:`float<class_float>` **linear_spring_y/equilibrium_point**
  903. +----------+--------------------+
  904. | *Setter* | set_param_y(value) |
  905. +----------+--------------------+
  906. | *Getter* | get_param_y() |
  907. +----------+--------------------+
  908. ----
  909. .. _class_Generic6DOFJoint_property_linear_spring_y/stiffness:
  910. - :ref:`float<class_float>` **linear_spring_y/stiffness**
  911. +----------+--------------------+
  912. | *Setter* | set_param_y(value) |
  913. +----------+--------------------+
  914. | *Getter* | get_param_y() |
  915. +----------+--------------------+
  916. ----
  917. .. _class_Generic6DOFJoint_property_linear_spring_z/damping:
  918. - :ref:`float<class_float>` **linear_spring_z/damping**
  919. +----------+--------------------+
  920. | *Setter* | set_param_z(value) |
  921. +----------+--------------------+
  922. | *Getter* | get_param_z() |
  923. +----------+--------------------+
  924. ----
  925. .. _class_Generic6DOFJoint_property_linear_spring_z/enabled:
  926. - :ref:`bool<class_bool>` **linear_spring_z/enabled**
  927. +----------+-------------------+
  928. | *Setter* | set_flag_z(value) |
  929. +----------+-------------------+
  930. | *Getter* | get_flag_z() |
  931. +----------+-------------------+
  932. ----
  933. .. _class_Generic6DOFJoint_property_linear_spring_z/equilibrium_point:
  934. - :ref:`float<class_float>` **linear_spring_z/equilibrium_point**
  935. +----------+--------------------+
  936. | *Setter* | set_param_z(value) |
  937. +----------+--------------------+
  938. | *Getter* | get_param_z() |
  939. +----------+--------------------+
  940. ----
  941. .. _class_Generic6DOFJoint_property_linear_spring_z/stiffness:
  942. - :ref:`float<class_float>` **linear_spring_z/stiffness**
  943. +----------+--------------------+
  944. | *Setter* | set_param_z(value) |
  945. +----------+--------------------+
  946. | *Getter* | get_param_z() |
  947. +----------+--------------------+
  948. ----
  949. .. _class_Generic6DOFJoint_property_precision:
  950. - :ref:`int<class_int>` **precision**
  951. +----------+----------------------+
  952. | *Setter* | set_precision(value) |
  953. +----------+----------------------+
  954. | *Getter* | get_precision() |
  955. +----------+----------------------+