# 機能設計書 240-IsMouseDragging

## 概要

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

### 本機能の処理概要

IsMouseDragging関数は、指定されたマウスボタンでドラッグ操作が行われているかどうかを検出する機能である。マウスボタンが押されていて、かつドラッグしきい値（MouseDragThreshold）を超えてマウスが移動した場合にtrueを返す。ドラッグ操作の検出は、オブジェクトの移動やリサイズなどの実装に不可欠な機能を提供する。

**業務上の目的・背景**：GUIアプリケーションでは、マウスボタンを押しながらの移動（ドラッグ）操作が頻繁に使用される。ウィンドウの移動、スライダーの操作、オブジェクトの選択範囲など、多くのUI操作がドラッグに依存している。IsMouseDraggingは、単なるマウスの押下状態だけでなく、一定距離以上の移動を伴うドラッグ操作を正確に検出する。

**機能の利用シーン**：
- ドラッグ&ドロップ操作の検出
- ウィンドウやパネルの移動
- スライダーやスクロールバーの操作
- 選択範囲の描画（矩形選択）
- カスタムウィジェットでのドラッグ操作
- ゲームにおけるカメラ操作やオブジェクト移動

**主要な処理内容**：
1. マウスボタン番号の検証（0-4の範囲内）
2. 現在のボタン押下状態の確認（MouseDown配列）
3. ドラッグしきい値の決定（引数または設定値）
4. マウス移動距離の二乗がしきい値の二乗を超えているか判定
5. 結果の返却

**関連システム・外部連携**：ImGuiIO構造体からマウス入力情報とドラッグ距離情報を取得。IsMouseDragPastThreshold内部関数と連携してしきい値判定を行う。

**権限による制御**：キーオーナーシップ機能は直接適用されないが、マウスボタンの押下状態はオーナーシップの影響を受ける可能性がある。

## 関連画面

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

## 機能種別

入力判定処理 / ジェスチャー検出

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| button | ImGuiMouseButton | Yes | 判定対象のマウスボタン（0=左、1=右、2=中央） | 0-4の範囲内（IM_COUNTOFでアサーション） |
| lock_threshold | float | No | ドラッグしきい値（デフォルトは-1.0f、負の値の場合はio.MouseDragThresholdを使用） | なし |

### 入力データソース

- ImGuiIO.MouseDown[5]：各マウスボタンの押下状態配列
- ImGuiIO.MouseDragMaxDistanceSqr[5]：各マウスボタンのドラッグ最大距離の二乗
- ImGuiIO.MouseDragThreshold：ドラッグしきい値（デフォルト6.0ピクセル）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | マウスがドラッグ中の場合true、それ以外はfalse |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 関数呼び出し（IsMouseDragging(button, lock_threshold)）
   └─ グローバルコンテキストを取得

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

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

4. ドラッグしきい値判定
   └─ IsMouseDragPastThreshold(button, lock_threshold)を呼び出し
   └─ lock_threshold < 0の場合、io.MouseDragThresholdを使用
   └─ MouseDragMaxDistanceSqr >= threshold * thresholdでドラッグ判定

5. 結果の返却
   └─ しきい値を超えていればtrueを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始: IsMouseDragging] --> B{button が 0-4 の範囲内?}
    B -->|No| C[アサーションエラー]
    B -->|Yes| D{IO.MouseDown button == true?}
    D -->|No| E[return false]
    D -->|Yes| F[IsMouseDragPastThreshold button, lock_threshold]
    F --> G{lock_threshold < 0?}
    G -->|Yes| H[threshold = IO.MouseDragThreshold]
    G -->|No| I[threshold = lock_threshold]
    H --> J{MouseDragMaxDistanceSqr >= threshold^2?}
    I --> J
    J -->|No| K[return false]
    J -->|Yes| L[return true]
    C --> M[終了]
    E --> M
    K --> M
    L --> M
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-240-01 | しきい値判定 | マウスの移動距離がしきい値を超えた場合にドラッグと判定される | 常時 |
| BR-240-02 | デフォルトしきい値 | lock_threshold < 0の場合、io.MouseDragThreshold（デフォルト6.0ピクセル）を使用する | lock_threshold < 0時 |
| BR-240-03 | ボタン押下必須 | マウスボタンが押されていない場合はドラッグとは判定されない | 常時 |
| BR-240-04 | 距離の二乗比較 | パフォーマンスのため、距離の二乗同士を比較する（平方根の計算を省略） | 常時 |

### 計算ロジック

ドラッグ判定ロジック：
```
threshold = (lock_threshold < 0.0f) ? io.MouseDragThreshold : lock_threshold
IsMouseDragging = MouseDown[button] && (MouseDragMaxDistanceSqr[button] >= threshold * threshold)
```

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

該当なし

## パフォーマンス要件

- 処理時間：O(1)の定数時間で完了
- 1フレームあたり複数回呼び出し可能
- メモリアロケーションなし
- 距離の二乗比較により平方根計算を省略

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

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

## 備考

- GetMouseDragDelta()を使用してドラッグの移動量を取得できる
- ResetMouseDragDelta()でドラッグデルタをリセットできる
- マウスボタンを離した直後のフレームでも、IsMouseDragPastThresholdは有効（ドラッグ完了判定に使用可能）

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiIO構造体のMouseDragMaxDistanceSqr[5]配列を確認 |
| 1-2 | imgui.h | `imgui.h` | ImGuiIO.MouseDragThresholdでドラッグしきい値を確認 |

**読解のコツ**: MouseDragMaxDistanceSqr[button]は、ボタンが押されてからのマウス移動距離の最大値の二乗を保持する。これにより、どれだけドラッグしたかを高速に判定できる。

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

関数の宣言と実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | IsMouseDragging関数の宣言（1112行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | 実装（9931-9938行目） |

**主要処理フロー**:
1. **9933行目**: グローバルコンテキストを取得
2. **9934行目**: ボタン番号の範囲チェック（アサーション）
3. **9935-9936行目**: MouseDown配列で押下状態を確認、falseならreturn false
4. **9937行目**: IsMouseDragPastThresholdを呼び出してドラッグ判定

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

ドラッグしきい値判定の詳細を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | IsMouseDragPastThreshold関数（9922-9929行目）でしきい値判定を確認 |

**主要処理フロー**:
- **9924行目**: グローバルコンテキストを取得
- **9925行目**: ボタン番号の範囲チェック
- **9926-9927行目**: lock_threshold < 0の場合、io.MouseDragThresholdを使用
- **9928行目**: MouseDragMaxDistanceSqr >= threshold * thresholdで判定

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

```
ImGui::IsMouseDragging(ImGuiMouseButton button, float lock_threshold)  [imgui.cpp:9931]
    │
    ├─ g.IO.MouseDown[button]
    │
    └─ IsMouseDragPastThreshold(button, lock_threshold)  [imgui.cpp:9922]
           │
           └─ g.IO.MouseDragMaxDistanceSqr[button] >= threshold * threshold
```

### データフロー図

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

ImGuiMouseButton button  ───▶ IO.MouseDown[button]で
float lock_threshold           押下状態を確認
                                     │
                                     ▼
                         lock_threshold < 0 の場合
                         IO.MouseDragThreshold を使用
                                     │
                                     ▼
                         MouseDragMaxDistanceSqr >=
                         threshold * threshold で
                         ドラッグ判定
                                     │
                                     ▼
                               bool結果を返却      ───▶ 呼び出し元
```

### 関連ファイル一覧

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