# 通知設計書 1-BeginTooltip

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるBeginTooltip API関数の設計・動作仕様を記載したものである。BeginTooltipはツールチップウィンドウを開始するためのAPI関数であり、ユーザーインターフェースにおける補助的な情報表示機能を提供する。

### 本通知の処理概要

BeginTooltipは、マウスカーソルに追従するツールチップウィンドウを開始するための関数である。この関数はフォーカスを奪わない特殊なウィンドウを生成し、任意の型のウィジェットアイテムを含むことが可能である。

**業務上の目的・背景**：ユーザーインターフェースにおいて、特定のUI要素に対する追加情報や説明を表示する必要がある。ツールチップは、画面スペースを占有せずに補足情報を提供する標準的なUIパターンであり、ユーザーエクスペリエンスの向上に寄与する。

**通知の送信タイミング**：アプリケーションがツールチップを表示したいと判断した任意のタイミングで呼び出される。通常はIsItemHovered()チェック後に呼び出されることが多いが、任意のタイミングで使用可能である。

**通知の受信者**：Dear ImGuiの内部レンダリングシステム。BeginTooltipを呼び出すと、内部的にBegin()関数が呼び出され、専用のツールチップウィンドウが生成される。

**通知内容の概要**：ツールチップウィンドウの作成リクエスト。ウィンドウフラグとして、ImGuiWindowFlags_Tooltip、ImGuiWindowFlags_NoInputs、ImGuiWindowFlags_NoTitleBar、ImGuiWindowFlags_NoMove、ImGuiWindowFlags_NoResize、ImGuiWindowFlags_NoSavedSettings、ImGuiWindowFlags_AlwaysAutoResizeが設定される。

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

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### API関数シグネチャ

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

### 本文テンプレート

```cpp
// 基本的な使用パターン
if (ImGui::BeginTooltip())
{
    ImGui::Text("ツールチップのテキスト");
    // 任意のウィジェットを配置可能
    ImGui::EndTooltip();
}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| tooltip_flags | ツールチップフラグ | 固定値：ImGuiTooltipFlags_None | Yes |
| extra_window_flags | 追加ウィンドウフラグ | 固定値：ImGuiWindowFlags_None | Yes |
| TooltipOverrideCount | 現在のツールチップオーバーライドカウント | GImGui->TooltipOverrideCount | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | BeginTooltip()呼び出し | 常に実行 | 開発者によるAPI呼び出し |
| 内部呼び出し | BeginItemTooltip()経由 | IsItemHovered(ImGuiHoveredFlags_ForTooltip)がtrue | アイテムホバー時の自動呼び出し |
| 内部呼び出し | SetTooltip()経由 | 常に実行 | テキストのみツールチップの内部呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | BeginTooltipは常にtrueを返し、処理を実行する |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BeginTooltip呼び出し] --> B[BeginTooltipEx呼び出し]
    B --> C{ドラッグ&ドロップ中?}
    C -->|Yes| D[特殊ポジション設定]
    C -->|No| E[通常処理]
    D --> F[背景透明度設定]
    F --> G{前のツールチップを隠す?}
    E --> G
    G -->|Yes| H[前ツールチップを非表示]
    G -->|No| I[ウィンドウ名生成]
    H --> I
    I --> J[ウィンドウフラグ設定]
    J --> K[Begin呼び出し]
    K --> L[true返却]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ImGuiContext (GImGui) | グローバルコンテキスト | ツールチップ状態管理 |

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

#### ImGuiContext

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| DragDropWithinSource | ドラッグ&ドロップソース内か判定 | 常時 |
| DragDropWithinTarget | ドラッグ&ドロップターゲット内か判定 | 常時 |
| TooltipPreviousWindow | 前回のツールチップウィンドウ | 常時 |
| TooltipOverrideCount | ツールチップカウント | 常時 |
| IO.MousePos | マウス位置 | ドラッグ&ドロップ時 |
| IO.MouseSource | マウスソース種別 | ドラッグ&ドロップ時 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ImGuiContext | UPDATE | TooltipOverrideCount更新 |

#### ツールチップ状態

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | TooltipOverrideCount | インクリメント | オーバーライド時 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | - | BeginTooltipは現在常にtrueを返す |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- BeginTooltip()がtrueを返した場合は、必ずEndTooltip()を呼び出すこと
- 2023/03/09 (1.89.4)でbool戻り値が追加された。現在は常にtrueを返すが、将来的に変更される可能性がある
- SetTooltip()は「if (BeginTooltip()) { Text(...); EndTooltip(); }」のショートカット

---

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

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

### 推奨読解順序

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

ImGuiのツールチップ管理に関連するデータ構造を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | TooltipOverrideCount、TooltipPreviousWindowフィールドの定義（2486-2487行目） |
| 1-2 | imgui.h | `imgui.h` | ImGuiWindowFlagsの定義、特にImGuiWindowFlags_Tooltip（1191行目） |

**読解のコツ**: ImGuiコンテキスト構造体は非常に大きいため、ツールチップ関連フィールドに焦点を当てて読むこと。

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

処理の起点となるBeginTooltip関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | BeginTooltipのAPI宣言（822行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | BeginTooltipの実装（11952-11955行目） |

**主要処理フロー**:
1. **11952行目**: BeginTooltip関数定義開始
2. **11954行目**: BeginTooltipExへの委譲呼び出し

#### Step 3: 内部実装を理解する

BeginTooltipExの詳細実装を読み解く。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | BeginTooltipEx実装（11964-12009行目） |

**主要処理フロー**:
- **11968-11988行目**: ドラッグ&ドロップ中の特殊処理
- **11990-11996行目**: 前ツールチップの非表示処理
- **11998-12002行目**: ウィンドウ名生成とBegin呼び出し

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

```
BeginTooltip() [imgui.cpp:11952]
    │
    └─ BeginTooltipEx() [imgui.cpp:11964]
           │
           ├─ SetNextWindowPos() [条件付き: ドラッグ&ドロップ時]
           │
           ├─ SetNextWindowBgAlpha() [条件付き: ドラッグ&ドロップ時]
           │
           ├─ SetWindowHiddenAndSkipItemsForCurrentFrame() [条件付き: オーバーライド時]
           │
           └─ Begin() [imgui.cpp]
                  └─ ウィンドウ作成・更新処理
```

### データフロー図

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

なし               ───▶ BeginTooltip()          ───▶ bool (常にtrue)
                          │
                          ▼
GImGui             ───▶ BeginTooltipEx()        ───▶ ツールチップウィンドウ
  │                       │                              │
  ├─ TooltipOverrideCount ▼                              │
  ├─ TooltipPreviousWindow ウィンドウ名生成              │
  └─ DragDropWithinSource  │                              │
                          ▼                              │
                       Begin()               ───▶ ウィンドウスタック更新
```

### 関連ファイル一覧

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