# 機能設計書 55-PushStyleColor

## 概要

本ドキュメントは、ImGuiライブラリのPushStyleColor関数の設計仕様を定義する。PushStyleColorはスタイルカラーを一時的に変更し、カラースタックにプッシュするための機能である。

### 本機能の処理概要

PushStyleColor関数は、指定されたスタイルカラー（ImGuiCol）を新しい色値で一時的に変更する。変更前の値はカラースタックに保存され、PopStyleColorで復元できる。NewFrame()の後でスタイルを変更する場合は、直接g.Style.Colorsを変更せず、この関数を使用する必要がある。

**業務上の目的・背景**：GUIアプリケーションでは、特定のウィジェットやUI領域だけ色を変更したい場合がある。例えば、エラーメッセージを赤色で表示したり、特定のボタンを強調色で表示したりする。PushStyleColor/PopStyleColorのスタック機構により、一時的な色変更を安全に管理でき、元の状態への復元が保証される。

**機能の利用シーン**：
- 警告やエラーメッセージの色を変更する場合
- 特定のボタンやウィジェットを強調表示する場合
- テーマやスキンの一部をカスタマイズする場合
- 状態に応じて動的に色を変更する場合

**主要な処理内容**：
1. 現在のカラー値をバックアップ構造体に保存
2. バックアップをカラースタックにプッシュ
3. 新しいカラー値をスタイルに適用（デバッグフラッシュ中でない場合）

**関連システム・外部連携**：ImGuiStyleシステムと連携し、すべてのウィジェットの色表示に影響する。

**権限による制御**：特になし。すべてのコンテキストで利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 6 | Style Editor | 補助機能 | RGBAカラーの編集時に内部で使用 |

## 機能種別

スタック操作 / スタイル変更

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| idx | ImGuiCol | Yes | 変更するカラーのインデックス | 0 <= idx < ImGuiCol_COUNT |
| col | ImU32 / ImVec4 | Yes | 新しいカラー値（U32またはVec4オーバーロード） | 有効な色値 |

### 入力データソース

- ImGuiCol列挙型（60以上の色定義）
- ImU32形式（0xAABBGGRR）またはImVec4形式（R,G,B,A各0.0-1.0）の色値

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| なし | void | 戻り値なし |

### 出力先

- ImGuiContext.ColorStack（カラースタック）
- ImGuiContext.Style.Colors[idx]（スタイルカラー配列）

## 処理フロー

### 処理シーケンス

```
1. コンテキストの取得
   └─ グローバルコンテキストGImGuiを参照
2. バックアップ構造体の作成
   └─ ImGuiColorMod構造体を初期化
3. 現在の色値を保存
   └─ backup.Col = idx, backup.BackupValue = g.Style.Colors[idx]
4. スタックにプッシュ
   └─ g.ColorStack.push_back(backup)
5. 新しい色を適用
   └─ デバッグフラッシュ中でなければg.Style.Colors[idx]を更新
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[ImGuiColorMod backup作成]
    B --> C[backup.Col = idx]
    C --> D[backup.BackupValue = Colors idx]
    D --> E[ColorStack.push_back]
    E --> F{DebugFlashStyleColorIdx != idx?}
    F -->|Yes| G[Colors idx = col]
    F -->|No| H[色を変更しない]
    G --> I[終了]
    H --> I
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-55-01 | Push/Popペアリング | PushStyleColorは必ずPopStyleColorとペアで使用する | 常時 |
| BR-55-02 | NewFrame後使用 | NewFrame()の後でスタイルを変更する場合はこの関数を使用 | フレーム中 |
| BR-55-03 | デバッグフラッシュ例外 | デバッグフラッシュ中は色変更がスキップされる | デバッグ時 |

### 計算ロジック

ImU32からImVec4への変換：
```
R = (col & 0x000000FF) / 255.0f
G = (col & 0x0000FF00) >> 8 / 255.0f
B = (col & 0x00FF0000) >> 16 / 255.0f
A = (col & 0xFF000000) >> 24 / 255.0f
```

## データベース操作仕様

該当なし（メモリ内操作のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 範囲外参照 | idx >= ImGuiCol_COUNT | 有効なImGuiCol値を使用 |

### リトライ仕様

該当なし

## トランザクション仕様

該当なし（メモリ内操作のみ）

## パフォーマンス要件

- スタック操作のため、O(1)の時間計算量
- フレームごとに複数回呼び出されることを想定した軽量実装

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

特になし

## 備考

- 2つのオーバーロードが存在：ImU32版とImVec4版
- ImU32版は内部でColorConvertU32ToFloat4を呼び出してImVec4に変換

---

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

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

### 推奨読解順序

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

カラー管理に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiCol_列挙型（1734-1804行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiColorMod構造体（915-919行目） |
| 1-3 | imgui.h | `imgui.h` | PushStyleColor関数シグネチャ（528-529行目） |

**読解のコツ**: ImGuiCol_はすべてのUIカラー（60以上）を定義する列挙型。ImGuiColorModはバックアップ用構造体でColとBackupValueを保持する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | PushStyleColor(ImU32)実装（3556-3565行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | PushStyleColor(ImVec4)実装（3567-3576行目） |

**主要処理フロー**:
1. **3558-3561行目**: バックアップ構造体の作成と初期化
2. **3562行目**: ColorStackにプッシュ
3. **3563-3564行目**: デバッグフラッシュチェックと色更新

#### Step 3: 関連関数を理解する

PopStyleColor関数と色変換関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | PopStyleColor実装（3578-3593行目） |
| 3-2 | imgui.cpp | `imgui.cpp` | ColorConvertU32ToFloat4関数 |

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

```
ImGui::PushStyleColor(ImGuiCol idx, ImU32 col)
    │
    ├─ ImGuiColorMod backup作成
    │
    ├─ g.ColorStack.push_back(backup)
    │
    └─ g.Style.Colors[idx] = ColorConvertU32ToFloat4(col)

ImGui::PushStyleColor(ImGuiCol idx, const ImVec4& col)
    │
    ├─ ImGuiColorMod backup作成
    │
    ├─ g.ColorStack.push_back(backup)
    │
    └─ g.Style.Colors[idx] = col
```

### データフロー図

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

ImGuiCol idx      ───▶ backup.Col = idx             ───▶ ColorStack
                              │
ImU32/ImVec4 col  ───▶ Colors[idx] = col            ───▶ Style.Colors[idx]
                              │
Colors[idx]       ───▶ backup.BackupValue保存       ───▶ ColorStack.back()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | PushStyleColor関数の宣言（528-529行目） |
| imgui.h | `imgui.h` | ヘッダー | ImGuiCol_列挙型（1734-1804行目） |
| imgui.cpp | `imgui.cpp` | ソース | PushStyleColor関数の実装（3556-3576行目） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiColorMod構造体（915-919行目） |
