# 機能設計書 207-SetNavCursorVisible

## 概要

本ドキュメントは、ImGuiライブラリにおける `SetNavCursorVisible` 関数の機能設計を定義する。この関数は、キーボード/ゲームパッドナビゲーションカーソルの表示/非表示を手動で制御するために使用される。

### 本機能の処理概要

SetNavCursorVisible関数は、ナビゲーションカーソル（キーボードやゲームパッドで選択中のアイテムを示すハイライト表示）の可視性を手動で制御する。デフォルトでは、矢印キーを使用するとカーソルが表示され、マウスでクリックすると非表示になるが、この関数でその動作をオーバーライドできる。

**業務上の目的・背景**：ゲームパッドやキーボードでのナビゲーションを重視するアプリケーションでは、ナビゲーションカーソルの表示を細かく制御する必要がある。特定の操作後にカーソルを明示的に表示または非表示にすることで、ユーザーインターフェースの一貫性と使いやすさを向上させることができる。

**機能の利用シーン**：
- ゲームパッドのみの操作モードでのカーソル常時表示
- マウス操作時のカーソル強制非表示
- カスタムナビゲーション実装でのカーソル制御
- ウィジェットのアクティベーション後のカーソル状態管理
- アクセシビリティ機能としてのカーソル強調表示

**主要な処理内容**：
1. ナビゲーションウィンドウの入力制限確認
2. ConfigNavCursorVisibleAlways設定の確認
3. NavCursorVisibleフラグの更新

**関連システム・外部連携**：ナビゲーションシステム、ウィンドウシステム、IO設定と連携する。

**権限による制御**：本機能自体に権限制御はない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 27 | Inputs | 参照画面 | キーボード/ゲームパッド入力でのナビゲーション |

## 機能種別

ナビゲーション制御 / 表示制御 / 設定変更

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| visible | bool | Yes | ナビゲーションカーソルを表示するかどうか | なし |

### 入力データソース

プログラムコードからの直接呼び出し。

## 出力仕様

### 出力データ

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

### 出力先

- ImGuiContext::NavCursorVisible（ナビゲーションカーソル表示フラグ）

## 処理フロー

### 処理シーケンス

```
1. ImGuiContextの取得
   └─ グローバルコンテキスト（GImGui）を取得
2. NoNavInputsウィンドウ確認
   └─ ナビゲーションウィンドウがNoNavInputsフラグを持つ場合、visible=falseに強制
3. ConfigNavCursorVisibleAlways確認
   └─ io.ConfigNavCursorVisibleAlwaysがtrueの場合、visible=trueに強制
4. NavCursorVisibleフラグ更新
   └─ 計算結果をg.NavCursorVisibleに設定
```

### フローチャート

```mermaid
flowchart TD
    A[SetNavCursorVisible呼び出し] --> B{NavWindowにNoNavInputs?}
    B -->|Yes| C[visible = false]
    B -->|No| D{ConfigNavCursorVisibleAlways?}
    C --> E[g.NavCursorVisible = visible]
    D -->|Yes| F[visible = true]
    D -->|No| E
    F --> E
    E --> G[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-207-1 | NoNavInputs優先 | NavWindowがNoNavInputsフラグを持つ場合、常に非表示 | ウィンドウフラグ設定時 |
| BR-207-2 | AlwaysVisible設定 | ConfigNavCursorVisibleAlwaysがtrueの場合、常に表示 | IO設定時 |
| BR-207-3 | デフォルト動作 | 矢印キー使用で表示、マウスクリックで非表示 | 手動設定なし時 |

### 計算ロジック

可視性の最終決定：
```
if (NavWindow && (NavWindow->Flags & ImGuiWindowFlags_NoNavInputs)):
    visible = false
else if (io.ConfigNavCursorVisibleAlways):
    visible = true
// else: 引数の値をそのまま使用

g.NavCursorVisible = visible
```

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

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

本機能はデータベース操作を行わない（純粋なUI制御機能）。

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ機能なし（即時処理）

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

トランザクション管理なし（UI状態の更新）。

## パフォーマンス要件

- 軽量な処理（フラグの条件判定と設定のみ）
- オーバーヘッドは最小限

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

- 表示制御はUIの利便性機能であり、セキュリティ上のリスクはない

## 備考

- 関連関数としてSetNavCursorVisibleAfterMove()がある（内部用、移動後の自動表示）
- バージョン1.91.4以前はNavRestoreHighlightAfterMove()という名前だった
- io.ConfigNavCursorVisibleAutoがtrueの場合、自動表示機能が有効

---

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

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

### 推奨読解順序

#### Step 1: API宣言を理解する

公開APIの宣言とドキュメントコメントを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | SetNavCursorVisible関数の宣言（998行目） |

**主要処理フロー**:
- **997-998行目**: Keyboard/Gamepad Navigationセクションのコメントと関数宣言

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

SetNavCursorVisible関数の実装詳細を確認する。

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

**主要処理フロー**:
- **12961行目**: 関数定義の開始
- **12963-12965行目**: NoNavInputsウィンドウのチェック
- **12966-12967行目**: ConfigNavCursorVisibleAlwaysのチェック
- **12968行目**: NavCursorVisibleの設定

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

内部で使用される関連関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | SetNavCursorVisibleAfterMove関数（12972-12984行目） |

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

```
ImGui::SetNavCursorVisible(bool visible)
    │
    ├─ GImGui（グローバルコンテキスト取得）
    │
    ├─ g.NavWindow確認
    │      └─ ImGuiWindowFlags_NoNavInputsチェック
    │
    ├─ g.IO.ConfigNavCursorVisibleAlways確認
    │
    └─ g.NavCursorVisible = visible
```

### データフロー図

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

visible(bool) ────────▶ SetNavCursorVisible() ─▶ NavCursorVisible
                              │
NavWindow.Flags ──────▶       │
                              │
IO.ConfigNavCursor... ▶       │
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | 公開API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | 実装コード |
| imgui_internal.h | `imgui_internal.h` | ヘッダ | NavCursorVisibleの定義 |
