# 機能設計書 235-IsMouseDown

## 概要

本ドキュメントは、ImGuiライブラリにおけるマウスボタン押下状態判定機能「IsMouseDown」の設計仕様を定義する。

### 本機能の処理概要

IsMouseDown関数は、指定されたマウスボタンが現在押されている（ホールド状態）かどうかを判定する機能である。キーボードのIsKeyDownに相当する機能をマウス入力に対して提供し、マウスボタンの継続的な押下状態を検出できる。

**業務上の目的・背景**：GUIアプリケーションでは、マウスボタンが押されている間だけ特定の処理を行うケースが多い。例えば、ドラッグ操作中のオブジェクト移動、押し続けている間のスクロール、長押しによるコンテキストメニュー表示などである。IsMouseDownは、このようなマウスボタンのホールド状態を検出するための基本機能を提供する。

**機能の利用シーン**：
- ドラッグ操作の検出（マウスボタンを押しながら移動）
- 長押し操作の検出
- カスタムウィジェットでのマウスインタラクション
- ゲームにおける射撃やアクションの継続入力
- パンやズーム操作の実装

**主要な処理内容**：
1. マウスボタン番号の検証（0-4の範囲内）
2. ImGuiIO.MouseDown配列から押下状態を取得
3. キーオーナーシップの検証（マウスボタンは内部的にキーとして扱われる）
4. 両条件を満たした場合にtrueを返却

**関連システム・外部連携**：ImGuiIO構造体からマウス入力情報を取得。マウスボタンは内部的にImGuiKeyに変換されてキーオーナーシップシステムと連携する。

**権限による制御**：キーオーナーシップ機能により、特定のウィジェットがマウス入力を専有している場合、他のコンポーネントからのIsMouseDown呼び出しはfalseを返す。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 27 | Inputs | 主機能 | マウスボタン判定のデモ表示 |
| 20 | Custom Rendering | 参照画面 | カスタム描画でのマウス入力使用 |

## 機能種別

入力判定処理 / 状態監視

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| button | ImGuiMouseButton | Yes | 判定対象のマウスボタン（0=左、1=右、2=中央） | 0-4の範囲内（IM_COUNTOFでアサーション） |
| owner_id | ImGuiID | No | キーオーナーID（内部API版のみ、デフォルトはImGuiKeyOwner_Any） | なし |

### マウスボタン定義

| 値 | 定数名 | 説明 |
|---|--------|------|
| 0 | ImGuiMouseButton_Left | 左ボタン |
| 1 | ImGuiMouseButton_Right | 右ボタン |
| 2 | ImGuiMouseButton_Middle | 中央ボタン（ホイールクリック） |
| 3-4 | - | 拡張ボタン（バックエンド依存） |

### 入力データソース

- ImGuiIO.MouseDown[5]：各マウスボタンの押下状態配列

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | マウスボタンが押されている場合true、それ以外はfalse |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. パブリックAPI呼び出し（IsMouseDown(button)）
   └─ owner_idをImGuiKeyOwner_Anyとして処理

2. マウスボタン番号の検証
   └─ IM_ASSERTで0-4の範囲内を確認

3. マウスボタン押下状態の取得
   └─ g.IO.MouseDown[button]を確認

4. キーオーナーシップの検証
   └─ MouseButtonToKey()でマウスボタンをImGuiKeyに変換
   └─ TestKeyOwner()でオーナーシップを確認

5. 結果の返却
   └─ 両条件を満たした場合trueを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始: IsMouseDown] --> B{button が 0-4 の範囲内?}
    B -->|No| C[アサーションエラー]
    B -->|Yes| D{IO.MouseDown button == true?}
    D -->|No| E[return false]
    D -->|Yes| F[MouseButtonToKey button]
    F --> G{TestKeyOwner 成功?}
    G -->|No| H[return false]
    G -->|Yes| I[return true]
    C --> J[終了]
    E --> J
    H --> J
    I --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-235-01 | 継続状態検出 | マウスボタンが押されている間、毎フレームtrueを返す | 常時 |
