class_segmentshape2d.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SegmentShape2D.xml.
  6. .. _class_SegmentShape2D:
  7. SegmentShape2D
  8. ==============
  9. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A 2D line segment shape used for physics collision.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. A 2D line segment shape, intended for use in physics. Usually used to provide a shape for a :ref:`CollisionShape2D<class_CollisionShape2D>`.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +-------------------------------+-------------------------------------------+--------------------+
  21. | :ref:`Vector2<class_Vector2>` | :ref:`a<class_SegmentShape2D_property_a>` | ``Vector2(0, 0)`` |
  22. +-------------------------------+-------------------------------------------+--------------------+
  23. | :ref:`Vector2<class_Vector2>` | :ref:`b<class_SegmentShape2D_property_b>` | ``Vector2(0, 10)`` |
  24. +-------------------------------+-------------------------------------------+--------------------+
  25. .. rst-class:: classref-section-separator
  26. ----
  27. .. rst-class:: classref-descriptions-group
  28. Property Descriptions
  29. ---------------------
  30. .. _class_SegmentShape2D_property_a:
  31. .. rst-class:: classref-property
  32. :ref:`Vector2<class_Vector2>` **a** = ``Vector2(0, 0)``
  33. .. rst-class:: classref-property-setget
  34. - void **set_a** **(** :ref:`Vector2<class_Vector2>` value **)**
  35. - :ref:`Vector2<class_Vector2>` **get_a** **(** **)**
  36. The segment's first point position.
  37. .. rst-class:: classref-item-separator
  38. ----
  39. .. _class_SegmentShape2D_property_b:
  40. .. rst-class:: classref-property
  41. :ref:`Vector2<class_Vector2>` **b** = ``Vector2(0, 10)``
  42. .. rst-class:: classref-property-setget
  43. - void **set_b** **(** :ref:`Vector2<class_Vector2>` value **)**
  44. - :ref:`Vector2<class_Vector2>` **get_b** **(** **)**
  45. The segment's second point position.
  46. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  47. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  48. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  49. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  50. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  51. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  52. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`