# 通知設計書 14-BeginPopupContextVoid

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける`BeginPopupContextVoid()`関数の設計仕様を記載する。この関数は、ウィンドウが存在しない領域（void領域）でクリックされた時にコンテキストメニュー（ポップアップ）を開く機能を提供する。

### 本通知の処理概要

`BeginPopupContextVoid()`は、どのウィンドウ上でもない空白領域でマウスボタンがリリースされた時に自動的にポップアップを開き、BeginPopup処理を実行するヘルパー関数である。デスクトップ背景のようなグローバルなコンテキストメニューを実装するために使用される。

**業務上の目的・背景**：アプリケーションの空白領域（ウィンドウ外）での右クリックメニューは、新規ウィンドウ作成やグローバル設定へのアクセスなど、アプリケーション全体に関わる操作を提供するUIパターンとして一般的である。この関数は、そのような機能を簡単に実装する手段を提供する。

**通知の送信タイミング**：どのウィンドウ上でもない領域でマウスボタン（デフォルトは右クリック）がリリースされた時。!IsWindowHovered(AnyWindow)とIsMouseReleased()の条件が両方満たされ、かつモーダルポップアップが開いていない時にポップアップが開かれる。

**通知の受信者**：ImGuiの内部ポップアップスタック管理システム。OpenPopupStackにポップアップエントリが追加され、新しいウィンドウ描画コンテキストが開始される。

**通知内容の概要**：void領域に関連付けられたポップアップID（デフォルトは"void_context"）で新しいポップアップウィンドウを開く指示。

**期待されるアクション**：戻り値がtrueの場合、開発者はポップアップ内のUIコンテンツを描画し、最後にEndPopup()を呼び出す。

## 通知種別

内部API呼び出し / コンテキストメニュー通知

## 送信仕様

### 基本情報

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

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

1. str_idがNULLの場合、デフォルトID"void_context"を使用
2. window->GetID(str_id)でIDを生成
3. ImGuiPopupFlagsからマウスボタンを取得（デフォルトは右ボタン）
4. IsMouseReleased()かつ!IsWindowHovered(AnyWindow)の場合にOpenPopupEx()を呼び出し
5. GetTopMostPopupModal()がNULLの場合のみポップアップを開く（モーダル優先）

## 通知テンプレート

### API呼び出し形式

| 項目 | 内容 |
|-----|------|
| 関数名 | BeginPopupContextVoid(const char* str_id, ImGuiPopupFlags popup_flags) |
| 戻り値 | bool（ポップアップが開いている場合true） |
| 引数1 | str_id: ポップアップID（NULLの場合は"void_context"を使用） |
| 引数2 | popup_flags: ポップアップフラグ（デフォルト0=右クリック） |

### 使用例

