# 機能設計書 212-IsItemVisible

## 概要

本ドキュメントは、ImGuiのIsItemVisible関数の機能設計書である。直前に追加されたアイテムが画面上で表示されているか（クリッピング/スクロールにより非表示になっていないか）を判定する機能について記載する。

### 本機能の処理概要

IsItemVisible関数は、直前に追加されたウィジェット（アイテム）が現在のクリッピング領域内に表示されているかを判定するAPIである。スクロールやクリッピングによって視野外になったアイテムを検出できる。

**業務上の目的・背景**：大量のアイテムを表示するリストやテーブルにおいて、表示されていないアイテムに対する重い処理（カスタム描画、テクスチャロード等）をスキップすることでパフォーマンスを最適化できる。また、仮想スクロールの実装時に、実際に描画が必要なアイテムのみを処理対象とする判断材料として使用される。

**機能の利用シーン**：
- カスタム描画を行う際に、クリッピングされて見えないアイテムの描画処理をスキップする場合
- スクロール可能なリストで表示領域外のアイテムに対する重い処理を回避する場合
- デバッグ目的で特定のアイテムが画面に表示されているかを確認する場合
- 遅延ロードの実装（表示されたタイミングでリソースをロード）

**主要な処理内容**：
1. ImGuiContextから直前のアイテムのStatusFlagsを取得
2. ImGuiItemStatusFlags_Visibleビットが設定されているかを確認
3. 設定されていればtrue、そうでなければfalseを返却

**関連システム・外部連携**：ImGuiの内部状態管理システム（ImGuiContext）のLastItemData.StatusFlagsを参照する。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | Demo Window | 参照画面 | Querying StatusセクションでIsItemVisibleの動作確認 |
| 20 | Custom Rendering | 参照画面 | カスタム描画時の可視性判定に使用 |

## 機能種別

状態判定 / クエリ機能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | 引数なし | - |

### 入力データソース

- ImGuiContext::LastItemData.StatusFlags - 直前に追加されたアイテムの状態フラグ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | アイテムが表示されている場合true、クリッピング/スクロールで非表示の場合false |

### 出力先

呼び出し元への戻り値として返却

## 処理フロー

### 処理シーケンス

```
1. コンテキスト取得
   └─ ImGuiContextへの参照を取得
2. StatusFlags確認
   └─ g.LastItemData.StatusFlagsを参照
3. Visibleビット判定
   └─ ImGuiItemStatusFlags_Visibleビットが設定されているかチェック
4. 結果返却
   └─ ビットが設定されていればtrue、そうでなければfalse
```

### フローチャート

```mermaid
flowchart TD
    A[IsItemVisible呼び出し] --> B[ImGuiContext取得]
    B --> C[LastItemData.StatusFlags参照]
    C --> D{ImGuiItemStatusFlags_Visible<br>ビットが設定?}
    D -->|Yes| E[true を返却]
    D -->|No| F[false を返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-212-01 | クリッピング判定 | アイテムの矩形が現在のクリッピング矩形と重なっている場合にVisibleとなる | アイテム追加時 |
| BR-212-02 | WIP機能 | 本機能は内部的にはWIP（Work In Progress）状態であり、ItemAdd()のリファクタリングに伴い変更される可能性がある | 常時 |

### 計算ロジック

```cpp
bool ImGui::IsItemVisible()
{
    ImGuiContext& g = *GImGui;
    return (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Visible) != 0;
}
```

## データベース操作仕様

該当なし（GUIフレームワーク内部の状態参照のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 暗黙的エラー | 前にアイテムが追加されていない場合 | LastItemDataが初期状態となり、falseを返す |

### リトライ仕様

該当なし

## トランザクション仕様

該当なし

## パフォーマンス要件

- 単純なビット演算のみで構成される軽量な判定処理
- フレームごとに大量のアイテムに対して呼び出しても問題なし

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

該当なし

## 備考

- **注意**: コメントによると、このAPIはWIP（Work In Progress）であり、ItemAdd()のリファクタリングに伴いAPIが変更される可能性がある。将来のバージョンで動作が変わる可能性があることに留意すること。
- ImDrawListを使用したカスタム描画において、クリッピングされた要素はImDrawListレベルでクリップされないため、IsItemVisibleでスキップすることが推奨される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiItemStatusFlags_Visible定義（998行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiLastItemData構造体（1376-1389行目） |

**読解のコツ**: ImGuiItemStatusFlags_Visibleは「アイテムが現在のクリッピング矩形と重なっている」ことを示すフラグ。WIP状態であることがコメントに明記されている。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | 関数宣言（1010行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | 関数実装（6278-6282行目） |

**主要処理フロー**:
1. **6278行目**: 関数定義
2. **6280行目**: ImGuiContext参照の取得
3. **6281行目**: StatusFlagsのVisibleビット判定

#### Step 3: 使用例を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_demo.cpp | `imgui_demo.cpp` | 使用例（2158行目、5156行目） |

**使用パターン**:
- 5156行目: カスタム描画のスキップに使用

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

```
ImGui::IsItemVisible()
    │
    └─ g.LastItemData.StatusFlags 参照
           └─ ImGuiItemStatusFlags_Visible ビット判定
```

### データフロー図

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

アイテム追加時に設定 ─────▶ ItemAdd()
                              │
                              ▼
                     g.LastItemData.StatusFlags
                              │
                              ▼
IsItemVisible() ─────────▶ ビット判定 ─────────▶ bool (true/false)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 公開API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | 関数実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | 内部データ構造定義 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | 使用例 |
| imgui_tables.cpp | `imgui_tables.cpp` | ソース | テーブル内での使用 |
