class_generic6dofjoint.rst 57 KB

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