# 機能設計書 74-NewLine

## 概要

本ドキュメントは、Dear ImGuiライブラリのNewLine関数の機能設計を記述する。この関数は、SameLine()を取り消すか、水平レイアウトコンテキスト内で強制的に改行するためのAPI関数である。

### 本機能の処理概要

NewLine関数は、水平レイアウトモードを終了し、垂直レイアウトに戻すための関数である。SameLine()で開始した水平配置を取り消し、次のウィジェットを新しい行に配置する。また、現在の行に高さがない場合はフォントサイズ分の高さを確保する。

**業務上の目的・背景**：複雑なUIレイアウトでは、水平配置と垂直配置を自在に切り替える必要がある。例えば、複数のボタンを横に並べた後で次のセクションを新しい行から開始したい場合や、条件によって水平配置を途中でキャンセルしたい場合がある。NewLineは、SameLine()との組み合わせで、柔軟なレイアウト制御を実現する。特に、動的に変化するUIやレスポンシブなレイアウトを構築する際に重要な役割を果たす。

**機能の利用シーン**：SameLine()による水平配置の明示的な終了、条件分岐によるレイアウト切り替え、グループ内での強制改行、複雑なカスタムレイアウトの構築などで使用される。

**主要な処理内容**：
1. ウィンドウのSkipItemsフラグを確認する
2. 一時的にLayoutTypeをVerticalに設定する
3. IsSameLineフラグをfalseに設定する
4. 現在の行の高さに応じてItemSizeを呼び出す
5. LayoutTypeを元に戻す

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 24 | Layout | 主機能 | 改行のデモ |

## 機能種別

レイアウト制御

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力先

現在のウィンドウのDrawing Context（DC）を更新する。

## 処理フロー

### 処理シーケンス

```
1. ウィンドウのSkipItemsフラグを確認
   └─ trueの場合は即座にreturn
2. 現在のLayoutTypeを保存
   └─ backup_layout_type = DC.LayoutType
3. LayoutTypeをVerticalに設定
   └─ DC.LayoutType = ImGuiLayoutType_Vertical
4. IsSameLineをfalseに設定
   └─ SameLine状態の解除
5. 行の高さに応じてItemSize呼び出し
   5a. CurrLineSize.y > 0 の場合
       └─ ItemSize(ImVec2(0, 0)) - 既存の行高さを使用
   5b. CurrLineSize.y == 0 の場合
       └─ ItemSize(ImVec2(0, FontSize)) - フォントサイズ分の高さを確保
6. LayoutTypeを元に戻す
   └─ DC.LayoutType = backup_layout_type
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SkipItems?}
    B -->|Yes| C[return]
    B -->|No| D[LayoutTypeを保存]
    D --> E[LayoutType = Vertical]
    E --> F[IsSameLine = false]
    F --> G{CurrLineSize.y > 0?}
    G -->|Yes| H[ItemSize 0,0]
    G -->|No| I[ItemSize 0,FontSize]
    H --> J[LayoutType復元]
    I --> J
    J --> K[終了]
    C --> K
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | SameLine解除 | IsSameLineフラグをfalseに設定することでSameLine状態を解除する | 常時 |
| BR-02 | 最小行高さ | 現在の行に高さがない場合、フォントサイズ分の高さを確保する | CurrLineSize.y == 0 の場合 |
| BR-03 | LayoutType復元 | 一時的にVerticalに変更したLayoutTypeを処理後に復元する | 常時 |

### 計算ロジック

行の高さの決定：
- CurrLineSize.y > 0: 既存の行高さを維持
- CurrLineSize.y == 0: g.FontSize をデフォルト高さとして使用

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

該当なし

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

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

## パフォーマンス要件

非常に軽量な操作。ItemSize呼び出しを含むが、基本的には座標計算とフラグ設定のみ。

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

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

## 備考

- SameLine()の対となる関数として設計されている
- Spacing()と異なり、IsSameLineフラグを明示的にfalseに設定する
- 水平レイアウトコンテキスト（メニューバー等）での改行にも使用可能

---

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

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

### 推奨読解順序

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

レイアウト状態に関わるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindowTempData構造体のIsSameLine、LayoutType、CurrLineSizeフィールドを確認（2587-2638行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiLayoutType_の定義を確認（Vertical/Horizontal） |

**読解のコツ**: IsSameLineはSameLine()が呼び出されたかどうかを示すフラグ。NewLine()はこれを明示的にfalseに設定する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui_widgets.cpp | `imgui_widgets.cpp` | NewLine関数の実装（1592-1607行目） |

**主要処理フロー**:
1. **1594-1596行目**: SkipItemsチェック
2. **1599行目**: LayoutTypeのバックアップ
3. **1600行目**: LayoutTypeをVerticalに設定
4. **1601行目**: IsSameLine = false
5. **1602-1605行目**: 行の高さに応じたItemSize呼び出し
6. **1606行目**: LayoutTypeの復元

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | SameLine関数（11354-11378行目）でIsSameLine = trueの設定を確認 |
| 3-2 | imgui_widgets.cpp | `imgui_widgets.cpp` | Spacing関数（1573-1579行目）との違いを確認（IsSameLineを操作しない） |

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

```
ImGui::NewLine()
    │
    ├─ SkipItemsチェック
    │
    ├─ LayoutTypeバックアップ
    │      └─ backup_layout_type = DC.LayoutType
    │
    ├─ DC.LayoutType = Vertical
    │
    ├─ DC.IsSameLine = false
    │
    ├─ 分岐: CurrLineSize.y > 0
    │      │
    │      ├─ Yes: ItemSize(0, 0)
    │      │
    │      └─ No: ItemSize(0, FontSize)
    │
    └─ DC.LayoutType = backup_layout_type
```

### データフロー図

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

(なし) ──────────▶ NewLine() ──────────▶ DC.IsSameLine = false
                        │
                        ├────────────────▶ DC.LayoutType
                        │                  (一時的にVertical、後に復元)
                        │
                        └─ ItemSize() ──▶ DC.CursorPos
                                          (次の行の開始位置に更新)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | NewLine関数の宣言（579行目） |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | NewLine関数の実装（1592-1607行目） |
| imgui.cpp | `imgui.cpp` | ソース | SameLine関数の実装（11354-11378行目） |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | ImGuiWindowTempData構造体、ImGuiLayoutType_の定義 |
