mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
132 lines
8.3 KiB
ReStructuredText
132 lines
8.3 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.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>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Scalable texture-based frame that tiles the texture's centers and sides, but keeps the corners' original size. Perfect for panels and dialog boxes.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_h_axis_stretch_mode<class_NinePatchRect_get_h_axis_stretch_mode>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_patch_margin<class_NinePatchRect_get_patch_margin>` **(** :ref:`int<class_int>` margin **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_rect2>` | :ref:`get_region_rect<class_NinePatchRect_get_region_rect>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_NinePatchRect_get_texture>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_v_axis_stretch_mode<class_NinePatchRect_get_v_axis_stretch_mode>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_draw_center_enabled<class_NinePatchRect_is_draw_center_enabled>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_draw_center<class_NinePatchRect_set_draw_center>` **(** :ref:`bool<class_bool>` draw_center **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_h_axis_stretch_mode<class_NinePatchRect_set_h_axis_stretch_mode>` **(** :ref:`int<class_int>` mode **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_patch_margin<class_NinePatchRect_set_patch_margin>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` value **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_region_rect<class_NinePatchRect_set_region_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_texture<class_NinePatchRect_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_v_axis_stretch_mode<class_NinePatchRect_set_v_axis_stretch_mode>` **(** :ref:`int<class_int>` mode **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
- **texture_changed** **(** **)**
|
|
Fired when the node's texture changes.
|
|
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
- :ref:`int<class_int>` **axis_stretch_horizontal** - Doesn't do anything at the time of writing.
|
|
- :ref:`int<class_int>` **axis_stretch_vertical** - Doesn't do anything at the time of writing.
|
|
- :ref:`bool<class_bool>` **draw_center** - If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code]
|
|
- :ref:`int<class_int>` **patch_margin_bottom** - The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values indivually to create panels with non-uniform borders.
|
|
- :ref:`int<class_int>` **patch_margin_left** - The height of the 9-slice's left column.
|
|
- :ref:`int<class_int>` **patch_margin_right** - The height of the 9-slice's right column.
|
|
- :ref:`int<class_int>` **patch_margin_top** - The height of the 9-slice's top row.
|
|
- :ref:`Rect2<class_rect2>` **region_rect** - Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one.
|
|
- :ref:`Texture<class_texture>` **texture** - The node's texture resource.
|
|
|
|
Numeric Constants
|
|
-----------------
|
|
|
|
- **AXIS_STRETCH_MODE_STRETCH** = **0** --- Doesn't do anything at the time of writing. Default value for ``axis_stretch_horizontal`` and ``axis_stretch_vertical``.
|
|
- **AXIS_STRETCH_MODE_TILE** = **1** --- Doesn't do anything at the time of writing.
|
|
- **AXIS_STRETCH_MODE_TILE_FIT** = **2** --- Doesn't do anything at the time of writing.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Better known as 9-slice panels, NinePatchRect produces clean panels of any size, based on a small texture. To do so, it splits the texture in a 3 by 3 grid. When you scale the node, it tiles the texture's sides horizontally or vertically, the center on both axes but it doesn't scale or tile the corners.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_NinePatchRect_get_h_axis_stretch_mode:
|
|
|
|
- :ref:`int<class_int>` **get_h_axis_stretch_mode** **(** **)** const
|
|
|
|
.. _class_NinePatchRect_get_patch_margin:
|
|
|
|
- :ref:`int<class_int>` **get_patch_margin** **(** :ref:`int<class_int>` margin **)** const
|
|
|
|
.. _class_NinePatchRect_get_region_rect:
|
|
|
|
- :ref:`Rect2<class_rect2>` **get_region_rect** **(** **)** const
|
|
|
|
.. _class_NinePatchRect_get_texture:
|
|
|
|
- :ref:`Texture<class_texture>` **get_texture** **(** **)** const
|
|
|
|
.. _class_NinePatchRect_get_v_axis_stretch_mode:
|
|
|
|
- :ref:`int<class_int>` **get_v_axis_stretch_mode** **(** **)** const
|
|
|
|
.. _class_NinePatchRect_is_draw_center_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **is_draw_center_enabled** **(** **)** const
|
|
|
|
.. _class_NinePatchRect_set_draw_center:
|
|
|
|
- void **set_draw_center** **(** :ref:`bool<class_bool>` draw_center **)**
|
|
|
|
.. _class_NinePatchRect_set_h_axis_stretch_mode:
|
|
|
|
- void **set_h_axis_stretch_mode** **(** :ref:`int<class_int>` mode **)**
|
|
|
|
.. _class_NinePatchRect_set_patch_margin:
|
|
|
|
- void **set_patch_margin** **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` value **)**
|
|
|
|
.. _class_NinePatchRect_set_region_rect:
|
|
|
|
- void **set_region_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
|
|
|
|
.. _class_NinePatchRect_set_texture:
|
|
|
|
- void **set_texture** **(** :ref:`Texture<class_texture>` texture **)**
|
|
|
|
.. _class_NinePatchRect_set_v_axis_stretch_mode:
|
|
|
|
- void **set_v_axis_stretch_mode** **(** :ref:`int<class_int>` mode **)**
|
|
|
|
|