# 通知設計書 3-SetTooltip

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるSetTooltip API関数の設計・動作仕様を記載したものである。SetTooltipはテキストのみのツールチップを簡単に設定するためのショートカット関数である。

### 本通知の処理概要

SetTooltipは、テキストのみのツールチップを設定するための便利な関数である。内部的には「if (BeginTooltip()) { Text(...); EndTooltip(); }」というパターンを実行するが、以前のSetTooltip呼び出しを上書きする特別な機能を持つ。

**業務上の目的・背景**：ツールチップ表示において最も一般的なユースケースは単純なテキスト表示である。SetTooltipは、BeginTooltip/EndTooltipペアを記述する手間を省き、1行でテキストツールチップを設定できるようにする。また、同一フレーム内で複数回呼び出された場合、最後の呼び出しのみが表示される。

**通知の送信タイミング**：通常はIsItemHovered()チェック後に呼び出される。任意のタイミングで呼び出し可能だが、一般的にはホバー状態の検出後に使用される。

**通知の受信者**：Dear ImGuiの内部レンダリングシステム。SetTooltipを呼び出すと、ImGuiTooltipFlags_OverridePreviousフラグ付きでBeginTooltipExが呼び出され、前回のツールチップが上書きされる。

**通知内容の概要**：テキストツールチップの作成リクエスト。書式文字列と可変長引数を受け取り、フォーマットされたテキストをツールチップ内に表示する。

**期待されるアクション**：ImGuiは新しいツールチップウィンドウを作成（または既存のものを上書き）し、指定されたテキストを表示する。EndTooltipの呼び出しは内部で自動的に行われる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### API関数シグネチャ

| 項目 | 内容 |
|-----|------|
| 関数名 | SetTooltip |
| 戻り値 | void |
| 引数 | const char* fmt, ... (可変長引数) |
| 定義場所 | imgui.h:824 |

### 本文テンプレート

```cpp
// 基本的な使用パターン
ImGui::SetTooltip("これはツールチップです");

// 書式文字列を使用
ImGui::SetTooltip("値: %d, 名前: %s", value, name);

// IsItemHovered()と組み合わせた典型的な使用例
if (ImGui::IsItemHovered())
    ImGui::SetTooltip("このアイテムの説明");
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| fmt | 書式文字列 | 呼び出し元から渡される | Yes |
| ... | 可変長引数 | 呼び出し元から渡される | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | SetTooltip()呼び出し | 常に実行 | 開発者によるAPI呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| BeginTooltipExがfalseを返す場合 | 現在は常にtrueを返すため実質なし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[SetTooltip呼び出し] --> B[va_start処理]
    B --> C[SetTooltipV呼び出し]
    C --> D[BeginTooltipEx呼び出し<br/>OverridePreviousフラグ付き]
    D --> E{BeginTooltipEx<br/>成功?}
    E -->|Yes| F[TextV呼び出し]
    E -->|No| G[処理終了]
    F --> H[EndTooltip呼び出し]
    H --> I[va_end処理]
    I --> J[終了]
    G --> J
```

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

### 参照テーブル一覧

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

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

#### ImGuiContext

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| TooltipPreviousWindow | 前回のツールチップウィンドウ | 上書き処理時 |
| TooltipOverrideCount | ツールチップカウント | ウィンドウ名生成時 |

### 更新テーブル一覧

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

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

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | - | SetTooltipは常に正常に動作する |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

特になし。ローカルUIレンダリング処理のため、外部通信やデータ永続化は行わない。書式文字列の脆弱性については、呼び出し元の責任で適切に管理する必要がある。

## 備考

- SetTooltipは以前のSetTooltip呼び出しを上書きする
- ImGuiTooltipFlags_OverridePreviousフラグがBeginTooltipExに渡される
- EndTooltipは内部で自動的に呼び出されるため、呼び出し元で呼ぶ必要はない
- printf形式の書式文字列をサポート（IM_FMTARGS(1)マクロによる）

---

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

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

### 推奨読解順序

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

ツールチップのオーバーライド機能に関連するデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiTooltipFlags_OverridePrevious定義 |
| 1-2 | imgui_internal.h | `imgui_internal.h` | TooltipOverrideCount、TooltipPreviousWindow（2486-2487行目） |

**読解のコツ**: OverridePreviousフラグがどのように使用されるかを追跡する。

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

SetTooltipとSetTooltipVの実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | SetTooltip API宣言（824行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | SetTooltip実装（12017-12023行目） |
| 2-3 | imgui.cpp | `imgui.cpp` | SetTooltipV実装（12025-12031行目） |

**主要処理フロー**:
1. **12017-12023行目**: SetTooltip - va_argsを設定してSetTooltipVを呼び出し
2. **12027行目**: BeginTooltipEx呼び出し（OverridePreviousフラグ付き）
3. **12029行目**: TextV呼び出しでテキスト表示
4. **12030行目**: EndTooltip呼び出し

#### Step 3: BeginTooltipExのオーバーライド処理を理解する

OverridePreviousフラグによる前ツールチップの非表示処理を確認する。

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

**主要処理フロー**:
- **11990-11996行目**: OverridePreviousフラグによる前ツールチップ非表示処理

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

```
SetTooltip(fmt, ...) [imgui.cpp:12017]
    │
    └─ SetTooltipV(fmt, args) [imgui.cpp:12025]
           │
           ├─ BeginTooltipEx(OverridePrevious) [imgui.cpp:11964]
           │       │
           │       ├─ SetWindowHiddenAndSkipItemsForCurrentFrame() [条件付き]
           │       │
           │       └─ Begin() [ウィンドウ作成]
           │
           ├─ TextV(fmt, args) [テキスト描画]
           │
           └─ EndTooltip() [imgui.cpp:12011]
                  └─ End()
```

### データフロー図

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

fmt (書式文字列)   ───▶ SetTooltip()             ───▶ void
...  (可変長引数)         │
                          ▼
                       va_start
                          │
                          ▼
                     SetTooltipV()
                          │
                          ├──▶ BeginTooltipEx()  ───▶ ツールチップウィンドウ
                          │         │
                          │         └── 前ツールチップ非表示
                          │
                          ├──▶ TextV()           ───▶ テキスト描画
                          │
                          └──▶ EndTooltip()      ───▶ ウィンドウ終了
```

### 関連ファイル一覧

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