class_concavepolygonshape2d.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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 Functions
  13. ----------------
  14. +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_segments<class_ConcavePolygonShape2D_get_segments>` **(** **)** const |
  16. +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_segments<class_ConcavePolygonShape2D_set_segments>` **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)** |
  18. +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  19. Member Variables
  20. ----------------
  21. - :ref:`PoolVector2Array<class_poolvector2array>` **segments**
  22. Description
  23. -----------
  24. 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.
  25. The main difference between a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` and a :ref:`ConcavePolygonShape2D<class_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.
  26. Member Function Description
  27. ---------------------------
  28. .. _class_ConcavePolygonShape2D_get_segments:
  29. - :ref:`PoolVector2Array<class_poolvector2array>` **get_segments** **(** **)** const
  30. Return the array of segments.
  31. .. _class_ConcavePolygonShape2D_set_segments:
  32. - void **set_segments** **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)**
  33. Set the array of segments.