# 通知設計書 25-PopupBorderSize

## 概要

本ドキュメントは、ImGuiライブラリにおける`PopupBorderSize`スタイル設定の仕様と動作を定義する設計書である。このスタイル設定は、ポップアップ/ツールチップウィンドウの枠線（ボーダー）の太さを制御する。

### 本通知の処理概要

`PopupBorderSize`は、ImGuiStyleの一部としてポップアップウィンドウおよびツールチップウィンドウの枠線の太さをピクセル単位で定義するfloat値である。この設定により、ポップアップの境界を明確にし、背景コンテンツとの視覚的な分離を強調できる。

**業務上の目的・背景**：ポップアップやツールチップは一時的に表示されるオーバーレイ要素であり、背景コンテンツとの区別が重要である。枠線を追加することで、ポップアップの境界が明確になり、ユーザーにとって認識しやすくなる。デザインによっては枠線なし（0.0f）でクリーンな外観を、または細い枠線（1.0f）で境界を強調する選択ができる。

**通知の送信タイミング**：この値は、ポップアップまたはツールチップウィンドウの描画時に参照される。具体的には、`Begin()`関数内でウィンドウの`WindowBorderSize`を決定する際に使用される。

**通知の受信者**：ImGuiの描画システム（レンダラー）が受信者である。ウィンドウボーダーの描画時に`ImDrawList::AddRect()`などで参照される。

**通知内容の概要**：ピクセル単位のボーダー太さ（float値）を伝達する。デフォルト値は1.0f。

**期待されるアクション**：開発者はこの値を調整してポップアップの枠線を制御する。通常は0.0f（枠線なし）または1.0f（細い枠線）が推奨される。他の値はテストが不十分でCPU/GPUコストが増加する可能性がある。

## 通知種別

スタイル設定値（float）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（即時反映） |
| 優先度 | 中 |
| リトライ | 無 |

### 送信先決定ロジック

スタイル値は`ImGuiStyle::PopupBorderSize`に格納され、ポップアップ/ツールチップウィンドウの描画時に自動的に参照される。

## 通知テンプレート

### スタイル定義

| 項目 | 内容 |
|-----|------|
| スタイル名 | PopupBorderSize |
| 型 | float |
| 定義場所 | imgui.h:2295 |
| 関連StyleVar | ImGuiStyleVar_PopupBorderSize |

### デフォルト値

| 項目 | 値 |
|------|-----|
| デフォルト | 1.0f |
| 推奨最小値 | 0.0f |
| 推奨最大値 | 1.0f |

### 使用例

```cpp
// スタイル全体で設定
ImGuiStyle& style = ImGui::GetStyle();
style.PopupBorderSize = 0.0f;  // 枠線なし

// 一時的に変更（PushStyleVar/PopStyleVar）
ImGui::PushStyleVar(ImGuiStyleVar_PopupBorderSize, 2.0f);
if (ImGui::BeginPopup("bordered_popup"))
{
    ImGui::Text("Popup with border");
    ImGui::EndPopup();
}
ImGui::PopStyleVar();
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| PopupBorderSize | 枠線の太さ（ピクセル） | ImGuiStyle::PopupBorderSize | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 描画 | ポップアップ/ツールチップ描画 | ウィンドウが開いている | 枠線描画に使用 |
| API呼び出し | ImGuiStyle初期化 | スタイル初期化時 | デフォルト値設定 |
| API呼び出し | PushStyleVar | 一時的変更時 | スタック上に値を積む |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 値が0.0f | 枠線描画がスキップされる |
| モーダルウィンドウ | モーダルはWindowBorderSizeを使用 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BeginPopup/BeginTooltip呼び出し] --> B[Begin関数呼び出し]
    B --> C{ウィンドウタイプ判定}
    C -->|Child| D[WindowBorderSize = ChildBorderSize]
    C -->|Popup/Tooltip && !Modal| E[WindowBorderSize = PopupBorderSize]
    C -->|Other| F[WindowBorderSize = WindowBorderSize]
    E --> G{BorderSize > 0?}
    G -->|Yes| H[ウィンドウ枠線描画]
    G -->|No| I[枠線描画スキップ]
    H --> J[AddRect with WindowBorderSize]
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（ImGuiはメモリベースの即時モードGUI）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 負の値 | 負数を設定 | 0にクランプされる |
| 過大な値 | 大きな値を設定 | CPU/GPUコスト増加、視覚的問題 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0 |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 無制限 |
| 1日あたり上限 | 無制限 |

### 配信時間帯

制限なし（フレームごとに評価）

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

特になし。スタイル設定は視覚的な表示のみに影響する。

## 備考

- ツールチップにも適用される（`PopupRounding`とは異なる）
- モーダルウィンドウには`WindowBorderSize`が適用される
- 0.0fまたは1.0fが推奨値。他の値は十分にテストされていない
- 大きな値はCPU/GPUコストが増加する可能性がある
- 枠線の色は`ImGuiCol_Border`で制御される

---

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

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

### 推奨読解順序

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

スタイル値の定義位置を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiStyle::PopupBorderSize定義（2295行目） |
| 1-2 | imgui.h | `imgui.h` | ImGuiStyleVar_PopupBorderSize定義（1827行目） |

**読解のコツ**: コメントに「0.0f or 1.0f」が推奨と記載されている点に注意。

#### Step 2: デフォルト値と初期化を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | ImGuiStyle::ImGuiStyle()コンストラクタ（1459行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | ScaleAllSizes関数（1538行目） |

**主要処理フロー**:
1. **1459行目**: デフォルト値1.0fの設定
2. **1538行目**: スケーリング時の自動調整

#### Step 3: 適用箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | Begin関数内のWindowBorderSize設定（7591-7594行目） |

**主要処理フロー**:
- **7591-7594行目**: ウィンドウタイプに応じたBorderSize値の選択ロジック
  - `ChildWindow` → `ChildBorderSize`
  - `(Popup | Tooltip) && !Modal` → `PopupBorderSize`
  - その他 → `WindowBorderSize`

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

```
ImGuiStyle::ImGuiStyle()
    |
    +-- PopupBorderSize = 1.0f

BeginPopup() / BeginTooltip()
    |
    +-- Begin() [with popup/tooltip flags]
           |
           +-- window->WindowBorderSize =
           |      (flags & ChildWindow) ? ChildBorderSize :
           |      ((flags & (Popup | Tooltip)) && !(flags & Modal)) ? PopupBorderSize :
           |      WindowBorderSize
           |
           +-- RenderWindowDecorations()
                  |
                  +-- if (WindowBorderSize > 0.0f)
                         |
                         +-- ImDrawList::AddRect(..., WindowBorderSize)
```

### データフロー図

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

ImGuiStyle.PopupBorderSize ───> Begin() ウィンドウタイプ判定 ───> window->WindowBorderSize
                                     |
                                     v
                               RenderWindowDecorations()
                                     |
                                     v
                               枠線描画（BorderSize > 0の場合）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | PopupBorderSize定義（2295行目）、StyleVar定義（1827行目） |
| imgui.cpp | `imgui.cpp` | ソース | 初期化（1459行目）、WindowBorderSize設定（7591-7594行目） |
| imgui.cpp | `imgui.cpp` | ソース | ScaleAllSizes（1538行目） |
| imgui.cpp | `imgui.cpp` | ソース | GStyleVarInfo配列（3607行目） |
