# 機能設計書 32-GetWindowDrawList

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける `GetWindowDrawList` 関数の機能設計書である。この関数は、現在のウィンドウに関連付けられた描画リスト（ImDrawList）を取得するためのAPIを提供する。

### 本機能の処理概要

**業務上の目的・背景**：GUIアプリケーションにおいて、標準的なウィジェットでは実現できないカスタム描画を行う必要がある場合がある。GetWindowDrawList関数は、現在のウィンドウの描画リストへのポインタを返し、ユーザーが独自の描画プリミティブ（線、矩形、円、テキストなど）を追加できるようにする。これにより、グラフ、チャート、カスタムUIコンポーネント、ゲーム用のオーバーレイなどを実装できる。

**機能の利用シーン**：
- カスタムグラフやチャートを描画する場合
- 独自のウィジェットやUIコンポーネントを実装する場合
- ゲームのHUDやオーバーレイを描画する場合
- 画像編集ツールでキャンバスに図形を描画する場合
- デバッグ情報を視覚的に表示する場合

**主要な処理内容**：
1. 現在のウィンドウを取得（GetCurrentWindow）
2. ウィンドウに関連付けられたDrawListポインタを返却

**関連システム・外部連携**：ImDrawList APIと連携し、AddLine、AddRect、AddCircle、AddText などの描画関数を利用可能。

**権限による制御**：特になし。すべてのウィンドウで利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 20 | Custom Rendering | 主機能 | 描画リストの取得 |

## 機能種別

状態取得API / 描画補助

## 入力仕様

### 入力パラメータ

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

### 入力データソース

ImGuiコンテキストから現在のウィンドウ（CurrentWindow）を参照。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | ImDrawList* | 現在のウィンドウに関連付けられた描画リストへのポインタ |

### 出力先

呼び出し元に直接返却。返されたポインタを使用して描画コマンドを追加する。

## 処理フロー

### 処理シーケンス

```
1. 現在のウィンドウを取得
   └─ GetCurrentWindow() を呼び出し

2. DrawListポインタを返却
   └─ window->DrawList を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[GetCurrentWindow]
    B --> C[window->DrawList取得]
    C --> D[ポインタを返却]
    D --> E[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | Begin/End必須 | この関数はBegin/End ブロック内で呼び出す必要がある | 常時 |
| BR-02 | 描画順序 | DrawListへの描画はウィンドウの他のコンテンツと同じレイヤーに追加される | 常時 |
| BR-03 | 座標系 | 描画座標は画面絶対座標（スクリーン座標）を使用する | 常時 |

### 計算ロジック

特になし。

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 未定義動作 | Begin/End ブロック外で呼び出した場合 | Begin/End ブロック内で呼び出す |

### リトライ仕様

リトライは不要。

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

該当なし。

## パフォーマンス要件

- 毎フレーム複数回呼び出される可能性がある
- O(1) の計算量（単純なポインタ取得のみ）

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

特になし。

## 備考

- GetBackgroundDrawList() / GetForegroundDrawList() と異なり、ウィンドウのコンテンツと同じレイヤーに描画される
- 描画リストはフレーム終了時にImGuiによって処理され、Render()呼び出し後に確定する
- ImDrawList::AddImage() 等で画像を描画することも可能

---

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

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

### 推奨読解順序

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

ImDrawListの構造と、ウィンドウとの関連を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImDrawList クラスの定義（描画プリミティブのAPI） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiWindow 構造体の DrawList メンバ |

**読解のコツ**: ImDrawListは多数のAddXXX関数（AddLine, AddRect, AddCircle等）を持っている。これらの関数を使って描画コマンドを蓄積する。

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

GetWindowDrawList 関数の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | GetWindowDrawList 関数の実装（8644-8648行） |

**主要処理フロー**:
1. **8646行目**: GetCurrentWindow() で現在のウィンドウを取得
2. **8647行目**: window->DrawList を返却

#### Step 3: ImDrawListのAPIを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.h | `imgui.h` | ImDrawList の AddLine, AddRect, AddCircle 等の宣言 |
| 3-2 | imgui_draw.cpp | `imgui_draw.cpp` | ImDrawList の各描画関数の実装 |

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

```
GetWindowDrawList()
    │
    └─ GetCurrentWindow()
           │
           └─ window->DrawList を返却
                   │
                   └─ [ユーザーコード] ImDrawList::AddXXX()
                           ├─ AddLine()
                           ├─ AddRect() / AddRectFilled()
                           ├─ AddCircle() / AddCircleFilled()
                           ├─ AddTriangle() / AddTriangleFilled()
                           ├─ AddText()
                           ├─ AddImage()
                           └─ AddBezierCubic() / AddBezierQuadratic()
```

### データフロー図

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

（なし）
        │
        └──────────────▶ GetCurrentWindow() ────────────▶ ImDrawList*
                               │                              │
                               ▼                              ▼
                         window->DrawList ──────────▶ 描画コマンド追加可能
                                                              │
                                                              ▼
                                                    Render()で描画確定
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | GetWindowDrawList 関数の宣言、ImDrawList クラスの定義 |
| imgui.cpp | `imgui.cpp` | ソース | GetWindowDrawList 関数の実装（8644-8648行） |
| imgui_draw.cpp | `imgui_draw.cpp` | ソース | ImDrawList の各描画関数の実装 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | GetWindowDrawList の使用例（3647行、9934行、10090行など） |
