ImGui 基础概念

如果您是初次使用 ImGui 包，我们希望您能认真阅读此页面，以保证您具备使用此包的基本概念。而后，您才可能知道您在自己的项目中需要什么，想要什么。

总体容阅读时间约为 20 min，请酌情参考。

本页面将呈现以下内容：

• 典型 ImGui 程序的代码布局
• 显示器方法（Open GL）
• 应用（application）简要
• 向量（vec2/vec4）
• 字体（font）简要
• 窗口（window）简要
• 控件（widget）简要
• 布局和组（group）
• 画板（canvas）

ImGui 的所有内容均组织在名为 application 的，由系统提供的窗口内。

一个 application 内可以绘制多个窗口（window）。

每个窗口内可以拥有若干控件。

我们可以使用一种典型代码结构来编写可视化工具：

while !app.is_closed()
    app.prepare()
    ...
    app.render()
end

在 app.prepare() 和 app.render() 间设计的布局的每个窗口（包括每个控件），都将以每一帧为单位染至应用（application）上。

Open GL 是 Dear ImGui 的后端，其方法与 Dear ImGui 无关。

在 ImGui 中保留并提供了对显示器的方法：

显示器 id 由系统分配。

例如：win10 下，显示器编号为 1~n，则在 ImGui 中显示器 id 对应为 0~n-1。

单显示器下显示器 id 为 0。

application 分为两种：

创建全屏应用需手动指定显示器 id。

创建窗口应用需指定长宽，需要创建与屏幕成比例的窗口，可以配合显示器方法（获取显示器长宽）使用。

application 支持设置内部所有窗口（window）的主题风格：

在 Dear ImGui 中，有两类向量：

• vec2：二维向量，常用于表示坐标或长宽

• vec4：四维向量，常用于表示有三通道和透明度的色彩（RGBA）

ImGui 对此保留了以上设计：

ImGui 会为整个应用维护一个字体栈，每绘制一次窗口，都会自动使用字体栈顶的字体。

ImGui 为字体栈提供了以下方法：

ImGui 为字体提供了专用的字体包 imgui_font【待更新】 和以下方法：

import imgui
import imgui_font
var font0 = add_font_extend_cn(imgui_font.source_han_sans,25)
var font1 = add_font_default(25)
...
while !app.is_closed
    app.prepare()
    push_font(font0)
    ... # 此处控件使用 font0 字体
    pop_font()
    push_font(font1)
    ... # 此处控件使用 font1 字体
    app.render()
end

ImGui 的提供的窗口仅在应用中生效，即：应用内窗口。

窗口是控件的载体，每个应用内可以涵有若干窗口。

一般来说，通过如下的方式来设置窗口

对于以上方法做出解释。

例如，在 app 内绘制一个 window，然后渲染：

while !app.is_closed
    app.prepare()
        begin_window("my_window##mw1", mw1_isopen, {})
            set_window_pos(vec2(0,0))
            set_window_size(vec2(get_widow_width(app),get_widow_height(app)))
            ...
        end_window()
    app.render()
end

互动类控件通常使用返回boolean类型的值，来表示其状态。

如按钮（button）：

...
begin_window(...)
    if button("click me!")
        # do something
    ...
end_window()

控件种类繁多，不在此一一赘述。如有需要可以参考 ImGui 控件文档。

标识符：一般用于右键菜单等，默认情况下标识符就是控件名，但有些控件无 ID 时就要特别标示

一般控件名可使用title##id的形式指定控件的标识符

ImGui支持使用begin_group()和end_group()一对方法标签，将若干控件组合为一个组（group），并对其实施统一的布局行为。 以下改变布局的行为，仅对组内控件生效：

另外还有树形节点，您可以理解为组（group）的树状形式：

可以粗浅理解为“当前选中的窗口或控件”。大部分I/O指令都作用于焦点控件（或窗口）上。焦点会被鼠标左键触发设置，您也可以自行设置焦点（根据逻辑）。

画板提供了在窗口内绘图的系列方法。