# 通知設計書 23-ImGuiCol_ModalWindowDimBg

## 概要

本ドキュメントは、ImGuiライブラリにおける`ImGuiCol_ModalWindowDimBg`スタイルカラーの仕様と動作を定義する設計書である。このカラー設定は、モーダルウィンドウが開いている時の背後の暗転（ディミング）効果の色を制御する。

### 本通知の処理概要

`ImGuiCol_ModalWindowDimBg`は、モーダルダイアログが表示されている際に、背後のコンテンツを暗くするオーバーレイの色を定義するスタイルカラー定数である。この効果により、モーダルウィンドウがユーザーの注意を集め、背後のインターフェースとの操作が制限されていることを視覚的に示す。

**業務上の目的・背景**：モーダルダイアログは、ユーザーの即時の対応が必要な重要な情報やアクションを提示するために使用される。背景の暗転効果は、モーダルの重要性を強調し、ユーザーがモーダル以外の要素と誤って操作することを防ぐUXパターンとして広く採用されている。この色設定により、暗転の度合いを調整でき、アプリケーションのデザインに合わせたカスタマイズが可能となる。

**通知の送信タイミング**：この色は、`BeginPopupModal()`で開始されたモーダルウィンドウがアクティブな状態で、フレーム描画の最終段階でオーバーレイを描画する際に参照される。モーダルウィンドウの`End()`または`EndPopup()`呼び出し後、次のフレーム描画前に適用される。

**通知の受信者**：ImGuiの描画システム（レンダラー）が受信者である。フレーム終了時の`Render()`処理内で、モーダルオーバーレイの描画命令が発行される。

**通知内容の概要**：RGBA形式の色情報を伝達する。デフォルト値は`ImVec4(0.80f, 0.80f, 0.80f, 0.35f)`（ダークテーマ）で、半透明のグレーオーバーレイを提供する。

**期待されるアクション**：開発者はこの色を調整することで、モーダルの視覚的強調度を制御する。完全な黒(`0,0,0`)や高いアルファ値で強い暗転効果を、低いアルファ値で軽微な暗転効果を実現できる。

## 通知種別

スタイルカラー定数

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（即時反映） |
| 優先度 | 中 |
| リトライ | 無 |

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

スタイルカラーは`ImGuiStyle::Colors[ImGuiCol_ModalWindowDimBg]`に格納され、モーダルウィンドウがアクティブな場合に自動的に参照される。

## 通知テンプレート

### カラー定義

| 項目 | 内容 |
|-----|------|
| カラー名 | ImGuiCol_ModalWindowDimBg |
| インデックス | ImGuiCol_列挙型内（1795行目） |
| 定義場所 | imgui.h:1795 |

### デフォルト値

| テーマ | R | G | B | A |
|-------|---|---|---|---|
| Dark (StyleColorsDark) | 0.80 | 0.80 | 0.80 | 0.35 |
| Classic (StyleColorsClassic) | 0.20 | 0.20 | 0.20 | 0.35 |
| Light (StyleColorsLight) | 0.20 | 0.20 | 0.20 | 0.35 |

### 使用例

```cpp
// 強い暗転効果を設定
ImGuiStyle& style = ImGui::GetStyle();
style.Colors[ImGuiCol_ModalWindowDimBg] = ImVec4(0.0f, 0.0f, 0.0f, 0.7f);

// モーダルダイアログの表示
if (ImGui::BeginPopupModal("Confirm Dialog"))
{
    ImGui::Text("Are you sure?");
    if (ImGui::Button("OK")) { /* ... */ ImGui::CloseCurrentPopup(); }
    ImGui::EndPopup();
}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| R | 赤成分 (0.0-1.0) | ImVec4.x | Yes |
| G | 緑成分 (0.0-1.0) | ImVec4.y | Yes |
| B | 青成分 (0.0-1.0) | ImVec4.z | Yes |
| A | 透明度 (0.0-1.0) | ImVec4.w | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 描画 | モーダルウィンドウアクティブ | BeginPopupModal()がtrueを返した | オーバーレイとして描画 |
| API呼び出し | StyleColorsDark等 | テーマ変更時 | デフォルト値が設定 |
| API呼び出し | PushStyleColor | 一時的変更時 | スタック上に色を積む |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| モーダル未表示 | モーダルウィンドウがアクティブでない場合は参照されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BeginPopupModal呼び出し] --> B{モーダル開いている?}
    B -->|Yes| C[ImGuiWindowFlags_Modalフラグ設定]
    C --> D[window->DC.ModalDimBgColor設定]
    D --> E[フレーム描画処理]
    E --> F[モーダルオーバーレイ描画]
    F --> G[GetStyleColorVec4 ImGuiCol_ModalWindowDimBg]
    G --> H[全画面オーバーレイ描画]
    B -->|No| I[スキップ]
```

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

