class_generic6dofjoint.rst 53 KB

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