# 機能設計書 61-PushItemWidth

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける`PushItemWidth`関数の機能設計を定義する。この関数は、ウィジェットの幅をスタックにプッシュし、以降のウィジェット描画時に適用されるアイテム幅を設定する。

### 本機能の処理概要

PushItemWidth関数は、ImGuiにおける「アイテム+ラベル」型ウィジェット（InputText、DragFloat、SliderInt等）の幅を制御するためのスタックベースの設定機能を提供する。

**業務上の目的・背景**：GUIアプリケーションでは、ウィジェットの配置とサイズを精密に制御することが重要である。特に、フォームやプロパティエディタなど、複数のウィジェットを整列させる場面では、一貫したアイテム幅の設定が必要となる。PushItemWidthは、ネストされた構造でも幅設定を維持・復元できるスタック機構を提供し、複雑なUI構築を可能にする。

**機能の利用シーン**：
- プロパティエディタで複数の入力フィールドを同じ幅に揃えたい場合
- ウィンドウ幅に応じてウィジェット幅を動的に調整したい場合（負の値でウィンドウ右端からの相対位置指定）
- TreeNodeやCollapsingHeaderなどのネスト構造内で、異なる幅設定を適用したい場合

**主要な処理内容**：
1. 現在のアイテム幅（window->DC.ItemWidth）をスタックにバックアップ
2. 引数で指定された幅を新しいアイテム幅として設定
3. 引数が0.0fの場合はデフォルト幅（ItemWidthDefault）を使用
4. NextItemDataフラグをクリアして、SetNextItemWidthの影響を無効化

**関連システム・外部連携**：本機能はImGuiの内部レイアウトシステムと連携し、CalcItemWidth関数で計算される最終的なアイテム幅に影響する。

**権限による制御**：特になし。任意のウィンドウコンテキスト内で使用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 24 | Layout | 補助機能 | アイテム幅の設定 |

## 機能種別

レイアウト制御 / パラメータスタック操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| item_width | float | Yes | アイテム幅（ピクセル単位）。>0.0f: 幅をピクセルで指定、<0.0f: ウィンドウ右端からxx ピクセルの位置に整列（-FLT_MINで常に右端整列）、0.0f: デフォルト幅を使用 | 特になし |

### 入力データソース

- 呼び出し元からの直接パラメータ指定

## 出力仕様

### 出力データ

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

### 出力先

- ImGuiWindow::DC.ItemWidth（現在のアイテム幅設定）
- ImGuiWindow::DC.ItemWidthStack（幅設定のバックアップスタック）

## 処理フロー

### 処理シーケンス

```
1. グローバルコンテキストGImGuiを取得
   └─ ImGuiContext& g = *GImGui

2. 現在のウィンドウを取得
   └─ ImGuiWindow* window = g.CurrentWindow

3. 現在のItemWidthをスタックにバックアップ
   └─ window->DC.ItemWidthStack.push_back(window->DC.ItemWidth)

4. 新しいアイテム幅を設定
   └─ item_width == 0.0f の場合: window->DC.ItemWidthDefault を使用
   └─ それ以外: 引数の item_width を使用

5. NextItemDataフラグをクリア
   └─ SetNextItemWidthの影響を無効化
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[グローバルコンテキスト取得]
    B --> C[現在のウィンドウ取得]
    C --> D[現在のItemWidthをスタックにpush]
    D --> E{item_width == 0.0f?}
    E -->|Yes| F[ItemWidthDefault を使用]
    E -->|No| G[item_widthをそのまま使用]
    F --> H[NextItemDataフラグをクリア]
    G --> H
    H --> I[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-61-01 | スタックペアリング | PushItemWidthを呼び出したら必ずPopItemWidthを呼び出すこと | 常時 |
| BR-61-02 | ゼロ値のデフォルト化 | item_width=0.0fの場合はItemWidthDefaultが適用される | item_width == 0.0f |
| BR-61-03 | 負値の右端整列 | item_width<0.0fの場合はウィンドウ右端からの相対位置として解釈される | item_width < 0.0f |

### 計算ロジック

負の値が指定された場合の最終的な幅計算は`CalcItemWidth`で行われる：
```
w = ImMax(1.0f, region_avail_x + item_width)
```
ここで`region_avail_x`は現在のカーソル位置から利用可能な幅。

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | アサーション | PopItemWidthを呼びすぎた場合 | PopItemWidthで警告が発生する |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- O(1)の定数時間操作
- スタック操作のみで軽量

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

特になし

## 備考

- SetNextItemWidthはPushItemWidthより優先される（ただしPushItemWidth呼び出しでクリアされる）
- 複数コンポーネントウィジェット（DragFloat3等）にはPushMultiItemsWidthsが内部で使用される

---

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

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

### 推奨読解順序

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

まず、アイテム幅に関連するデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindowTempData構造体内のItemWidth、ItemWidthDefault、ItemWidthStackの定義を確認 |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiNextItemData構造体のWidthフィールドとHasFlagsの関係を理解 |

**読解のコツ**: ImGuiWindowTempData（DCと呼ばれる）は各ウィンドウの一時的なレイアウト状態を保持する。ItemWidthStackはPush/Pop操作のためのスタックで、ItemWidthは現在適用される幅。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | PushItemWidthの関数宣言（540行目）とコメントで幅指定の仕様を確認 |

**主要処理フロー**:
1. **540行目**: 関数宣言と正値/負値の意味についてのコメント

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | PushItemWidth関数の実装（11469-11476行目） |

**主要処理フロー**:
- **11471行目**: グローバルコンテキストの取得
- **11472行目**: 現在のウィンドウの取得
- **11473行目**: 現在のItemWidthをスタックにバックアップ
- **11474行目**: 新しいItemWidthの設定（0.0fの場合はデフォルト値を使用）
- **11475行目**: NextItemDataフラグのクリア

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

```
PushItemWidth(float item_width)
    │
    ├─ window->DC.ItemWidthStack.push_back()
    │      └─ ImVector<float>::push_back() [スタック操作]
    │
    └─ g.NextItemData.HasFlags &= ~ImGuiNextItemDataFlags_HasWidth
           └─ NextItemDataフラグのクリア
```

### データフロー図

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

item_width ───────▶ PushItemWidth() ───────▶ DC.ItemWidth（更新）
                          │
                          ├───▶ DC.ItemWidthStack（push）
                          │
                          └───▶ NextItemData.HasFlags（クリア）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | 公開API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | 関数実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダ | 内部データ構造定義 |