### 参照テーブル一覧

該当なし（ImGuiはメモリベースの即時モードGUI）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 無効な色値 | 範囲外の値を設定 | クランプされる（0.0-1.0） |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（フレームごとに評価）

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

特になし。色設定は視覚的な表示のみに影響する。

## 備考

- モーダルウィンドウ専用の暗転色（通常ポップアップには適用されない）
- `ImGuiCol_NavWindowingDimBg`はCtrl+Tabウィンドウ切り替え時の暗転色として別途存在
- アルファ値を0にすると暗転効果を無効化できる
- 複数のモーダルがスタックされている場合、最前面のモーダルの背後のみ暗転される

---

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

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

### 推奨読解順序

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

カラー定数の定義位置を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiCol_ModalWindowDimBg定義（1795行目） |
| 1-2 | imgui.h | `imgui.h` | ImGuiCol_NavWindowingDimBgとの関係（1794行目） |

**読解のコツ**: `ModalWindowDimBg`と`NavWindowingDimBg`は用途が異なることを理解する。

#### Step 2: デフォルト値の設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui_draw.cpp | `imgui_draw.cpp` | StyleColorsDark関数（251行目） |
| 2-2 | imgui_draw.cpp | `imgui_draw.cpp` | StyleColorsClassic関数（318行目） |

**主要処理フロー**:
1. **251行目**: ダークテーマでのModalWindowDimBg設定
2. **318行目**: クラシックテーマでの設定

#### Step 3: 使用箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | Begin関数内でのModalDimBgColor設定（8003-8004行目） |
| 3-2 | imgui.cpp | `imgui.cpp` | モーダルオーバーレイ描画処理 |

**主要処理フロー**:
- **8003行目**: `ImGuiWindowFlags_Modal`フラグ判定
- **8004行目**: `ModalDimBgColor`への色変換・格納

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

```
BeginPopupModal()
    |
    +-- Begin() [with ImGuiWindowFlags_Modal]
           |
           +-- if (flags & ImGuiWindowFlags_Modal)
           |      window->DC.ModalDimBgColor = ColorConvertFloat4ToU32(
           |          GetStyleColorVec4(ImGuiCol_ModalWindowDimBg))
           |
           +-- [フレーム終了時]
                  |
                  +-- RenderDimmedBackgrounds()
                         |
                         +-- ImDrawList::AddRectFilled(全画面, ModalDimBgColor)
```

### データフロー図

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

ImGuiStyle.Colors[] ───────> GetStyleColorVec4() ───────> ImVec4 色値
                                    |
                                    v
                            ColorConvertFloat4ToU32()
                                    |
                                    v
                            window->DC.ModalDimBgColor
                                    |
                                    v
                            RenderDimmedBackgrounds()
                                    |
                                    v
                            全画面オーバーレイ描画
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | ImGuiCol_ModalWindowDimBg定義（1795行目） |
| imgui_draw.cpp | `imgui_draw.cpp` | ソース | デフォルト色設定（251, 318行目） |
| imgui.cpp | `imgui.cpp` | ソース | ModalDimBgColor設定（8003-8004行目） |
| imgui.cpp | `imgui.cpp` | ソース | オーバーレイ描画処理 |
