:github_url: hide .. _class_Line2D: Line2D ====== **Hérite de :** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Une polyligne 2D qui peut être optionnellement texturée. .. rst-class:: classref-introduction-group Description ----------- Ce nœud dessine une polyligne 2D, c'est-à-dire une forme composée de plusieurs points reliés par des segments. **Line2D** n'est pas une polyligne mathématique, c'est-à-dire que les segments ne sont pas infiniment minces. Elle est destinée au rendu et peut être optionnellement coloriée et texturée. \ **Attention :** Certaines configurations peuvent être impossibles à bien dessiner, comme des angles très tranchants. Dans ces situations, le nœud utilise une logique de dessin de repli pour paraître décent. \ **Note :** **Line2D** est dessiné à l'aide d'un maillage 2D. .. rst-class:: classref-introduction-group Tutoriels ------------------ - `Démo de transformation matricielle `__ - `Démo de jeu 2,5D `__ .. rst-class:: classref-reftable-group Propriétés -------------------- .. table:: :widths: auto +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`bool` | :ref:`antialiased` | ``false`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`LineCapMode` | :ref:`begin_cap_mode` | ``0`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`bool` | :ref:`closed` | ``false`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`Color` | :ref:`default_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`LineCapMode` | :ref:`end_cap_mode` | ``0`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`Gradient` | :ref:`gradient` | | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`LineJointMode` | :ref:`joint_mode` | ``0`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`PackedVector2Array` | :ref:`points` | ``PackedVector2Array()`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`int` | :ref:`round_precision` | ``8`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`float` | :ref:`sharp_limit` | ``2.0`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`texture` | | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`LineTextureMode` | :ref:`texture_mode` | ``0`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`float` | :ref:`width` | ``10.0`` | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ | :ref:`Curve` | :ref:`width_curve` | | +-----------------------------------------------------+---------------------------------------------------------------+--------------------------+ .. rst-class:: classref-reftable-group Méthodes ---------------- .. table:: :widths: auto +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_point`\ (\ position\: :ref:`Vector2`, index\: :ref:`int` = -1\ ) | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_points`\ (\ ) | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_count`\ (\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_point_position`\ (\ index\: :ref:`int`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_point`\ (\ index\: :ref:`int`\ ) | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_point_position`\ (\ index\: :ref:`int`, position\: :ref:`Vector2`\ ) | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Énumérations ------------------------ .. _enum_Line2D_LineJointMode: .. rst-class:: classref-enumeration enum **LineJointMode**: :ref:`🔗` .. _class_Line2D_constant_LINE_JOINT_SHARP: .. rst-class:: classref-enumeration-constant :ref:`LineJointMode` **LINE_JOINT_SHARP** = ``0`` Makes the polyline's joints pointy, connecting the sides of the two segments by extending them until they intersect. If the rotation of a joint is too big (based on :ref:`sharp_limit`), the joint falls back to :ref:`LINE_JOINT_BEVEL` to prevent very long miters. .. _class_Line2D_constant_LINE_JOINT_BEVEL: .. rst-class:: classref-enumeration-constant :ref:`LineJointMode` **LINE_JOINT_BEVEL** = ``1`` Rend les liaisons de la polyligne biseautées/chanfreinées, reliant les côtés des deux segments avec une ligne simple. .. _class_Line2D_constant_LINE_JOINT_ROUND: .. rst-class:: classref-enumeration-constant :ref:`LineJointMode` **LINE_JOINT_ROUND** = ``2`` Rend les liaisons de la polyligne arrondies, reliant les côtés des deux segments avec un arc. Le détail de cet arc dépend de :ref:`round_precision`. .. rst-class:: classref-item-separator ---- .. _enum_Line2D_LineCapMode: .. rst-class:: classref-enumeration enum **LineCapMode**: :ref:`🔗` .. _class_Line2D_constant_LINE_CAP_NONE: .. rst-class:: classref-enumeration-constant :ref:`LineCapMode` **LINE_CAP_NONE** = ``0`` Ne dessine pas de bouchon de ligne. .. _class_Line2D_constant_LINE_CAP_BOX: .. rst-class:: classref-enumeration-constant :ref:`LineCapMode` **LINE_CAP_BOX** = ``1`` Dessine le bouchon de ligne comme une boîte, prolongeant légèrement le premier / dernier segment. .. _class_Line2D_constant_LINE_CAP_ROUND: .. rst-class:: classref-enumeration-constant :ref:`LineCapMode` **LINE_CAP_ROUND** = ``2`` Dessine le bouchon de ligne comme un demi-cercle attaché au premier/dernier segment. .. rst-class:: classref-item-separator ---- .. _enum_Line2D_LineTextureMode: .. rst-class:: classref-enumeration enum **LineTextureMode**: :ref:`🔗` .. _class_Line2D_constant_LINE_TEXTURE_NONE: .. rst-class:: classref-enumeration-constant :ref:`LineTextureMode` **LINE_TEXTURE_NONE** = ``0`` Takes the left pixels of the texture and renders them over the whole polyline. .. _class_Line2D_constant_LINE_TEXTURE_TILE: .. rst-class:: classref-enumeration-constant :ref:`LineTextureMode` **LINE_TEXTURE_TILE** = ``1`` Tiles the texture over the polyline. :ref:`CanvasItem.texture_repeat` of the **Line2D** node must be :ref:`CanvasItem.TEXTURE_REPEAT_ENABLED` or :ref:`CanvasItem.TEXTURE_REPEAT_MIRROR` for it to work properly. .. _class_Line2D_constant_LINE_TEXTURE_STRETCH: .. rst-class:: classref-enumeration-constant :ref:`LineTextureMode` **LINE_TEXTURE_STRETCH** = ``2`` Stretches the texture across the polyline. :ref:`CanvasItem.texture_repeat` of the **Line2D** node must be :ref:`CanvasItem.TEXTURE_REPEAT_DISABLED` for best results. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Descriptions des propriétés ------------------------------------------------------ .. _class_Line2D_property_antialiased: .. rst-class:: classref-property :ref:`bool` **antialiased** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_antialiased**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_antialiased**\ (\ ) If ``true``, the polyline's border will be anti-aliased. \ **Note:** **Line2D** is not accelerated by batching when being anti-aliased. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_begin_cap_mode: .. rst-class:: classref-property :ref:`LineCapMode` **begin_cap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_begin_cap_mode**\ (\ value\: :ref:`LineCapMode`\ ) - :ref:`LineCapMode` **get_begin_cap_mode**\ (\ ) Le style du début de la polyligne, si :ref:`closed` vaut ``false``. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_closed: .. rst-class:: classref-property :ref:`bool` **closed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_closed**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_closed**\ (\ ) Si ``true`` et que la polyligne a plus de 2 points, le dernier point et le premier seront connectés par un segment. \ **Note :** La forme du segment de fermeture n'est pas garantie d'être transparente si une courbe de largeur :ref:`width_curve` est fournie. \ **Note:** La liaison entre le segment de fermeture et le premier segment est dessinée en premier et échantillonne le :ref:`gradient` et la :ref:`width_curve` au début. C'est un détail d'implémentation qui pourrait changer dans une version future. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_default_color: .. rst-class:: classref-property :ref:`Color` **default_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_default_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_default_color**\ (\ ) La couleur de la polyligne. Ne sera pas utilisé si un gradient est défini. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_end_cap_mode: .. rst-class:: classref-property :ref:`LineCapMode` **end_cap_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_end_cap_mode**\ (\ value\: :ref:`LineCapMode`\ ) - :ref:`LineCapMode` **get_end_cap_mode**\ (\ ) Le style de la fin de la polyligne, si :ref:`closed` vaut ``false``. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_gradient: .. rst-class:: classref-property :ref:`Gradient` **gradient** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_gradient**\ (\ value\: :ref:`Gradient`\ ) - :ref:`Gradient` **get_gradient**\ (\ ) Le gradient est dessiné sur toute la ligne du début à la fin. La couleur par défaut :ref:`default_color` ne sera pas utilisée si cette propriété est définie. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_joint_mode: .. rst-class:: classref-property :ref:`LineJointMode` **joint_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_joint_mode**\ (\ value\: :ref:`LineJointMode`\ ) - :ref:`LineJointMode` **get_joint_mode**\ (\ ) Le style des connexions entre les segments de la polyligne. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_points: .. rst-class:: classref-property :ref:`PackedVector2Array` **points** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_points**\ (\ value\: :ref:`PackedVector2Array`\ ) - :ref:`PackedVector2Array` **get_points**\ (\ ) Les points de la polyline, interprétés dans les coordonnées 2D locales. Les segments sont dessinés entre les points adjacents dans ce tableau. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_round_precision: .. rst-class:: classref-property :ref:`int` **round_precision** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_round_precision**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_round_precision**\ (\ ) Le lissage utilisé pour les liaisons arrondies et les bouchons. Les valeurs plus élevées entraînent des coins plus lisses, mais sont plus exigeantes pour rendre et mettre à jour. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_sharp_limit: .. rst-class:: classref-property :ref:`float` **sharp_limit** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sharp_limit**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_sharp_limit**\ (\ ) Determines the miter limit of the polyline. Normally, when :ref:`joint_mode` is set to :ref:`LINE_JOINT_SHARP`, sharp angles fall back to using the logic of :ref:`LINE_JOINT_BEVEL` joints to prevent very long miters. Higher values of this property mean that the fallback to a bevel joint will happen at sharper angles. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_texture: .. rst-class:: classref-property :ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) - :ref:`Texture2D` **get_texture**\ (\ ) La texture utilisée pour la polyligne. Utilise :ref:`texture_mode` pour le style de dessin. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_texture_mode: .. rst-class:: classref-property :ref:`LineTextureMode` **texture_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_mode**\ (\ value\: :ref:`LineTextureMode`\ ) - :ref:`LineTextureMode` **get_texture_mode**\ (\ ) Le style de rendu de la :ref:`texture` de la polyligne. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_width: .. rst-class:: classref-property :ref:`float` **width** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_width**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_width**\ (\ ) La largeur de la polyligne. .. rst-class:: classref-item-separator ---- .. _class_Line2D_property_width_curve: .. rst-class:: classref-property :ref:`Curve` **width_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_curve**\ (\ value\: :ref:`Curve`\ ) - :ref:`Curve` **get_curve**\ (\ ) La courbe de largeur de la polyligne. La largeur de la polyligne sur sa longueur sera équivalente à la valeur de la courbe de largeur sur son domaine. La courbe de largeur devrait être une :ref:`Curve` unitaire. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Descriptions des méthodes -------------------------------------------------- .. _class_Line2D_method_add_point: .. rst-class:: classref-method |void| **add_point**\ (\ position\: :ref:`Vector2`, index\: :ref:`int` = -1\ ) :ref:`🔗` Ajoute un point avec la position ``position`` spécifiée par rapport à la propre position de la polyligne. Si aucun ``index`` n'est fourni, le nouveau point sera ajouté à la fin du tableau de points. Si ``index`` est donné, le nouveau point est inséré avant le point existant identifié par l'index ``index``. Les indices des points après le nouveau point sont augmentés de 1. L'index ``index`` fourni ne doit pas dépasser le nombre de points existants dans la polyligne. Voir :ref:`get_point_count()`. .. rst-class:: classref-item-separator ---- .. _class_Line2D_method_clear_points: .. rst-class:: classref-method |void| **clear_points**\ (\ ) :ref:`🔗` Enlève tous les points de la polyligne, la rendant vide. .. rst-class:: classref-item-separator ---- .. _class_Line2D_method_get_point_count: .. rst-class:: classref-method :ref:`int` **get_point_count**\ (\ ) |const| :ref:`🔗` Renvoie le nombre de points dans la polyligne. .. rst-class:: classref-item-separator ---- .. _class_Line2D_method_get_point_position: .. rst-class:: classref-method :ref:`Vector2` **get_point_position**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Renvoie la position du point à l'index ``index``. .. rst-class:: classref-item-separator ---- .. _class_Line2D_method_remove_point: .. rst-class:: classref-method |void| **remove_point**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Supprime le point à l'index ``index`` de la polyligne. .. rst-class:: classref-item-separator ---- .. _class_Line2D_method_set_point_position: .. rst-class:: classref-method |void| **set_point_position**\ (\ index\: :ref:`int`, position\: :ref:`Vector2`\ ) :ref:`🔗` Remplace la position du point à l'``index`` donné par la ``position`` spécifiée. .. |virtual| replace:: :abbr:`virtual (Cette méthode doit typiquement être redéfinie par l'utilisateur pour avoir un effet.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (Cette méthode n'a pas d'effets de bord. Elle ne modifie aucune des variables membres de l'instance.)` .. |vararg| replace:: :abbr:`vararg (Cette méthode accepte n'importe quel nombre d'arguments après ceux décris ici.)` .. |constructor| replace:: :abbr:`constructor (Cette méthode est utilisée pour construire un type.)` .. |static| replace:: :abbr:`static (Cette méthode n'a pas besoin d'instance pour être appelée, elle peut donc être directement appelée en utilisant le nom de la classe.)` .. |operator| replace:: :abbr:`operator (Cette méthode décrit un opérateur valide à utiliser avec ce type en tant qu'opérande gauche.)` .. |bitfield| replace:: :abbr:`BitField (Cette valeur est un nombre entier composé d'un masque de bits des options suivantes.)` .. |void| replace:: :abbr:`void (Aucune valeur de retour.)`