# 機能設計書 238-IsMouseDoubleClicked

## 概要

本ドキュメントは、ImGuiライブラリにおけるマウスダブルクリック検出機能「IsMouseDoubleClicked」の設計仕様を定義する。

### 本機能の処理概要

IsMouseDoubleClicked関数は、指定されたマウスボタンがダブルクリックされたかどうかを検出する機能である。ダブルクリックは、MouseDoubleClickTime（デフォルト0.3秒）以内に同じボタンが2回クリックされた場合に検出される。GetMouseClickedCount() == 2 と同等の判定を行う。

**業務上の目的・背景**：GUIアプリケーションでは、シングルクリックとダブルクリックで異なるアクションを実行することが一般的である。例えば、ファイルマネージャーでのファイル選択（シングルクリック）とファイルを開く操作（ダブルクリック）の区別などに使用される。IsMouseDoubleClickedは、このようなダブルクリックイベントを正確に検出するための機能を提供する。

**機能の利用シーン**：
- ファイルやアイテムを開く操作
- テキストの単語選択（ダブルクリックで単語を選択）
- リストアイテムの詳細表示
- ツリーノードの展開/折りたたみ
- カスタムウィジェットでのダブルクリックハンドリング
- 設定値のリセット（ダブルクリックでデフォルト値に戻す）

**主要な処理内容**：
1. マウスボタン番号の検証（0-4の範囲内）
2. ImGuiIO.MouseClickedCount配列からクリック回数を取得
3. クリック回数が2であることを確認
4. キーオーナーシップの検証（マウスボタンは内部的にキーとして扱われる）
5. 両条件を満たした場合にtrueを返却

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 27 | Inputs | 参照画面 | マウス入力判定のデモ表示 |

## 機能種別

入力判定処理 / イベント検出

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- ImGuiIO.MouseClickedCount[5]：各マウスボタンのクリック回数配列
- ImGuiIO.MouseDoubleClickTime：ダブルクリック判定の時間閾値（デフォルト0.3秒）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | マウスボタンがダブルクリックされた場合true、それ以外はfalse |

### 出力先

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

## 処理フロー

### 処理シーケンス

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

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

3. クリック回数の取得と判定
   └─ g.IO.MouseClickedCount[button]を確認
   └─ 値が2でない場合、falseを返却

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

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

### フローチャート

```mermaid
flowchart TD
    A[開始: IsMouseDoubleClicked] --> B{button が 0-4 の範囲内?}
    B -->|No| C[アサーションエラー]
    B -->|Yes| D{IO.MouseClickedCount button == 2?}
    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-238-01 | ダブルクリック判定 | MouseDoubleClickTime（デフォルト0.3秒）以内に2回クリックされた場合にダブルクリックと判定される | 常時 |
| BR-238-02 | シングルクリック併用 | ダブルクリック時もIsMouseClickedはtrueを返す | 常時 |
| BR-238-03 | オーナーシップ準拠 | キーオーナーシップが設定されている場合、オーナー以外からの検出はブロックされる | owner_id指定時 |
| BR-238-04 | クリックカウント等価 | GetMouseClickedCount() == 2 と同等の判定を行う | 常時 |

### 計算ロジック

ダブルクリック判定ロジック：
```
IsMouseDoubleClicked = (g.IO.MouseClickedCount[button] == 2) && TestKeyOwner(MouseButtonToKey(button), owner_id)
```

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

該当なし

## パフォーマンス要件

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

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

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

## 備考

- ダブルクリック時もIsMouseClicked()はtrueを返すため、シングルクリックとダブルクリックの区別が必要な場合は注意が必要
- トリプルクリック以上はGetMouseClickedCount()を使用して検出できる
- MouseDoubleClickTimeはImGuiIO構造体で設定可能（デフォルト0.3秒）

---

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

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

### 推奨読解順序

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

マウスダブルクリック検出に関連するデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiIO構造体のMouseClickedCount[5]配列を確認 |
| 1-2 | imgui.h | `imgui.h` | ImGuiIO.MouseDoubleClickTimeでダブルクリック時間閾値を確認 |

**読解のコツ**: MouseClickedCount[button]は、短時間内にクリックされた回数を保持する。ダブルクリックの場合は2、トリプルクリックの場合は3となる。

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

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

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

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

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

内部API版とクリックカウント取得関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | 内部API版（9888-9893行目）でowner_id引数付きバージョンを確認 |
| 3-2 | imgui.cpp | `imgui.cpp` | GetMouseClickedCount関数（9895-9900行目）でクリック回数取得を確認 |
| 3-3 | imgui.cpp | `imgui.cpp` | TestKeyOwner関数（10544-10559行目）でオーナーシップ検証を確認 |

**主要処理フロー**:
- **9890行目**: グローバルコンテキストを取得
- **9891行目**: ボタン番号の範囲チェック
- **9892行目**: MouseClickedCount == 2 とTestKeyOwnerの論理積を返却（owner_id指定版）

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

```
ImGui::IsMouseDoubleClicked(ImGuiMouseButton button)  [Public API - imgui.cpp:9881]
    │
    └─ g.IO.MouseClickedCount[button] == 2 && TestKeyOwner(MouseButtonToKey(button), ImGuiKeyOwner_Any)
           │
           ├─ MouseButtonToKey(button)
           │      └─ ImGuiKey_MouseLeft + button
           │
           └─ TestKeyOwner(key, owner_id)  [imgui.cpp:10544]

ImGui::IsMouseDoubleClicked(ImGuiMouseButton button, ImGuiID owner_id)  [Internal - imgui.cpp:9888]
    │
    └─ g.IO.MouseClickedCount[button] == 2 && TestKeyOwner(MouseButtonToKey(button), owner_id)
```

### データフロー図

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

ImGuiMouseButton button  ───▶ IO.MouseClickedCount[button]
                               でクリック回数を取得
                                     │
                                     ▼
                         クリック回数 == 2?
                                     │
                                     ▼
                         MouseButtonToKey(button)で
                         ImGuiKeyに変換
                                     │
                                     ▼
                         TestKeyOwner()で
                         オーナーシップ検証
                                     │
                                     ▼
                               bool結果を返却      ───▶ 呼び出し元
```

### 関連ファイル一覧

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