# 通知設計書 6-BeginPopup

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるBeginPopup API関数の設計・動作仕様を記載したものである。BeginPopupはポップアップウィンドウが開いている場合にコンテンツの追加を開始するAPI関数である。

### 本通知の処理概要

BeginPopupは、指定されたIDのポップアップが開いているかどうかを確認し、開いている場合はポップアップウィンドウへのコンテンツ追加を開始する。ポップアップの可視性状態はImGuiライブラリ内部で管理される。

**業務上の目的・背景**：ポップアップはコンテキストメニュー、ドロップダウン、ダイアログなど多様なUIパターンで使用される。BeginPopupは、OpenPopup()で開かれたポップアップに対してコンテンツを追加するための標準的なインターフェースを提供する。通常のウィンドウとは異なり、ポップアップは外部クリックやESCAPEキーで自動的に閉じられる。

**通知の送信タイミング**：毎フレームのレンダリングループ内で呼び出される。OpenPopup()でポップアップが開かれた後、BeginPopup()でそのポップアップが開いているかを確認し、開いていればコンテンツを追加する。

**通知の受信者**：Dear ImGuiの内部ポップアップスタック管理システム。OpenPopupStackとBeginPopupStackを使用してポップアップの状態を管理する。

**通知内容の概要**：ポップアップウィンドウの開始リクエスト。文字列IDを使用してポップアップを識別し、ImGuiWindowFlagsを追加で指定可能。

**期待されるアクション**：関数がtrueを返した場合、呼び出し側はポップアップ内にコンテンツを配置し、EndPopup()を呼び出す必要がある。falseを返した場合は何もしない。

## 通知種別

UI内部通知（ImGuiウィンドウシステム内での状態変更通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | 無 |

### 送信先決定ロジック

BeginPopupの呼び出しは、OpenPopupStackの現在のレベルに対して行われる。ポップアップIDは現在のIDスタックに対して相対的に計算される。

## 通知テンプレート

### API関数シグネチャ

| 項目 | 内容 |
|-----|------|
| 関数名 | BeginPopup |
| 戻り値 | bool |
| 引数 | const char* str_id, ImGuiWindowFlags flags = 0 |
| 定義場所 | imgui.h:845 |

### 本文テンプレート