| BR-235-02 | オーナーシップ準拠 | キーオーナーシップが設定されている場合、オーナー以外からの検出はブロックされる | owner_id指定時 |
| BR-235-03 | マウスキー変換 | マウスボタンは内部的にImGuiKey_MouseXXXに変換される | 常時 |

### 計算ロジック

マウスボタン押下判定ロジック：
```
IsMouseDown = g.IO.MouseDown[button] && TestKeyOwner(MouseButtonToKey(button), owner_id)
```

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

該当なし（メモリ上のマウス状態データのみ参照）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | アサーションエラー | 無効なマウスボタン番号が指定された場合 | デバッグビルドでアサーションが発生 |

### リトライ仕様

該当なし（同期的な状態チェック関数のため）

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

該当なし

## パフォーマンス要件

- 処理時間：O(1)の定数時間で完了
- 1フレームあたり複数回呼び出し可能
- メモリアロケーションなし

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

該当なし（UIライブラリ内部の入力状態チェックのみ）

## 備考

- IsMouseDownはIsKeyDownのマウス版として設計されている
- マウスボタンは内部的にImGuiKey_MouseLeft、ImGuiKey_MouseRight等のキーとして扱われる
- IsMouseClickedは押された瞬間の検出、IsMouseDownは継続的な押下状態の検出を行う

---

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

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

### 推奨読解順序

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

マウス入力状態を保持するデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiMouseButton_列挙型（1946-1952行目）でマウスボタン定義を確認 |
| 1-2 | imgui.h | `imgui.h` | ImGuiIO構造体のMouseDown[5]配列を確認 |

**読解のコツ**: ImGuiMouseButton_COUNTは5であり、左・右・中央の3ボタンに加えて拡張ボタン用のスロットがある。

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

パブリックAPI関数の宣言と実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | IsMouseDown関数の宣言（1101行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | パブリックAPI版の実装（9815-9820行目） |

**主要処理フロー**:
1. **9817行目**: グローバルコンテキストを取得
2. **9818行目**: ボタン番号の範囲チェック（アサーション）
3. **9819行目**: MouseDown配列とTestKeyOwnerの論理積を返却

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

内部API版とヘルパー関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | 内部API版（9822-9827行目）でowner_id引数付きバージョンを確認 |
| 3-2 | imgui.cpp | `imgui.cpp` | MouseButtonToKey関数でマウスボタンからキーへの変換を確認 |
| 3-3 | imgui.cpp | `imgui.cpp` | TestKeyOwner関数（10544-10559行目）でオーナーシップ検証を確認 |

**主要処理フロー**:
- **9824行目**: グローバルコンテキストを取得
- **9825行目**: ボタン番号の範囲チェック
- **9826行目**: MouseDown配列とTestKeyOwnerの論理積を返却（owner_id指定版）

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

```
ImGui::IsMouseDown(ImGuiMouseButton button)  [Public API - imgui.cpp:9815]
    │
    └─ g.IO.MouseDown[button] && TestKeyOwner(MouseButtonToKey(button), ImGuiKeyOwner_Any)
           │
           ├─ MouseButtonToKey(button)
           │      └─ ImGuiKey_MouseLeft + button
           │
           └─ TestKeyOwner(key, owner_id)  [imgui.cpp:10544]
                  └─ GetKeyOwnerData(&g, key)

ImGui::IsMouseDown(ImGuiMouseButton button, ImGuiID owner_id)  [Internal - imgui.cpp:9822]
    │
    └─ g.IO.MouseDown[button] && TestKeyOwner(MouseButtonToKey(button), owner_id)
```

### データフロー図

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

ImGuiMouseButton button  ───▶ IO.MouseDown[button]
                               でボタン押下状態を取得
                                     │
                                     ▼
                         MouseButtonToKey(button)で
                         ImGuiKeyに変換
                                     │
                                     ▼
                         TestKeyOwner()で
                         オーナーシップ検証
                                     │
                                     ▼
                               bool結果を返却      ───▶ 呼び出し元
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | パブリックAPIの宣言、ImGuiMouseButton定義 |
| imgui.cpp | `imgui.cpp` | ソース | IsMouseDownの実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | 内部API版の宣言 |
| imgui_demo.cpp | `imgui_demo.cpp` | ソース | 使用例のデモコード |
