# 機能設計書 28-IsWindowAppearing

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるIsWindowAppearing機能の設計仕様を記述する。この機能は、現在のウィンドウが表示されつつある（最初に表示される、または非表示から表示に切り替わった）状態かどうかを判定するための関数である。

### 本機能の処理概要

**業務上の目的・背景**：ウィンドウが初めて表示されるタイミングや、非表示から表示に切り替わったタイミングを検出する必要がある場合がある。例えば、ポップアップが開かれた直後に特定の処理を行いたい場合や、ウィンドウの初期化処理を表示時にのみ行いたい場合などに使用される。Appearingフラグはウィンドウが「現れつつある」状態を示し、1フレームだけtrueになる。

**機能の利用シーン**：
- ポップアップが開かれた直後に初期化処理を行う場合
- ウィンドウが表示されるタイミングでフォーカスを設定する場合
- ウィンドウの初回表示時にアニメーションを開始する場合
- 条件付きの初期化処理を行う場合

**主要な処理内容**：
1. 現在のウィンドウを取得する
2. ウィンドウのAppearingフラグを返す

**関連システム・外部連携**：ImGuiのウィンドウ管理システムと連携する。

**権限による制御**：特になし。すべてのユーザーが任意のタイミングで呼び出し可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 全てのウィンドウ | 参照機能 | ウィンドウの表示開始検出 |

## 機能種別

状態取得 / ウィンドウユーティリティ

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- グローバルコンテキストの現在のウィンドウ（GetCurrentWindowRead()経由）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | ウィンドウが表示されつつある場合はtrue、そうでない場合はfalse |

### 出力先

なし（戻り値として返す）

## 処理フロー

### 処理シーケンス

```
1. 現在のウィンドウを取得
   └─ GetCurrentWindowRead()で読み取り専用でウィンドウを取得
2. Appearingフラグを返す
   └─ window->Appearingを返す
```

### フローチャート

```mermaid
flowchart TD
    A[IsWindowAppearing開始] --> B[GetCurrentWindowRead]
    B --> C[window->Appearingを返す]
    C --> D[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 1フレーム有効 | Appearingフラグはウィンドウが表示され始めるフレームでのみtrue | 常時 |
| BR-002 | Begin/End内で使用 | Begin()とEnd()の間で呼び出す必要がある | 常時 |
| BR-003 | ポップアップの再利用 | ポップアップはリサイクルされるため、PopupIdが変わった場合もAppearingとなる | ポップアップの場合 |

### 計算ロジック

- Appearingフラグは、ウィンドウのLastFrameActiveが(current_frame - 1)より小さい場合にtrueになる
- ポップアップの場合は、PopupIdの変更やウィンドウの変更でもAppearingとなる

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

### 操作別データベース影響一覧

なし（本機能はメモリ内のデータ構造の読み取りのみを行う）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 本関数は失敗しない設計 | - |

### リトライ仕様

なし

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

なし

## パフォーマンス要件

- 処理時間: 極めて軽量（単純なメンバ変数アクセス）
- メモリ使用: なし

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

なし

## 備考

- OpenPopupOnItemClick()はv1.79でbool戻り値が削除されたが、代わりにBeginPopup()後にIsWindowAppearing()を使用することで同様の機能を実現できる
- ウィンドウが最初に作成される場合だけでなく、非表示から表示に切り替わった場合もAppearingとなる

---

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

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

### 推奨読解順序

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

ImGuiWindow::Appearingフラグを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindow::Appearingメンバ |

**読解のコツ**: Appearingはbool型のフラグで、ウィンドウが「現れつつある」状態を示す。Begin関数内で設定される。

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

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

**主要処理フロー**:
1. **8560-8562行目**: GetCurrentWindowRead()で現在のウィンドウを取得
2. **8563行目**: window->Appearingを返す

#### Step 3: Appearingフラグの設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | Begin関数内でのAppearing設定（7379-7389行目） |

**主要処理フロー**:
- **7380行目**: window_just_activated_by_userの判定
- **7381-7386行目**: ポップアップの場合の追加判定
- **7387行目**: window->Appearingの設定

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

```
IsWindowAppearing()
    │
    └─ GetCurrentWindowRead()
           │
           └─ return window->Appearing
```

### データフロー図

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

g.CurrentWindow ──────────▶ IsWindowAppearing()     ──▶ bool (Appearing状態)
                                │
                                ▼
                          window->Appearing を返す
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | IsWindowAppearing関数の実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダ | ImGuiWindow::Appearing定義 |
