# 機能設計書 243-SetMouseCursor

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるSetMouseCursor関数の機能設計について記述する。この関数はマウスカーソルの形状を設定するためのユーティリティ関数である。

### 本機能の処理概要

SetMouseCursor関数は、アプリケーションで表示するマウスカーソルの形状（矢印、テキスト入力、リサイズなど）を設定する機能を提供する。設定されたカーソル形状は、バックエンド（プラットフォーム実装）によって実際のOSカーソルに反映される。

**業務上の目的・背景**：GUIアプリケーションでは、ユーザーの操作コンテキストに応じてマウスカーソルの形状を変更することが一般的である。例えば、テキスト入力欄にホバー時はIビームカーソル、ウィンドウの境界でリサイズ可能な場合はリサイズカーソル、リンク上ではハンドカーソルなど、視覚的フィードバックを提供することでユーザー体験を向上させる。

**機能の利用シーン**：カスタムウィジェットでのカーソル形状制御、ウィンドウリサイズ時のカーソル変更、テキスト入力フィールドでのIビームカーソル表示、待機状態の表示、ドラッグ禁止状態の表示などに使用される。

**主要な処理内容**：
1. 指定されたカーソル形状をグローバルコンテキストに設定
2. バックエンドがNewFrame時にこの値を読み取りOSカーソルを更新

**関連システム・外部連携**：バックエンド（imgui_impl_*）がg.MouseCursorの値を読み取り、プラットフォーム固有のAPIを使用してOSのカーソル形状を変更する。ソフトウェアレンダリング（io.MouseDrawCursor）の場合は、ImGui自身がカーソルを描画する。

**権限による制御**：本機能に権限による制御は存在しない。コンテキストが有効であれば常に呼び出し可能である。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 全画面共通 | 主機能 | カーソル形状の動的制御 |

## 機能種別

設定処理 / 状態更新

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| cursor_type | ImGuiMouseCursor | Yes | 設定するカーソル形状 | ImGuiMouseCursor_COUNT未満 |

### カーソル形状の種類

| 値 | 名前 | 説明 |
|-----|------|------|
| -1 | ImGuiMouseCursor_None | カーソル非表示 |
| 0 | ImGuiMouseCursor_Arrow | 標準矢印カーソル |
| 1 | ImGuiMouseCursor_TextInput | テキスト入力用Iビームカーソル |
| 2 | ImGuiMouseCursor_ResizeAll | 全方向リサイズカーソル（未使用） |
| 3 | ImGuiMouseCursor_ResizeNS | 垂直リサイズカーソル |
| 4 | ImGuiMouseCursor_ResizeEW | 水平リサイズカーソル |
| 5 | ImGuiMouseCursor_ResizeNESW | 北東-南西リサイズカーソル |
| 6 | ImGuiMouseCursor_ResizeNWSE | 北西-南東リサイズカーソル |
| 7 | ImGuiMouseCursor_Hand | ハンドカーソル（リンク用） |
| 8 | ImGuiMouseCursor_Wait | 待機カーソル |
| 9 | ImGuiMouseCursor_Progress | 進行中カーソル |
| 10 | ImGuiMouseCursor_NotAllowed | 禁止カーソル |

### 入力データソース

- アプリケーションコードからの直接指定
- ImGuiウィジェットからの内部呼び出し

## 出力仕様

### 出力データ

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

### 出力先

- ImGuiContext::MouseCursor - カーソル形状の格納先
- バックエンドがこの値を参照してOSカーソルを更新

## 処理フロー

### 処理シーケンス

```
1. グローバルコンテキスト取得
   └─ GImGuiを逆参照
2. カーソル形状を設定
   └─ g.MouseCursor = cursor_type
```

### フローチャート

