# 機能設計書 213-IsItemEdited

## 概要

本ドキュメントは、ImGuiのIsItemEdited関数の機能設計書である。直前に追加されたアイテムがそのフレーム内で値を変更したかを判定する機能について記載する。

### 本機能の処理概要

IsItemEdited関数は、直前に追加されたウィジェット（アイテム）がその underlying value（基底値）を現在のフレームで変更したかを判定するAPIである。多くのウィジェットがbool値を返すのと同等の情報を提供する。

**業務上の目的・背景**：ウィジェットの値が変更されたタイミングを検出することは、UIアプリケーションにおいて重要である。例えば、スライダーやテキスト入力の変更を検出して、関連するデータを更新したり、変更履歴を記録したりする場合に使用される。本機能により、ウィジェットの戻り値とは独立して編集状態を確認できる。

**機能の利用シーン**：
- ウィジェットの値が変更されたときにリアルタイムでデータを同期する場合
- 変更検出ロジックを集約して実装する場合
- ウィジェットの戻り値を使用しないケースでの変更検出
- ボタンが押されたかの判定（押されたことも「編集」として扱われる）

**主要な処理内容**：
1. ImGuiContextから直前のアイテムのStatusFlagsを取得
2. ImGuiItemStatusFlags_Editedビットが設定されているかを確認
3. 設定されていればtrue、そうでなければfalseを返却

**関連システム・外部連携**：ImGuiの内部状態管理システム（ImGuiContext）のLastItemData.StatusFlagsを参照する。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | Demo Window | 参照画面 | Querying StatusセクションでIsItemEditedの動作確認 |
| 23 | Widgets | 参照画面 | 各ウィジェットの編集検出 |

## 機能種別

状態判定 / クエリ機能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | 引数なし | - |

### 入力データソース

- ImGuiContext::LastItemData.StatusFlags - 直前に追加されたアイテムの状態フラグ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | 値が編集された場合true、それ以外はfalse |

### 出力先

呼び出し元への戻り値として返却

## 処理フロー

### 処理シーケンス

```
1. コンテキスト取得
   └─ ImGuiContextへの参照を取得
2. StatusFlags確認
   └─ g.LastItemData.StatusFlagsを参照
3. Editedビット判定
   └─ ImGuiItemStatusFlags_Editedビットが設定されているかチェック
4. 結果返却
   └─ ビットが設定されていればtrue、そうでなければfalse
```

### フローチャート

```mermaid
flowchart TD
    A[IsItemEdited呼び出し] --> B[ImGuiContext取得]
    B --> C[LastItemData.StatusFlags参照]
    C --> D{ImGuiItemStatusFlags_Edited<br>ビットが設定?}
    D -->|Yes| E[true を返却]
    D -->|No| F[false を返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-213-01 | ウィジェット戻り値との対応 | 多くのウィジェットのbool戻り値と同等の意味を持つ | 値を返すウィジェット全般 |
| BR-213-02 | ボタン押下の検出 | ボタンが押された場合も「編集」として検出される | Button系ウィジェット |

### 計算ロジック

```cpp
bool ImGui::IsItemEdited()
{
    ImGuiContext& g = *GImGui;
    return (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Edited) != 0;
}
```

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

該当なし（GUIフレームワーク内部の状態参照のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 暗黙的エラー | 前にアイテムが追加されていない場合 | LastItemDataが初期状態となり、falseを返す |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- 単純なビット演算のみで構成される軽量な判定処理
- フレームごとに複数回呼び出しても問題なし

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

該当なし

## 備考

- ImGuiItemStatusFlags_Editedフラグは、ウィジェットが内部で「値が変更された」と判断した場合に設定される
- ボタンの場合は「押された」ことが「編集」として扱われる
- IsItemDeactivatedAfterEdit()と組み合わせることで、編集完了タイミングでの処理（Undo/Redo等）が実装しやすくなる

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiItemStatusFlags_Edited定義（992行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiLastItemData構造体（1376-1389行目） |

**読解のコツ**: ImGuiItemStatusFlags_Editedは、ウィジェットによって値が変更されたことを示す。多くのウィジェットのbool戻り値と一致する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | 関数宣言（1011行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | 関数実装（6284-6288行目） |

**主要処理フロー**:
1. **6284行目**: 関数定義
2. **6286行目**: ImGuiContext参照の取得
3. **6287行目**: StatusFlagsのEditedビット判定

#### Step 3: Editedフラグが設定される場所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_widgets.cpp | `imgui_widgets.cpp` | ウィジェット実装でのEdited設定箇所 |

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

```
ImGui::IsItemEdited()
    │
    └─ g.LastItemData.StatusFlags 参照
           └─ ImGuiItemStatusFlags_Edited ビット判定
```

### データフロー図

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

ウィジェットが値を変更時 ──▶ StatusFlagsにEdited設定
                                  │
                                  ▼
                        g.LastItemData.StatusFlags
                                  │
                                  ▼
IsItemEdited() ────────────▶ ビット判定 ────────▶ bool (true/false)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 公開API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | 関数実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | 内部データ構造定義 |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | Editedフラグ設定箇所 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | 使用例（2154行目） |
