# 機能設計書 75-Spacing

## 概要

本ドキュメントは、Dear ImGuiライブラリのSpacing関数の機能設計を記述する。この関数は、垂直スペースを追加するためのAPI関数である。

### 本機能の処理概要

Spacing関数は、現在のカーソル位置に垂直方向のスペース（余白）を追加する。ItemSize(0, 0)を呼び出すことで、style.ItemSpacing.y分の垂直スペースを確保する。視覚的にはウィジェット間に空白行を挿入する効果がある。

**業務上の目的・背景**：GUIレイアウトにおいて、ウィジェット間の視覚的な分離や、セクション間の余白確保は重要なデザイン要素である。Separator()が視覚的な区切り線を描画するのに対し、Spacing()は透明な余白を追加する。これにより、UIの視覚的なグループ化や、読みやすさの向上、デザインの一貫性維持が可能となる。コンパクトなUIとゆったりとしたUIを状況に応じて切り替える際にも活用される。

**機能の利用シーン**：フォーム内のセクション間の余白追加、ウィジェットグループ間の視覚的分離、リスト項目間の間隔調整、テキストブロック間のスペース確保、レイアウトの微調整などで使用される。

**主要な処理内容**：
1. ウィンドウのSkipItemsフラグを確認する
2. ItemSize(ImVec2(0, 0))を呼び出す
3. style.ItemSpacing.y分のスペースが自動的に追加される

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

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

## 関連画面

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

## 機能種別

レイアウト制御

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. ウィンドウのSkipItemsフラグを確認
   └─ trueの場合は即座にreturn
2. ItemSize(ImVec2(0, 0))を呼び出す
   └─ アイテムサイズは0x0だが、ItemSpacing.yが自動追加される
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SkipItems?}
    B -->|Yes| C[return]
    B -->|No| D[ItemSize 0,0]
    D --> E[終了]
    C --> E
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | スペース量 | スペース量はstyle.ItemSpacing.yによって決まる | 常時 |
| BR-02 | ゼロサイズアイテム | ItemSizeに(0,0)を渡すが、内部でItemSpacing.yが追加される | 常時 |

### 計算ロジック

実際に追加されるスペースの高さ：
```
vertical_space = style.ItemSpacing.y
```

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

該当なし

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

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

## パフォーマンス要件

非常に軽量な操作。ItemSize呼び出し1回のみ。

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

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

## 備考

- Dummy(ImVec2(0, height))で任意の高さのスペースを作成可能
- 複数回呼び出すことで複数行分のスペースを追加可能
- NewLine()と異なり、IsSameLineフラグを操作しない

---

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

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

### 推奨読解順序

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

スタイル設定に関わるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiStyle構造体のItemSpacingフィールドを確認 |

**読解のコツ**: ItemSpacingはImVec2型で、xが水平方向、yが垂直方向のスペーシングを定義する。Spacing()関数はItemSpacing.yを利用する。

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

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

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

**主要処理フロー**:
1. **1575行目**: GetCurrentWindow()でウィンドウを取得
2. **1576-1577行目**: SkipItemsチェック
3. **1578行目**: ItemSize(ImVec2(0, 0))の呼び出し

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | ItemSize関数の実装で、ItemSpacing.yがどのように追加されるかを確認 |

**主要処理フロー**:
- ItemSize内部でCursorPos.yにsize.y + ItemSpacing.yが追加される

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

```
ImGui::Spacing()
    │
    ├─ GetCurrentWindow()
    │
    ├─ SkipItemsチェック
    │
    └─ ItemSize(ImVec2(0, 0))
           │
           └─ CursorPos.y += 0 + ItemSpacing.y
```

### データフロー図

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

(なし) ──────────▶ Spacing() ──────────▶ DC.CursorPos.y
                        │                  (ItemSpacing.y分増加)
                        │
                        └─ ItemSize(0, 0)
                               │
                               └─ +style.ItemSpacing.y
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | Spacing関数の宣言（580行目） |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | Spacing関数の実装（1573-1579行目） |
| imgui.h | `imgui.h` | ヘッダー | ImGuiStyle構造体のItemSpacing定義 |
