# 機能設計書 71-SetCursorPos

## 概要

本ドキュメントは、Dear ImGuiライブラリのSetCursorPos関数の機能設計を記述する。この関数は、ウィンドウローカル座標でカーソル位置を設定するためのAPI関数である。

### 本機能の処理概要

SetCursorPos関数は、ImGuiウィンドウ内でのカーソル（描画位置）をウィンドウローカル座標系で設定する機能を提供する。この関数を使用することで、ウィジェットやテキストの配置位置を自由に制御できる。

**業務上の目的・背景**：GUIアプリケーションにおいて、ウィジェットの配置は自動レイアウトに依存するだけでなく、特定の位置に正確に配置したい場面が多々存在する。SetCursorPosは、ウィンドウ内の任意の位置にカーソルを移動させることで、カスタムレイアウトやオーバーレイ表示、グラフィカルなUI構築を可能にする。ウィンドウローカル座標を使用することで、ウィンドウのスクロール状態に依存しない相対的な位置指定が可能となる。

**機能の利用シーン**：カスタムウィジェットの作成時、ダッシュボードや計器盤のような特定レイアウトのUI構築時、ウィンドウ内の特定位置へのアイテム配置時に使用される。特に、グリッドレイアウトやカード型UIの実装、グラフやチャートの描画位置制御において重要な役割を果たす。

**主要な処理内容**：
1. 現在のウィンドウオブジェクトを取得する
2. ウィンドウローカル座標をスクリーン絶対座標に変換する
3. ウィンドウのDC（Drawing Context）のCursorPosを更新する
4. IsSetPosフラグをtrueに設定する

**関連システム・外部連携**：この関数は純粋にImGui内部の座標管理に関わるため、外部システムとの連携はない。ただし、SetCursorScreenPosと組み合わせて使用されることが多い。

**権限による制御**：権限による制御は存在しない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | (全ウィンドウ) | 主画面 | カーソル位置の設定によるレイアウト制御 |

## 機能種別

レイアウト制御 / 座標操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| local_pos | const ImVec2& | Yes | ウィンドウローカル座標での位置（X, Y） | 特になし（負の値やウィンドウ外の座標も許容） |

### 入力データソース

ユーザーコードから直接呼び出される。入力値は開発者が任意に指定する。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (なし) | void | 戻り値なし |

### 出力先

現在のウィンドウのDrawing Context（DC）内のCursorPos、IsSetPosフラグを更新する。

## 処理フロー

### 処理シーケンス

```
1. GetCurrentWindow()で現在のウィンドウを取得
   └─ ウィンドウポインタをwindow変数に格納
2. ウィンドウローカル座標をスクリーン座標に変換
   └─ window->Pos - window->Scroll + local_pos を計算
3. window->DC.CursorPosに変換後の座標を設定
   └─ 内部的にはスクリーン絶対座標で管理される
4. window->DC.IsSetPosをtrueに設定
   └─ 明示的な位置設定が行われたことを記録
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[GetCurrentWindow]
    B --> C[local_posをスクリーン座標に変換]
    C --> D[DC.CursorPosを更新]
    D --> E[DC.IsSetPos = true]
    E --> F[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 座標変換 | ローカル座標はウィンドウ位置とスクロール量を考慮してスクリーン座標に変換される | 常時 |
| BR-02 | IsSetPosフラグ | 明示的な位置設定時にフラグが立てられ、親境界拡張のエラーチェックに使用される | 常時 |

### 計算ロジック

```
スクリーン座標 = window->Pos - window->Scroll + local_pos
```

- `window->Pos`: ウィンドウの左上隅のスクリーン座標
- `window->Scroll`: ウィンドウの現在のスクロール量
- `local_pos`: ユーザー指定のローカル座標

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

該当なし（メモリ内操作のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | アサーション | ウィンドウコンテキストが存在しない場合 | Begin()〜End()ブロック内で呼び出す |

### リトライ仕様

該当なし

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

該当なし（フレーム単位の即座反映）

## パフォーマンス要件

非常に軽量な操作（単純な座標計算とメンバ変数への代入のみ）。毎フレーム複数回呼び出しても問題ない。

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

特になし（純粋なUI操作）

## 備考

- SetCursorPosX()、SetCursorPosY()で個別軸の設定も可能
- GetCursorPos()で現在位置を取得可能
- スクリーン絶対座標での操作にはSetCursorScreenPos()を使用する

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindowTempData構造体（2587-2638行目）でCursorPos、CursorPosPrevLine、Indent等のレイアウト関連フィールドを確認 |
| 1-2 | imgui.h | `imgui.h` | ImVec2構造体（295-305行目）で座標の基本型を確認 |

**読解のコツ**: ImGuiWindowTempDataはウィンドウごとの一時データを保持し、DCはDrawing Contextの略。CursorPosは内部的にスクリーン絶対座標で管理されているが、外部APIではウィンドウローカル座標として扱われる点に注意。

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

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

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

**主要処理フロー**:
1. **11416行目**: GetCurrentWindow()で現在のウィンドウを取得
2. **11417行目**: window->Pos - window->Scroll + local_posでスクリーン座標を計算しDC.CursorPosに設定
3. **11419行目**: DC.IsSetPos = true でフラグ設定

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | SetCursorPosX（11422-11428行目）、SetCursorPosY（11430-11436行目）で個別軸設定 |
| 3-2 | imgui.cpp | `imgui.cpp` | GetCursorPos（11396-11400行目）で逆変換を理解 |

**主要処理フロー**:
- **11399行目**: GetCursorPosの戻り値は`window->DC.CursorPos - window->Pos + window->Scroll`（SetCursorPosの逆変換）

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

```
ImGui::SetCursorPos(local_pos)
    │
    ├─ GetCurrentWindow()
    │      └─ g.CurrentWindow を返す
    │
    └─ 座標変換・設定
           ├─ DC.CursorPos = Pos - Scroll + local_pos
           └─ DC.IsSetPos = true
```

### データフロー図

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

ImVec2 local_pos ───▶ SetCursorPos() ───▶ window->DC.CursorPos
                            │                   (スクリーン座標)
                            │
                            └────────────▶ window->DC.IsSetPos = true
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | SetCursorPos関数の宣言（571行目） |
| imgui.cpp | `imgui.cpp` | ソース | SetCursorPos関数の実装（11414-11420行目） |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | ImGuiWindowTempData構造体の定義（2587-2638行目） |