```cpp
// 基本的な使用例（ウィンドウ外の空白領域で右クリック）
if (ImGui::BeginPopupContextVoid())
{
    if (ImGui::MenuItem("New Window")) { /* 新規ウィンドウ作成 */ }
    if (ImGui::MenuItem("Settings")) { /* 設定画面を開く */ }
    ImGui::Separator();
    if (ImGui::MenuItem("Exit")) { /* アプリケーション終了 */ }
    ImGui::EndPopup();
}

// カスタムIDで左クリック
if (ImGui::BeginPopupContextVoid("global_menu", ImGuiPopupFlags_MouseButtonLeft))
{
    ImGui::Text("Global Menu");
    ImGui::EndPopup();
}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| N/A | N/A | N/A | この通知には添付ファイルは存在しない |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| id | ポップアップID | window->GetID(str_id ? str_id : "void_context") | Yes |
| mouse_button | トリガーマウスボタン | GetMouseButtonFromPopupFlags(popup_flags) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| マウス操作 | マウスボタンリリース | IsMouseReleased(button) && !IsWindowHovered(AnyWindow) | void領域でのクリック |
| 継続状態 | ポップアップ表示中 | IsPopupOpen(id) | 開いているポップアップの描画継続 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| GetTopMostPopupModal() != NULL | モーダルポップアップが開いている場合は開かない |
| IsWindowHovered(AnyWindow) == true | いずれかのウィンドウ上にマウスがある場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BeginPopupContextVoid呼び出し] --> B{str_id指定?}
    B -->|No| C["void_context"使用]
    B -->|Yes| D[指定str_id使用]
    C --> E[window->GetIDでID生成]
    D --> E
    E --> F[マウスボタン取得]
    F --> G{IsMouseReleased?}
    G -->|No| L[BeginPopupEx呼び出し]
    G -->|Yes| H{IsWindowHovered AnyWindow?}
    H -->|Yes| L
    H -->|No| I{GetTopMostPopupModal NULL?}
    I -->|No| L
    I -->|Yes| J[OpenPopupEx呼び出し]
    J --> L
    L --> M{ポップアップ開いている?}
    M -->|Yes| N[return true]
    M -->|No| O[return false]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| g.CurrentWindow | 現在のウィンドウ | ID生成に使用 |
| g.HoveredWindow | ホバー中のウィンドウ | void判定に使用 |
| g.OpenPopupStack | ポップアップスタック | モーダル確認・開閉状態確認 |

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

#### g.OpenPopupStack

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| Window | モーダルウィンドウ確認 | GetTopMostPopupModal() |
| Flags | ImGuiWindowFlags_Modal確認 | モーダル判定 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| g.OpenPopupStack | INSERT | クリック時に新規ポップアップ追加 |

#### 送信ログテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| DEBUG_LOG | OpenPopupEx | 0x%08X | ポップアップID |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 特になし | N/A | この関数は基本的にエラーを発生させない |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

即座に実行される同期処理のため、配信時間帯の制限なし。

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

この関数は内部状態の更新のみを行い、外部リソースへのアクセスや機密情報の処理は行わない。モーダルダイアログが開いている場合はポップアップを開かないため、意図しないUI操作を防ぐ設計になっている。

## 備考

- モーダルポップアップが開いている場合は、void領域クリックでもポップアップは開かない
- この関数は主にアプリケーション全体のコンテキストメニュー（新規ウィンドウ作成など）に使用される
- 現在のウィンドウのIDスタックからIDが生成されるため、呼び出し位置によってIDが異なる可能性がある

---

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

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

### 推奨読解順序

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

ポップアップスタックとモーダル判定の仕組みを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiPopupData構造体 |
| 1-2 | imgui.h | `imgui.h` | ImGuiWindowFlags_Modal定義 |

**読解のコツ**: モーダルウィンドウはFlags & ImGuiWindowFlags_Modalで判定される。

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

BeginPopupContextVoid関数の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | BeginPopupContextVoid関数（12525行目） |

**主要処理フロー**:
1. **12529-12530行**: str_idがNULLの場合"void_context"を使用
2. **12531行**: window->GetIDでID生成
3. **12532行**: マウスボタン取得
4. **12533行**: IsMouseReleased && !IsWindowHovered(AnyWindow)判定
5. **12534行**: GetTopMostPopupModal() == NULL判定
6. **12535行**: OpenPopupEx呼び出し
7. **12536行**: BeginPopupEx呼び出し

#### Step 3: モーダル判定を理解する

GetTopMostPopupModal関数の動作を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | GetTopMostPopupModal関数（12097行目） |

**主要処理フロー**:
- OpenPopupStackを逆順に走査
- ImGuiWindowFlags_Modalを持つポップアップを探す

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

```
BeginPopupContextVoid()  [imgui.cpp:12525]
    |
    +-- str_id NULLチェック → "void_context"
    |
    +-- window->GetID()
    |
    +-- GetMouseButtonFromPopupFlags()  [imgui.cpp:12453]
    |
    +-- IsMouseReleased()
    |
    +-- IsWindowHovered(ImGuiHoveredFlags_AnyWindow)
    |
    +-- GetTopMostPopupModal()  [imgui.cpp:12097]
    |       +-- OpenPopupStack走査
    |       +-- Modal フラグ確認
    |
    +-- OpenPopupEx()  [imgui.cpp:12172] (条件付き)
    |
    +-- BeginPopupEx()  [imgui.cpp:12345]
```

### データフロー図

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

str_id / NULL ─────▶ "void_context"置換 ──────────▶ popup_id
                          |
                    window->GetID()

popup_flags ───────▶ GetMouseButtonFromPopupFlags ──▶ mouse_button
                          |
IsMouseReleased ───▶ void領域クリック判定 ──▶ OpenPopupEx
!IsWindowHovered ──────┘     |
                             +─▶ モーダルチェック
GetTopMostPopupModal ──────────┘
                          |
                    BeginPopupEx ──▶ bool (表示中か否か)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | BeginPopupContextVoid関数宣言（872行目） |
| imgui.cpp | `imgui.cpp` | ソース | BeginPopupContextVoid実装（12525行目） |
| imgui.cpp | `imgui.cpp` | ソース | GetTopMostPopupModal実装（12097行目） |
| imgui.h | `imgui.h` | ヘッダー | ImGuiHoveredFlags_AnyWindow定義 |
