# 機能設計書 236-IsMouseClicked

## 概要

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

### 本機能の処理概要

IsMouseClicked関数は、指定されたマウスボタンがクリックされた瞬間（!Down状態からDown状態への遷移）を検出する機能である。IsMouseDownが継続的な押下状態を検出するのに対し、IsMouseClickedは押された瞬間の1フレームのみtrueを返す。オプションでリピート機能も提供する。

**業務上の目的・背景**：GUIアプリケーションでは、マウスボタンが押された瞬間を検出してアクションを実行することが一般的である。ボタンクリック、メニュー選択、アイテム選択など、多くのUI操作はクリックの瞬間に処理を行う。IsMouseClickedは、このような単発のクリックイベントを正確に検出するための機能を提供する。

**機能の利用シーン**：
- ボタンやウィジェットのクリック検出
- コンテキストメニューのトリガー（右クリック）
- アイテムの選択操作
- カスタムウィジェットでのクリックハンドリング
- ゲームにおける単発アクション（射撃、ジャンプ等）
- 連続クリック（リピート機能使用時）

**主要な処理内容**：
1. マウスボタン番号の検証（0-4の範囲内）
2. 現在のボタン押下状態の確認（MouseDown配列）
3. 押下継続時間の確認（MouseDownDuration配列）
4. リピートモードの場合、タイプマティックリピート計算
5. キーオーナーシップの検証
6. 結果の返却

**関連システム・外部連携**：ImGuiIO構造体からマウス入力情報と時間情報を取得。タイプマティックリピート計算機能と連携。

**権限による制御**：キーオーナーシップ機能により、特定のウィジェットがマウス入力を専有できる。

## 関連画面

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

## 機能種別

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

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| button | ImGuiMouseButton | Yes | 判定対象のマウスボタン（0=左、1=右、2=中央） | 0-4の範囲内（IM_COUNTOFでアサーション） |
| repeat | bool | No | リピート機能の有効化（デフォルトはfalse） | なし |
| flags | ImGuiInputFlags | No | 入力フラグ（内部API版のみ） | ImGuiInputFlags_SupportedByIsMouseClickedで検証 |
| owner_id | ImGuiID | No | キーオーナーID（内部API版のみ） | なし |

### 入力データソース

- ImGuiIO.MouseDown[5]：各マウスボタンの押下状態配列
- ImGuiIO.MouseDownDuration[5]：各マウスボタンの押下継続時間配列
- ImGuiIO.KeyRepeatDelay：キーリピート開始遅延
- ImGuiIO.KeyRepeatRate：キーリピート間隔

## 出力仕様

### 出力データ

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

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. パブリックAPI呼び出し（IsMouseClicked(button, repeat)）
   └─ repeatをフラグに変換し、内部API版を呼び出し

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

3. 現在の押下状態確認
   └─ MouseDown[button]がfalseの場合、falseを返却

4. 押下継続時間の取得
   └─ t = MouseDownDuration[button]
   └─ t < 0の場合、falseを返却（まだ押されていない）

5. フラグの検証
   └─ サポートされるフラグのみか確認（アサーション）

6. クリック判定
   └─ t == 0.0fの場合、押された瞬間
   └─ repeat && t > KeyRepeatDelay の場合、タイプマティックリピート計算

7. キーオーナーシップの検証
   └─ TestKeyOwner()でオーナーシップを確認

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

### フローチャート

