class_concavepolygonshape2d.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the ConcavePolygonShape2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_ConcavePolygonShape2D:
  5. ConcavePolygonShape2D
  6. =====================
  7. **Inherits:** :ref:`Shape2D<class_shape2d>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Concave polygon 2D shape resource for physics.
  12. Member Variables
  13. ----------------
  14. .. _class_ConcavePolygonShape2D_segments:
  15. - :ref:`PoolVector2Array<class_poolvector2array>` **segments** - The array of points that make up the ``ConcavePolygonShape2D``'s line segments.
  16. Description
  17. -----------
  18. Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for :ref:`RigidBody2D<class_rigidbody2d>` nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions.
  19. The main difference between a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` and a ``ConcavePolygonShape2D`` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.