```cpp
// 基本的な使用パターン
if (ImGui::Button("メニューを開く"))
    ImGui::OpenPopup("my_popup");

if (ImGui::BeginPopup("my_popup"))
{
    ImGui::Text("ポップアップの内容");
    if (ImGui::Button("閉じる"))
        ImGui::CloseCurrentPopup();
    ImGui::EndPopup();
}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| str_id | ポップアップ識別子 | 呼び出し元から渡される | Yes |
| flags | ウィンドウフラグ | 呼び出し元から渡される | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | BeginPopup()呼び出し | ポップアップが開いている | IsPopupOpen()がtrue |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| OpenPopupStack.Size <= BeginPopupStack.Size | ポップアップが開いていない |
| IsPopupOpen(id)がfalse | 指定IDのポップアップが開いていない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BeginPopup呼び出し] --> B{OpenPopupStack.Size ><br/>BeginPopupStack.Size?}
    B -->|No| C[NextWindowData.ClearFlags]
    B -->|Yes| D[IDを計算]
    C --> E[false返却]
    D --> F[フラグを追加]
    F --> G[BeginPopupEx呼び出し]
    G --> H{IsPopupOpen?}
    H -->|Yes| I[Begin呼び出し]
    H -->|No| J[false返却]
    I --> K{Begin成功?}
    K -->|Yes| L[true返却]
    K -->|No| M[EndPopup呼び出し]
    M --> J
    E --> N[終了]
    J --> N
    L --> N
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ImGuiContext (GImGui) | グローバルコンテキスト | ポップアップスタック管理 |

### テーブル別参照項目詳細

#### ImGuiContext

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| OpenPopupStack | 開いているポップアップのスタック | 常時 |
| BeginPopupStack | Begin済みポップアップのスタック | 常時 |
| CurrentWindow | 現在のウィンドウ | ID計算用 |
| NextWindowData | 次ウィンドウデータ | フラグクリア用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| BeginPopupStack | PUSH | ポップアップ開始時 |
| NextWindowData | UPDATE | フラグクリア |

#### ポップアップスタック操作

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| PUSH | BeginPopupStack | ポップアップ参照 | BeginPopupEx内部 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| Begin失敗 | ウィンドウがクリップされている場合 | EndPopup()を自動呼び出し |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0 |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（即座に実行される同期処理）

## セキュリティ考慮事項

特になし。ローカルUIレンダリング処理のため、外部通信やデータ永続化は行わない。

## 備考

- ポップアップIDは現在のIDスタックに対して相対的
- OpenPopupとBeginPopupは同じレベルのIDスタックで呼び出す必要がある
- ImGuiWindowFlags_AlwaysAutoResize、ImGuiWindowFlags_NoTitleBar、ImGuiWindowFlags_NoSavedSettingsが自動的に追加される
- ポップアップは外部クリックまたはESCAPEキーで閉じられる
- trueを返した場合は必ずEndPopup()を呼び出すこと

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

ポップアップ管理に関連するデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiPopupData構造体（1471-1483行目） |
| 1-2 | imgui.h | `imgui.h` | ImGuiPopupFlags定義（1337-1352行目） |

**読解のコツ**: OpenPopupStackとBeginPopupStackの役割の違いを理解する。

#### Step 2: エントリーポイントを理解する

BeginPopupの宣言と実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | BeginPopup API宣言（845行目） |
| 2-2 | imgui.h | `imgui.h` | ポップアップセクションコメント（835-844行目） |
| 2-3 | imgui.cpp | `imgui.cpp` | BeginPopup実装（12384-12395行目） |

**主要処理フロー**:
1. **12387-12391行目**: OpenPopupStack.Size確認、早期リターン
2. **12392行目**: フラグ追加（AlwaysAutoResize, NoTitleBar, NoSavedSettings）
3. **12393行目**: ID計算
4. **12394行目**: BeginPopupEx呼び出し

#### Step 3: BeginPopupExの動作を理解する

BeginPopupExの詳細実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | BeginPopupEx実装（12345-12363行目） |

**主要処理フロー**:
- **12348-12352行目**: IsPopupOpenチェック
- **12354-12356行目**: ウィンドウ名生成
- **12358-12362行目**: Begin呼び出しと結果処理

### プログラム呼び出し階層図

```
BeginPopup(str_id, flags) [imgui.cpp:12384]
    │
    ├─ OpenPopupStack.Size確認
    │
    ├─ NextWindowData.ClearFlags() [条件付き: 早期リターン時]
    │
    ├─ CurrentWindow->GetID(str_id) [ID計算]
    │
    └─ BeginPopupEx(id, flags) [imgui.cpp:12345]
           │
           ├─ IsPopupOpen(id) [ポップアップ状態確認]
           │
           ├─ ImFormatString() [ウィンドウ名生成]
           │
           └─ Begin() [ウィンドウ開始]
                  │
                  └─ BeginPopupStack.push_back()
```

### データフロー図

```
[入力]                    [処理]                         [出力]

str_id             ───▶ BeginPopup()             ───▶ bool
flags                     │
                          ▼
CurrentWindow      ───▶ GetID(str_id)
  │                       │
  └─ IDStack              ▼
                       ID計算
                          │
OpenPopupStack     ───▶ IsPopupOpen(id)
  │                       │
  └─ PopupId              ▼
                     BeginPopupEx()
                          │
                          ▼
                       Begin()                  ───▶ ポップアップウィンドウ
                          │
                          ▼
BeginPopupStack    ◀─── push_back(popup_ref)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ソース | API宣言・フラグ定義 |
| imgui.cpp | `imgui.cpp` | ソース | 実装本体 |
| imgui_internal.h | `imgui_internal.h` | ソース | ImGuiPopupData構造体定義 |
