class_concavepolygonshape2d.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ConcavePolygonShape2D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ConcavePolygonShape2D:
  6. ConcavePolygonShape2D
  7. =====================
  8. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Concave polygon 2D shape resource for physics.
  13. Properties
  14. ----------
  15. +-------------------------------------------------+----------------------------------------------------------------+----------------------+
  16. | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` | PoolVector2Array( ) |
  17. +-------------------------------------------------+----------------------------------------------------------------+----------------------+
  18. Description
  19. -----------
  20. Concave polygon 2D shape resource for physics. It is made out of segments and is optimal for complex polygonal concave collisions. However, it is 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.
  21. 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.
  22. Property Descriptions
  23. ---------------------
  24. .. _class_ConcavePolygonShape2D_property_segments:
  25. - :ref:`PoolVector2Array<class_PoolVector2Array>` **segments**
  26. +-----------+----------------------+
  27. | *Default* | PoolVector2Array( ) |
  28. +-----------+----------------------+
  29. | *Setter* | set_segments(value) |
  30. +-----------+----------------------+
  31. | *Getter* | get_segments() |
  32. +-----------+----------------------+
  33. The array of points that make up the ``ConcavePolygonShape2D``'s line segments.