# 通知設計書 2-EndTooltip

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるEndTooltip API関数の設計・動作仕様を記載したものである。EndTooltipはBeginTooltip()/BeginItemTooltip()で開始されたツールチップウィンドウを終了するためのAPI関数である。

### 本通知の処理概要

EndTooltipは、BeginTooltip()またはBeginItemTooltip()で開始されたツールチップウィンドウを終了し、内部的にEnd()を呼び出してウィンドウスタックをポップする関数である。

**業務上の目的・背景**：ツールチップウィンドウのライフサイクル管理において、開始と終了のペアリングは重要である。EndTooltipは、BeginTooltipで開始されたウィンドウコンテキストを適切に終了し、レンダリングパイプラインの整合性を保つ。Begin/Endパターンを遵守することで、ウィンドウスタックの破損を防止する。

**通知の送信タイミング**：BeginTooltip()またはBeginItemTooltip()がtrueを返した後、ツールチップ内のコンテンツ描画が完了したタイミングで呼び出される。必ずBeginとペアで呼び出す必要がある。

**通知の受信者**：Dear ImGuiの内部ウィンドウ管理システム。EndTooltipの呼び出しにより、現在のウィンドウコンテキストが終了し、ウィンドウスタックから現在のツールチップウィンドウがポップされる。

**通知内容の概要**：ツールチップウィンドウの終了通知。内部的にEnd()関数を呼び出し、ウィンドウのレンダリング処理を完了させる。

**期待されるアクション**：ImGuiウィンドウシステムは、現在のツールチップウィンドウを終了し、親ウィンドウコンテキストに復帰する。

## 通知種別

UI内部通知（ImGuiウィンドウシステム内での状態変更通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | 無 |

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

EndTooltipの呼び出しは、グローバルImGuiコンテキスト（GImGui）の現在のウィンドウに対して行われる。送信先は固定で、現在のウィンドウスタックのトップにあるツールチップウィンドウである。

## 通知テンプレート

### API関数シグネチャ

| 項目 | 内容 |
|-----|------|
| 関数名 | EndTooltip |
| 戻り値 | void |
| 引数 | なし |
| 定義場所 | imgui.h:823 |

### 本文テンプレート

```cpp
// BeginTooltip()がtrueを返した場合のみ呼び出す
if (ImGui::BeginTooltip())
{
    ImGui::Text("ツールチップのテキスト");
    ImGui::EndTooltip();  // 必須
}

// BeginItemTooltip()の場合も同様
if (ImGui::BeginItemTooltip())
{
    ImGui::Text("アイテムツールチップ");
    ImGui::EndTooltip();  // 必須
}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | - | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | EndTooltip()呼び出し | 現在のウィンドウがツールチップフラグを持つこと | 開発者によるAPI呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ツールチップウィンドウでない場合 | IM_ASSERTによりエラーが発生する |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[EndTooltip呼び出し] --> B{現在ウィンドウは<br/>ツールチップ?}
    B -->|Yes| C[End呼び出し]
    B -->|No| D[IM_ASSERT失敗]
    C --> E[ウィンドウスタックポップ]
    E --> F[終了]
    D --> F
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ImGuiContext (GImGui) | 現在のウィンドウ取得 | GetCurrentWindowRead() |

### テーブル別参照項目詳細

#### ImGuiContext

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| CurrentWindow | 現在のウィンドウコンテキスト | GetCurrentWindowRead() |
| CurrentWindow->Flags | ウィンドウフラグ確認 | ImGuiWindowFlags_Tooltip検証 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ウィンドウスタック | POP | End()による自動処理 |

#### ウィンドウスタック操作

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| POP | CurrentWindowStack | スタックから削除 | End()内部処理 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| アサーション失敗 | 現在ウィンドウがツールチップでない | BeginTooltip/EndTooltipのペア確認 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（即座に実行される同期処理）

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

特になし。ローカルUIレンダリング処理のため、外部通信やデータ永続化は行わない。

## 備考

- BeginTooltip()/BeginItemTooltip()がtrueを返した場合のみEndTooltip()を呼び出すこと
- Begin/Endペアの不一致はアサーション失敗を引き起こす
- 内部的にはEnd()関数を呼び出すだけのシンプルなラッパー

---

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

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

### 推奨読解順序

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

ImGuiのウィンドウフラグとウィンドウ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiWindowFlags_Tooltipの定義（1191行目） |

**読解のコツ**: ImGuiWindowFlagsは内部使用フラグを含むため、_Tooltipフラグの用途を確認する。

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

EndTooltipの宣言と実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | EndTooltip API宣言（823行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | EndTooltip実装（12011-12015行目） |

**主要処理フロー**:
1. **12011行目**: EndTooltip関数定義開始
2. **12013行目**: IM_ASSERTによるツールチップフラグ検証
3. **12014行目**: End()関数呼び出し

#### Step 3: End関数の動作を理解する

End()関数の実装を確認し、ウィンドウ終了処理の詳細を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | End関数（Begin/Endペア管理） |

**主要処理フロー**:
- ウィンドウスタックのポップ処理
- レンダリング完了処理

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

```
EndTooltip() [imgui.cpp:12011]
    │
    ├─ GetCurrentWindowRead() [ウィンドウ取得]
    │       └─ CurrentWindow->Flags検証
    │
    ├─ IM_ASSERT() [ツールチップフラグ検証]
    │
    └─ End() [imgui.cpp]
           └─ ウィンドウスタック管理
               ├─ レンダリング完了
               └─ スタックポップ
```

### データフロー図

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

なし               ───▶ EndTooltip()             ───▶ void
                          │
                          ▼
CurrentWindow      ───▶ フラグ検証               ───▶ アサーション
  │                       │
  └─ Flags                ▼
                       End()                    ───▶ ウィンドウ終了
                          │
                          ▼
                  ウィンドウスタックポップ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ソース | API宣言・フラグ定義 |
| imgui.cpp | `imgui.cpp` | ソース | 実装本体 |
