# 機能設計書 29-IsWindowCollapsed

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるIsWindowCollapsed機能の設計仕様を記述する。この機能は、現在のウィンドウが折りたたまれている（タイトルバーのみ表示されている）状態かどうかを判定するための関数である。

### 本機能の処理概要

**業務上の目的・背景**：ウィンドウが折りたたまれている状態を検出することで、ウィンドウの表示状態に応じた処理を行うことができる。折りたたまれたウィンドウではコンテンツ領域が表示されないため、重い処理を省略したり、代替の表示を行ったりする際に使用される。Begin関数もウィンドウが折りたたまれている場合にfalseを返すが、本関数を使用することでより明示的に状態を確認できる。

**機能の利用シーン**：
- ウィンドウが折りたたまれている場合に処理を省略する場合
- 折りたたみ状態に応じた条件分岐を行う場合
- デバッグや状態表示のためにウィンドウの折りたたみ状態を確認する場合

**主要な処理内容**：
1. 現在のウィンドウを取得する
2. ウィンドウのCollapsedフラグを返す

**関連システム・外部連携**：ImGuiのウィンドウ管理システムと連携する。

**権限による制御**：特になし。すべてのユーザーが任意のタイミングで呼び出し可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 全てのウィンドウ | 参照機能 | ウィンドウの折りたたみ状態取得 |

## 機能種別

状態取得 / ウィンドウユーティリティ

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- グローバルコンテキストの現在のウィンドウ（GetCurrentWindowRead()経由）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | ウィンドウが折りたたまれている場合はtrue、そうでない場合はfalse |

### 出力先

なし（戻り値として返す）

## 処理フロー

### 処理シーケンス

```
1. 現在のウィンドウを取得
   └─ GetCurrentWindowRead()で読み取り専用でウィンドウを取得
2. Collapsedフラグを返す
   └─ window->Collapsedを返す
```

### フローチャート

```mermaid
flowchart TD
    A[IsWindowCollapsed開始] --> B[GetCurrentWindowRead]
    B --> C[window->Collapsedを返す]
    C --> D[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 折りたたみ状態の意味 | 折りたたまれたウィンドウはタイトルバーのみが表示される | 常時 |
| BR-002 | Begin/End内で使用 | Begin()とEnd()の間で呼び出す必要がある | 常時 |
| BR-003 | Beginの戻り値との関係 | Begin()がfalseを返す場合の一因となりうる | 常時 |

### 計算ロジック

特になし（単純なフラグの取得）

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

### 操作別データベース影響一覧

なし（本機能はメモリ内のデータ構造の読み取りのみを行う）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 本関数は失敗しない設計 | - |

### リトライ仕様

なし

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

なし

## パフォーマンス要件

- 処理時間: 極めて軽量（単純なメンバ変数アクセス）
- メモリ使用: なし

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

なし

## 備考

- v1.40（2015/05/31）で GetWindowCollapsed() から IsWindowCollapsed() にリネームされた
- SetWindowCollapsed()やSetNextWindowCollapsed()を使用して折りたたみ状態を制御できる
- ImGuiWindowFlags_NoCollapseフラグを使用すると、ユーザーによる折りたたみを無効化できる

---

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

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

### 推奨読解順序

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

ImGuiWindow::Collapsedフラグを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindow::Collapsedメンバ |

**読解のコツ**: Collapsedはbool型のフラグで、ウィンドウが折りたたまれている状態を示す。ユーザーのダブルクリックやSetWindowCollapsed()で変更される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | IsWindowCollapsed関数宣言（463行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | IsWindowCollapsed関数実装（8554-8558行目） |

**主要処理フロー**:
1. **8554-8556行目**: GetCurrentWindowRead()で現在のウィンドウを取得
2. **8557行目**: window->Collapsedを返す

#### Step 3: 関連する折りたたみ制御を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | SetWindowCollapsed関数（8549-8552行目） |
| 3-2 | imgui.cpp | `imgui.cpp` | SetNextWindowCollapsed関数（8620-8625行目） |

**主要処理フロー**:
- SetWindowCollapsed: 現在のウィンドウの折りたたみ状態を直接設定
- SetNextWindowCollapsed: 次のBegin()呼び出しで作成されるウィンドウの折りたたみ状態を設定

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

```
IsWindowCollapsed()
    │
    └─ GetCurrentWindowRead()
           │
           └─ return window->Collapsed
```

### データフロー図

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

g.CurrentWindow ──────────▶ IsWindowCollapsed()     ──▶ bool (Collapsed状態)
                                │
                                ▼
                          window->Collapsed を返す
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | IsWindowCollapsed関数の実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダ | ImGuiWindow::Collapsed定義 |
