# 機能設計書 64-ノート描画

## 概要

本ドキュメントは、K-Shoot MANIA のプレイ画面におけるノート（BT/FXのチップ・ロングノート・レーザー）の3D描画機能の設計を記述する。drawFrame 関数内で、譜面データに基づいたノートオブジェクトをリアルタイムに描画する。

### 本機能の処理概要

**業務上の目的・背景**：リズムゲームの核となる視覚表現機能である。プレイヤーが判定タイミングを視覚的に認識するため、譜面データに基づくノートを画面上にリアルタイムで描画する必要がある。ノートの種類（BT/FX/レーザー）ごとに異なる描画処理が実装されている。

**機能の利用シーン**：ゲームプレイ画面（SCENE_PLAY）の毎フレーム描画処理として、drawFrame 関数の一部として実行される。

**主要な処理内容**：
1. 小節線の描画（拍子に基づく等間隔線）
2. レーンアニメーションの描画（スクロール効果）
3. ロング FX ノートの描画（82px幅、判定状態に応じた色変化）
4. ロング BT ノートの描画（40px幅、判定状態に応じた色変化）
5. チップ FX ノートの描画（キー音有無で画像切替）
6. チップ BT ノートの描画（距離に応じたスプライト選択）
7. レーザー（アナログ）ノートの描画（直角・斜線・接続表現）
8. BT/FX の光エフェクト描画（judge 配列に基づく判定アニメーション）

**関連システム・外部連携**：HGIMG4（HSP 3Dエンジン）による3D描画。テクスチャはキャッシュファイル（cache/）およびリソース画像（imgs/）から読み込み。

**権限による制御**：ノートモード設定（shortmode/longmode/analogmode）により、ON/OFF/HIDE/AUTO の各モードで描画・非描画が制御される。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 5 | ゲームプレイ画面 | 主画面 | play_draw_frame.hsp による BT/FX/レーザーのチップ・ロング・3D描画 |

## 機能種別

描画処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| note | int配列 | Yes | ノートデータ配列（レーン/位置/長さ/タイミング等） | notenum 個のノート |
| analog | int配列 | Yes | アナログ（レーザー）データ配列 | analognum 個のレーザー |
| cnow | int | Yes | 現在の譜面位置（カウント値） | - |
| hs | int | Yes | HiSpeed値（スクロール速度） | 1以上 |
| ra | int | Yes | 解像度スケーリング係数 | 1 または 2 |
| t | int | Yes | 現在のプレイ時間（ms） | - |
| judge | int配列 | Yes | 判定結果配列（タイミング・判定種別） | 6レーン分 |
| arstat | int配列 | Yes | アクティブノート状態配列 | - |

### 入力データソース

譜面読み込み処理（play_chart_load.hsp）で展開された note/analog 配列。play_game_logic.hsp で更新される判定状態。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 画面描画 | ビットマップ | バッファ5（メインレーン）および51（光レーン）への描画出力 |

### 出力先

画面バッファ（gsel 5 / gsel 51）へのビットマップ描画。3Dエンジン経由でテクスチャとしてレーンオブジェクトに適用。

## 処理フロー

### 処理シーケンス

```
1. Center Split の計算
   └─ GetCurrentCamValue で center_split_now を取得し、ピクセル値に変換
2. レーンテクスチャのコピー（左右分割）
3. 小節線の描画
   └─ 拍子(beatn/beatd)に基づき等間隔で小節線をgcopy
4. レーンスクロールアニメーション
   └─ 300px周期の4段階アニメーション
5. ロングFXノートの描画 (repeat 2, 4)
   └─ note.i.2>0 のノートを対象に、hsrc関数で位置計算
   └─ 判定状態(arstat/ljudge)に応じた4パターンの色切替
6. ロングBTノートの描画 (repeat 4)
   └─ 同様の位置計算と判定状態に応じた色切替
7. チップFXノートの描画 (repeat 2, 4)
   └─ note.i.2=0 のノートを対象
   └─ キー音有無(notese.i)で画像切替（gcopy 43 / gcopy 186）
8. チップBTノートの描画 (repeat 4)
   └─ 距離に応じたスプライト番号選択（8段階 * 9種 + note.i.6）
9. レーザー（アナログ）ノートの描画
   └─ 直角判定(analog.i.2<=UNIT_MEASURE_32)で描画方法分岐
   └─ gsquare によるポリゴン描画（テクスチャマッピング付き）
10. 光エフェクトの描画（bg>=1 の場合）
    └─ バッファ51への加算合成描画
```

### フローチャート

