button_row_pool.gd

Go to the documentation of this file.

extends RefCounted
 
 
 
var parent:Control = null
var buttons:Array = []
var total_created:int = 0
var total_reused:int = 0
var pass_created:int = 0
var pass_reused:int = 0
var last_hidden:int = 0
 
 
func bind(next_parent:Control) -> void:
    parent = next_parent
 
 
func render(items:Array, options:Dictionary = {}) -> Array:
    if parent == null:
        return []
    pass_created = 0
    pass_reused = 0
    last_hidden = 0
    var rendered:Array = []
    for index in range(items.size()):
        var button:Button = _button_at(index)
        var item:Dictionary = {}
        if items[index] is Dictionary:
            item = items[index]
        _configure_button(button, item, index, options)
        button.visible = true
        rendered.append(button)
    for index in range(items.size(), buttons.size()):
        var button:Button = buttons[index]
        button.visible = false
        last_hidden += 1
    return rendered
 
 
func clear() -> void:
    for button in buttons:
        if is_instance_valid(button):
            button.queue_free()
    buttons.clear()
    total_created = 0
    total_reused = 0
    pass_created = 0
    pass_reused = 0
    last_hidden = 0
 
 
func get_button(index:int) -> Button:
    if index < 0 or index >= buttons.size():
        return null
    return buttons[index]
 
 
func get_stats() -> Dictionary:
    var visible_count:int = 0
    for button in buttons:
        if button is CanvasItem and button.visible:
            visible_count += 1
    return {
        "buttons": buttons.size(),
        "visible_buttons": visible_count,
        "hidden_last_pass": last_hidden,
        "pass_created": pass_created,
        "pass_reused": pass_reused,
        "total_created": total_created,
        "total_reused": total_reused
    }
 
 
func get_cache_stats() -> Dictionary:
    return get_stats()
 
 
func _button_at(index:int) -> Button:
    if index < buttons.size() and buttons[index] is Button:
        pass_reused += 1
        total_reused += 1
        return buttons[index]
    var button:Button = Button.new()
    button.focus_mode = Control.FOCUS_NONE
    button.size_flags_horizontal = Control.SIZE_EXPAND_FILL
    button.pressed.connect(func(): _emit_pressed(button))
    buttons.append(button)
    parent.add_child(button)
    pass_created += 1
    total_created += 1
    return button
 
 
func _configure_button(button:Button, item:Dictionary, index:int, options:Dictionary) -> void:
    button.name = str(item.get("name", "%s%d" % [str(options.get("name_prefix", "Button")), index + 1]))
    button.text = str(item.get("text", ""))
    button.disabled = bool(item.get("disabled", false))
    var icon_value = item.get("icon", null)
    button.icon = icon_value if icon_value is Texture2D else null
    button.expand_icon = bool(item.get("expand_icon", true))
    button.custom_minimum_size = Vector2(
        float(item.get("min_width", 0.0)),
        float(item.get("height", options.get("height", 44.0)))
    )
    button.set_meta("action_id", str(item.get("id", index)))
    button.set_meta("action_index", index)
    button.set_meta("callback", item.get("callback", Callable()))
    for key in ["font_color", "font_disabled_color"]:
        if item.has(key):
            button.add_theme_color_override(key, Color(item[key]))
    for style_name in ["normal", "hover", "pressed", "disabled", "focus"]:
        if item.has("%s_style" % style_name) and item["%s_style" % style_name] is StyleBox:
            button.add_theme_stylebox_override(style_name, item["%s_style" % style_name])
 
 
func _emit_pressed(button:Button) -> void:
    if button == null:
        return
    var callback:Callable = button.get_meta("callback", Callable())
    if callback is Callable and callback.is_valid():
        callback.call(int(button.get_meta("action_index", -1)), str(button.get_meta("action_id", "")))