Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_physicsdirectspacestate3d.rst

class_physicsdirectspacestate3d.rst 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the PhysicsDirectSpaceState3D.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_PhysicsDirectSpaceState3D:
    8. 

  8. 

  9. PhysicsDirectSpaceState3D
    10. 

  10. =========================
    11. 

  11. 

  12. **Inherits:** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Direct access object to a space in the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. Direct access object to a space in the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. It's used mainly to do queries against objects and areas residing in a given space.
    20. 

  20. 

  21. Tutorials
    22. 

  22. ---------
    23. 

  23. 

  24. - :doc:`Physics introduction <../tutorials/physics/physics_introduction>`
    25. 

  25. 

  26. - :doc:`Ray-casting <../tutorials/physics/ray-casting>`
    27. 

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`Array<class_Array>`           | :ref:`cast_motion<class_PhysicsDirectSpaceState3D_method_cast_motion>` **(** :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` parameters **)**                                               |
    33. 

  33. +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`Array<class_Array>`           | :ref:`collide_shape<class_PhysicsDirectSpaceState3D_method_collide_shape>` **(** :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` parameters, :ref:`int<class_int>` max_results=32 **)**     |
    35. 

  35. +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_rest_info<class_PhysicsDirectSpaceState3D_method_get_rest_info>` **(** :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` parameters **)**                                           |
    37. 

  37. +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`Array<class_Array>`           | :ref:`intersect_point<class_PhysicsDirectSpaceState3D_method_intersect_point>` **(** :ref:`PhysicsPointQueryParameters3D<class_PhysicsPointQueryParameters3D>` parameters, :ref:`int<class_int>` max_results=32 **)** |
    39. 

  39. +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`Dictionary<class_Dictionary>` | :ref:`intersect_ray<class_PhysicsDirectSpaceState3D_method_intersect_ray>` **(** :ref:`PhysicsRayQueryParameters3D<class_PhysicsRayQueryParameters3D>` parameters **)**                                               |
    41. 

  41. +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`Array<class_Array>`           | :ref:`intersect_shape<class_PhysicsDirectSpaceState3D_method_intersect_shape>` **(** :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` parameters, :ref:`int<class_int>` max_results=32 **)** |
    43. 

  43. +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. 

  45. Method Descriptions
    46. 

  46. -------------------
    47. 

  47. 

  48. .. _class_PhysicsDirectSpaceState3D_method_cast_motion:
    49. 

  49. 

  50. - :ref:`Array<class_Array>` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` parameters **)**
    51. 

  51. 

  52. Checks how far a :ref:`Shape3D<class_Shape3D>` can move without colliding. All the parameters for the query, including the shape, are supplied through a :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` object.
    53. 

  53. 

  54. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of ``[1.0, 1.0]`` will be returned.
    55. 

  55. 

  56. \ **Note:** Any :ref:`Shape3D<class_Shape3D>`\ s that the shape is already colliding with e.g. inside of, will be ignored. Use :ref:`collide_shape<class_PhysicsDirectSpaceState3D_method_collide_shape>` to determine the :ref:`Shape3D<class_Shape3D>`\ s that the shape is already colliding with.
    57. 

  57. 

  58. ----
    59. 

  59. 

  60. .. _class_PhysicsDirectSpaceState3D_method_collide_shape:
    61. 

  61. 

  62. - :ref:`Array<class_Array>` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` parameters, :ref:`int<class_int>` max_results=32 **)**
    63. 

  63. 

  64. Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape<class_PhysicsDirectSpaceState3D_method_intersect_shape>`, the number of returned results can be limited to save processing time.
    65. 

  65. 

  66. Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` object, second one is in the collided shape from the physics space.
    67. 

  67. 

  68. \ **Note:** This method does not take into account the ``motion`` property of the object.
    69. 

  69. 

  70. ----
    71. 

  71. 

  72. .. _class_PhysicsDirectSpaceState3D_method_get_rest_info:
    73. 

  73. 

  74. - :ref:`Dictionary<class_Dictionary>` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` parameters **)**
    75. 

  75. 

  76. Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields:
    77. 

  77. 

  78. \ ``collider_id``: The colliding object's ID.
    79. 

  79. 

  80. \ ``linear_velocity``: The colliding object's velocity :ref:`Vector3<class_Vector3>`. If the object is an :ref:`Area3D<class_Area3D>`, the result is ``(0, 0, 0)``.
    81. 

  81. 

  82. \ ``normal``: The object's surface normal at the intersection point.
    83. 

  83. 

  84. \ ``point``: The intersection point.
    85. 

  85. 

  86. \ ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    87. 

  87. 

  88. \ ``shape``: The shape index of the colliding shape.
    89. 

  89. 

  90. If the shape did not intersect anything, then an empty dictionary is returned instead.
    91. 

  91. 

  92. \ **Note:** This method does not take into account the ``motion`` property of the object.
    93. 

  93. 

  94. ----
    95. 

  95. 

  96. .. _class_PhysicsDirectSpaceState3D_method_intersect_point:
    97. 

  97. 

  98. - :ref:`Array<class_Array>` **intersect_point** **(** :ref:`PhysicsPointQueryParameters3D<class_PhysicsPointQueryParameters3D>` parameters, :ref:`int<class_int>` max_results=32 **)**
    99. 

  99. 

  100. Checks whether a point is inside any solid shape. Position and other parameters are defined through :ref:`PhysicsPointQueryParameters3D<class_PhysicsPointQueryParameters3D>`. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:
    101. 

  101. 

  102. \ ``collider``: The colliding object.
    103. 

  103. 

  104. \ ``collider_id``: The colliding object's ID.
    105. 

  105. 

  106. \ ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    107. 

  107. 

  108. \ ``shape``: The shape index of the colliding shape.
    109. 

  109. 

  110. The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time.
    111. 

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_PhysicsDirectSpaceState3D_method_intersect_ray:
    115. 

  115. 

  116. - :ref:`Dictionary<class_Dictionary>` **intersect_ray** **(** :ref:`PhysicsRayQueryParameters3D<class_PhysicsRayQueryParameters3D>` parameters **)**
    117. 

  117. 

  118. Intersects a ray in a given space. Ray position and other parameters are defined through :ref:`PhysicsRayQueryParameters3D<class_PhysicsRayQueryParameters3D>`. The returned object is a dictionary with the following fields:
    119. 

  119. 

  120. \ ``collider``: The colliding object.
    121. 

  121. 

  122. \ ``collider_id``: The colliding object's ID.
    123. 

  123. 

  124. \ ``normal``: The object's surface normal at the intersection point, or ``Vector3(0, 0, 0)`` if the ray starts inside the shape and :ref:`PhysicsRayQueryParameters3D.hit_from_inside<class_PhysicsRayQueryParameters3D_property_hit_from_inside>` is ``true``.
    125. 

  125. 

  126. \ ``position``: The intersection point.
    127. 

  127. 

  128. \ ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    129. 

  129. 

  130. \ ``shape``: The shape index of the colliding shape.
    131. 

  131. 

  132. If the ray did not intersect anything, then an empty dictionary is returned instead.
    133. 

  133. 

  134. ----
    135. 

  135. 

  136. .. _class_PhysicsDirectSpaceState3D_method_intersect_shape:
    137. 

  137. 

  138. - :ref:`Array<class_Array>` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` parameters, :ref:`int<class_int>` max_results=32 **)**
    139. 

  139. 

  140. Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D<class_PhysicsShapeQueryParameters3D>` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields:
    141. 

  141. 

  142. \ ``collider``: The colliding object.
    143. 

  143. 

  144. \ ``collider_id``: The colliding object's ID.
    145. 

  145. 

  146. \ ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    147. 

  147. 

  148. \ ``shape``: The shape index of the colliding shape.
    149. 

  149. 

  150. The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time.
    151. 

  151. 

  152. \ **Note:** This method does not take into account the ``motion`` property of the object.
    153. 

  153. 

  154. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    155. 

  155. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    156. 

  156. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    157. 

  157. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    158. 

  158. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    159. 

  159. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    160.