# 通知設計書 17-ImGuiPopupFlags_MouseButtonRight

## 概要

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

### 本通知の処理概要

`ImGuiPopupFlags_MouseButtonRight`は、ポップアップのトリガーマウスボタンを右ボタンに設定するためのフラグである。BeginPopupContextItem、BeginPopupContextWindow、BeginPopupContextVoid、OpenPopupOnItemClick関数で使用され、GetMouseButtonFromPopupFlags関数によってマウスボタン値に変換される。このフラグはデフォルト動作であり、明示的に指定しなくても適用される。

**業務上の目的・背景**：右クリックでコンテキストメニューを開くのは、GUIアプリケーションにおける最も一般的なUIパターンである。このフラグはその標準的な動作を明示的に指定する手段を提供するとともに、他のマウスボタンフラグと組み合わせてフラグ処理を行う際に使用される。

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

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

**通知内容の概要**：ポップアップのトリガーボタンを右マウスボタンに設定する指示（デフォルト動作）。

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

## 通知種別

フラグ定数 / ポップアップ動作オプション（デフォルト）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| フラグ値 | 2 << 2 = 8 |
| カテゴリ | マウスボタン指定 |
| 排他性 | 他のMouseButtonフラグと排他（1つのみ指定可能） |
| デフォルト | Yes（フラグ未指定時に適用） |

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

GetMouseButtonFromPopupFlags関数により、フラグ値からマウスボタン番号に変換される：
- ImGuiPopupFlags_MouseButtonRight (2 << 2) → ImGuiMouseButton_Right (1)
- 計算式: ((flags & MouseButtonMask_) >> MouseButtonShift_) - 1 = ((8 & 0x0C) >> 2) - 1 = 1
- フラグ未指定時（flags & MouseButtonMask_ == 0）もデフォルトでImGuiMouseButton_Rightを返す

## 通知テンプレート

### フラグ定義

| 項目 | 内容 |
|-----|------|
| フラグ名 | ImGuiPopupFlags_MouseButtonRight |
| 値 | 2 << 2 (= 8) |
| 定義場所 | imgui.h:1341 |

### 使用例

```cpp
// 明示的に右クリックを指定（デフォルトと同じ動作）
if (ImGui::BeginPopupContextItem("context", ImGuiPopupFlags_MouseButtonRight))
{
    ImGui::MenuItem("Copy");
    ImGui::MenuItem("Paste");
    ImGui::EndPopup();
}

// 他のフラグと組み合わせて使用
if (ImGui::BeginPopupContextItem("context", ImGuiPopupFlags_MouseButtonRight | ImGuiPopupFlags_NoReopen))
{
    ImGui::MenuItem("Option");
    ImGui::EndPopup();
}

// フラグ省略時も右クリックがデフォルト
if (ImGui::BeginPopupContextItem()) // ImGuiPopupFlags_MouseButtonRightと同等
{
    ImGui::MenuItem("Default right-click menu");
    ImGui::EndPopup();
}
```

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

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

## 処理フロー

### フラグ処理フロー

```mermaid
flowchart TD
    A[popup_flags取得] --> B{MouseButtonMask_に値?}
    B -->|Yes| C[指定されたボタン取得]
    B -->|No| D[デフォルト: Right]
    C --> E{MouseButtonRight?}
    E -->|Yes| F[ImGuiMouseButton_Right = 1 を返す]
    D --> F
    F --> G[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以降、フラグ未指定時のデフォルトが右クリックになった
- バージョン1.92.6以前は、デフォルト値が1（＝右クリック）だったが、0を渡すと左クリックになる仕様だった
- 現在は0を渡しても右クリックがデフォルトになる
- MouseButtonフラグは排他的であり、複数同時に指定することはできない
- コメントに「(default)」と明記されている

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiPopupFlags_MouseButtonRight定義（1341行目） |
| 1-2 | imgui.h | `imgui.h` | コメント「(default)」の確認 |

**読解のコツ**: MouseButtonRight = 2 << 2 = 8。コメントに「(default)」とある点に注目。

#### 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: API変更履歴を確認する

バージョン1.92.6での変更を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | API BREAKING CHANGES（398-415行） |

**主要変更点**:
- デフォルト値が1から0に変更
- 0を渡した場合の動作が左→右に変更
- レガシー互換のため1は右として解釈

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

```
BeginPopupContextItem/Window/Void()
    |
    +-- GetMouseButtonFromPopupFlags(popup_flags)  [imgui.cpp:12453]
            |
            +-- (flags & MouseButtonMask_) == 0 ?
            |       |
            |       +-- Yes → return ImGuiMouseButton_Right (1)
            |
            +-- (flags & MouseButtonMask_) >> MouseButtonShift_ - 1
            |       = (8 & 0x0C) >> 2 - 1
            |       = 2 - 1
            |       = 1 (ImGuiMouseButton_Right)
            |
            +-- return ImGuiMouseButton_Right
```

### データフロー図

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

ImGuiPopupFlags_MouseButtonRight (8)
        |
        +──▶ GetMouseButtonFromPopupFlags
        |           |
        |           +──▶ & MouseButtonMask_ (0x0C) ──▶ 8
        |           |
        |           +──▶ >> MouseButtonShift_ (2) ──▶ 2
        |           |
        |           +──▶ - 1 ──▶ 1
        |
        +──▶ ImGuiMouseButton_Right (1)

または

flags = 0（未指定）
        |
        +──▶ GetMouseButtonFromPopupFlags
                    |
                    +──▶ (flags & MouseButtonMask_) == 0
                    |
                    +──▶ return ImGuiMouseButton_Right (1)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | ImGuiPopupFlags_MouseButtonRight定義（1341行目） |
| imgui.h | `imgui.h` | ヘッダー | コメント「(default)」 |
| imgui.cpp | `imgui.cpp` | ソース | GetMouseButtonFromPopupFlags実装（12453行目） |
| imgui.cpp | `imgui.cpp` | ソース | デフォルト値return文（12463行） |
| imgui.cpp | `imgui.cpp` | ソース | API BREAKING CHANGES（398-415行） |
