# 機能設計書 33-GetWindowPos

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける `GetWindowPos` 関数の機能設計書である。この関数は、現在のウィンドウの画面座標（スクリーン座標）上の位置を取得するためのAPIを提供する。

### 本機能の処理概要

**業務上の目的・背景**：GUIアプリケーションにおいて、ウィンドウの絶対位置を知る必要がある場面がある。GetWindowPos関数は、現在処理中のウィンドウ（Begin/End ブロック内）の左上角の画面座標を返す。ただし、多くの場合は GetCursorScreenPos() と GetContentRegionAvail() の組み合わせで目的を達成できるため、この関数の直接使用は稀である。

**機能の利用シーン**：
- ウィンドウローカル座標から画面絶対座標への変換が必要な場合
- 複数ウィンドウ間の相対位置を計算する場合
- カスタム描画でウィンドウ位置を基準にした座標計算を行う場合
- デバッグ目的でウィンドウの配置を確認する場合

**主要な処理内容**：
1. 現在のウィンドウを取得（g.CurrentWindow）
2. ウィンドウのPosプロパティを返却

**関連システム・外部連携**：GetCursorScreenPos、GetContentRegionAvail、SetWindowPos などの座標系関連APIと連携。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能は直接的に画面に関連付けられていないが、すべてのウィンドウで使用可能 |

## 機能種別

状態取得API

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | ImVec2 | ウィンドウの左上角の画面座標（x, y） |

### 出力先

呼び出し元に直接返却。

## 処理フロー

### 処理シーケンス

```
1. コンテキストの取得
   └─ GImGui からコンテキストを取得

2. 現在のウィンドウを取得
   └─ g.CurrentWindow を参照

3. 位置を返却
   └─ window->Pos を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[GImGuiコンテキスト取得]
    B --> C[g.CurrentWindow取得]
    C --> D[window->Pos返却]
    D --> E[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | Begin/End必須 | この関数はBegin/End ブロック内で呼び出す必要がある | 常時 |
| BR-02 | 画面座標系 | 返される座標は画面絶対座標（左上が原点） | 常時 |
| BR-03 | 推奨代替API | 多くの場合、GetCursorScreenPos() + GetContentRegionAvail() の使用を推奨 | 常時 |

### 計算ロジック

- ウィンドウローカル座標から画面座標への変換: `画面座標 = ローカル座標 + GetWindowPos()`
- この逆変換は: `ローカル座標 = 画面座標 - GetWindowPos()`

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライは不要。

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

該当なし。

## パフォーマンス要件

- O(1) の計算量（単純なプロパティ取得のみ）

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

特になし。

## 備考

- imgui.h のコメントでは「IT IS UNLIKELY YOU EVER NEED TO USE THIS」と記載されており、多くの場合は GetCursorScreenPos() を使用することを推奨している
- 座標変換が必要な場合は、この関数よりも GetCursorScreenPos() の方が直感的に使える

---

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

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

### 推奨読解順序

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

ImGuiWindow 構造体の Pos メンバと、座標系の概念を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImVec2 構造体の定義 |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiWindow 構造体の Pos メンバ |

**読解のコツ**: ImVec2 は単純な2次元ベクトル（x, y）であり、画面座標では左上が原点、右下に向かって正の方向となる。

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

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

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

**主要処理フロー**:
1. **8437行目**: GImGui からコンテキストを取得
2. **8438行目**: g.CurrentWindow を取得
3. **8439行目**: window->Pos を返却

#### Step 3: 関連APIを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | GetCursorScreenPos 関数（推奨代替API） |
| 3-2 | imgui.cpp | `imgui.cpp` | SetWindowPos 関数（位置設定API） |
| 3-3 | imgui.cpp | `imgui.cpp` | GetWindowSize 関数（サイズ取得API） |

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

```
GetWindowPos()
    │
    ├─ GImGui (コンテキスト参照)
    │
    └─ g.CurrentWindow->Pos
           │
           └─ ImVec2 を返却
```

### データフロー図

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

（なし）
        │
        └──────────────▶ g.CurrentWindow 参照 ──────────▶ ImVec2 (x, y)
                               │                              │
                               ▼                              ▼
                         window->Pos ──────────────▶ 画面座標として使用
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | GetWindowPos 関数の宣言、ImVec2 構造体の定義 |
| imgui.cpp | `imgui.cpp` | ソース | GetWindowPos 関数の実装（8435-8440行） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiWindow 構造体の定義 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | GetWindowPos の使用例（10163行） |
