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
f0bd3cc2c1a621ff9cb83b9f677c87bbd603f606
godot-docs/classes/class_line2d.rst
Rémi Verschelde f0bd3cc2c1 classref: Remove stray spaces in method signatures
2017-10-21 14:03:27 +02:00

265 lines
16 KiB
ReStructuredText
Raw Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Line2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Line2D:
Line2D
======
**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
A 2D line.
Member Functions
----------------
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Line2D_add_point>` **(** :ref:`Vector2<class_vector2>` position **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :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:`Gradient<class_gradient>` | :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_position<class_Line2D_get_point_position>` **(** :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:`Texture<class_texture>` | :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:`Gradient<class_gradient>` color **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_joint_mode<class_Line2D_set_joint_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_position<class_Line2D_set_point_position>` **(** :ref:`int<class_int>` i, :ref:`Vector2<class_vector2>` position **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| 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:`Texture<class_texture>` 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
----------------
.. _class_Line2D_begin_cap_mode:
- :ref:`int<class_int>` **begin_cap_mode** - Controls the style of the line's first point. Use ``LINE_CAP\_\*`` constants. Default value: ``LINE_CAP_NONE``.
.. _class_Line2D_default_color:
- :ref:`Color<class_color>` **default_color** - The line's color. Will not be used if a gradient is set.
.. _class_Line2D_end_cap_mode:
- :ref:`int<class_int>` **end_cap_mode** - Controls the style of the line's last point. Use ``LINE_CAP\_\*`` constants. Default value: ``LINE_CAP_NONE``.
.. _class_Line2D_gradient:
- :ref:`Gradient<class_gradient>` **gradient** - The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set.
.. _class_Line2D_joint_mode:
- :ref:`int<class_int>` **joint_mode** - The style for the points inbetween the start and the end.
.. _class_Line2D_points:
- :ref:`PoolVector2Array<class_poolvector2array>` **points** - The points that form the lines. The line is drawn between every point set in this array.
.. _class_Line2D_round_precision:
- :ref:`int<class_int>` **round_precision** - The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round.
.. _class_Line2D_sharp_limit:
- :ref:`float<class_float>` **sharp_limit** - The direction difference in radians between vector points. This value is only used if ``joint mode`` is set to ``LINE_JOINT_SHARP``.
.. _class_Line2D_texture:
- :ref:`Texture<class_texture>` **texture** - The texture used for the line's texture. Uses ``texture_mode`` for drawing style.
.. _class_Line2D_texture_mode:
- :ref:`int<class_int>` **texture_mode** - The style to render the ``texture`` on the line. Use ``LINE_TEXTURE\_\*`` constants. Default value: ``LINE_TEXTURE_NONE``.
.. _class_Line2D_width:
- :ref:`float<class_float>` **width** - The line's width.
Numeric Constants
-----------------
- **LINE_JOINT_SHARP** = **0** --- The line's joints will be pointy. If ``sharp_limit`` is greater than the rotation of a joint, it becomes a bevel joint instead.
- **LINE_JOINT_BEVEL** = **1** --- The line's joints will be bevelled/chamfered.
- **LINE_JOINT_ROUND** = **2** --- The line's joints will be rounded.
- **LINE_CAP_NONE** = **0** --- Don't have a line cap.
- **LINE_CAP_BOX** = **1** --- Draws the line cap as a box.
- **LINE_CAP_ROUND** = **2** --- Draws the line cap as a circle.
- **LINE_TEXTURE_NONE** = **0** --- Takes the left pixels of the texture and renders it over the whole line.
- **LINE_TEXTURE_TILE** = **1** --- Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly.
Description
-----------
A line through several points in 2D space.
Member Function Description
---------------------------
.. _class_Line2D_add_point:
- void **add_point** **(** :ref:`Vector2<class_vector2>` position **)**
Add a point at the ``position``. Appends the point at the end of the line.
.. _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:`Gradient<class_gradient>` **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
Returns the Line2D's amount of points.
.. _class_Line2D_get_point_position:
- :ref:`Vector2<class_vector2>` **get_point_position** **(** :ref:`int<class_int>` i **)** const
Returns point ``i[code]'s position.
.. _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:`Texture<class_texture>` **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 **)**
Remove the point at index ``i`` from the line.
.. _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:`Gradient<class_gradient>` color **)**
.. _class_Line2D_set_joint_mode:
- void **set_joint_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_Line2D_set_point_position:
- void **set_point_position** **(** :ref:`int<class_int>` i, :ref:`Vector2<class_vector2>` position **)**
Overwites the position in point ``i`` with the supplied ``position``.
.. _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:`Texture<class_texture>` 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