Files
godot-docs/classes/class_segmentshape2d.rst
2017-04-07 22:11:07 +02:00

70 lines
2.4 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_SegmentShape2D:
SegmentShape2D
==============
**Inherits:** :ref:`Shape2D<class_shape2d>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Segment Shape for 2D Collision Detection.
Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_a<class_SegmentShape2D_get_a>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_b<class_SegmentShape2D_get_b>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------+
| void | :ref:`set_a<class_SegmentShape2D_set_a>` **(** :ref:`Vector2<class_vector2>` a **)** |
+--------------------------------+----------------------------------------------------------------------------------------+
| void | :ref:`set_b<class_SegmentShape2D_set_b>` **(** :ref:`Vector2<class_vector2>` b **)** |
+--------------------------------+----------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Vector2<class_vector2>` **a**
- :ref:`Vector2<class_vector2>` **b**
Description
-----------
Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'.
Member Function Description
---------------------------
.. _class_SegmentShape2D_get_a:
- :ref:`Vector2<class_vector2>` **get_a** **(** **)** const
Return the first point's position.
.. _class_SegmentShape2D_get_b:
- :ref:`Vector2<class_vector2>` **get_b** **(** **)** const
Return the second point's position.
.. _class_SegmentShape2D_set_a:
- void **set_a** **(** :ref:`Vector2<class_vector2>` a **)**
Set the first point's position.
.. _class_SegmentShape2D_set_b:
- void **set_b** **(** :ref:`Vector2<class_vector2>` b **)**
Set the second point's position.