# 機能設計書 46-SetScrollY

## 概要

本ドキュメントは、ImGuiライブラリにおける `SetScrollY` 関数の機能設計を記述する。この関数は、現在のウィンドウの垂直方向スクロール量を設定するために使用される。

### 本機能の処理概要

**業務上の目的・背景**：ImGuiウィンドウのスクロール位置をプログラムから制御する必要がある場面は多い。特に垂直スクロールはリスト、ログ、テキストエディタなどで頻繁に使用される。`SetScrollY` は垂直方向のスクロール量を直接設定する関数で、ウィンドウ内のコンテンツ表示位置を制御できる。ページネーション、特定アイテムへのジャンプ、状態復元などに活用される。

**機能の利用シーン**：
- チャットログやコンソールで最新メッセージを表示する場合
- リスト表示で特定アイテムにジャンプする場合
- Page Up/Page Down によるページ移動を実装する場合
- 保存されたスクロール位置を復元する場合
- ズーム操作時にマウス位置を維持する場合

**主要な処理内容**：
1. 引数で渡されたスクロール値をウィンドウの `ScrollTarget.y` に設定
2. `ScrollTargetCenterRatio.y` を 0.0f に設定（上端揃え）
3. `ScrollTargetEdgeSnapDist.y` を 0.0f に設定（エッジスナップなし）
4. 次のフレームの `Begin()` 呼び出し時にスクロールが適用される

**関連システム・外部連携**：本機能はImGuiの内部システムのみで完結し、外部システムとの連携はない。

**権限による制御**：権限制御は存在しない。すべてのコンテキストで同様に動作する。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面機能マッピングに該当なし |

## 機能種別

スクロール / 値設定

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| scroll_y | float | Yes | 垂直スクロール量（0 〜 GetScrollMaxY() の範囲推奨） | 範囲外の値は自動的にクランプされる |

### 入力データソース

プログラムコード内で直接指定

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| なし | void | 戻り値なし（状態設定のみ） |

### 出力先

ImGuiWindow の ScrollTarget.y、ScrollTargetCenterRatio.y、ScrollTargetEdgeSnapDist.y に格納

## 処理フロー

### 処理シーケンス

```
1. SetScrollY(scroll_y) 呼び出し
   └─ 引数: scroll_y
2. オーバーロード解決
   └─ 公開API SetScrollY(float) が内部 SetScrollY(ImGuiWindow*, float) を呼び出し
3. ウィンドウ取得
   └─ ImGuiContext g から CurrentWindow を取得
4. スクロールターゲット設定
   └─ window->ScrollTarget.y = scroll_y
   └─ window->ScrollTargetCenterRatio.y = 0.0f
   └─ window->ScrollTargetEdgeSnapDist.y = 0.0f
5. 次フレームで適用
   └─ 次の Begin() 呼び出し時にスクロールが実行される
```

### フローチャート

```mermaid
flowchart TD
    A[SetScrollY 呼び出し] --> B[CurrentWindow 取得]
    B --> C[ScrollTarget.y に scroll_y を設定]
    C --> D[ScrollTargetCenterRatio.y を 0.0f に設定]
    D --> E[ScrollTargetEdgeSnapDist.y を 0.0f に設定]
    E --> F[関数終了]
    F --> G[次の Begin で適用]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-46-01 | 遅延適用 | スクロール変更は次のフレームの Begin() 呼び出し時に適用される | 常時 |
| BR-46-02 | カレントウィンドウ参照 | Begin() と End() の間で呼び出す必要がある | 常時 |
| BR-46-03 | 値のクランプ | 範囲外の値は 0 〜 ScrollMax.y の範囲にクランプされる | 常時 |
| BR-46-04 | 代替手段 | フレーム遅延を避けたい場合は SetNextWindowScroll を使用 | オプション |
| BR-46-05 | リセット | SetScrollY(0.0f) で最上部にスクロール | 常時 |

### 計算ロジック

特になし

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| なし | - | 本関数はエラーを発生させない | - |

### リトライ仕様

リトライ不要

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

該当なし

## パフォーマンス要件

本関数は単純な値の設定のみを行い、O(1) の時間複雑度で完了する。

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

該当なし

## 備考

- SetScrollX と対で使用されることが多い
- 内部的には ImGuiWindow* を引数に取るオーバーロードが存在し、公開API は CurrentWindow に対して呼び出す
- マウスホイール、ナビゲーション、Page Up/Down でのスクロールも内部的に SetScrollY を使用する
- デモコードでは複数の使用例がある（4887行目、10913行目など）

---

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

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

### 推奨読解順序

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

まず、スクロールターゲットを保持する ImGuiWindow 構造体を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindow 構造体の ScrollTarget フィールド（2668-2670行目） |

**読解のコツ**: ImGuiWindow 構造体には `Scroll`（現在のスクロール値）と `ScrollTarget`（次フレームで適用されるスクロール値）がある。`ScrollTarget` は FLT_MAX で「変更なし」を表す。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | SetScrollY(float) 公開API（11878-11882行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | SetScrollY(ImGuiWindow*, float) 内部関数（11865-11870行目） |

**主要処理フロー**:
1. **11880-11881行目**: ImGuiContext g を取得し、CurrentWindow に対して内部 SetScrollY を呼び出し
2. **11867行目**: window->ScrollTarget.y = scroll_y
3. **11868行目**: window->ScrollTargetCenterRatio.y = 0.0f
4. **11869行目**: window->ScrollTargetEdgeSnapDist.y = 0.0f

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

公開APIとしての宣言を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.h | `imgui.h` | SetScrollY の宣言とコメント（497行目） |
| 3-2 | imgui_internal.h | `imgui_internal.h` | 内部 SetScrollY の宣言（3258行目） |

**主要処理フロー**:
- **497行目**: `IMGUI_API void SetScrollY(float scroll_y);` - スクロール量は 0 から GetScrollMaxY() の範囲

#### Step 4: 使用例を確認する

デモコードでの使用例を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | imgui_demo.cpp | `imgui_demo.cpp` | スクロールデモでの使用例（4887行目） |
| 4-2 | imgui_demo.cpp | `imgui_demo.cpp` | アセットブラウザでの使用例（10913行目） |

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

```
ユーザーコード
    │
    └─ SetScrollY(scroll_y)  [公開API]
           │
           └─ SetScrollY(window, scroll_y)  [内部関数]
                  └─ window->ScrollTarget.y = scroll_y
                  └─ window->ScrollTargetCenterRatio.y = 0.0f
                  └─ window->ScrollTargetEdgeSnapDist.y = 0.0f
```

### データフロー図

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

float scroll_y ───▶ SetScrollY() ───▶ window->ScrollTarget.y
                                       window->ScrollTargetCenterRatio.y
                                       window->ScrollTargetEdgeSnapDist.y

                         ▼

                   次の Begin() でスクロール適用
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 公開API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | SetScrollY の実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | 内部関数宣言、ImGuiWindow 構造体定義 |
| imgui_demo.cpp | `imgui_demo.cpp` | ソース | 使用例 |
