# 機能設計書 64-CalcItemWidth

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける`CalcItemWidth`関数の機能設計を定義する。この関数は、現在のアイテム幅設定とカーソル位置に基づいて、ウィジェットの実際の幅をピクセル単位で計算する。

### 本機能の処理概要

CalcItemWidth関数は、PushItemWidthまたはSetNextItemWidthで設定された幅値を、実際のピクセル幅に変換する計算処理を行う。特に負の値が指定された場合、ウィンドウの利用可能領域から相対的な幅を計算する。

**業務上の目的・背景**：ImGuiでは、アイテム幅を正の値（ピクセル指定）または負の値（右端からの相対位置）で指定できる。ウィジェット描画時には、これらの抽象的な指定を実際のピクセル幅に変換する必要がある。CalcItemWidthはこの変換を一元的に行い、すべてのウィジェットで一貫した幅計算を保証する。

**機能の利用シーン**：
- ウィジェット内部でのサイズ計算時
- カスタムウィジェット作成時の幅取得
- レイアウト計算のデバッグや検証

**主要な処理内容**：
1. SetNextItemWidthで設定された幅があればそれを使用
2. なければPushItemWidthで設定された幅（DC.ItemWidth）を使用
3. 負の値の場合、利用可能領域との相対計算を行う
4. 最終結果をトランケート（小数点以下切り捨て）して返す

**関連システム・外部連携**：GetContentRegionAvail関数を内部で呼び出し、負の値の場合の幅計算に使用する。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 特定の画面に紐づかない汎用機能 |

## 機能種別

計算処理 / レイアウト支援

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- ImGuiContext::NextItemData.Width（SetNextItemWidthで設定された場合）
- ImGuiWindow::DC.ItemWidth（PushItemWidthで設定された場合）
- GetContentRegionAvail()の戻り値（負の値の場合の計算に使用）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | float | 計算されたアイテム幅（ピクセル単位、最小1.0f） |

### 出力先

- 呼び出し元への戻り値として返却

## 処理フロー

### 処理シーケンス

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

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

3. 幅の決定
   └─ NextItemDataにHasWidthフラグがある場合: NextItemData.Widthを使用
   └─ それ以外: window->DC.ItemWidthを使用

4. 負の値の処理
   └─ w < 0.0f の場合:
       └─ region_avail_x = GetContentRegionAvail().x
       └─ w = ImMax(1.0f, region_avail_x + w)

5. トランケート処理
   └─ w = IM_TRUNC(w)

6. 計算された幅を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[グローバルコンテキスト取得]
    B --> C[現在のウィンドウ取得]
    C --> D{NextItemDataにHasWidthフラグ?}
    D -->|Yes| E[w = NextItemData.Width]
    D -->|No| F[w = DC.ItemWidth]
    E --> G{w < 0.0f?}
    F --> G
    G -->|Yes| H[region_avail_x = GetContentRegionAvail().x]
    H --> I[w = ImMax 1.0f, region_avail_x + w]
    G -->|No| J[w = IM_TRUNC w]
    I --> J
    J --> K[return w]
    K --> L[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-64-01 | NextItemData優先 | SetNextItemWidthの設定がPushItemWidthより優先される | NextItemDataにHasWidthフラグがある場合 |
| BR-64-02 | 最小幅保証 | 負の値計算の結果、幅は最小1.0fが保証される | w < 0.0f |
| BR-64-03 | トランケート | 最終結果は小数点以下が切り捨てられる | 常時 |
| BR-64-04 | 右端整列 | -FLT_MINを指定するとウィンドウ右端まで伸びる | w が非常に小さい負の値 |

### 計算ロジック

負の値の場合の幅計算：
```cpp
float region_avail_x = GetContentRegionAvail().x;
w = ImMax(1.0f, region_avail_x + w);
```

例: ウィンドウの利用可能幅が200pxで、item_width=-50の場合：
- w = ImMax(1.0f, 200 + (-50)) = ImMax(1.0f, 150) = 150px

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 特になし | 最小幅1.0fが保証される |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- O(1)の定数時間操作
- GetContentRegionAvailの呼び出しを含むが軽量

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

特になし

## 備考

- この関数は直近のアイテムの幅を返すわけではない（関数名に注意）
- CalcItemSizeという内部関数も存在するが、そちらは公開されていない
- ウィジェット内部で頻繁に呼び出されるため、パフォーマンスが重要

---

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

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

### 推奨読解順序

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

まず、関連するデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindowTempData::ItemWidth（2633行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiNextItemData::Width（1362行目） |

**読解のコツ**: ItemWidthはウィンドウのDC（DrawContext）に格納され、NextItemData.Widthはグローバルコンテキストに格納される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | CalcItemWidthの関数宣言（543行目）とコメント |

**主要処理フロー**:
1. **543行目**: 関数宣言と「NOT necessarily the width of last item」という注意書き

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

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

**主要処理フロー**:
- **11514-11515行目**: コンテキストとウィンドウの取得
- **11517-11520行目**: NextItemDataまたはDC.ItemWidthから幅を取得
- **11521-11525行目**: 負の値の処理（GetContentRegionAvailとの計算）
- **11526行目**: IM_TRUNCでトランケート
- **11527行目**: 結果を返す

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

```
CalcItemWidth()
    │
    ├─ NextItemData.HasFlags チェック
    │      └─ NextItemData.Width または DC.ItemWidth を選択
    │
    ├─ w < 0.0f の場合
    │      └─ GetContentRegionAvail()
    │             └─ 利用可能領域との相対計算
    │
    └─ IM_TRUNC(w)
           └─ 小数点以下切り捨て
```

### データフロー図

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

NextItemData.Width ─────┐
                        ├───▶ CalcItemWidth() ───▶ 計算された幅（float）
DC.ItemWidth ───────────┘           │
                                    │
GetContentRegionAvail() ────────────┘
      （負の値の場合のみ）
```

### 関連ファイル一覧

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