# 機能設計書 35-SetNextWindowPos

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける `SetNextWindowPos` 関数の機能設計書である。この関数は、次にBegin()で作成されるウィンドウの位置を事前に設定するためのAPIを提供する。

### 本機能の処理概要

**業務上の目的・背景**：GUIアプリケーションにおいて、ウィンドウの配置を制御することは重要なUIデザイン要素である。SetNextWindowPos関数は、Begin()を呼び出す前に次のウィンドウの位置を指定することで、初回表示位置の制御、条件付き配置、中央揃えやピボットを使った柔軟な配置を可能にする。これにより、オーバーレイ、ポップアップ、ダイアログなどの配置を細かく制御できる。

**機能の利用シーン**：
- ウィンドウを画面の特定位置（角、中央など）に配置する場合
- オーバーレイウィンドウを固定位置に表示する場合
- ポップアップやモーダルダイアログを親ウィンドウの中央に配置する場合
- 複数ウィンドウを整列して配置する場合
- 初回表示時のみ位置を設定し、以降はユーザーの移動を許可する場合

**主要な処理内容**：
1. 条件フラグ（ImGuiCond）の検証
2. NextWindowData構造体に位置情報を格納
3. ピボット値を使った配置計算の準備

**関連システム・外部連携**：Begin()関数がNextWindowDataを読み取り、ウィンドウ位置を決定。GetMainViewport()と組み合わせて画面サイズを考慮した配置が可能。

**権限による制御**：特になし。すべてのウィンドウで利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 17 | Simple Overlay | 主機能 | ウィンドウ位置の設定 |
| 18 | Fullscreen Window | 主機能 | ウィンドウ位置の設定 |

## 機能種別

設定API / ウィンドウ操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| pos | const ImVec2& | Yes | ウィンドウの位置（画面座標） | なし |
| cond | ImGuiCond | No | 適用条件（デフォルト: 0 = Always） | 2のべき乗であること |
| pivot | const ImVec2& | No | ピボット点（デフォルト: (0,0) = 左上角） | なし |

### ImGuiCond 条件フラグ

| フラグ名 | 説明 |
|---------|------|
| ImGuiCond_None / ImGuiCond_Always | 常に設定を適用（デフォルト） |
| ImGuiCond_Once | ランタイムセッション中1回のみ適用 |
| ImGuiCond_FirstUseEver | .iniファイルにエントリがない場合のみ適用（初回使用時） |
| ImGuiCond_Appearing | ウィンドウが表示される際に適用 |

### 入力データソース

呼び出し元から直接パラメータとして受け取る。

## 出力仕様

### 出力データ

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

### 出力先

ImGuiコンテキストの NextWindowData 構造体に以下を格納：
- HasFlags に ImGuiNextWindowDataFlags_HasPos を追加
- PosVal に位置を格納
- PosPivotVal にピボットを格納
- PosCond に条件を格納

## 処理フロー

### 処理シーケンス

```
1. コンテキストの取得
   └─ GImGui からコンテキストを取得

2. 条件フラグの検証
   └─ 条件が2のべき乗であることをアサート

3. NextWindowDataに設定を格納
   ├─ HasFlags に HasPos フラグを追加
   ├─ PosVal に位置を設定
   ├─ PosPivotVal にピボットを設定
   └─ PosCond に条件を設定（0の場合はAlways）

4. Begin()呼び出し時に位置が適用される
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[コンテキスト取得]
    B --> C{cond検証}
    C -->|無効| Z[アサート失敗]
    C -->|有効| D[HasFlags設定]
    D --> E[PosVal設定]
    E --> F[PosPivotVal設定]
    F --> G[PosCond設定]
    G --> H[終了]
    H --> I[Begin呼び出し時に適用]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | Begin前呼び出し | Begin()の前に呼び出す必要がある | 常時 |
| BR-02 | 次のウィンドウのみ | 設定は次のBegin()呼び出しにのみ適用される | 常時 |
| BR-03 | ピボット中央揃え | pivot=(0.5, 0.5)で指定位置を中心としたウィンドウ配置 | pivot指定時 |
| BR-04 | 条件の排他性 | 複数の条件フラグを組み合わせることはできない | 常時 |

### 計算ロジック

ピボットによる位置調整の計算式：
```
実際の左上位置.x = pos.x - (window_size.x * pivot.x)
実際の左上位置.y = pos.y - (window_size.y * pivot.y)
```

例：
- pivot=(0, 0): posが左上角
- pivot=(0.5, 0.5): posが中心
- pivot=(1, 1): posが右下角

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ASSERT | アサーション | condが2のべき乗でない（複数フラグの組み合わせ） | 単一の条件フラグのみを指定 |

### リトライ仕様

リトライは不要。

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

該当なし。

## パフォーマンス要件

- O(1) の計算量（データ構造への代入のみ）

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

特になし。

## 備考

- SetWindowPos()よりもSetNextWindowPos()の使用を推奨（ティアリングや副作用を回避）
- 旧API SetNextWindowPosCenter() は廃止され、SetNextWindowPos() + pivot で代替可能
- Begin()を呼び出さずに次のフレームに移行すると、設定はリセットされる

---

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

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

### 推奨読解順序

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

NextWindowData 構造体と ImGuiCond 列挙型を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiCond_ 列挙型の定義（1988-1995行） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiNextWindowData 構造体、ImGuiNextWindowDataFlags |

**読解のコツ**: ImGuiCond はビットフラグではなく、単一の値として使用される（複数組み合わせ不可）。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | SetNextWindowPos 関数の実装（8572-8580行） |

**主要処理フロー**:
1. **8574行目**: GImGui からコンテキストを取得
2. **8575行目**: cond が2のべき乗かアサート検証
3. **8576行目**: HasFlags に HasPos を追加
4. **8577行目**: PosVal に位置を設定
5. **8578行目**: PosPivotVal にピボットを設定
6. **8579行目**: PosCond に条件を設定

#### Step 3: Begin()での適用を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | Begin関数内でのNextWindowData.PosValの使用箇所 |

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

```
SetNextWindowPos(pos, cond, pivot)
    │
    ├─ IM_ASSERT (条件検証)
    │
    └─ g.NextWindowData への設定
           ├─ HasFlags |= HasPos
           ├─ PosVal = pos
           ├─ PosPivotVal = pivot
           └─ PosCond = cond ? cond : Always
                   │
                   ▼
           [次のBegin()呼び出しで使用]
```

### データフロー図

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

pos (ImVec2)
cond (ImGuiCond)           g.NextWindowData 更新
pivot (ImVec2)                    │
        │                         │
        └────────────────────────▶│
                                  ▼
                            Begin() で読み取り
                                  │
                                  ▼
                            ウィンドウ位置決定
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | SetNextWindowPos 関数の宣言、ImGuiCond の定義 |
| imgui.cpp | `imgui.cpp` | ソース | SetNextWindowPos 関数の実装（8572-8580行） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiNextWindowData 構造体の定義 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | SetNextWindowPos の使用例（410行、9796行、9843行など） |
