# 機能設計書 72-Separator

## 概要

本ドキュメントは、Dear ImGuiライブラリのSeparator関数の機能設計を記述する。この関数は、ウィジェット間にセパレータ（区切り線）を追加するためのAPI関数である。

### 本機能の処理概要

Separator関数は、現在のレイアウト方向に応じて水平または垂直のセパレータ線を描画する。通常のウィンドウコンテキストでは水平線、メニューバーや水平レイアウト内では垂直線として表示される。視覚的にコンテンツを区切り、UIの可読性を向上させる。

**業務上の目的・背景**：GUIアプリケーションにおいて、関連するウィジェット群をグループ化し、異なるセクション間を視覚的に分離することは、ユーザビリティの観点から非常に重要である。Separatorは、フォームの各セクション、メニュー項目のグループ化、設定画面のカテゴリ分けなど、様々な場面でUIの構造を明確にするために使用される。シンプルながら効果的なUI要素として、アプリケーション全体の視認性と使いやすさを向上させる。

**機能の利用シーン**：メニュー内での項目グループの区切り、設定画面でのセクション分け、ツールバー内のツールグループの分離、プロパティパネルでのカテゴリ区切り、ダイアログボックス内のコンテンツ整理など、幅広い場面で利用される。

**主要な処理内容**：
1. 現在のウィンドウとレイアウト方向を確認する
2. レイアウト方向に応じてセパレータフラグを設定する（水平/垂直）
3. レガシーColumns API使用時は全カラムにまたがるフラグを追加する
4. SeparatorEx内部関数で実際のセパレータを描画する

**関連システム・外部連携**：この関数は純粋にImGui内部の描画に関わるため、外部システムとの連携はない。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 5 | About Window | 補助機能 | セクション間のセパレータ |
| 9 | Main Menu Bar | 補助機能 | メニュー内のセパレータ |

## 機能種別

レイアウト制御 / 描画

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力先

描画リスト（ImDrawList）にセパレータの矩形が追加される。

## 処理フロー

### 処理シーケンス

```
1. ウィンドウのSkipItemsフラグを確認
   └─ trueの場合は即座にreturn
2. 現在のレイアウト方向を確認
   └─ Horizontal: 垂直セパレータ
   └─ Vertical: 水平セパレータ
3. レガシーColumns使用中か確認
   └─ 使用中: SpanAllColumnsフラグを追加
4. SeparatorEx関数を呼び出し（厚さ1.0f）
   └─ 実際の描画処理を実行
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SkipItems?}
    B -->|Yes| C[return]
    B -->|No| D{LayoutType?}
    D -->|Horizontal| E[flags = Vertical]
    D -->|Vertical| F[flags = Horizontal]
    E --> G{CurrentColumns?}
    F --> G
    G -->|Yes| H[flags |= SpanAllColumns]
    G -->|No| I[SeparatorEx呼び出し]
    H --> I
    I --> J[終了]
    C --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 方向自動判定 | レイアウト方向に応じてセパレータの向きが自動決定される | 常時 |
| BR-02 | カラムスパン | レガシーColumns API使用時は全カラムにまたがる | CurrentColumnsが設定されている場合 |
| BR-03 | 厚さ固定 | Separator関数では厚さは1.0fで固定 | 常時 |

### 計算ロジック

水平セパレータの場合：
- x1: window->DC.CursorPos.x
- x2: window->WorkRect.Max.x
- y: window->DC.CursorPos.y
- 厚さ: 1.0f（レイアウトへの影響は0.0f）

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

該当なし

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

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

## パフォーマンス要件

軽量な描画操作。矩形を1つ描画リストに追加するのみ。

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

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

## 備考

- SeparatorText()関数を使用すると、テキスト付きのセパレータを描画可能
- スタイル設定でセパレータの色を変更可能（ImGuiCol_Separator）

---

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

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

### 推奨読解順序

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

セパレータのスタイル設定に関わる構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiCol_Separator（カラー定義）の確認 |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiSeparatorFlags_の定義を確認 |

**読解のコツ**: セパレータは単純な矩形描画だが、レイアウト方向やColumns対応など、コンテキストに応じた挙動の違いを理解することが重要。

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

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

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

**主要処理フロー**:
1. **1690-1692行目**: SkipItemsチェック
2. **1696行目**: LayoutTypeに応じたフラグ設定
3. **1699-1700行目**: CurrentColumns使用時のSpanAllColumnsフラグ追加
4. **1702行目**: SeparatorEx(flags, 1.0f)の呼び出し

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_widgets.cpp | `imgui_widgets.cpp` | SeparatorEx関数（1623-1685行目）で垂直/水平セパレータの描画処理 |

**主要処理フロー**:
- **1633-1647行目**: 垂直セパレータの処理
- **1648-1683行目**: 水平セパレータの処理
- **1674行目**: AddRectFilledで実際の描画

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

```
ImGui::Separator()
    │
    ├─ SkipItemsチェック
    │
    ├─ フラグ決定
    │      ├─ Horizontal Layout → Vertical Separator
    │      └─ Vertical Layout → Horizontal Separator
    │
    └─ SeparatorEx(flags, 1.0f)
           │
           ├─ ItemSize()
           │
           ├─ ItemAdd()
           │
           └─ DrawList->AddRectFilled()
```

### データフロー図

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

(なし) ──────────▶ Separator() ──────────▶ DrawList
                        │                    (矩形追加)
                        │
                        ├─ フラグ決定
                        │
                        └─ SeparatorEx()
                               │
                               └─ AddRectFilled(bb.Min, bb.Max, color)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | Separator関数の宣言（577行目） |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | Separator関数の実装（1687-1703行目） |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | SeparatorEx関数の実装（1623-1685行目） |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | ImGuiSeparatorFlags_の定義 |