```mermaid
flowchart TD
    A[drawFrame 開始] --> B[Center Split 計算]
    B --> C[レーンテクスチャコピー]
    C --> D[小節線描画]
    D --> E[レーンアニメーション描画]
    E --> F[ロングFXノート描画]
    F --> G[ロングBTノート描画]
    G --> H[チップFXノート描画]
    H --> I[チップBTノート描画]
    I --> J[判定光エフェクト描画]
    J --> K[レーザーノート描画]
    K --> L[判定光エフェクト2]
    L --> M[return]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-64-1 | 描画範囲 | cnow-UNIT_MEASURE_4 以降のノートのみ描画（過ぎ去ったノートはスキップ） | 全ノート |
| BR-64-2 | 上端打ち切り | hsrc > UNIT_MEASURE*(vh+20)/10/hs のノートは描画打ち切り | 全ノート |
| BR-64-3 | 判定状態色分け | アクティブ・成功・失敗・未到達の4パターンで色を変える | ロングノート |
| BR-64-4 | キー音ノート区別 | notese.i=-1（キー音なし）と notese.i!=-1（キー音あり）で異なる画像使用 | チップFX |
| BR-64-5 | Center Split 対応 | center_split_now に応じて左右のレーン描画位置をずらす | 全描画 |
| BR-64-6 | 光レーン描画条件 | bg>=1 の場合のみバッファ51への光レーン描画を行う | 背景有効時 |

### 計算ロジック

**ノートのY座標計算**:
```
hsrc1 = hsrc(note.i.1, note.i.3)  // カウント位置→スクロール位置変換
Y = -(hsrc1 * 10 * hs / UNIT_MEASURE) / ra + vh/ra - 16/ra + 7/ra
```

**ロングノートの長さ計算**:
```
hsrc12 = hsrc(note.i.1 + note.i.2, note.i.4)  // 終端位置
stat1 = max((hsrc12 - hsrc1) * hs * 10 / UNIT_MEASURE / ra, 1)
```

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

該当なし。メモリ上の配列データと画面バッファへの描画のみ。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ノート範囲外 | i<0 または i>=notenum | break で描画ループ終了 |
| - | ロングノート長さ0 | stat1-stat3-stat4<=0 | 描画をスキップ |

### リトライ仕様

該当なし。

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

該当なし。

## パフォーマンス要件

毎フレーム実行される描画処理であり、ノート数に比例する処理時間が必要。notefcnt 配列による描画開始位置の最適化と、上端打ち切りによる早期ループ終了で負荷を軽減している。

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

該当なし。

## 備考

- anaranfl=2 の場合はアナログランダム用の別バッファ（gsel 168）に描画される
- note配列の構造: note.i.0=レーン(0-5), note.i.1=カウント位置, note.i.2=長さ, note.i.3=開始時間, note.i.4=終了時間, note.i.5=次ノートインデックス, note.i.6=スプライト種別
- slshift 変数はSTOP対応のスクロール位置シフトに使用される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | play_chart_load.hsp | `src/scene/play/play_chart_load.hsp` | note 配列の構造: [レーン][カウント位置][長さ][開始時間][終了時間][次ノートIdx][スプライト] |
| 1-2 | play_chart_load.hsp | `src/scene/play/play_chart_load.hsp` | analog 配列の構造: [L/R][カウント位置][長さ][開始位置][終了位置][直角フラグ][開始時間][終了時間][接続フラグ] |

**読解のコツ**: HSP では多次元配列が `note.i.0` の形式でアクセスされる。`.` の左がインデックス、右がフィールド番号。notefcnt は各レーンの描画開始インデックスを保持し、過去のノートをスキップするための最適化に使われる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | play_draw_frame.hsp | `src/scene/play/play_draw_frame.hsp` | `drawFrame` 関数（1行目から定義）の前半部分がノート描画処理 |

**主要処理フロー**:
1. **1-30行目**: Center Split 計算とレーンテクスチャのコピー
2. **33-59行目**: 小節線の描画
3. **62-68行目**: レーンスクロールアニメーション
4. **72-126行目**: ロングFXノートの描画
5. **128-199行目**: ロングBTノートの描画
6. **201-233行目**: チップFXノートの描画
7. **235-264行目**: チップBTノートの描画
8. **266-485行目**: レーザー（アナログ）ノートの描画

#### Step 3: 位置計算関数 hsrc を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | play_game_logic.hsp | `src/scene/play/play_game_logic.hsp` | hsrc 関数: カウント位置をスクロール位置（ピクセル相当）に変換する関数。BPM変化・STOP対応 |

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

```
play_update (メインループ)
    |
    +-- drawFrame
            |
            +-- GetCurrentCamValue(CAM_CENTER_SPLIT)
            +-- gcopy (レーンテクスチャ / 小節線 / ノートスプライト)
            +-- hsrc() (位置計算)
            +-- gsquare (レーザーポリゴン描画)
            +-- gmode (描画モード切替: 0=通常, 2=透過, 5=加算, 6=乗算, 7=半透明)
```

### データフロー図

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

note配列          ───>  ┌───────────────────────────┐
analog配列        ───>  |  drawFrame               |
cnow (現在位置)   ───>  |  ├─ 小節線描画           |
hs (スクロール速度)───>  |  ├─ ロングFX描画         |      バッファ5 (メインレーン)
judge配列        ───>  |  ├─ ロングBT描画         |  ──> バッファ51 (光レーン)
arstat配列       ───>  |  ├─ チップFX描画         |      テクスチャ → 3Dレーン
                        |  ├─ チップBT描画         |
                        |  └─ レーザー描画         |
                        └───────────────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| play_draw_frame.hsp | `src/scene/play/play_draw_frame.hsp` | ソース | drawFrame 関数（ノート描画の主処理、1-485行目） |
| play_chart_load.hsp | `src/scene/play/play_chart_load.hsp` | ソース | note/analog 配列の構築 |
| play_game_logic.hsp | `src/scene/play/play_game_logic.hsp` | ソース | hsrc 関数（位置計算）、judge/arstat の更新 |
| play_graphics.hsp | `src/scene/play/play_graphics.hsp` | ソース | ノート描画用テクスチャのロード |
