:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState3D.xml. .. _class_PhysicsDirectSpaceState3D: PhysicsDirectSpaceState3D ========================= **Inherits:** :ref:`Object` **Inherited By:** :ref:`PhysicsDirectSpaceState3DExtension` Provides direct access to a physics space in the :ref:`PhysicsServer3D`. .. rst-class:: classref-introduction-group Description ----------- Provides direct access to a physics space in the :ref:`PhysicsServer3D`. It's used mainly to do queries against objects and areas residing in a given space. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Physics introduction <../tutorials/physics/physics_introduction>` - :doc:`Ray-casting <../tutorials/physics/ray-casting>` .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat32Array` | :ref:`cast_motion`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Vector3`\] | :ref:`collide_shape`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_rest_info`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`intersect_point`\ (\ parameters\: :ref:`PhysicsPointQueryParameters3D`, max_results\: :ref:`int` = 32\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`intersect_ray`\ (\ parameters\: :ref:`PhysicsRayQueryParameters3D`\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`intersect_shape`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_PhysicsDirectSpaceState3D_method_cast_motion: .. rst-class:: classref-method :ref:`PackedFloat32Array` **cast_motion**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) :ref:`🔗` Checks how far a :ref:`Shape3D` can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a :ref:`PhysicsShapeQueryParameters3D` object. 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. \ **Note:** Any :ref:`Shape3D`\ s that the shape is already colliding with e.g. inside of, will be ignored. Use :ref:`collide_shape()` to determine the :ref:`Shape3D`\ s that the shape is already colliding with. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectSpaceState3D_method_collide_shape: .. rst-class:: classref-method :ref:`Array`\[:ref:`Vector3`\] **collide_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) :ref:`🔗` Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape()`, the number of returned results can be limited to save processing time. Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in :ref:`PhysicsShapeQueryParameters3D` object, second one is in the collided shape from the physics space. \ **Note:** This method does not take into account the ``motion`` property of the object. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectSpaceState3D_method_get_rest_info: .. rst-class:: classref-method :ref:`Dictionary` **get_rest_info**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) :ref:`🔗` Checks the intersections of a shape, given through a :ref:`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: \ ``collider_id``: The colliding object's ID. \ ``linear_velocity``: The colliding object's velocity :ref:`Vector3`. If the object is an :ref:`Area3D`, the result is ``(0, 0, 0)``. \ ``normal``: The collision normal of the query shape at the intersection point, pointing away from the intersecting object. \ ``point``: The intersection point. \ ``rid``: The intersecting object's :ref:`RID`. \ ``shape``: The shape index of the colliding shape. If the shape did not intersect anything, then an empty dictionary is returned instead. \ **Note:** This method does not take into account the ``motion`` property of the object. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectSpaceState3D_method_intersect_point: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **intersect_point**\ (\ parameters\: :ref:`PhysicsPointQueryParameters3D`, max_results\: :ref:`int` = 32\ ) :ref:`🔗` Checks whether a point is inside any solid shape. Position and other parameters are defined through :ref:`PhysicsPointQueryParameters3D`. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: \ ``collider``: The colliding object. \ ``collider_id``: The colliding object's ID. \ ``rid``: The intersecting object's :ref:`RID`. \ ``shape``: The shape index of the colliding shape. The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectSpaceState3D_method_intersect_ray: .. rst-class:: classref-method :ref:`Dictionary` **intersect_ray**\ (\ parameters\: :ref:`PhysicsRayQueryParameters3D`\ ) :ref:`🔗` Intersects a ray in a given space. Ray position and other parameters are defined through :ref:`PhysicsRayQueryParameters3D`. The returned object is a dictionary with the following fields: \ ``collider``: The colliding object. \ ``collider_id``: The colliding object's ID. \ ``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` is ``true``. \ ``position``: The intersection point. \ ``face_index``: The face index at the intersection point. \ **Note:** Returns a valid number only if the intersected shape is a :ref:`ConcavePolygonShape3D`. Otherwise, ``-1`` is returned. \ ``rid``: The intersecting object's :ref:`RID`. \ ``shape``: The shape index of the colliding shape. If the ray did not intersect anything, then an empty dictionary is returned instead. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectSpaceState3D_method_intersect_shape: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **intersect_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) :ref:`🔗` Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: \ ``collider``: The colliding object. \ ``collider_id``: The colliding object's ID. \ ``rid``: The intersecting object's :ref:`RID`. \ ``shape``: The shape index of the colliding shape. The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time. \ **Note:** This method does not take into account the ``motion`` property of the object. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`