class_concavepolygonshape.rst 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ConcavePolygonShape.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ConcavePolygonShape:
  6. ConcavePolygonShape
  7. ===================
  8. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Concave polygon shape.
  10. Description
  11. -----------
  12. Concave polygon shape resource, which can be set into a :ref:`PhysicsBody<class_PhysicsBody>` or area. This shape is created by feeding a list of triangles.
  13. **Note:** When used for collision, ``ConcavePolygonShape`` is intended to work with static :ref:`PhysicsBody<class_PhysicsBody>` nodes like :ref:`StaticBody<class_StaticBody>` and will not work with :ref:`KinematicBody<class_KinematicBody>` or :ref:`RigidBody<class_RigidBody>` with a mode other than Static.
  14. Tutorials
  15. ---------
  16. - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
  17. Methods
  18. -------
  19. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_faces<class_ConcavePolygonShape_method_get_faces>` **(** **)** |const| |
  21. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_faces<class_ConcavePolygonShape_method_set_faces>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` faces **)** |
  23. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  24. Method Descriptions
  25. -------------------
  26. .. _class_ConcavePolygonShape_method_get_faces:
  27. - :ref:`PoolVector3Array<class_PoolVector3Array>` **get_faces** **(** **)** |const|
  28. Returns the faces (an array of triangles).
  29. ----
  30. .. _class_ConcavePolygonShape_method_set_faces:
  31. - void **set_faces** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` faces **)**
  32. Sets the faces (an array of triangles).
  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  34. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  35. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`