# 通知設計書 5-SetItemTooltip

## 概要

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

### 本通知の処理概要

SetItemTooltipは、「if (IsItemHovered(ImGuiHoveredFlags_ForTooltip)) { SetTooltip(...); }」というパターンのショートカットである。直前に描画されたUIアイテムがホバーされた場合のみ、テキストツールチップを表示する。以前のSetTooltip呼び出しを上書きする。

**業務上の目的・背景**：UIアイテムに対するテキストツールチップ表示は最も一般的なユースケースである。SetItemTooltipは、ホバー判定とテキストツールチップ設定を1つの関数呼び出しにまとめることで、コードの簡潔性を大幅に向上させる。BeginItemTooltip/EndTooltipペアを使う必要がなく、1行で完結する。

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

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

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

**期待されるアクション**：ホバー状態の場合、ImGuiは新しいツールチップを作成し、指定されたテキストを表示する。EndTooltipの呼び出しは不要で、関数内で完結する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### API関数シグネチャ

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

### 本文テンプレート

```cpp
// 基本的な使用パターン（最もシンプル）
ImGui::Button("ホバーしてください");
ImGui::SetItemTooltip("ボタンの説明");

// 書式文字列を使用
ImGui::Button("カウンター");
ImGui::SetItemTooltip("現在の値: %d", count);

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

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| IsItemHovered(ImGuiHoveredFlags_ForTooltip)がfalse | SetTooltipVは呼び出されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[SetItemTooltip呼び出し] --> B[va_start処理]
    B --> C{IsItemHovered<br/>ForTooltip?}
    C -->|Yes| D[SetTooltipV呼び出し]
    C -->|No| E[何もしない]
    D --> F[va_end処理]
    E --> F
    F --> G[終了]
```

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

### 参照テーブル一覧

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

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

#### ImGuiContext

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| LastItemData | 直前アイテム情報 | IsItemHovered()内部 |
| TooltipPreviousWindow | 前回のツールチップ | SetTooltipV内部 |
| TooltipOverrideCount | ツールチップカウント | SetTooltipV内部 |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- SetItemTooltipはSetTooltipと同様に以前の呼び出しを上書きする
- EndTooltipの呼び出しは不要（内部で完結）
- printf形式の書式文字列をサポート（IM_FMTARGS(1)マクロによる）
- 最も簡潔なツールチップ設定方法である

---

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

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

### 推奨読解順序

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

ホバーフラグとツールチップ関連のデータ構造を理解する。

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

**読解のコツ**: ForTooltipフラグがどのように展開されるか確認する。

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

SetItemTooltipとSetItemTooltipVの実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | SetItemTooltip API宣言（832行目） |
| 2-2 | imgui.h | `imgui.h` | ショートカット説明コメント（829行目） |
| 2-3 | imgui.cpp | `imgui.cpp` | SetItemTooltip実装（12035-12042行目） |
| 2-4 | imgui.cpp | `imgui.cpp` | SetItemTooltipV実装（12044-12048行目） |

**主要処理フロー**:
1. **12037-12038行目**: va_args設定
2. **12039行目**: IsItemHovered(ForTooltip)チェック
3. **12040行目**: 条件を満たす場合SetTooltipV呼び出し
4. **12041行目**: va_end処理

#### Step 3: SetTooltipVの動作を理解する

SetTooltipVがどのようにツールチップを作成するか確認する。

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

**主要処理フロー**:
- BeginTooltipEx（OverridePreviousフラグ付き）
- TextVでテキスト描画
- EndTooltip呼び出し

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

```
SetItemTooltip(fmt, ...) [imgui.cpp:12035]
    │
    ├─ va_start
    │
    ├─ IsItemHovered(ImGuiHoveredFlags_ForTooltip)
    │       │
    │       └─ ホバー状態判定
    │
    └─ [条件付き] SetTooltipV(fmt, args) [imgui.cpp:12025]
           │
           ├─ BeginTooltipEx(OverridePrevious)
           │       └─ Begin()
           │
           ├─ TextV(fmt, args)
           │
           └─ EndTooltip()
                  └─ End()
```

### データフロー図

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

fmt (書式文字列)   ───▶ SetItemTooltip()         ───▶ void
... (可変長引数)          │
                          ▼
LastItemData       ───▶ IsItemHovered()
  │                       │
  └─ ID, StatusFlags      ▼
                       ホバー判定
                          │
                          ▼ (trueの場合のみ)
                     SetTooltipV()              ───▶ ツールチップ表示
                          │
                          └──▶ テキスト描画
```

### 関連ファイル一覧

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