```mermaid
flowchart TD
    A[開始: IsMouseClicked] --> B{button が 0-4 の範囲内?}
    B -->|No| C[アサーションエラー]
    B -->|Yes| D{IO.MouseDown button == true?}
    D -->|No| E[return false]
    D -->|Yes| F[t = IO.MouseDownDuration button]
    F --> G{t < 0?}
    G -->|Yes| H[return false]
    G -->|No| I{フラグが有効?}
    I -->|No| J[アサーションエラー]
    I -->|Yes| K{t == 0.0f?}
    K -->|Yes| L[pressed = true 押された瞬間]
    K -->|No| M{repeat && t > KeyRepeatDelay?}
    M -->|Yes| N[CalcTypematicRepeatAmount でリピート計算]
    M -->|No| O[pressed = false]
    N --> P{リピート回数 > 0?}
    P -->|Yes| L
    P -->|No| O
    L --> Q{pressed == true?}
    O --> Q
    Q -->|No| R[return false]
    Q -->|Yes| S{TestKeyOwner 成功?}
    S -->|No| T[return false]
    S -->|Yes| U[return true]
    C --> V[終了]
    E --> V
    H --> V
    J --> V
    R --> V
    T --> V
    U --> V
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-236-01 | 単一フレーム検出 | クリックは押された瞬間の1フレームのみtrueを返す | repeat=false時 |
| BR-236-02 | リピート機能 | repeat=true時、KeyRepeatDelay後にKeyRepeatRate間隔でtrueを返す | repeat=true時 |
| BR-236-03 | オーナーシップ準拠 | キーオーナーシップが設定されている場合、オーナー以外からの検出はブロックされる | 常時 |
| BR-236-04 | ダブルクリック判定との関係 | ダブルクリック時もIsMouseClickedはtrueを返す | 常時 |

### 計算ロジック

クリック判定ロジック：
```
pressed = (t == 0.0f) || (repeat && t > KeyRepeatDelay && CalcTypematicRepeatAmount(t - DeltaTime, t, KeyRepeatDelay, KeyRepeatRate) > 0)
IsMouseClicked = MouseDown[button] && (t >= 0) && pressed && TestKeyOwner(key, owner_id)
```

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

該当なし

## パフォーマンス要件

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

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

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

## 備考

- IsMouseClickedは押された瞬間を検出、IsMouseDownは継続的な押下状態を検出
- GetMouseClickedCount()でクリック回数（シングル、ダブル等）を取得できる
- IsMouseDoubleClickedはダブルクリックのみを検出する

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiIO構造体のMouseDown、MouseDownDuration配列を確認 |
| 1-2 | imgui.h | `imgui.h` | ImGuiIO.KeyRepeatDelay、KeyRepeatRateでリピート設定を確認 |

**読解のコツ**: MouseDownDuration[button]は、ボタンが押された瞬間は0.0f、それ以降は経過時間が加算される。押されていない場合は負の値。

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

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

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

**主要処理フロー**:
1. **9829-9832行目**: repeatパラメータをImGuiInputFlags_Repeatに変換して内部版を呼び出し

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

クリック検出の詳細ロジックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | 内部API版IsMouseClickedの実装（9834-9853行目） |
| 3-2 | imgui.cpp | `imgui.cpp` | CalcTypematicRepeatAmount関数でリピート計算を確認 |
| 3-3 | imgui.cpp | `imgui.cpp` | TestKeyOwner関数（10544-10559行目）でオーナーシップ検証を確認 |

**主要処理フロー**:
- **9837行目**: ボタン番号の範囲チェック
- **9838-9839行目**: MouseDown配列での押下状態確認
- **9840-9842行目**: MouseDownDurationの確認
- **9843行目**: フラグの検証（アサーション）
- **9845-9846行目**: pressed判定（初回クリックまたはリピート）
- **9850-9851行目**: TestKeyOwnerでオーナーシップ検証

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

```
ImGui::IsMouseClicked(ImGuiMouseButton button, bool repeat)  [Public API - imgui.cpp:9829]
    │
    └─ ImGui::IsMouseClicked(ImGuiMouseButton button, ImGuiInputFlags flags, ImGuiID owner_id)  [Internal - imgui.cpp:9834]
           │
           ├─ CalcTypematicRepeatAmount(t - DeltaTime, t, KeyRepeatDelay, KeyRepeatRate)  [リピート時]
           │
           └─ TestKeyOwner(MouseButtonToKey(button), owner_id)  [imgui.cpp:10544]
```

### データフロー図

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

ImGuiMouseButton button  ───▶ IO.MouseDown[button]で
bool repeat                    押下状態を確認
                                     │
                                     ▼
                         IO.MouseDownDuration[button]で
                         押下継続時間を取得
                                     │
                                     ▼
                         t == 0.0f?（初回クリック）
                         または repeat時のリピート判定
                                     │
                                     ▼
                         TestKeyOwner()で
                         オーナーシップ検証
                                     │
                                     ▼
                               bool結果を返却      ───▶ 呼び出し元
```

### 関連ファイル一覧

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