Ui

The editor's immediate-mode UI for plugin panels and settings pages, drawn with the editor theme (no Dear ImGui dependency). Valid only inside a draw callback. Begin*/End* pairs follow Dear ImGui's rule: call End* only when Begin* returned true; the host closes whatever a panel leaves open. Labels may carry "##id" suffixes to keep ids unique.

public sealed class ReportPanel : EditorPlugin
{
    public override void OnLoad() => Host.AddPanel(new PanelOptions("Report", "Scene Report"), Draw);

    private void Draw(Ui ui)
    {
        World? scene = Host.Document;
        if (scene is null)
        {
            ui.TextColored(ThemeColor.TextSecondary, "Open a scene to see its report.");
            return;
        }
        IReadOnlyList<Entity> entities = scene.Entities;
        ui.Text($"{entities.Count} entities");
        if (ui.BeginTable("entities", 2))
        {
            ui.TableSetupColumn("Name");
            ui.TableSetupColumn("Position");
            ui.TableHeadersRow();
            foreach (Entity entity in entities.Take(200))
            {
                ui.TableNextRow();
                ui.TableNextColumn();
                ui.Text(scene.GetName(entity));
                ui.TableNextColumn();
                ui.Text(scene.GetTransform(entity).Position.ToString("0.0", CultureInfo.InvariantCulture));
            }
            ui.EndTable();
        }
    }
}

public float DeltaSeconds { get; }
public float Width { get; }
public float Height { get; }
public void Text(string text)
public void TextWrapped(string text)
public void TextColored(ThemeColor color, string text)
public void Heading(string text)
public void Icon(string iconName)
public bool Button(string label, ButtonStyle style = ButtonStyle.Default)
public bool IconButton(string id, string iconName, string? tooltip = null)
public bool Checkbox(string label, ref bool value)
public bool InputText(string label, ref string value, int capacity = 256, InputFlags flags = InputFlags.None)
public bool InputInt(string label, ref int value)
public bool InputFloat(string label, ref float value)
public bool SliderFloat(string label, ref float value, float minimum, float maximum)
public bool DragFloat3(string label, ref Vector3 value, float speed = 0.1f)
public bool Combo(string label, ref int index, IReadOnlyList<string> items)
public bool Selectable(string label, bool selected = false)
public bool ColorEdit4(string label, ref Vector4 rgba)
public void ProgressBar(float fraction, string? overlay = null)
public void SameLine()
public void Spacing()
public void Separator()
public void SeparatorText(string text)
public void Indent()
public void Unindent()
public void SetNextItemWidth(float width)
public float AvailableWidth { get; }
public void BeginDisabled(bool disabled = true)
public void EndDisabled()
public void PushId(string id)
public void PopId()
public Scope Disabled(bool disabled = true)
public Scope Id(string id)
public bool BeginSection(string label, bool defaultOpen = true)
public void EndSection()
public bool Section(string label, Action content, bool defaultOpen = true)
public bool BeginTable(string id, int columns, TableFlags flags = TableFlags.Borders | TableFlags.RowBackground)
public void TableSetupColumn(string label, float width = 0.0f)
public void TableHeadersRow()
public void TableNextRow()
public bool TableNextColumn()
public void EndTable()
public bool TreeNode(string label, TreeFlags flags = TreeFlags.None)
public void TreePop()
public void Tooltip(string text)
public bool IsItemHovered()
public bool IsItemClicked()
public Vector4 ThemeColorOf(ThemeColor color)
public float ThemeMetricOf(ThemeMetric metric)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.