2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 12:40:43 +00:00
<class name= "NinePatchRect" inherits= "Control" category= "Core" version= "3.1" >
2017-09-12 20:42:36 +00:00
<brief_description >
2017-09-16 09:54:44 +00:00
Scalable texture-based frame that tiles the texture's centers and sides, but keeps the corners' original size. Perfect for panels and dialog boxes.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2017-09-16 09:54:44 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
</methods>
<members >
2017-09-13 06:49:40 +00:00
<member name= "axis_stretch_horizontal" type= "int" setter= "set_h_axis_stretch_mode" getter= "get_h_axis_stretch_mode" enum= "NinePatchRect.AxisStretchMode" >
2017-09-16 09:54:44 +00:00
Doesn't do anything at the time of writing.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "axis_stretch_vertical" type= "int" setter= "set_v_axis_stretch_mode" getter= "get_v_axis_stretch_mode" enum= "NinePatchRect.AxisStretchMode" >
2017-09-16 09:54:44 +00:00
Doesn't do anything at the time of writing.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "draw_center" type= "bool" setter= "set_draw_center" getter= "is_draw_center_enabled" >
2017-09-16 09:54:44 +00:00
If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code]
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "patch_margin_bottom" type= "int" setter= "set_patch_margin" getter= "get_patch_margin" >
2017-10-14 10:45:26 +00:00
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 individually to create panels with non-uniform borders.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "patch_margin_left" type= "int" setter= "set_patch_margin" getter= "get_patch_margin" >
2017-09-16 09:54:44 +00:00
The height of the 9-slice's left column.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "patch_margin_right" type= "int" setter= "set_patch_margin" getter= "get_patch_margin" >
2017-09-16 09:54:44 +00:00
The height of the 9-slice's right column.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "patch_margin_top" type= "int" setter= "set_patch_margin" getter= "get_patch_margin" >
2017-09-16 09:54:44 +00:00
The height of the 9-slice's top row.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "region_rect" type= "Rect2" setter= "set_region_rect" getter= "get_region_rect" >
2017-09-16 09:54:44 +00:00
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.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-16 09:54:44 +00:00
The node's texture resource.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals >
<signal name= "texture_changed" >
<description >
2017-09-16 09:54:44 +00:00
Fired when the node's texture changes.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "AXIS_STRETCH_MODE_STRETCH" value= "0" enum= "AxisStretchMode" >
2017-09-16 09:54:44 +00:00
Doesn't do anything at the time of writing. Default value for [code]axis_stretch_horizontal[/code] and [code]axis_stretch_vertical[/code].
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AXIS_STRETCH_MODE_TILE" value= "1" enum= "AxisStretchMode" >
2017-09-16 09:54:44 +00:00
Doesn't do anything at the time of writing.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AXIS_STRETCH_MODE_TILE_FIT" value= "2" enum= "AxisStretchMode" >
2017-09-16 09:54:44 +00:00
Doesn't do anything at the time of writing.
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>