# 通知設計書 16-ImGuiPopupFlags_MouseButtonLeft

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける`ImGuiPopupFlags_MouseButtonLeft`フラグの設計仕様を記載する。このフラグは、BeginPopupContext系関数で左マウスボタンリリース時にポップアップを開くことを指定する。

### 本通知の処理概要

`ImGuiPopupFlags_MouseButtonLeft`は、ポップアップのトリガーマウスボタンを左ボタンに設定するためのフラグである。BeginPopupContextItem、BeginPopupContextWindow、BeginPopupContextVoid、OpenPopupOnItemClick関数で使用され、GetMouseButtonFromPopupFlags関数によってマウスボタン値に変換される。

**業務上の目的・背景**：標準的なコンテキストメニューは右クリックで開くが、一部のUIパターンでは左クリックでポップアップを開く必要がある。例えば、ドロップダウンメニューやカスタムボタンアクションなど。このフラグは、そのようなケースに対応するための手段を提供する。

**通知の送信タイミング**：このフラグ自体は送信を行わない。BeginPopupContext系関数のpopup_flagsパラメータとして渡された時、IsMouseReleased(ImGuiMouseButton_Left)の条件判定に使用される。

**通知の受信者**：BeginPopupContext系関数およびOpenPopupOnItemClick関数内のマウスボタン判定ロジック。

**通知内容の概要**：ポップアップのトリガーボタンを左マウスボタンに設定する指示。

**期待されるアクション**：左マウスボタンリリース時にポップアップが開くようになる。

## 通知種別

フラグ定数 / ポップアップ動作オプション

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| フラグ値 | 1 << 2 = 4 |
| カテゴリ | マウスボタン指定 |
| 排他性 | 他のMouseButtonフラグと排他（1つのみ指定可能） |

### フラグ変換ロジック

GetMouseButtonFromPopupFlags関数により、フラグ値からマウスボタン番号に変換される：
- ImGuiPopupFlags_MouseButtonLeft (1 << 2) → ImGuiMouseButton_Left (0)
- 計算式: ((flags & MouseButtonMask_) >> MouseButtonShift_) - 1 = ((4 & 0x0C) >> 2) - 1 = 0

## 通知テンプレート

### フラグ定義

| 項目 | 内容 |
|-----|------|
| フラグ名 | ImGuiPopupFlags_MouseButtonLeft |
| 値 | 1 << 2 (= 4) |
| 定義場所 | imgui.h:1340 |

### 使用例

```cpp
// 左クリックでコンテキストメニューを開く
if (ImGui::Button("Click me"))
{
    // ボタンの通常処理
}
if (ImGui::BeginPopupContextItem("left_popup", ImGuiPopupFlags_MouseButtonLeft))
{
    ImGui::Text("Left-click context menu");
    ImGui::EndPopup();
}

// 左クリックでウィンドウコンテキストメニュー
if (ImGui::BeginPopupContextWindow("window_menu", ImGuiPopupFlags_MouseButtonLeft))
{
    ImGui::MenuItem("Option 1");
    ImGui::MenuItem("Option 2");
    ImGui::EndPopup();
}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| N/A | N/A | N/A | フラグ定義のため添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| N/A | N/A | N/A | フラグ定義のため変数なし |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| マウス操作 | 左マウスボタンリリース | IsMouseReleased(ImGuiMouseButton_Left) | フラグ設定時のトリガー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 他のMouseButtonフラグとの併用 | 複数のボタンフラグは同時に使用できない |

## 処理フロー

### フラグ処理フロー

```mermaid
flowchart TD
    A[popup_flagsにMouseButtonLeft設定] --> B[GetMouseButtonFromPopupFlags呼び出し]
    B --> C{MouseButtonMask_と AND}
    C --> D[シフト演算]
    D --> E[ImGuiMouseButton_Left = 0 を返す]
    E --> F[IsMouseReleased 左ボタン で判定]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | N/A | フラグ定義のためテーブル参照なし |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| N/A | N/A | フラグ定義のため更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 複数ボタンフラグ | 複数のMouseButtonフラグを同時指定 | 1つのみ指定する |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | N/A |
| 1日あたり上限 | N/A |

### 配信時間帯

フラグ定義のため配信概念なし。

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

フラグ定義であり、セキュリティ上のリスクは存在しない。

## 備考

- バージョン1.92.6以前は、デフォルト値が異なっていた（0が左ボタンを意味していた）
- 現在のバージョンでは、明示的にマウスボタンを指定することが推奨される
- MouseButtonフラグは排他的であり、複数同時に指定することはできない
- コメントに「Only one button allowed!」と明記されている

---

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

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

### 推奨読解順序

#### Step 1: フラグ定義を理解する

ImGuiPopupFlags_列挙型の定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiPopupFlags_MouseButtonLeft定義（1340行目） |
| 1-2 | imgui.h | `imgui.h` | MouseButtonMask_, MouseButtonShift_定義（1350-1351行） |

**読解のコツ**: MouseButtonLeft = 1 << 2 = 4、Mask = 0x0C、Shift = 2。

#### Step 2: フラグ変換ロジックを理解する

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

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

**主要処理フロー**:
1. **12456-12457行**: レガシー互換処理（InvalidMask_）
2. **12461-12462行**: MouseButtonMask_でフラグ抽出、シフトして-1
3. **12463行**: デフォルトはImGuiMouseButton_Right

#### Step 3: 使用箇所を確認する

BeginPopupContext系関数での使用を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | BeginPopupContextItem内での使用（12505行） |
| 3-2 | imgui.cpp | `imgui.cpp` | BeginPopupContextWindow内での使用（12518行） |

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

```
BeginPopupContextItem/Window/Void()
    |
    +-- GetMouseButtonFromPopupFlags(popup_flags)  [imgui.cpp:12453]
    |       |
    |       +-- (flags & MouseButtonMask_) >> MouseButtonShift_ - 1
    |       |       = (4 & 0x0C) >> 2 - 1
    |       |       = 1 - 1
    |       |       = 0 (ImGuiMouseButton_Left)
    |       |
    |       +-- return ImGuiMouseButton_Left
    |
    +-- IsMouseReleased(ImGuiMouseButton_Left)
```

### データフロー図

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

ImGuiPopupFlags_MouseButtonLeft (4)
        |
        +──▶ GetMouseButtonFromPopupFlags
        |           |
        |           +──▶ & MouseButtonMask_ (0x0C) ──▶ 4
        |           |
        |           +──▶ >> MouseButtonShift_ (2) ──▶ 1
        |           |
        |           +──▶ - 1 ──▶ 0
        |
        +──▶ ImGuiMouseButton_Left (0)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | ImGuiPopupFlags_MouseButtonLeft定義（1340行目） |
| imgui.h | `imgui.h` | ヘッダー | コメント「Only one button allowed!」 |
| imgui.cpp | `imgui.cpp` | ソース | GetMouseButtonFromPopupFlags実装（12453行目） |
| imgui.cpp | `imgui.cpp` | ソース | API BREAKING CHANGES（398-415行） |
