# 機能設計書 229-IsKeyDown

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける`IsKeyDown`関数の機能設計書である。この関数は、指定されたキーが現在押下されているかどうかを判定するためのキーボード入力検出関数である。

### 本機能の処理概要

`IsKeyDown`関数は、指定されたImGuiKeyが現在押下状態にあるかどうかをブール値で返す機能を提供する。この関数は「キーが押されている」という状態を検出し、キーが押されている間ずっとtrueを返し続ける。

**業務上の目的・背景**：インタラクティブなGUIアプリケーションでは、キーボード入力に応じたリアルタイムな操作が必要になる場合がある。例えば、Ctrlキーを押しながらマウスホイールでズーム操作を行う、Shiftキーを押しながら複数選択を行うなどの場合に、修飾キーが押されているかどうかを継続的に判定する必要がある。本機能はこのような要件を満たすための基本的な入力検出手段を提供する。

**機能の利用シーン**：
- 修飾キー（Ctrl、Shift、Alt）との組み合わせ操作の検出
- カメラ操作やズーム操作でのキー押下判定
- ゲームやインタラクティブアプリでの継続的なキー入力検出
- キーホールド中のアクション実行
- キーボードナビゲーションの実装

**主要な処理内容**：
1. 指定されたキーのキーデータを取得
2. キーの押下状態（Down）を確認
3. キーオーナーシップのテスト（必要な場合）
4. 結果をブール値で返却

**関連システム・外部連携**：プラットフォームバックエンド（Win32、GLFW、SDL等）がキー入力イベントを受け取り、ImGuiIOを通じてキー状態を更新する。

**権限による制御**：キーオーナーシップシステムにより、特定のウィジェットがキーを「所有」している場合、他のコードからの判定がブロックされることがある。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 27 | Inputs | 主画面 | キーボード入力のデモ |

## 機能種別

入力判定（読み取り専用）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| key | ImGuiKey | Yes | 判定対象のキー | ImGuiKey_NamedKey_BEGIN以上の有効なキー値 |

### ImGuiKey列挙型の主要な値

| キー | 説明 |
|-----|------|
| ImGuiKey_Tab | Tabキー |
| ImGuiKey_LeftArrow | 左矢印キー |
| ImGuiKey_Space | スペースキー |
| ImGuiKey_A - ImGuiKey_Z | アルファベットキー |
| ImGuiKey_0 - ImGuiKey_9 | 数字キー |
| ImGuiKey_LeftCtrl | 左Ctrlキー |
| ImGuiMod_Ctrl | Ctrl修飾キー（左右両方） |

### 入力データソース

ImGuiIOのKeysData配列（バックエンドから更新される）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | キーが押下されている場合true、そうでない場合false |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 公開API（引数1つ）の呼び出し
   └─ 内部API（オーナーID指定版）を呼び出し
2. キーデータの取得
   └─ GetKeyData(key)でImGuiKeyData*を取得
3. 押下状態の確認
   └─ key_data->Downがfalseなら即座にfalseを返す
4. キーオーナーシップテスト
   └─ TestKeyOwner(key, owner_id)でオーナーシップを確認
5. 結果を返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B["GetKeyData(key)"]
    B --> C{key_data->Down ?}
    C -->|No| D["return false"]
    C -->|Yes| E["TestKeyOwner(key, owner_id)"]
    E --> F{オーナーシップOK?}
    F -->|No| G["return false"]
    F -->|Yes| H["return true"]
    D --> I[終了]
    G --> I
    H --> I
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 継続的な判定 | キーが押されている間はtrueを返し続ける | 常時 |
| BR-002 | キーオーナーシップ | 他のウィジェットがキーを所有している場合はfalseを返す | owner_id指定時 |
| BR-003 | レガシーキーの廃止 | ImGuiKey < 512のレガシーネイティブキーはサポートされない（v1.91.5以降） | 常時 |

### 計算ロジック

```cpp
bool ImGui::IsKeyDown(ImGuiKey key)
{
    return IsKeyDown(key, ImGuiKeyOwner_Any);
}

bool ImGui::IsKeyDown(ImGuiKey key, ImGuiID owner_id)
{
    const ImGuiKeyData* key_data = GetKeyData(key);
    if (!key_data->Down)
        return false;
    if (!TestKeyOwner(key, owner_id))
        return false;
    return true;
}
```

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| なし | - | 本関数はエラーを発生させない | - |

### リトライ仕様

なし

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

該当なし

## パフォーマンス要件

- O(1)の時間計算量
- メモリアロケーションなし
- フレーム毎に複数回呼び出しても問題ない軽量関数

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

特になし

## 備考

- IsKeyPressedとは異なり、キーが押されている間ずっとtrueを返す
- Shortcut()関数の方がより高機能で推奨される場合がある（フォーカスルーティング対応）
- v1.87以前のレガシーネイティブキーインデックスはv1.91.5で完全に廃止

---

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

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

### 推奨読解順序

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

まず、キー入力に関するデータ構造を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiKey列挙型（1551-1660行目付近）- キー識別子 |
| 1-2 | imgui.h | `imgui.h` | ImGuiKeyData構造体（2382-2390行目付近）- キー状態データ |

**読解のコツ**: ImGuiKeyは512以上の値から始まる名前付きキー（NamedKey）を使用。旧バージョンのネイティブキーインデックス（0-511）は廃止されている。

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

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

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

**主要処理フロー**:
1. **9740-9743行目**: 公開API（owner_id = ImGuiKeyOwner_Any）
2. **9745-9753行目**: 内部API（オーナーシップ確認付き）

#### Step 3: 関連関数を理解する

キーデータ取得とオーナーシップテストを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | GetKeyData関数 |
| 3-2 | imgui.cpp | `imgui.cpp` | TestKeyOwner関数 |

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

```
ImGui::IsKeyDown(ImGuiKey)
    │
    └─ ImGui::IsKeyDown(ImGuiKey, ImGuiID)
           │
           ├─ GetKeyData(key)
           │      └─ ImGuiKeyData* 取得
           │
           └─ TestKeyOwner(key, owner_id)
                  └─ キーオーナーシップ確認
```

### データフロー図

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

ImGuiKey      ───▶ GetKeyData() ───┐
                        │          │
                        ▼          │
              ImGuiKeyData::Down ──┤
                        │          │
                        ▼          │
              TestKeyOwner() ──────┴─▶ bool (true/false)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 関数宣言、ImGuiKey列挙型、ImGuiKeyData構造体 |
| imgui.cpp | `imgui.cpp` | ソース | IsKeyDown関数実装 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | 使用例（7836行目：Keys down表示） |
