class_concavepolygonshape2d.rst 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_ConcavePolygonShape2D:
  4. ConcavePolygonShape2D
  5. =====================
  6. **Inherits:** :ref:`Shape2D<class_shape2d>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Concave polygon 2D shape resource for physics.
  11. Member Functions
  12. ----------------
  13. +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_segments<class_ConcavePolygonShape2D_get_segments>` **(** **)** const |
  15. +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_segments<class_ConcavePolygonShape2D_set_segments>` **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)** |
  17. +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  18. Member Variables
  19. ----------------
  20. - :ref:`PoolVector2Array<class_poolvector2array>` **segments**
  21. Description
  22. -----------
  23. 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.
  24. 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.
  25. Member Function Description
  26. ---------------------------
  27. .. _class_ConcavePolygonShape2D_get_segments:
  28. - :ref:`PoolVector2Array<class_poolvector2array>` **get_segments** **(** **)** const
  29. Return the array of segments.
  30. .. _class_ConcavePolygonShape2D_set_segments:
  31. - void **set_segments** **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)**
  32. Set the array of segments.