| github_url: | hide |
|---|
Inherits: :ref:`Resource<class_Resource>` < :ref:`RefCounted<class_RefCounted>` < :ref:`Object<class_Object>`
Inherited By: :ref:`CapsuleShape2D<class_CapsuleShape2D>`, :ref:`CircleShape2D<class_CircleShape2D>`, :ref:`ConcavePolygonShape2D<class_ConcavePolygonShape2D>`, :ref:`ConvexPolygonShape2D<class_ConvexPolygonShape2D>`, :ref:`RectangleShape2D<class_RectangleShape2D>`, :ref:`SegmentShape2D<class_SegmentShape2D>`, :ref:`SeparationRayShape2D<class_SeparationRayShape2D>`, :ref:`WorldBoundaryShape2D<class_WorldBoundaryShape2D>`
Abstract base class for 2D shapes used for physics collision.
.. rst-class:: classref-introduction-group
Abstract base class for all 2D shapes, intended for use in physics.
Performance: Primitive shapes, especially :ref:`CircleShape2D<class_CircleShape2D>`, are fast to check collisions against. :ref:`ConvexPolygonShape2D<class_ConvexPolygonShape2D>` is slower, and :ref:`ConcavePolygonShape2D<class_ConcavePolygonShape2D>` is the slowest.
.. rst-class:: classref-introduction-group
.. rst-class:: classref-reftable-group
| :ref:`float<class_float>` | :ref:`custom_solver_bias<class_Shape2D_property_custom_solver_bias>` | 0.0 |
.. rst-class:: classref-reftable-group
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-property
:ref:`float<class_float>` custom_solver_bias = 0.0 :ref:`🔗<class_Shape2D_property_custom_solver_bias>`
.. rst-class:: classref-property-setget
- |void| set_custom_solver_bias(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_custom_solver_bias()
The shape's custom solver bias. Defines how much bodies react to enforce contact separation when this shape is involved.
When set to 0, the default value from :ref:`ProjectSettings.physics/2d/solver/default_contact_bias<class_ProjectSettings_property_physics/2d/solver/default_contact_bias>` is used.
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-method
:ref:`bool<class_bool>` collide(local_xform: :ref:`Transform2D<class_Transform2D>`, with_shape: :ref:`Shape2D<class_Shape2D>`, shape_xform: :ref:`Transform2D<class_Transform2D>`) :ref:`🔗<class_Shape2D_method_collide>`
Returns true if this shape is colliding with another.
This method needs the transformation matrix for this shape (local_xform), the shape to check collisions with (with_shape), and the transformation matrix of that shape (shape_xform).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` collide_and_get_contacts(local_xform: :ref:`Transform2D<class_Transform2D>`, with_shape: :ref:`Shape2D<class_Shape2D>`, shape_xform: :ref:`Transform2D<class_Transform2D>`) :ref:`🔗<class_Shape2D_method_collide_and_get_contacts>`
Returns a list of contact point pairs where this shape touches another.
If there are no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary of with_shape.
A collision pair A, B can be used to calculate the collision normal with (B - A).normalized(), and the collision depth with (B - A).length(). This information is typically used to separate shapes, particularly in collision solvers.
This method needs the transformation matrix for this shape (local_xform), the shape to check collisions with (with_shape), and the transformation matrix of that shape (shape_xform).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` collide_with_motion(local_xform: :ref:`Transform2D<class_Transform2D>`, local_motion: :ref:`Vector2<class_Vector2>`, with_shape: :ref:`Shape2D<class_Shape2D>`, shape_xform: :ref:`Transform2D<class_Transform2D>`, shape_motion: :ref:`Vector2<class_Vector2>`) :ref:`🔗<class_Shape2D_method_collide_with_motion>`
Returns whether this shape would collide with another, if a given movement was applied.
This method needs the transformation matrix for this shape (local_xform), the movement to test on this shape (local_motion), the shape to check collisions with (with_shape), the transformation matrix of that shape (shape_xform), and the movement to test onto the other object (shape_motion).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` collide_with_motion_and_get_contacts(local_xform: :ref:`Transform2D<class_Transform2D>`, local_motion: :ref:`Vector2<class_Vector2>`, with_shape: :ref:`Shape2D<class_Shape2D>`, shape_xform: :ref:`Transform2D<class_Transform2D>`, shape_motion: :ref:`Vector2<class_Vector2>`) :ref:`🔗<class_Shape2D_method_collide_with_motion_and_get_contacts>`
Returns a list of contact point pairs where this shape would touch another, if a given movement was applied.
If there would be no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary of with_shape.
A collision pair A, B can be used to calculate the collision normal with (B - A).normalized(), and the collision depth with (B - A).length(). This information is typically used to separate shapes, particularly in collision solvers.
This method needs the transformation matrix for this shape (local_xform), the movement to test on this shape (local_motion), the shape to check collisions with (with_shape), the transformation matrix of that shape (shape_xform), and the movement to test onto the other object (shape_motion).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
|void| draw(canvas_item: :ref:`RID<class_RID>`, color: :ref:`Color<class_Color>`) :ref:`🔗<class_Shape2D_method_draw>`
Draws a solid shape onto a :ref:`CanvasItem<class_CanvasItem>` with the :ref:`RenderingServer<class_RenderingServer>` API filled with the specified color. The exact drawing method is specific for each shape and cannot be configured.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Rect2<class_Rect2>` get_rect() |const| :ref:`🔗<class_Shape2D_method_get_rect>`
Returns a :ref:`Rect2<class_Rect2>` representing the shapes boundary.