# 機能設計書 79-BeginGroup

## 概要

本ドキュメントは、Dear ImGuiライブラリのBeginGroup関数の機能設計を記述する。この関数は、水平開始位置をロックし、複数のウィジェットをグループとしてまとめるためのAPI関数である。

### 本機能の処理概要

BeginGroup関数は、グループの開始を宣言し、現在のレイアウト状態（カーソル位置、インデント、行サイズ等）をスタックに保存する。グループ内のすべてのウィジェットは、EndGroup()呼び出し時に1つの「アイテム」として扱われ、IsItemHovered()やSameLine()などのアイテム系関数をグループ全体に適用可能になる。

**業務上の目的・背景**：複雑なUIでは、複数のウィジェットを論理的・視覚的に1つの単位として扱いたい場面が多い。例えば、ラベルと入力フィールドのペア、複数のボタンのセット、カスタムコンポジットウィジェットなどである。BeginGroup/EndGroupは、これらを1つのアイテムとしてグループ化し、グループ全体へのホバー検出、グループ単位でのSameLine配置、グループのバウンディングボックス取得を可能にする。これにより、再利用可能なUIコンポーネントの構築や、複雑なレイアウトの実現が容易になる。

**機能の利用シーン**：複数ウィジェットの水平配置、カスタムコンポジットウィジェットの作成、グループ全体へのホバー検出、レイアウトのバウンディングボックス取得、条件付きグループ表示などで使用される。

**主要な処理内容**：
1. 現在のレイアウト状態をImGuiGroupData構造体に保存する
2. GroupStackに新しいグループデータをプッシュする
3. グループ内のレイアウト状態を初期化する
4. GroupOffsetを設定する

**関連システム・外部連携**：この関数は純粋にImGui内部のレイアウト管理に関わるため、外部システムとの連携はない。

**権限による制御**：権限による制御は存在しない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 24 | Layout | 主機能 | グループの開始 |

## 機能種別

レイアウト制御 / グループ管理

## 入力仕様

### 入力パラメータ

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

### 入力データソース

ユーザーコードから直接呼び出される。

## 出力仕様

### 出力データ

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

### 出力先

グローバルコンテキストのGroupStackに新しいグループデータをプッシュし、ウィンドウのDCを更新する。

## 処理フロー

### 処理シーケンス

```
1. グローバルコンテキストとウィンドウを取得
   └─ g = *GImGui, window = g.CurrentWindow
2. GroupStackをリサイズして新しいエントリを追加
   └─ g.GroupStack.resize(Size + 1)
3. 現在の状態をgroup_dataにバックアップ
   └─ BackupCursorPos, BackupCursorMaxPos, BackupIndent等
4. グループ用のレイアウト状態を初期化
   └─ GroupOffset設定、CursorMaxPos初期化、CurrLineSize初期化
5. EmitItem = trueを設定
   └─ EndGroup()でアイテムを生成するフラグ
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[ウィンドウ取得]
    B --> C[GroupStackに新エントリ追加]
    C --> D[現在の状態をバックアップ]
    D --> E[GroupOffset設定]
    E --> F[CursorMaxPos初期化]
    F --> G[CurrLineSize初期化]
    G --> H[EmitItem = true]
    H --> I[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | ペア使用 | 必ずEndGroup()と対で使用する必要がある | 常時 |
| BR-02 | ネスト可能 | BeginGroup/EndGroupはネスト可能 | 常時 |
| BR-03 | 状態保存 | カーソル位置、インデント、行サイズ等の状態が保存される | 常時 |

### 計算ロジック

GroupOffsetの計算：
```
DC.GroupOffset.x = DC.CursorPos.x - window->Pos.x - DC.ColumnsOffset.x
DC.Indent = DC.GroupOffset
```

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

該当なし（メモリ内操作のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | アサーション | EndGroup()が不足している場合 | 必ずペアで呼び出す |

### リトライ仕様

該当なし

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

該当なし（フレーム単位の即座反映）

## パフォーマンス要件

軽量な操作。GroupStackへのプッシュと状態のコピーのみ。

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

特になし（純粋なUI操作）

## 備考

- EndGroup()と必ずペアで使用すること
- グループ内のウィジェットはEndGroup()後に1つのアイテムとして扱われる
- IsItemHovered()、GetItemRectMin/Max()等がグループ全体に適用可能
- グループはネスト可能

---

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

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

### 推奨読解順序

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

グループ管理に関わるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiGroupData構造体の定義（1171-1187行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiContext構造体のGroupStack（2307行目） |

**読解のコツ**: ImGuiGroupDataはグループ開始時の状態をバックアップするための構造体。BackupCursorPos、BackupIndent等のフィールドでレイアウト状態を保存する。

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

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

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

**主要処理フロー**:
1. **11612-11613行目**: グローバルコンテキストとウィンドウを取得
2. **11615-11616行目**: GroupStackに新しいエントリを追加
3. **11618-11630行目**: 現在の状態をgroup_dataにバックアップ
4. **11632-11635行目**: グループ用のレイアウト状態を初期化
5. **11636-11637行目**: ログ出力対応

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | EndGroup関数（11640-11704行目）でグループ終了時の処理を確認 |

**主要処理フロー**:
- **11653行目**: グループのバウンディングボックス計算
- **11672-11673行目**: ItemSize/ItemAddでグループをアイテムとして登録
- **11679-11700行目**: ActiveId、HoveredId等のステータス転送

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

```
ImGui::BeginGroup()
    │
    ├─ GImGui, CurrentWindow取得
    │
    ├─ GroupStack.resize(Size + 1)
    │
    ├─ 状態バックアップ
    │      ├─ BackupCursorPos
    │      ├─ BackupCursorMaxPos
    │      ├─ BackupCursorPosPrevLine
    │      ├─ BackupIndent
    │      ├─ BackupGroupOffset
    │      ├─ BackupCurrLineSize
    │      ├─ BackupCurrLineTextBaseOffset
    │      ├─ BackupActiveIdIsAlive
    │      ├─ BackupHoveredIdIsAlive
    │      ├─ BackupIsSameLine
    │      └─ BackupActiveIdHasBeenEditedThisFrame
    │
    ├─ GroupOffset設定
    │      └─ DC.GroupOffset.x = CursorPos.x - Pos.x - ColumnsOffset.x
    │
    ├─ DC.Indent = DC.GroupOffset
    │
    ├─ DC.CursorMaxPos = DC.CursorPos
    │
    └─ DC.CurrLineSize = ImVec2(0, 0)
```

### データフロー図

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

(なし) ──────────▶ BeginGroup() ──────────▶ GroupStack
                        │                    (新エントリ追加)
                        │
                        ├────────────────▶ ImGuiGroupData
                        │                    (状態バックアップ)
                        │
                        └────────────────▶ DC
                                             (GroupOffset, CursorMaxPos更新)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | BeginGroup関数の宣言（584行目） |
| imgui.cpp | `imgui.cpp` | ソース | BeginGroup関数の実装（11610-11638行目） |
| imgui.cpp | `imgui.cpp` | ソース | EndGroup関数の実装（11640-11704行目） |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | ImGuiGroupData構造体の定義（1171-1187行目） |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | ImGuiContext構造体のGroupStack（2307行目） |
