StyleBox
继承
简要描述
用于为UI绘制样式化框的基类。
描述
StyleBox是提供了抽象基类，用于为UI绘制样式化框的Resource。
成员
| 类型 | 属性名 | 默认值 |
|---|---|---|
| float | content_margin_bottom | -1.0 |
| float | content_margin_left | -1.0 |
| float | content_margin_right | -1.0 |
| float | content_margin_top | -1.0 |
方法
| 返回值类型 | 方法名称 |
|---|---|
| void | draw(canvas_item: RID, rect: Rect2) const |
| Vector2 | get_center_size() const |
| CanvasItem | get_current_item_drawn() const |
| float | get_default_margin(margin: int) const |
| float | get_margin(margin: int) const |
| Vector2 | get_minimum_size() const |
| Vector2 | get_offset() const |
| void | set_default_margin(margin: int, offset: float) |
| bool | test_mask(point: Vector2, rect: Rect2) const |
常量
成员说明
- float content_margin_bottom
| Default | -1.0 |
|---|---|
| setter | set_default_margin(value) |
| getter | get_default_margin |
- float content_margin_left
| Default | -1.0 |
|---|---|
| setter | set_default_margin(value) |
| getter | get_default_margin |
- float content_margin_right
| Default | -1.0 |
|---|---|
| setter | set_default_margin(value) |
| getter | get_default_margin |
- float content_margin_top
| Default | -1.0 |
|---|---|
| setter | set_default_margin(value) |
| getter | get_default_margin |
方法说明
- draw draw(canvas_item: RID, rect: Rect2) const
使用具有给定RID的CanvasItem绘制此样式框。
您可以在CanvasItem派生的节点上使用Object.get_instance_id获取RID值。
- get_center_size get_center_size() const
返回此StyleBox的大小，不带边距。
- get_current_item_drawn get_current_item_drawn() const
返回此时处理其CanvasItem.NOTIFICATION_DRAW或CanvasItem._draw回调的CanvasItem。
- get_default_margin get_default_margin(margin: int) const
返回指定的Margin的默认值。
- get_margin get_margin(margin: int) const
返回指定Margin的内容边距偏移量。
正值向内减小大小，这与Control的边距值不同。
- get_minimum_size get_minimum_size() const
返回此样式框可以缩小到的最小尺寸。
- get_offset get_offset() const
返回样式框的“偏移”。
- set_default_margin set_default_margin(margin: int, offset: float)
将指定的Margin的默认值设置为给定的offset以像素为单位。
- test_mask test_mask(point: Vector2, rect: Rect2) const
测试矩形中的位置，返回其是否通过遮罩测试。