# 機能設計書 67-GetCursorScreenPos

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける`GetCursorScreenPos`関数の機能設計を定義する。この関数は、現在のカーソル位置を画面絶対座標（スクリーン座標）で取得する。

### 本機能の処理概要

GetCursorScreenPos関数は、現在のウィンドウ内でのカーソル位置（次にウィジェットが描画される位置）を、画面全体での絶対座標として取得する。ImGuiの公式ドキュメントで「YOUR BEST FRIEND」と呼ばれる最も推奨される位置取得関数である。

**業務上の目的・背景**：GUIアプリケーションでは、ウィジェットやカスタム描画の正確な位置を把握する必要がある。特にImDrawList APIを使用したカスタム描画や、複雑なレイアウトの実装において、画面絶対座標での位置情報が不可欠である。GetCursorScreenPosはウィンドウのスクロールや位置に関係なく、画面上での実際の座標を提供するため、最も信頼性の高い位置取得方法となっている。

**機能の利用シーン**：
- ImDrawListを使用したカスタム描画（図形、線、テキストなど）
- ウィジェットの位置を基準にした相対配置
- マウス位置との相対計算
- デバッグ情報の表示

**主要な処理内容**：
1. 現在のウィンドウを読み取り専用で取得
2. DC.CursorPos（内部で保持する絶対座標）を返す

**関連システム・外部連携**：ImDrawList APIと密接に連携。SetCursorScreenPosと対になる関数。

**権限による制御**：特になし。任意のウィンドウコンテキスト内で使用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 20 | Custom Rendering | 補助機能 | カーソル位置の取得 |

## 機能種別

位置取得 / レイアウト支援

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- ImGuiWindow::DC.CursorPos（現在のカーソル位置、絶対座標）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | ImVec2 | カーソル位置（画面絶対座標、ピクセル単位） |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 現在のウィンドウを読み取り専用で取得
   └─ ImGuiWindow* window = GetCurrentWindowRead()

2. カーソル位置を返す
   └─ return window->DC.CursorPos
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[GetCurrentWindowRead]
    B --> C[DC.CursorPosを返す]
    C --> D[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-67-01 | 絶対座標 | 返される座標はウィンドウ位置やスクロールに関係なく画面全体での絶対位置 | 常時 |
| BR-67-02 | 読み取り専用 | この関数はウィンドウの状態を変更しない | 常時 |
| BR-67-03 | 推奨使用法 | GetCursorPos()よりもこちらの使用が推奨される | 常時 |

### 計算ロジック

関連する座標変換式：
```cpp
GetCursorScreenPos() = GetCursorPos() + GetWindowPos()
```

つまり、ウィンドウローカル座標 + ウィンドウ位置 = 画面絶対座標

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 特になし | - |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- O(1)の定数時間操作
- 単純な値の取得のみで非常に軽量

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

特になし

## 備考

- ImGuiコメントで「THIS IS YOUR BEST FRIEND」と記載されており、最も推奨される位置取得方法
- GetCursorPos()はウィンドウローカル座標を返すが、こちらは画面絶対座標を返す
- GetContentRegionAvail()と組み合わせることで、ほとんどのレイアウト処理が可能

---

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

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

### 推奨読解順序

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

まず、カーソル位置に関連するデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindowTempData構造体内のCursorPos定義（2590行目） |

**読解のコツ**: CursorPosは「現在の出力位置（絶対座標）」を表す。ウィジェットはこの位置に描画され、描画後にCursorPosが更新される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | GetCursorScreenPosの関数宣言（565行目）とコメント |

**主要処理フロー**:
1. **565行目**: 関数宣言と「THIS IS YOUR BEST FRIEND」というコメント

#### Step 3: 実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | GetCursorScreenPos関数の実装（11380-11384行目） |

**主要処理フロー**:
- **11382行目**: GetCurrentWindowRead()で現在のウィンドウを読み取り専用で取得
- **11383行目**: DC.CursorPosを直接返す

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

```
GetCursorScreenPos()
    │
    └─ GetCurrentWindowRead()
           └─ 現在のウィンドウポインタを取得
                  │
                  └─ window->DC.CursorPos を返す
```

### データフロー図

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

なし ──────────────▶ GetCursorScreenPos() ──────▶ ImVec2（画面絶対座標）
                           │
                           └─ DC.CursorPos を参照
```

### 関連ファイル一覧

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