# 機能設計書 69-GetContentRegionAvail

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける`GetContentRegionAvail`関数の機能設計を定義する。この関数は、現在のカーソル位置から利用可能な残りスペースを取得する。

### 本機能の処理概要

GetContentRegionAvail関数は、現在のウィンドウ内で、カーソル位置からコンテンツ領域の終端までの利用可能なスペースを計算して返す。ImGuiの公式ドキュメントで「YOUR BEST FRIEND」と呼ばれる最も推奨される領域取得関数である。

**業務上の目的・背景**：GUIアプリケーションでは、ウィジェットを配置する際に利用可能なスペースを把握することが重要である。特に、ウィンドウサイズに応じたレスポンシブなレイアウトや、残りスペースを埋めるウィジェットの実装において不可欠な情報となる。GetContentRegionAvailは、テーブルや列の中でも正しく機能し、最も信頼性の高い領域取得方法である。

**機能の利用シーン**：
- ウィンドウ幅に合わせてウィジェットをリサイズする場合
- 残りスペースを埋めるカスタムウィジェットの作成
- 動的なレイアウト計算
- CalcItemWidthでの負値計算

**主要な処理内容**：
1. 現在のウィンドウを取得
2. コンテンツ領域の最大位置を決定（テーブル/列内ではWorkRect.Max、それ以外ではContentRegionRect.Max）
3. 現在のカーソル位置との差を計算して返す

**関連システム・外部連携**：GetCursorScreenPosと共に使用することで、ほとんどのレイアウト処理が可能。CalcItemWidthで負の値が指定された場合にも内部で使用される。

**権限による制御**：特になし。任意のウィンドウコンテキスト内で使用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 特定の画面に紐づかない汎用機能 |

## 機能種別

領域取得 / レイアウト支援

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- ImGuiWindow::DC.CursorPos（現在のカーソル位置）
- ImGuiWindow::WorkRect.Max（テーブル/列使用時）
- ImGuiWindow::ContentRegionRect.Max（通常時）
- ImGuiWindow::DC.CurrentColumns（列使用中フラグ）
- ImGuiContext::CurrentTable（テーブル使用中フラグ）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | ImVec2 | 利用可能なスペース（幅と高さ、ピクセル単位） |

### 出力先

- 呼び出し元への戻り値として返却

## 処理フロー

### 処理シーケンス

```
1. グローバルコンテキストGImGuiを取得
   └─ ImGuiContext& g = *GImGui

2. 現在のウィンドウを取得
   └─ ImGuiWindow* window = g.CurrentWindow

3. コンテンツ領域の最大位置を決定
   └─ テーブルまたは列を使用中: window->WorkRect.Max
   └─ それ以外: window->ContentRegionRect.Max

4. 利用可能スペースを計算
   └─ return mx - window->DC.CursorPos
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[グローバルコンテキスト取得]
    B --> C[現在のウィンドウ取得]
    C --> D{テーブルまたは列を使用中?}
    D -->|Yes| E[mx = WorkRect.Max]
    D -->|No| F[mx = ContentRegionRect.Max]
    E --> G[return mx - CursorPos]
    F --> G
    G --> H[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-69-01 | コンテキスト依存 | テーブルや列の中では、それらの領域を基準に計算される | CurrentColumns または CurrentTable が設定されている場合 |
| BR-69-02 | 推奨使用法 | GetContentRegionMax()などの旧APIより推奨される | 常時 |
| BR-69-03 | 動的な値 | カーソル位置に応じて値が変化する | 常時 |

### 計算ロジック

```cpp
ImVec2 mx = (window->DC.CurrentColumns || g.CurrentTable)
            ? window->WorkRect.Max
            : window->ContentRegionRect.Max;
return mx - window->DC.CursorPos;
```

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- O(1)の定数時間操作
- 単純な計算のみで非常に軽量

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

特になし

## 備考

- ImGuiコメントで「THIS IS YOUR BEST FRIEND」と記載されており、最も推奨される領域取得方法
- GetContentRegionMax()、GetWindowContentRegionMin()、GetWindowContentRegionMax()は廃止予定（obsoleted）で、この関数を使用することが推奨される
- GetCursorScreenPos()と組み合わせることで、99%のレイアウト処理が可能

---

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

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

### 推奨読解順序

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

まず、領域計算に関連するデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindow構造体内のWorkRect、ContentRegionRect定義（2716、2719行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiWindowTempData構造体内のCursorPos、CurrentColumns定義 |

**読解のコツ**: WorkRectはテーブル等のコンテナで縮小される作業領域、ContentRegionRectはスクロールを考慮しない領域。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | GetContentRegionAvailの関数宣言（567行目）とコメント |

**主要処理フロー**:
1. **567行目**: 関数宣言と「THIS IS YOUR BEST FRIEND」というコメント

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | GetContentRegionAvail関数の実装（11577-11583行目） |

**主要処理フロー**:
- **11579-11580行目**: コンテキストとウィンドウの取得
- **11581行目**: テーブル/列使用時はWorkRect.Max、それ以外はContentRegionRect.Maxを使用
- **11582行目**: 最大位置からカーソル位置を引いて返す

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

```
GetContentRegionAvail()
    │
    ├─ g.CurrentWindow を参照
    │
    ├─ CurrentColumns / CurrentTable チェック
    │      │
    │      ├─ (true)  → WorkRect.Max
    │      │
    │      └─ (false) → ContentRegionRect.Max
    │
    └─ mx - DC.CursorPos を計算して返す
```

### データフロー図

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

DC.CursorPos ─────────┐
                      │
WorkRect.Max ─────────┼───▶ GetContentRegionAvail() ──▶ ImVec2（利用可能スペース）
                      │
ContentRegionRect.Max ┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | 公開API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | 関数実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダ | 内部データ構造定義 |