```mermaid
flowchart TD
    A[SetMouseCursor呼び出し] --> B[コンテキスト取得]
    B --> C[g.MouseCursor = cursor_type]
    C --> D[終了]

    E[バックエンド NewFrame] --> F[g.MouseCursor読み取り]
    F --> G{ConfigFlags_NoMouseCursorChange?}
    G -->|Yes| H[何もしない]
    G -->|No| I[OSカーソル更新]
    H --> J[終了]
    I --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-243-1 | フレームリセット | カーソル形状はNewFrame()でArrowにリセットされる | 毎フレーム開始時 |
| BR-243-2 | バックエンド責務 | 実際のカーソル表示はバックエンドが担当 | バックエンド存在時 |
| BR-243-3 | ソフトウェア描画 | io.MouseDrawCursorがtrueの場合ImGuiが描画 | ソフトウェアレンダリング時 |
| BR-243-4 | 設定無効化 | ConfigFlags_NoMouseCursorChangeでカーソル変更を無効化可能 | フラグ設定時 |

### 計算ロジック

特別な計算処理は行わない。

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

### 操作別データベース影響一覧

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンテキスト未初期化 | GImGuiがNULL | CreateContext()を先に呼び出す |

### リトライ仕様

リトライ処理は不要。

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

本機能はトランザクション処理を行わない。

## パフォーマンス要件

- 処理時間: O(1) - 単純な代入のみ
- メモリ使用: 追加のメモリ割り当てなし
- 呼び出し頻度: 毎フレーム複数回呼び出し可能

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

- カーソル形状情報は機密性の低いデータ
- 入力値の範囲検証は行われない（列挙型の範囲内であることが期待される）
- 外部への情報漏洩リスクなし

## 備考

- GetMouseCursor()で現在設定されているカーソル形状を取得可能
- カスタムカーソルを使用する場合は、バックエンドの_NewFrame()前に処理を行い、一時的にConfigFlags_NoMouseCursorChangeを設定する
- ImGuiMouseCursor_ResizeAllは現在ImGui内部では使用されていないが、アプリケーションで使用可能

---

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

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

### 推奨読解順序

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

カーソル形状の列挙型とコンテキスト内での格納場所を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiMouseCursor_列挙型（1956-1971行目）- カーソル種別の定義 |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiContext::MouseCursor - カーソル状態の格納場所 |

**読解のコツ**: ImGuiMouseCursor_の各値は、OSのカーソル種別と対応している。バックエンド実装を見ることで、どのようにOSカーソルにマッピングされるかを理解できる。

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

関数の実装を確認する。

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

**主要処理フロー**:
1. **10026行目**: グローバルコンテキストを取得
2. **10027行目**: g.MouseCursorに引数のcursor_typeを設定

#### Step 3: バックエンドでの利用を理解する

バックエンドがどのようにカーソルを処理するかを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | GetMouseCursor関数（10015行目付近）- カーソル取得 |
| 3-2 | imgui_impl_win32.cpp | `backends/imgui_impl_win32.cpp` | Win32バックエンドでのカーソル処理例 |
| 3-3 | imgui_impl_glfw.cpp | `backends/imgui_impl_glfw.cpp` | GLFWバックエンドでのカーソル処理例 |

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

```
SetMouseCursor(cursor_type)
    │
    └─ g.MouseCursor = cursor_type
           │
           ▼
    [NewFrame() / Render()で参照]
           │
           └─ バックエンド (_NewFrame)
                  │
                  └─ OS API呼び出し
                         ├─ Win32: SetCursor()
                         ├─ GLFW: glfwSetCursor()
                         └─ SDL: SDL_SetCursor()
```

### データフロー図

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

アプリケーション            SetMouseCursor()     バックエンド
    │                          │                   │
    └── cursor_type ─────────▶ g.MouseCursor ────▶ OSカーソル更新
                                    │
                              [毎フレームNewFrame()で
                               ImGuiMouseCursor_Arrowにリセット]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 関数宣言、ImGuiMouseCursor_列挙型定義 |
| imgui.cpp | `imgui.cpp` | ソース | SetMouseCursor/GetMouseCursor関数の実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiContext::MouseCursor定義 |
| imgui_impl_win32.cpp | `backends/imgui_impl_win32.cpp` | バックエンド | Win32でのカーソル処理 |
| imgui_impl_glfw.cpp | `backends/imgui_impl_glfw.cpp` | バックエンド | GLFWでのカーソル処理 |
| imgui_impl_sdl2.cpp | `backends/imgui_impl_sdl2.cpp` | バックエンド | SDL2でのカーソル処理 |
