class_physicsdirectbodystate3d.rst 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the PhysicsDirectBodyState3D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_PhysicsDirectBodyState3D:
  6. PhysicsDirectBodyState3D
  7. ========================
  8. **Inherits:** :ref:`Object<class_Object>`
  9. Direct access object to a physics body in the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
  10. Description
  11. -----------
  12. Provides direct access to a physics body in the :ref:`PhysicsServer3D<class_PhysicsServer3D>`, allowing safe changes to physics properties. This object is passed via the direct state callback of dynamic bodies, and is intended for changing the direct state of that body. See :ref:`RigidDynamicBody3D._integrate_forces<class_RigidDynamicBody3D_method__integrate_forces>`.
  13. Tutorials
  14. ---------
  15. - :doc:`Physics introduction <../tutorials/physics/physics_introduction>`
  16. - :doc:`Ray-casting <../tutorials/physics/ray-casting>`
  17. Properties
  18. ----------
  19. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  20. | :ref:`Vector3<class_Vector3>` | :ref:`angular_velocity<class_PhysicsDirectBodyState3D_property_angular_velocity>` |
  21. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  22. | :ref:`Vector3<class_Vector3>` | :ref:`center_of_mass<class_PhysicsDirectBodyState3D_property_center_of_mass>` |
  23. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  24. | :ref:`Vector3<class_Vector3>` | :ref:`center_of_mass_local<class_PhysicsDirectBodyState3D_property_center_of_mass_local>` |
  25. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  26. | :ref:`Vector3<class_Vector3>` | :ref:`inverse_inertia<class_PhysicsDirectBodyState3D_property_inverse_inertia>` |
  27. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  28. | :ref:`float<class_float>` | :ref:`inverse_mass<class_PhysicsDirectBodyState3D_property_inverse_mass>` |
  29. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  30. | :ref:`Vector3<class_Vector3>` | :ref:`linear_velocity<class_PhysicsDirectBodyState3D_property_linear_velocity>` |
  31. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  32. | :ref:`Basis<class_Basis>` | :ref:`principal_inertia_axes<class_PhysicsDirectBodyState3D_property_principal_inertia_axes>` |
  33. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  34. | :ref:`bool<class_bool>` | :ref:`sleeping<class_PhysicsDirectBodyState3D_property_sleeping>` |
  35. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  36. | :ref:`float<class_float>` | :ref:`step<class_PhysicsDirectBodyState3D_property_step>` |
  37. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  38. | :ref:`float<class_float>` | :ref:`total_angular_damp<class_PhysicsDirectBodyState3D_property_total_angular_damp>` |
  39. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  40. | :ref:`Vector3<class_Vector3>` | :ref:`total_gravity<class_PhysicsDirectBodyState3D_property_total_gravity>` |
  41. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  42. | :ref:`float<class_float>` | :ref:`total_linear_damp<class_PhysicsDirectBodyState3D_property_total_linear_damp>` |
  43. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  44. | :ref:`Transform3D<class_Transform3D>` | :ref:`transform<class_PhysicsDirectBodyState3D_property_transform>` |
  45. +---------------------------------------+-----------------------------------------------------------------------------------------------+
  46. Methods
  47. -------
  48. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`add_constant_central_force<class_PhysicsDirectBodyState3D_method_add_constant_central_force>` **(** :ref:`Vector3<class_Vector3>` force=Vector3(0, 0, 0) **)** |
  50. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`add_constant_force<class_PhysicsDirectBodyState3D_method_add_constant_force>` **(** :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)** |
  52. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`add_constant_torque<class_PhysicsDirectBodyState3D_method_add_constant_torque>` **(** :ref:`Vector3<class_Vector3>` torque **)** |
  54. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`apply_central_force<class_PhysicsDirectBodyState3D_method_apply_central_force>` **(** :ref:`Vector3<class_Vector3>` force=Vector3(0, 0, 0) **)** |
  56. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | void | :ref:`apply_central_impulse<class_PhysicsDirectBodyState3D_method_apply_central_impulse>` **(** :ref:`Vector3<class_Vector3>` impulse=Vector3(0, 0, 0) **)** |
  58. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | void | :ref:`apply_force<class_PhysicsDirectBodyState3D_method_apply_force>` **(** :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)** |
  60. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`apply_impulse<class_PhysicsDirectBodyState3D_method_apply_impulse>` **(** :ref:`Vector3<class_Vector3>` impulse, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)** |
  62. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`apply_torque<class_PhysicsDirectBodyState3D_method_apply_torque>` **(** :ref:`Vector3<class_Vector3>` torque **)** |
  64. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`apply_torque_impulse<class_PhysicsDirectBodyState3D_method_apply_torque_impulse>` **(** :ref:`Vector3<class_Vector3>` impulse **)** |
  66. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`Vector3<class_Vector3>` | :ref:`get_constant_force<class_PhysicsDirectBodyState3D_method_get_constant_force>` **(** **)** |const| |
  68. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`Vector3<class_Vector3>` | :ref:`get_constant_torque<class_PhysicsDirectBodyState3D_method_get_constant_torque>` **(** **)** |const| |
  70. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`RID<class_RID>` | :ref:`get_contact_collider<class_PhysicsDirectBodyState3D_method_get_contact_collider>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  72. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`int<class_int>` | :ref:`get_contact_collider_id<class_PhysicsDirectBodyState3D_method_get_contact_collider_id>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  74. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`Object<class_Object>` | :ref:`get_contact_collider_object<class_PhysicsDirectBodyState3D_method_get_contact_collider_object>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  76. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`Vector3<class_Vector3>` | :ref:`get_contact_collider_position<class_PhysicsDirectBodyState3D_method_get_contact_collider_position>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  78. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`int<class_int>` | :ref:`get_contact_collider_shape<class_PhysicsDirectBodyState3D_method_get_contact_collider_shape>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  80. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`Vector3<class_Vector3>` | :ref:`get_contact_collider_velocity_at_position<class_PhysicsDirectBodyState3D_method_get_contact_collider_velocity_at_position>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  82. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`int<class_int>` | :ref:`get_contact_count<class_PhysicsDirectBodyState3D_method_get_contact_count>` **(** **)** |const| |
  84. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`float<class_float>` | :ref:`get_contact_impulse<class_PhysicsDirectBodyState3D_method_get_contact_impulse>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  86. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`Vector3<class_Vector3>` | :ref:`get_contact_local_normal<class_PhysicsDirectBodyState3D_method_get_contact_local_normal>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  88. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`Vector3<class_Vector3>` | :ref:`get_contact_local_position<class_PhysicsDirectBodyState3D_method_get_contact_local_position>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  90. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`int<class_int>` | :ref:`get_contact_local_shape<class_PhysicsDirectBodyState3D_method_get_contact_local_shape>` **(** :ref:`int<class_int>` contact_idx **)** |const| |
  92. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` | :ref:`get_space_state<class_PhysicsDirectBodyState3D_method_get_space_state>` **(** **)** |
  94. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`Vector3<class_Vector3>` | :ref:`get_velocity_at_local_position<class_PhysicsDirectBodyState3D_method_get_velocity_at_local_position>` **(** :ref:`Vector3<class_Vector3>` local_position **)** |const| |
  96. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | void | :ref:`integrate_forces<class_PhysicsDirectBodyState3D_method_integrate_forces>` **(** **)** |
  98. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | void | :ref:`set_constant_force<class_PhysicsDirectBodyState3D_method_set_constant_force>` **(** :ref:`Vector3<class_Vector3>` force **)** |
  100. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | void | :ref:`set_constant_torque<class_PhysicsDirectBodyState3D_method_set_constant_torque>` **(** :ref:`Vector3<class_Vector3>` torque **)** |
  102. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. Property Descriptions
  104. ---------------------
  105. .. _class_PhysicsDirectBodyState3D_property_angular_velocity:
  106. - :ref:`Vector3<class_Vector3>` **angular_velocity**
  107. +----------+-----------------------------+
  108. | *Setter* | set_angular_velocity(value) |
  109. +----------+-----------------------------+
  110. | *Getter* | get_angular_velocity() |
  111. +----------+-----------------------------+
  112. The body's rotational velocity in *radians* per second.
  113. ----
  114. .. _class_PhysicsDirectBodyState3D_property_center_of_mass:
  115. - :ref:`Vector3<class_Vector3>` **center_of_mass**
  116. +----------+----------------------+
  117. | *Getter* | get_center_of_mass() |
  118. +----------+----------------------+
  119. The body's center of mass position relative to the body's center in the global coordinate system.
  120. ----
  121. .. _class_PhysicsDirectBodyState3D_property_center_of_mass_local:
  122. - :ref:`Vector3<class_Vector3>` **center_of_mass_local**
  123. +----------+----------------------------+
  124. | *Getter* | get_center_of_mass_local() |
  125. +----------+----------------------------+
  126. The body's center of mass position in the body's local coordinate system.
  127. ----
  128. .. _class_PhysicsDirectBodyState3D_property_inverse_inertia:
  129. - :ref:`Vector3<class_Vector3>` **inverse_inertia**
  130. +----------+-----------------------+
  131. | *Getter* | get_inverse_inertia() |
  132. +----------+-----------------------+
  133. The inverse of the inertia of the body.
  134. ----
  135. .. _class_PhysicsDirectBodyState3D_property_inverse_mass:
  136. - :ref:`float<class_float>` **inverse_mass**
  137. +----------+--------------------+
  138. | *Getter* | get_inverse_mass() |
  139. +----------+--------------------+
  140. The inverse of the mass of the body.
  141. ----
  142. .. _class_PhysicsDirectBodyState3D_property_linear_velocity:
  143. - :ref:`Vector3<class_Vector3>` **linear_velocity**
  144. +----------+----------------------------+
  145. | *Setter* | set_linear_velocity(value) |
  146. +----------+----------------------------+
  147. | *Getter* | get_linear_velocity() |
  148. +----------+----------------------------+
  149. The body's linear velocity in units per second.
  150. ----
  151. .. _class_PhysicsDirectBodyState3D_property_principal_inertia_axes:
  152. - :ref:`Basis<class_Basis>` **principal_inertia_axes**
  153. +----------+------------------------------+
  154. | *Getter* | get_principal_inertia_axes() |
  155. +----------+------------------------------+
  156. ----
  157. .. _class_PhysicsDirectBodyState3D_property_sleeping:
  158. - :ref:`bool<class_bool>` **sleeping**
  159. +----------+------------------------+
  160. | *Setter* | set_sleep_state(value) |
  161. +----------+------------------------+
  162. | *Getter* | is_sleeping() |
  163. +----------+------------------------+
  164. If ``true``, this body is currently sleeping (not active).
  165. ----
  166. .. _class_PhysicsDirectBodyState3D_property_step:
  167. - :ref:`float<class_float>` **step**
  168. +----------+------------+
  169. | *Getter* | get_step() |
  170. +----------+------------+
  171. The timestep (delta) used for the simulation.
  172. ----
  173. .. _class_PhysicsDirectBodyState3D_property_total_angular_damp:
  174. - :ref:`float<class_float>` **total_angular_damp**
  175. +----------+--------------------------+
  176. | *Getter* | get_total_angular_damp() |
  177. +----------+--------------------------+
  178. The rate at which the body stops rotating, if there are not any other forces moving it.
  179. ----
  180. .. _class_PhysicsDirectBodyState3D_property_total_gravity:
  181. - :ref:`Vector3<class_Vector3>` **total_gravity**
  182. +----------+---------------------+
  183. | *Getter* | get_total_gravity() |
  184. +----------+---------------------+
  185. The total gravity vector being currently applied to this body.
  186. ----
  187. .. _class_PhysicsDirectBodyState3D_property_total_linear_damp:
  188. - :ref:`float<class_float>` **total_linear_damp**
  189. +----------+-------------------------+
  190. | *Getter* | get_total_linear_damp() |
  191. +----------+-------------------------+
  192. The rate at which the body stops moving, if there are not any other forces moving it.
  193. ----
  194. .. _class_PhysicsDirectBodyState3D_property_transform:
  195. - :ref:`Transform3D<class_Transform3D>` **transform**
  196. +----------+----------------------+
  197. | *Setter* | set_transform(value) |
  198. +----------+----------------------+
  199. | *Getter* | get_transform() |
  200. +----------+----------------------+
  201. The body's transformation matrix.
  202. Method Descriptions
  203. -------------------
  204. .. _class_PhysicsDirectBodyState3D_method_add_constant_central_force:
  205. - void **add_constant_central_force** **(** :ref:`Vector3<class_Vector3>` force=Vector3(0, 0, 0) **)**
  206. Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``.
  207. This is equivalent to using :ref:`add_constant_force<class_PhysicsDirectBodyState3D_method_add_constant_force>` at the body's center of mass.
  208. ----
  209. .. _class_PhysicsDirectBodyState3D_method_add_constant_force:
  210. - void **add_constant_force** **(** :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)**
  211. Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``.
  212. \ ``position`` is the offset from the body origin in global coordinates.
  213. ----
  214. .. _class_PhysicsDirectBodyState3D_method_add_constant_torque:
  215. - void **add_constant_torque** **(** :ref:`Vector3<class_Vector3>` torque **)**
  216. Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = Vector3(0, 0, 0)``.
  217. ----
  218. .. _class_PhysicsDirectBodyState3D_method_apply_central_force:
  219. - void **apply_central_force** **(** :ref:`Vector3<class_Vector3>` force=Vector3(0, 0, 0) **)**
  220. Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
  221. This is equivalent to using :ref:`apply_force<class_PhysicsDirectBodyState3D_method_apply_force>` at the body's center of mass.
  222. ----
  223. .. _class_PhysicsDirectBodyState3D_method_apply_central_impulse:
  224. - void **apply_central_impulse** **(** :ref:`Vector3<class_Vector3>` impulse=Vector3(0, 0, 0) **)**
  225. Applies a directional impulse without affecting rotation.
  226. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  227. This is equivalent to using :ref:`apply_impulse<class_PhysicsDirectBodyState3D_method_apply_impulse>` at the body's center of mass.
  228. ----
  229. .. _class_PhysicsDirectBodyState3D_method_apply_force:
  230. - void **apply_force** **(** :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)**
  231. Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
  232. \ ``position`` is the offset from the body origin in global coordinates.
  233. ----
  234. .. _class_PhysicsDirectBodyState3D_method_apply_impulse:
  235. - void **apply_impulse** **(** :ref:`Vector3<class_Vector3>` impulse, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)**
  236. Applies a positioned impulse to the body.
  237. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  238. \ ``position`` is the offset from the body origin in global coordinates.
  239. ----
  240. .. _class_PhysicsDirectBodyState3D_method_apply_torque:
  241. - void **apply_torque** **(** :ref:`Vector3<class_Vector3>` torque **)**
  242. Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
  243. ----
  244. .. _class_PhysicsDirectBodyState3D_method_apply_torque_impulse:
  245. - void **apply_torque_impulse** **(** :ref:`Vector3<class_Vector3>` impulse **)**
  246. Applies a rotational impulse to the body without affecting the position.
  247. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
  248. ----
  249. .. _class_PhysicsDirectBodyState3D_method_get_constant_force:
  250. - :ref:`Vector3<class_Vector3>` **get_constant_force** **(** **)** |const|
  251. Returns the body's total constant positional forces applied during each physics update.
  252. See :ref:`add_constant_force<class_PhysicsDirectBodyState3D_method_add_constant_force>` and :ref:`add_constant_central_force<class_PhysicsDirectBodyState3D_method_add_constant_central_force>`.
  253. ----
  254. .. _class_PhysicsDirectBodyState3D_method_get_constant_torque:
  255. - :ref:`Vector3<class_Vector3>` **get_constant_torque** **(** **)** |const|
  256. Returns the body's total constant rotational forces applied during each physics update.
  257. See :ref:`add_constant_torque<class_PhysicsDirectBodyState3D_method_add_constant_torque>`.
  258. ----
  259. .. _class_PhysicsDirectBodyState3D_method_get_contact_collider:
  260. - :ref:`RID<class_RID>` **get_contact_collider** **(** :ref:`int<class_int>` contact_idx **)** |const|
  261. Returns the collider's :ref:`RID<class_RID>`.
  262. ----
  263. .. _class_PhysicsDirectBodyState3D_method_get_contact_collider_id:
  264. - :ref:`int<class_int>` **get_contact_collider_id** **(** :ref:`int<class_int>` contact_idx **)** |const|
  265. Returns the collider's object id.
  266. ----
  267. .. _class_PhysicsDirectBodyState3D_method_get_contact_collider_object:
  268. - :ref:`Object<class_Object>` **get_contact_collider_object** **(** :ref:`int<class_int>` contact_idx **)** |const|
  269. Returns the collider object.
  270. ----
  271. .. _class_PhysicsDirectBodyState3D_method_get_contact_collider_position:
  272. - :ref:`Vector3<class_Vector3>` **get_contact_collider_position** **(** :ref:`int<class_int>` contact_idx **)** |const|
  273. Returns the contact position in the collider.
  274. ----
  275. .. _class_PhysicsDirectBodyState3D_method_get_contact_collider_shape:
  276. - :ref:`int<class_int>` **get_contact_collider_shape** **(** :ref:`int<class_int>` contact_idx **)** |const|
  277. Returns the collider's shape index.
  278. ----
  279. .. _class_PhysicsDirectBodyState3D_method_get_contact_collider_velocity_at_position:
  280. - :ref:`Vector3<class_Vector3>` **get_contact_collider_velocity_at_position** **(** :ref:`int<class_int>` contact_idx **)** |const|
  281. Returns the linear velocity vector at the collider's contact point.
  282. ----
  283. .. _class_PhysicsDirectBodyState3D_method_get_contact_count:
  284. - :ref:`int<class_int>` **get_contact_count** **(** **)** |const|
  285. Returns the number of contacts this body has with other bodies.
  286. \ **Note:** By default, this returns 0 unless bodies are configured to monitor contacts. See :ref:`RigidDynamicBody3D.contact_monitor<class_RigidDynamicBody3D_property_contact_monitor>`.
  287. ----
  288. .. _class_PhysicsDirectBodyState3D_method_get_contact_impulse:
  289. - :ref:`float<class_float>` **get_contact_impulse** **(** :ref:`int<class_int>` contact_idx **)** |const|
  290. Impulse created by the contact. Only implemented for Bullet physics.
  291. ----
  292. .. _class_PhysicsDirectBodyState3D_method_get_contact_local_normal:
  293. - :ref:`Vector3<class_Vector3>` **get_contact_local_normal** **(** :ref:`int<class_int>` contact_idx **)** |const|
  294. Returns the local normal at the contact point.
  295. ----
  296. .. _class_PhysicsDirectBodyState3D_method_get_contact_local_position:
  297. - :ref:`Vector3<class_Vector3>` **get_contact_local_position** **(** :ref:`int<class_int>` contact_idx **)** |const|
  298. Returns the local position of the contact point.
  299. ----
  300. .. _class_PhysicsDirectBodyState3D_method_get_contact_local_shape:
  301. - :ref:`int<class_int>` **get_contact_local_shape** **(** :ref:`int<class_int>` contact_idx **)** |const|
  302. Returns the local shape index of the collision.
  303. ----
  304. .. _class_PhysicsDirectBodyState3D_method_get_space_state:
  305. - :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **get_space_state** **(** **)**
  306. Returns the current state of the space, useful for queries.
  307. ----
  308. .. _class_PhysicsDirectBodyState3D_method_get_velocity_at_local_position:
  309. - :ref:`Vector3<class_Vector3>` **get_velocity_at_local_position** **(** :ref:`Vector3<class_Vector3>` local_position **)** |const|
  310. Returns the body's velocity at the given relative position, including both translation and rotation.
  311. ----
  312. .. _class_PhysicsDirectBodyState3D_method_integrate_forces:
  313. - void **integrate_forces** **(** **)**
  314. Calls the built-in force integration code.
  315. ----
  316. .. _class_PhysicsDirectBodyState3D_method_set_constant_force:
  317. - void **set_constant_force** **(** :ref:`Vector3<class_Vector3>` force **)**
  318. Sets the body's total constant positional forces applied during each physics update.
  319. See :ref:`add_constant_force<class_PhysicsDirectBodyState3D_method_add_constant_force>` and :ref:`add_constant_central_force<class_PhysicsDirectBodyState3D_method_add_constant_central_force>`.
  320. ----
  321. .. _class_PhysicsDirectBodyState3D_method_set_constant_torque:
  322. - void **set_constant_torque** **(** :ref:`Vector3<class_Vector3>` torque **)**
  323. Sets the body's total constant rotational forces applied during each physics update.
  324. See :ref:`add_constant_torque<class_PhysicsDirectBodyState3D_method_add_constant_torque>`.
  325. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  326. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  327. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  328. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  329. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  330. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`