# 機能設計書 47-GetScrollMaxX

## 概要

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

### 本機能の処理概要

**業務上の目的・背景**：ウィンドウのスクロール範囲を把握することは、スクロールバーの実装、ユーザーへのフィードバック表示、スクロール制御などに不可欠である。`GetScrollMaxX` は水平方向の最大スクロール量を取得する関数で、コンテンツがどこまでスクロール可能かを示す。これはコンテンツサイズからウィンドウサイズと装飾サイズを引いた値として計算される。

**機能の利用シーン**：
- カスタムスクロールバーを実装する場合
- スクロール位置をパーセンテージで表示する場合
- 端末までスクロールしたかどうかを判定する場合
- スクロール可能かどうかを判定する場合（最大値が0より大きいか）

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

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

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

## 関連画面

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

## 機能種別

スクロール / 値取得

## 入力仕様

### 入力パラメータ

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

### 入力データソース

ImGuiContext の CurrentWindow から取得

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| scroll_max_x | float | 最大水平スクロール量（ContentSize.x - WindowSize.x - DecorationsSize.x の概算） |

### 出力先

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

## 処理フロー

### 処理シーケンス

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

### フローチャート

```mermaid
flowchart TD
    A[GetScrollMaxX 呼び出し] --> B[CurrentWindow 取得]
    B --> C[window->ScrollMax.x を取得]
    C --> D[最大スクロール量を返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-47-01 | 非負値 | 戻り値は 0 以上 | 常時 |
| BR-47-02 | カレントウィンドウ参照 | 必ず Begin() と End() の間で呼び出す必要がある | 常時 |
| BR-47-03 | スクロール可能判定 | 戻り値 > 0.0f でスクロール可能 | 常時 |

### 計算ロジック

ScrollMax.x の概算式:
```
ScrollMax.x ≒ ContentSize.x - WindowSize.x - DecorationsSize.x
```

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ不要

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

該当なし

## パフォーマンス要件

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

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

該当なし

## 備考

- GetScrollMaxY と対で使用されることが多い
- コンテンツがウィンドウ内に収まる場合は 0.0f を返す
- `GetScrollX() / GetScrollMaxX()` でスクロール位置の割合を計算可能

---

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

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

### 推奨読解順序

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

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

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

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

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

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

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

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

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

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

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

**主要処理フロー**:
- **498行目**: `IMGUI_API float GetScrollMaxX();` - 最大スクロール量は ContentSize.x - WindowSize.x - DecorationsSize.x の概算

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

```
ユーザーコード
    │
    └─ GetScrollMaxX()
           └─ GImGui->CurrentWindow->ScrollMax.x を返却
```

### データフロー図

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

なし ─────────▶ GetScrollMaxX() ───▶ float (最大スクロール量)

                   ▲
                   │
         CurrentWindow->ScrollMax.x
```

### 関連ファイル一覧

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