# 機能設計書 44-GetScrollY

## 概要

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

### 本機能の処理概要

**業務上の目的・背景**：ImGuiのウィンドウでは、コンテンツがウィンドウの表示領域を超えるとスクロールバーが表示される。UIの状態を把握したり、スクロール位置に応じた処理を行うためには、現在のスクロール量を取得する必要がある。`GetScrollY` は垂直方向のスクロール量を取得する関数で、スクロール位置の保存・復元、オートスクロール判定、条件付き描画最適化などに使用される。特に垂直スクロールはリストやログ表示で頻繁に使用されるため、重要度が高い。

**機能の利用シーン**：
- チャットログやコンソールでオートスクロールの判定を行う場合
- リスト表示で現在の表示位置を保存・復元する場合
- スクロール位置に基づいてコンテンツの仮想化（culling）を行う場合
- スクロール位置をUIに表示する場合（デバッグ目的）

**主要な処理内容**：
1. ImGuiContext からカレントウィンドウを取得
2. ウィンドウの `Scroll.y` フィールドから垂直スクロール量を取得
3. スクロール量を浮動小数点数として返却

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

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

## 関連画面

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

## 機能種別

スクロール / 値取得

## 入力仕様

### 入力パラメータ

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

### 入力データソース

ImGuiContext の CurrentWindow から取得

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| scroll_y | float | 垂直スクロール量（0 〜 GetScrollMaxY() の範囲） |

### 出力先

戻り値として呼び出し元に返却

## 処理フロー

### 処理シーケンス

```
1. GetScrollY() 呼び出し
   └─ 引数なし
2. ウィンドウ取得
   └─ GImGui->CurrentWindow からカレントウィンドウを取得
3. スクロール値の取得
   └─ window->Scroll.y を取得
4. 値の返却
   └─ スクロール量を返却
```

### フローチャート

```mermaid
flowchart TD
    A[GetScrollY 呼び出し] --> B[CurrentWindow 取得]
    B --> C[window->Scroll.y を取得]
    C --> D[スクロール量を返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-44-01 | 範囲制約 | 戻り値は 0 から GetScrollMaxY() の範囲 | 常時 |
| BR-44-02 | カレントウィンドウ参照 | 必ず Begin() と End() の間で呼び出す必要がある | 常時 |
| BR-44-03 | オートスクロール判定 | GetScrollY() >= GetScrollMaxY() で最下部にいるか判定可能 | 常時 |

### 計算ロジック

特になし（単純なフィールド参照）

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ不要

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

該当なし

## パフォーマンス要件

本関数は単純なフィールド参照のみを行い、O(1) の時間複雑度で完了する。

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

該当なし

## 備考

- GetScrollX と対で使用されることが多い
- 垂直スクロールバーが表示されていない場合でも呼び出し可能（0.0f を返す）
- 歴史的に `GetScrollPosY()` という名前だったが、1.42 で `GetScrollY()` にリネームされた
- デモコードでは、オートスクロール判定パターン `GetScrollY() >= GetScrollMaxY()` が頻繁に使用される

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: ImGuiWindow 構造体の `Scroll` フィールドは ImVec2 型で、x が水平、y が垂直スクロール量を保持する。

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

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

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

**主要処理フロー**:
1. **11842行目**: GImGui->CurrentWindow からカレントウィンドウを取得
2. **11843行目**: window->Scroll.y を返却

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.h | `imgui.h` | GetScrollY の宣言とコメント（495行目） |

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

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | imgui_demo.cpp | `imgui_demo.cpp` | スクロールデモでの使用例（4905-4906行目） |
| 4-2 | imgui_demo.cpp | `imgui_demo.cpp` | コンソールでのオートスクロール判定（9018行目） |

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

```
ユーザーコード
    │
    └─ GetScrollY()
           └─ GImGui->CurrentWindow->Scroll.y を返却
```

### データフロー図

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

なし ─────────▶ GetScrollY() ───▶ float (スクロール量)

                   ▲
                   │
         CurrentWindow->Scroll.y
```

### 関連ファイル一覧

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