mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-02 21:48:52 +03:00
Currently including `zh_CN` and `es` which both have very high completion ratios. Others will be added once they reach a significant percentage too. These RST files will be used by godot-docs in place of its `classes` folder after we sync with https://github.com/godotengine/godot-docs/pull/5458. The update workflow is manual for now (example for `zh_CN`): - Build `godotengine/godot` in the branch we currently track (now `3.x`) - Run `godot --doctool -l zh_CN` - Run `cd doc && make rst LANGARG=zh_CN` - Copy `doc/_build/rst/*` to `classes/zh_CN/` here - Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
250 lines
14 KiB
ReStructuredText
250 lines
14 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
||
.. DO NOT EDIT THIS FILE, but the NinePatchRect.xml source instead.
|
||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||
|
||
.. _class_NinePatchRect:
|
||
|
||
NinePatchRect
|
||
=============
|
||
|
||
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||
|
||
Un fotograma escalable basado en la textura que enmarca el centro y los lados de la textura, pero mantiene el tamaño original de las esquinas. Perfecto para paneles y cuadros de diálogo.
|
||
|
||
Descripción
|
||
----------------------
|
||
|
||
También conocido como paneles de 9 cortes, el NinePatchRect produce paneles limpios de cualquier tamaño, basados en una pequeña textura. Para ello, divide la textura en una cuadrícula de 3×3. Cuando escalas el nodo, se nivelan los lados de la textura horizontal o verticalmente, el centro en ambos ejes, pero no se escalan o se nivelan las esquinas.
|
||
|
||
Propiedades
|
||
----------------------
|
||
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` | :ref:`axis_stretch_horizontal<class_NinePatchRect_property_axis_stretch_horizontal>` | ``0`` |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` | :ref:`axis_stretch_vertical<class_NinePatchRect_property_axis_stretch_vertical>` | ``0`` |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`draw_center<class_NinePatchRect_property_draw_center>` | ``true`` |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | ``2`` (overrides :ref:`Control<class_Control_property_mouse_filter>`) |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`patch_margin_bottom<class_NinePatchRect_property_patch_margin_bottom>` | ``0`` |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`patch_margin_left<class_NinePatchRect_property_patch_margin_left>` | ``0`` |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`patch_margin_right<class_NinePatchRect_property_patch_margin_right>` | ``0`` |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`patch_margin_top<class_NinePatchRect_property_patch_margin_top>` | ``0`` |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`Rect2<class_Rect2>` | :ref:`region_rect<class_NinePatchRect_property_region_rect>` | ``Rect2( 0, 0, 0, 0 )`` |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
| :ref:`Texture<class_Texture>` | :ref:`texture<class_NinePatchRect_property_texture>` | |
|
||
+------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||
|
||
Métodos
|
||
--------------
|
||
|
||
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`get_patch_margin<class_NinePatchRect_method_get_patch_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** |const| |
|
||
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`set_patch_margin<class_NinePatchRect_method_set_patch_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`int<class_int>` value **)** |
|
||
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
||
Señales
|
||
--------------
|
||
|
||
.. _class_NinePatchRect_signal_texture_changed:
|
||
|
||
- **texture_changed** **(** **)**
|
||
|
||
Emitido cuando la textura del nodo cambia.
|
||
|
||
Enumeraciones
|
||
--------------------------
|
||
|
||
.. _enum_NinePatchRect_AxisStretchMode:
|
||
|
||
.. _class_NinePatchRect_constant_AXIS_STRETCH_MODE_STRETCH:
|
||
|
||
.. _class_NinePatchRect_constant_AXIS_STRETCH_MODE_TILE:
|
||
|
||
.. _class_NinePatchRect_constant_AXIS_STRETCH_MODE_TILE_FIT:
|
||
|
||
enum **AxisStretchMode**:
|
||
|
||
- **AXIS_STRETCH_MODE_STRETCH** = **0** --- Stretches the center texture across the NinePatchRect. This may cause the texture to be distorted.
|
||
|
||
- **AXIS_STRETCH_MODE_TILE** = **1** --- Repeats the center texture across the NinePatchRect. This won't cause any visible distortion. The texture must be seamless for this to work without displaying artifacts between edges.
|
||
|
||
\ **Note:** Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like :ref:`AXIS_STRETCH_MODE_STRETCH<class_NinePatchRect_constant_AXIS_STRETCH_MODE_STRETCH>`.
|
||
|
||
- **AXIS_STRETCH_MODE_TILE_FIT** = **2** --- Repeats the center texture across the NinePatchRect, but will also stretch the texture to make sure each tile is visible in full. This may cause the texture to be distorted, but less than :ref:`AXIS_STRETCH_MODE_STRETCH<class_NinePatchRect_constant_AXIS_STRETCH_MODE_STRETCH>`. The texture must be seamless for this to work without displaying artifacts between edges.
|
||
|
||
\ **Note:** Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like :ref:`AXIS_STRETCH_MODE_STRETCH<class_NinePatchRect_constant_AXIS_STRETCH_MODE_STRETCH>`.
|
||
|
||
Descripciones de Propiedades
|
||
--------------------------------------------------------
|
||
|
||
.. _class_NinePatchRect_property_axis_stretch_horizontal:
|
||
|
||
- :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` **axis_stretch_horizontal**
|
||
|
||
+-----------+--------------------------------+
|
||
| *Default* | ``0`` |
|
||
+-----------+--------------------------------+
|
||
| *Setter* | set_h_axis_stretch_mode(value) |
|
||
+-----------+--------------------------------+
|
||
| *Getter* | get_h_axis_stretch_mode() |
|
||
+-----------+--------------------------------+
|
||
|
||
The stretch mode to use for horizontal stretching/tiling. See :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` for possible values.
|
||
|
||
----
|
||
|
||
.. _class_NinePatchRect_property_axis_stretch_vertical:
|
||
|
||
- :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` **axis_stretch_vertical**
|
||
|
||
+-----------+--------------------------------+
|
||
| *Default* | ``0`` |
|
||
+-----------+--------------------------------+
|
||
| *Setter* | set_v_axis_stretch_mode(value) |
|
||
+-----------+--------------------------------+
|
||
| *Getter* | get_v_axis_stretch_mode() |
|
||
+-----------+--------------------------------+
|
||
|
||
The stretch mode to use for vertical stretching/tiling. See :ref:`AxisStretchMode<enum_NinePatchRect_AxisStretchMode>` for possible values.
|
||
|
||
----
|
||
|
||
.. _class_NinePatchRect_property_draw_center:
|
||
|
||
- :ref:`bool<class_bool>` **draw_center**
|
||
|
||
+-----------+--------------------------+
|
||
| *Default* | ``true`` |
|
||
+-----------+--------------------------+
|
||
| *Setter* | set_draw_center(value) |
|
||
+-----------+--------------------------+
|
||
| *Getter* | is_draw_center_enabled() |
|
||
+-----------+--------------------------+
|
||
|
||
Si ``true``, dibuja el centro del panel. Si no, sólo dibuja los bordes de los 9 cortes.
|
||
|
||
----
|
||
|
||
.. _class_NinePatchRect_property_patch_margin_bottom:
|
||
|
||
- :ref:`int<class_int>` **patch_margin_bottom**
|
||
|
||
+-----------+-------------------------+
|
||
| *Default* | ``0`` |
|
||
+-----------+-------------------------+
|
||
| *Setter* | set_patch_margin(value) |
|
||
+-----------+-------------------------+
|
||
| *Getter* | get_patch_margin() |
|
||
+-----------+-------------------------+
|
||
|
||
La altura de la fila inferior del 9-cortes. Un margen de 16 significa que las esquinas inferiores y el lado de los 9 cortes tendrán una altura de 16 píxeles. Puede establecer los 4 valores de margen individualmente para crear paneles con bordes no uniformes.
|
||
|
||
----
|
||
|
||
.. _class_NinePatchRect_property_patch_margin_left:
|
||
|
||
- :ref:`int<class_int>` **patch_margin_left**
|
||
|
||
+-----------+-------------------------+
|
||
| *Default* | ``0`` |
|
||
+-----------+-------------------------+
|
||
| *Setter* | set_patch_margin(value) |
|
||
+-----------+-------------------------+
|
||
| *Getter* | get_patch_margin() |
|
||
+-----------+-------------------------+
|
||
|
||
The width of the 9-slice's left column. A margin of 16 means the 9-slice's left corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
|
||
|
||
----
|
||
|
||
.. _class_NinePatchRect_property_patch_margin_right:
|
||
|
||
- :ref:`int<class_int>` **patch_margin_right**
|
||
|
||
+-----------+-------------------------+
|
||
| *Default* | ``0`` |
|
||
+-----------+-------------------------+
|
||
| *Setter* | set_patch_margin(value) |
|
||
+-----------+-------------------------+
|
||
| *Getter* | get_patch_margin() |
|
||
+-----------+-------------------------+
|
||
|
||
The width of the 9-slice's right column. A margin of 16 means the 9-slice's right corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
|
||
|
||
----
|
||
|
||
.. _class_NinePatchRect_property_patch_margin_top:
|
||
|
||
- :ref:`int<class_int>` **patch_margin_top**
|
||
|
||
+-----------+-------------------------+
|
||
| *Default* | ``0`` |
|
||
+-----------+-------------------------+
|
||
| *Setter* | set_patch_margin(value) |
|
||
+-----------+-------------------------+
|
||
| *Getter* | get_patch_margin() |
|
||
+-----------+-------------------------+
|
||
|
||
The height of the 9-slice's top row. A margin of 16 means the 9-slice's top corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
|
||
|
||
----
|
||
|
||
.. _class_NinePatchRect_property_region_rect:
|
||
|
||
- :ref:`Rect2<class_Rect2>` **region_rect**
|
||
|
||
+-----------+-------------------------+
|
||
| *Default* | ``Rect2( 0, 0, 0, 0 )`` |
|
||
+-----------+-------------------------+
|
||
| *Setter* | set_region_rect(value) |
|
||
+-----------+-------------------------+
|
||
| *Getter* | get_region_rect() |
|
||
+-----------+-------------------------+
|
||
|
||
Región rectangular de la textura de la que tomar la muestra. Si trabajas con un atlas, usa esta propiedad para definir el área que el 9-cortes debe usar. Todas las demás propiedades son relativas a esta. Si el rectángulo está vacío, el NinePatchRect usará toda la textura.
|
||
|
||
----
|
||
|
||
.. _class_NinePatchRect_property_texture:
|
||
|
||
- :ref:`Texture<class_Texture>` **texture**
|
||
|
||
+----------+--------------------+
|
||
| *Setter* | set_texture(value) |
|
||
+----------+--------------------+
|
||
| *Getter* | get_texture() |
|
||
+----------+--------------------+
|
||
|
||
El recurso de textura del nodo.
|
||
|
||
Descripciones de Métodos
|
||
------------------------------------------------
|
||
|
||
.. _class_NinePatchRect_method_get_patch_margin:
|
||
|
||
- :ref:`int<class_int>` **get_patch_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** |const|
|
||
|
||
Devuelve el tamaño del margen identificado por la constante :ref:`Margin<enum_@GlobalScope_Margin>` dada.
|
||
|
||
----
|
||
|
||
.. _class_NinePatchRect_method_set_patch_margin:
|
||
|
||
- void **set_patch_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`int<class_int>` value **)**
|
||
|
||
Establece el tamaño del margen identificado por la constante :ref:`Margin<enum_@GlobalScope_Margin>` dada a ``value`` en píxeles.
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|