godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
43ed90b479c474fbf514a23a8b954d645b487a3c
godot-docs/classes/class_line2d.rst
Rémi Verschelde 43ed90b479 classref: Sync with current master branch
2017-06-17 11:32:15 +02:00

216 lines
14 KiB
ReStructuredText
Raw Blame History

.. 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_Line2D:
Line2D
======
**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Line2D_add_point>` **(** :ref:`Vector2<class_vector2>` pos **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_begin_cap_mode<class_Line2D_get_begin_cap_mode>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_default_color<class_Line2D_get_default_color>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_end_cap_mode<class_Line2D_get_end_cap_mode>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_gradient<class_Line2D_get_gradient>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joint_mode<class_Line2D_get_joint_mode>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Line2D_get_point_count>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_pos<class_Line2D_get_point_pos>` **(** :ref:`int<class_int>` i **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_points<class_Line2D_get_points>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_round_precision<class_Line2D_get_round_precision>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_sharp_limit<class_Line2D_get_sharp_limit>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_texture<class_Line2D_get_texture>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texture_mode<class_Line2D_get_texture_mode>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_width<class_Line2D_get_width>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Line2D_remove_point>` **(** :ref:`int<class_int>` i **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_begin_cap_mode<class_Line2D_set_begin_cap_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_color<class_Line2D_set_default_color>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_end_cap_mode<class_Line2D_set_end_cap_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gradient<class_Line2D_set_gradient>` **(** :ref:`Object<class_object>` color **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_joint_mode<class_Line2D_set_joint_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Line2D_set_point_pos>` **(** :ref:`int<class_int>` i, :ref:`Vector2<class_vector2>` pos **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_points<class_Line2D_set_points>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_round_precision<class_Line2D_set_round_precision>` **(** :ref:`int<class_int>` precision **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sharp_limit<class_Line2D_set_sharp_limit>` **(** :ref:`float<class_float>` limit **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_Line2D_set_texture>` **(** :ref:`Object<class_object>` texture **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_mode<class_Line2D_set_texture_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_width<class_Line2D_set_width>` **(** :ref:`float<class_float>` width **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **begin_cap_mode**
- :ref:`Color<class_color>` **default_color**
- :ref:`int<class_int>` **end_cap_mode**
- :ref:`Gradient<class_gradient>` **gradient**
- :ref:`int<class_int>` **joint_mode**
- :ref:`PoolVector2Array<class_poolvector2array>` **points**
- :ref:`int<class_int>` **round_precision**
- :ref:`float<class_float>` **sharp_limit**
- :ref:`Texture<class_texture>` **texture**
- :ref:`int<class_int>` **texture_mode**
- :ref:`float<class_float>` **width**
Numeric Constants
-----------------
- **LINE_JOINT_SHARP** = **0**
- **LINE_JOINT_BEVEL** = **1**
- **LINE_JOINT_ROUND** = **2**
- **LINE_CAP_NONE** = **0**
- **LINE_CAP_BOX** = **1**
- **LINE_CAP_ROUND** = **2**
- **LINE_TEXTURE_NONE** = **0**
- **LINE_TEXTURE_TILE** = **1**
Member Function Description
---------------------------
.. _class_Line2D_add_point:
- void **add_point** **(** :ref:`Vector2<class_vector2>` pos **)**
.. _class_Line2D_get_begin_cap_mode:
- :ref:`int<class_int>` **get_begin_cap_mode** **(** **)** const
.. _class_Line2D_get_default_color:
- :ref:`Color<class_color>` **get_default_color** **(** **)** const
.. _class_Line2D_get_end_cap_mode:
- :ref:`int<class_int>` **get_end_cap_mode** **(** **)** const
.. _class_Line2D_get_gradient:
- :ref:`Object<class_object>` **get_gradient** **(** **)** const
.. _class_Line2D_get_joint_mode:
- :ref:`int<class_int>` **get_joint_mode** **(** **)** const
.. _class_Line2D_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const
.. _class_Line2D_get_point_pos:
- :ref:`Vector2<class_vector2>` **get_point_pos** **(** :ref:`int<class_int>` i **)** const
.. _class_Line2D_get_points:
- :ref:`PoolVector2Array<class_poolvector2array>` **get_points** **(** **)** const
.. _class_Line2D_get_round_precision:
- :ref:`int<class_int>` **get_round_precision** **(** **)** const
.. _class_Line2D_get_sharp_limit:
- :ref:`float<class_float>` **get_sharp_limit** **(** **)** const
.. _class_Line2D_get_texture:
- :ref:`Object<class_object>` **get_texture** **(** **)** const
.. _class_Line2D_get_texture_mode:
- :ref:`int<class_int>` **get_texture_mode** **(** **)** const
.. _class_Line2D_get_width:
- :ref:`float<class_float>` **get_width** **(** **)** const
.. _class_Line2D_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` i **)**
.. _class_Line2D_set_begin_cap_mode:
- void **set_begin_cap_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_Line2D_set_default_color:
- void **set_default_color** **(** :ref:`Color<class_color>` color **)**
.. _class_Line2D_set_end_cap_mode:
- void **set_end_cap_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_Line2D_set_gradient:
- void **set_gradient** **(** :ref:`Object<class_object>` color **)**
.. _class_Line2D_set_joint_mode:
- void **set_joint_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_Line2D_set_point_pos:
- void **set_point_pos** **(** :ref:`int<class_int>` i, :ref:`Vector2<class_vector2>` pos **)**
.. _class_Line2D_set_points:
- void **set_points** **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)**
.. _class_Line2D_set_round_precision:
- void **set_round_precision** **(** :ref:`int<class_int>` precision **)**
.. _class_Line2D_set_sharp_limit:
- void **set_sharp_limit** **(** :ref:`float<class_float>` limit **)**
.. _class_Line2D_set_texture:
- void **set_texture** **(** :ref:`Object<class_object>` texture **)**
.. _class_Line2D_set_texture_mode:
- void **set_texture_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_Line2D_set_width:
- void **set_width** **(** :ref:`float<class_float>` width **)**
Reference in New Issue View Git Blame Copy Permalink