# 通知設計書 13-BeginPopupContextWindow

## 概要

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

### 本通知の処理概要

`BeginPopupContextWindow()`は、現在のウィンドウ上でマウスボタンがリリースされた時に自動的にポップアップを開き、BeginPopup処理を実行するヘルパー関数である。ウィンドウ全体をコンテキストメニューのトリガー領域として使用できる。

**業務上の目的・背景**：ウィンドウの空白領域や全体を右クリックした時にコンテキストメニューを表示するUIパターンは一般的である。この関数は、ウィンドウレベルのコンテキストメニューを簡単に実装するための手段を提供し、開発効率の向上とUI一貫性の維持を実現する。

**通知の送信タイミング**：現在のウィンドウ上でマウスボタン（デフォルトは右クリック）がリリースされた時。IsWindowHovered()とIsMouseReleased()の条件が両方満たされた時にポップアップが開かれる。

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

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

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

## 通知種別

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

## 送信仕様

### 基本情報

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

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

1. str_idがNULLの場合、デフォルトID"window_context"を使用
2. window->GetID(str_id)でIDを生成
3. ImGuiPopupFlagsからマウスボタンを取得（デフォルトは右ボタン）
4. IsMouseReleased()とIsWindowHovered()の両方がtrueの場合にOpenPopupEx()を呼び出し
5. ImGuiPopupFlags_NoOpenOverItemsフラグが設定されている場合、アイテム上ではポップアップを開かない

## 通知テンプレート

### API呼び出し形式

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

### 使用例

```cpp
// 基本的な使用例
if (ImGui::BeginPopupContextWindow())
{
    if (ImGui::MenuItem("Add item")) { /* アイテム追加処理 */ }
    if (ImGui::MenuItem("Clear all")) { /* 全クリア処理 */ }
    ImGui::EndPopup();
}

// 空白スペースのみでポップアップを開く
if (ImGui::BeginPopupContextWindow("context", ImGuiPopupFlags_NoOpenOverItems))
{
    if (ImGui::MenuItem("Background action")) { /* 背景アクション */ }
    ImGui::EndPopup();
}

// 左クリックで開く
if (ImGui::BeginPopupContextWindow("left_context", ImGuiPopupFlags_MouseButtonLeft))
{
    ImGui::Text("Left-click context menu");
    ImGui::EndPopup();
}
```

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ImGuiPopupFlags_NoOpenOverItems | アイテム上でホバー時は開かない |
| IsAnyItemHovered() == true | NoOpenOverItemsフラグ設定時、アイテム上では開かない |

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

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

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

#### g.CurrentWindow

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| IDStack | ID生成 | GetID()で使用 |

### 更新テーブル一覧

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

この関数は内部状態の更新のみを行い、外部リソースへのアクセスや機密情報の処理は行わない。

## 備考

- バージョン1.77でシグネチャが変更された（ImGuiMouseButton mb, bool over_items → ImGuiPopupFlags flags）
- over_itemsパラメータはImGuiPopupFlags_NoOpenOverItemsフラグに置き換えられた
- ImGuiHoveredFlags_AllowWhenBlockedByPopupが自動的に使用される

---

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

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

### 推奨読解順序

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

ポップアップフラグの定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiPopupFlags_列挙型（1337-1352行） |
| 1-2 | imgui.h | `imgui.h` | ImGuiPopupFlags_NoOpenOverItems（1346行） |

**読解のコツ**: NoOpenOverItemsは1<<8=256として定義されている。

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

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

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

**主要処理フロー**:
1. **12515-12516行**: str_idがNULLの場合"window_context"を使用
2. **12517行**: window->GetIDでID生成
3. **12518行**: マウスボタン取得
4. **12519行**: IsMouseReleased && IsWindowHovered判定
5. **12520行**: NoOpenOverItemsフラグとIsAnyItemHovered判定
6. **12521行**: OpenPopupEx呼び出し
7. **12522行**: BeginPopupEx呼び出し

#### Step 3: ホバー判定を理解する

IsWindowHoveredの動作を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | IsWindowHovered関数の実装 |

**主要処理フロー**:
- AllowWhenBlockedByPopupフラグの効果を確認

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

```
BeginPopupContextWindow()  [imgui.cpp:12511]
    |
    +-- str_id NULLチェック → "window_context"
    |
    +-- window->GetID()
    |
    +-- GetMouseButtonFromPopupFlags()  [imgui.cpp:12453]
    |
    +-- IsMouseReleased() / IsWindowHovered()
    |
    +-- (条件付き) IsAnyItemHovered()
    |
    +-- OpenPopupEx()  [imgui.cpp:12172] (条件付き)
    |
    +-- BeginPopupEx()  [imgui.cpp:12345]
```

### データフロー図

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

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

popup_flags ───────▶ GetMouseButtonFromPopupFlags ──▶ mouse_button
                          |
IsMouseReleased ───▶ ウィンドウクリック判定 ──▶ OpenPopupEx
IsWindowHovered ───────┘     |
                             +─▶ NoOpenOverItemsチェック
IsAnyItemHovered ──────────────┘
                          |
                    BeginPopupEx ──▶ bool (表示中か否か)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | BeginPopupContextWindow関数宣言（871行目） |
| imgui.cpp | `imgui.cpp` | ソース | BeginPopupContextWindow実装（12511行目） |
| imgui.cpp | `imgui.cpp` | ソース | API BREAKING CHANGES（858行目、1.77変更） |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | 使用例（8963, 9815, 10872行目） |
| imgui.h | `imgui.h` | ヘッダー | 廃止されたシグネチャコメント（4098行目） |
