# 通知設計書 4-BeginItemTooltip

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるBeginItemTooltip API関数の設計・動作仕様を記載したものである。BeginItemTooltipは直前のアイテムがホバーされた場合にツールチップウィンドウを開始するショートカット関数である。

### 本通知の処理概要

BeginItemTooltipは、「IsItemHovered(ImGuiHoveredFlags_ForTooltip) && BeginTooltip()」という一般的なパターンのショートカットである。直前に描画されたUIアイテムがマウスでホバーされた場合にのみツールチップウィンドウを開始する。

**業務上の目的・背景**：UIアイテムに対するツールチップ表示は非常に一般的なユースケースである。通常、IsItemHovered()でホバー状態を確認してからBeginTooltip()を呼び出す必要があるが、BeginItemTooltipはこの2つのステップを1つの関数呼び出しにまとめる。これにより、コードの簡潔性と可読性が向上する。

**通知の送信タイミング**：UIアイテムの描画直後に呼び出される。内部でIsItemHovered(ImGuiHoveredFlags_ForTooltip)を確認し、ホバー状態である場合のみツールチップウィンドウを開始する。

**通知の受信者**：Dear ImGuiの内部レンダリングシステム。条件を満たす場合のみBeginTooltipExが呼び出され、ツールチップウィンドウが作成される。

**通知内容の概要**：アイテムホバー時のツールチップウィンドウ開始リクエスト。ImGuiHoveredFlags_ForTooltipフラグを使用してホバー判定を行う。このフラグはstyle.HoverFlagsForTooltipMouse/Navの設定を使用する。

**期待されるアクション**：関数がtrueを返した場合、呼び出し側はツールチップ内にコンテンツを配置し、EndTooltip()を呼び出してツールチップを終了する。falseを返した場合は何もしない。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

BeginItemTooltipの呼び出しは、直前のUIアイテムに対して行われる。ホバー状態の判定には、LastItemDataを使用する。

## 通知テンプレート

### API関数シグネチャ

| 項目 | 内容 |
|-----|------|
| 関数名 | BeginItemTooltip |
| 戻り値 | bool |
| 引数 | なし |
| 定義場所 | imgui.h:831 |

### 本文テンプレート

```cpp
// 基本的な使用パターン
ImGui::Button("ホバーしてください");
if (ImGui::BeginItemTooltip())
{
    ImGui::Text("ボタンの説明");
    ImGui::EndTooltip();
}

// これは以下と同等
ImGui::Button("ホバーしてください");
if (ImGui::IsItemHovered(ImGuiHoveredFlags_ForTooltip) && ImGui::BeginTooltip())
{
    ImGui::Text("ボタンの説明");
    ImGui::EndTooltip();
}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ImGuiHoveredFlags_ForTooltip | ホバー判定フラグ | style.HoverFlagsForTooltipMouse/Nav | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | BeginItemTooltip()呼び出し | 直前アイテムがホバー状態 | IsItemHovered(ForTooltip)がtrue |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| IsItemHovered(ImGuiHoveredFlags_ForTooltip)がfalse | ツールチップウィンドウは開始されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BeginItemTooltip呼び出し] --> B{IsItemHovered<br/>ForTooltip?}
    B -->|Yes| C[BeginTooltipEx呼び出し]
    B -->|No| D[false返却]
    C --> E[true返却]
    D --> F[終了]
    E --> F
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ImGuiContext (GImGui) | グローバルコンテキスト | アイテム状態管理 |
| ImGuiStyle | スタイル設定 | HoverFlags取得 |

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

#### ImGuiContext

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| LastItemData | 直前アイテム情報 | IsItemHovered()内部 |
| HoveredWindow | ホバー中ウィンドウ | ホバー判定 |
| ActiveId | アクティブアイテムID | ホバー判定 |

#### ImGuiStyle

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| HoverFlagsForTooltipMouse | マウス使用時のホバーフラグ | マウス入力時 |
| HoverFlagsForTooltipNav | ナビゲーション使用時のホバーフラグ | キーボード/ゲームパッド入力時 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ImGuiContext | UPDATE | BeginTooltipEx経由で更新 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | - | BeginItemTooltipは常に安全に動作 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- ImGuiHoveredFlags_ForTooltipは、マウス使用時はImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayShort | ImGuiHoveredFlags_AllowWhenDisabledをデフォルトで含む
- キーボード/ゲームパッド使用時は、ImGuiHoveredFlags_NoSharedDelay | ImGuiHoveredFlags_DelayNormal | ImGuiHoveredFlags_AllowWhenDisabledを使用
- trueを返した場合は必ずEndTooltip()を呼び出すこと

---

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

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

### 推奨読解順序

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

ImGuiHoveredFlags_ForTooltipとスタイル設定を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiHoveredFlags_ForTooltip定義（1467行目） |
| 1-2 | imgui.cpp | `imgui.cpp` | HoverFlagsForTooltipMouse/Navの初期値（1513-1514行目） |

**読解のコツ**: ForTooltipフラグは、マウスとキーボード/ゲームパッドで異なるフラグを使用する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | BeginItemTooltip API宣言（831行目） |
| 2-2 | imgui.h | `imgui.h` | ショートカット説明コメント（828行目） |
| 2-3 | imgui.cpp | `imgui.cpp` | BeginItemTooltip実装（11957-11962行目） |

**主要処理フロー**:
1. **11959行目**: IsItemHovered(ImGuiHoveredFlags_ForTooltip)チェック
2. **11960行目**: falseの場合は早期リターン
3. **11961行目**: BeginTooltipEx呼び出し

#### Step 3: IsItemHoveredのForTooltip処理を理解する

IsItemHoveredがForTooltipフラグをどう処理するか確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | IsItemHovered実装 |

**主要処理フロー**:
- ForTooltipフラグの展開
- スタイル設定からのフラグ取得

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

```
BeginItemTooltip() [imgui.cpp:11957]
    │
    ├─ IsItemHovered(ImGuiHoveredFlags_ForTooltip)
    │       │
    │       ├─ フラグ展開（ForTooltip → 具体的フラグ）
    │       │
    │       └─ ホバー状態判定
    │
    └─ [条件付き] BeginTooltipEx()
           │
           └─ Begin() [ウィンドウ作成]
```

### データフロー図

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

なし               ───▶ BeginItemTooltip()       ───▶ bool
                          │
                          ▼
LastItemData       ───▶ IsItemHovered()
  │                       │
  └─ ID, StatusFlags      ▼
                       ホバー判定
                          │
                          ▼ (trueの場合のみ)
                     BeginTooltipEx()           ───▶ ツールチップウィンドウ
```

### 関連ファイル一覧

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