# 機能設計書 70-GetCursorPos

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける`GetCursorPos`関数の機能設計を定義する。この関数は、現在のカーソル位置をウィンドウローカル座標で取得する。

### 本機能の処理概要

GetCursorPos関数は、現在のウィンドウ内でのカーソル位置（次にウィジェットが描画される位置）を、ウィンドウの左上を原点としたローカル座標で取得する。内部ではスクロール補正を行った値を返す。

**業務上の目的・背景**：GUIアプリケーションでは、ウィンドウ内での相対的な位置を把握する場面がある。ただし、ImGuiの公式ドキュメントでは「This is not your best friend」と記載されており、GetCursorScreenPos()の使用が推奨されている。主にレガシーコードの互換性やウィンドウローカル座標が必要な特定の場面で使用される。

**機能の利用シーン**：
- ウィンドウ内での相対位置を知りたい場合
- SameLine()のオフセット計算
- ウィンドウローカル座標系を使用する他のAPI（PushTextWrapPos等）との連携
- レガシーコードの互換性維持

**主要な処理内容**：
1. 現在のウィンドウを読み取り専用で取得
2. DC.CursorPos（絶対座標）からウィンドウ位置を引き、スクロール量を加算
3. ウィンドウローカル座標として返す

**関連システム・外部連携**：SetCursorPosと対になる関数。GetCursorScreenPosの代替として使用可能だが非推奨。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 特定の画面に紐づかない汎用機能 |

## 機能種別

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- ImGuiWindow::DC.CursorPos（現在のカーソル位置、絶対座標）
- ImGuiWindow::Pos（ウィンドウ位置）
- ImGuiWindow::Scroll（スクロール量）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | ImVec2 | カーソル位置（ウィンドウローカル座標、ピクセル単位） |

### 出力先

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

## 処理フロー

### 処理シーケンス

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

2. ウィンドウローカル座標を計算
   └─ local_pos = DC.CursorPos - window->Pos + window->Scroll

3. 計算された座標を返す
   └─ return local_pos
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[GetCurrentWindowRead]
    B --> C[DC.CursorPos - Pos + Scroll を計算]
    C --> D[ローカル座標を返す]
    D --> E[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-70-01 | ローカル座標 | 返される座標はウィンドウ左上を原点としたローカル座標 | 常時 |
| BR-70-02 | スクロール補正 | スクロール量が座標に反映される | 常時 |
| BR-70-03 | 非推奨 | GetCursorScreenPos()の使用が推奨される | 常時 |

### 計算ロジック

```cpp
return window->DC.CursorPos - window->Pos + window->Scroll;
```

関連する座標変換式：
```cpp
GetCursorScreenPos() = GetCursorPos() + GetWindowPos()
// つまり
GetCursorPos() = GetCursorScreenPos() - GetWindowPos()
```

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

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

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

特になし

## 備考

- ImGuiコメントで「This is not your best friend」と記載されており、GetCursorScreenPos()の使用が推奨される
- ウィンドウローカル座標はスクロールと組み合わせて使用される
- 内部ではDC.CursorPosが絶対座標で保持されているため、変換処理が必要
- GetCursorPosX()、GetCursorPosY()という個別のX/Y取得関数も存在する

---

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

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

### 推奨読解順序

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

まず、座標変換に関連するデータ構造を理解することが重要。

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

**読解のコツ**: CursorPosは絶対座標で保持される。Posはウィンドウの左上座標、Scrollはスクロール量を表す。

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

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

**主要処理フロー**:
1. **568行目**: 関数宣言と「This is not your best friend」というコメント

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

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

**主要処理フロー**:
- **11394-11395行目**: コメントで座標変換の背景を説明
- **11398行目**: GetCurrentWindowRead()で現在のウィンドウを読み取り専用で取得
- **11399行目**: DC.CursorPos - Pos + Scroll の計算と返却

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

```
GetCursorPos()
    │
    └─ GetCurrentWindowRead()
           └─ 現在のウィンドウポインタを取得
                  │
                  └─ window->DC.CursorPos - window->Pos + window->Scroll を計算
```

### データフロー図

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

DC.CursorPos（絶対座標） ──┐
                          │
window->Pos ──────────────┼───▶ GetCursorPos() ──▶ ImVec2（ローカル座標）
                          │
window->Scroll ───────────┘
```

### 関連ファイル一覧

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