# 機能設計書 214-IsItemActivated

## 概要

本ドキュメントは、ImGuiのIsItemActivated関数の機能設計書である。直前に追加されたアイテムが「アクティブになった瞬間」かを判定する機能について記載する。

### 本機能の処理概要

IsItemActivated関数は、直前に追加されたウィジェット（アイテム）が、このフレームでアクティブ状態になった瞬間かを判定するAPIである。アイテムが「非アクティブ→アクティブ」に遷移したタイミングを検出できる。

**業務上の目的・背景**：ウィジェットがアクティブになったタイミング（例：テキストボックスにフォーカスが当たった、スライダーのドラッグを開始したなど）を検出することで、編集開始時の処理を実装できる。特にUndo/Redoシステムでは、編集開始時点の値を保存するために重要な情報となる。

**機能の利用シーン**：
- Undo/Redoシステムで編集開始時の値を記録する場合
- テキスト入力開始時にIME（入力メソッド）を有効化する場合
- ドラッグ操作開始時のアニメーションやエフェクトを開始する場合
- 編集モードへの遷移を検出する場合

**主要な処理内容**：
1. 現在のActiveIdが直前アイテムのIDと一致するかを確認
2. 前フレームのActiveIdが直前アイテムのIDと異なるかを確認
3. 両方の条件が満たされた場合（新しくアクティブになった）にtrueを返却

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

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

## 関連画面

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

## 機能種別

状態判定 / クエリ機能

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- ImGuiContext::ActiveId - 現在アクティブなアイテムのID
- ImGuiContext::ActiveIdPreviousFrame - 前フレームでアクティブだったアイテムのID
- ImGuiContext::LastItemData.ID - 直前に追加されたアイテムのID

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | このフレームでアクティブになった場合true、それ以外はfalse |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. ActiveId確認
   └─ g.ActiveIdが有効（非ゼロ）かを確認
2. 現在アクティブ判定
   └─ g.ActiveIdがg.LastItemData.IDと一致するかを確認
3. 新規アクティベーション判定
   └─ g.ActiveIdPreviousFrameがg.LastItemData.IDと異なるかを確認
4. 結果返却
   └─ すべての条件が満たされればtrue、そうでなければfalse
```

### フローチャート

```mermaid
flowchart TD
    A[IsItemActivated呼び出し] --> B{g.ActiveId != 0?}
    B -->|No| F[false を返却]
    B -->|Yes| C{g.ActiveId == LastItemData.ID?}
    C -->|No| F
    C -->|Yes| D{g.ActiveIdPreviousFrame != LastItemData.ID?}
    D -->|No| F
    D -->|Yes| E[true を返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-214-01 | 遷移検出 | 「非アクティブ→アクティブ」の遷移のみを検出し、継続的なアクティブ状態ではtrueにならない | 常時 |
| BR-214-02 | 単一フレーム | アクティブになった瞬間の1フレームのみtrueを返す | 常時 |

### 計算ロジック

```cpp
bool ImGui::IsItemActivated()
{
    ImGuiContext& g = *GImGui;
    if (g.ActiveId)
        if (g.ActiveId == g.LastItemData.ID && g.ActiveIdPreviousFrame != g.LastItemData.ID)
            return true;
    return false;
}
```

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

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

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

該当なし

## 備考

- IsItemDeactivated()と対になる機能であり、「アクティブになった」と「非アクティブになった」のペアで使用されることが多い
- Undo/Redoパターンでは、IsItemActivated()で開始値を保存し、IsItemDeactivatedAfterEdit()で終了値を確定するのが一般的

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiContext内のActiveId関連フィールド（2266-2269行目付近） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiLastItemData構造体のID（1378行目） |

**読解のコツ**: ActiveIdは現在アクティブなアイテムを追跡し、ActiveIdPreviousFrameは前フレームの状態を保持している。この2つを比較することで状態遷移を検出する。

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

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

**主要処理フロー**:
1. **6202行目**: 関数定義
2. **6204行目**: ImGuiContext参照の取得
3. **6205行目**: ActiveIdが有効かチェック
4. **6206行目**: 現在アクティブ かつ 前フレームで非アクティブ かをチェック
5. **6207行目**: 条件成立時にtrue返却

#### Step 3: 関連機能を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | IsItemDeactivated実装（6211-6217行目） |
| 3-2 | imgui.cpp | `imgui.cpp` | IsItemDeactivatedAfterEdit実装（6219-6223行目） |

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

```
ImGui::IsItemActivated()
    │
    ├─ g.ActiveId 参照
    │
    ├─ g.LastItemData.ID 参照
    │
    └─ g.ActiveIdPreviousFrame 参照
```

### データフロー図

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

g.ActiveId ─────────────────┐
                            │
g.ActiveIdPreviousFrame ────┼──▶ 遷移判定 ────────────▶ bool (true/false)
                            │
g.LastItemData.ID ──────────┘
```

### 関連ファイル一覧

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