overlay: ルビ表示の上下パディングを対称化(outer_padding導入)しテキスト周囲にUIパディングを追加、ルビ機能のドキュメントを追加
This commit is contained in:
41
src-python/docs/overlay_ruby.md
Normal file
41
src-python/docs/overlay_ruby.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# 小型ログ ルビ表示機能 (Ruby Overlay for Small Log)
|
||||
|
||||
## 概要
|
||||
小型ログ (Small Log Overlay) に日本語原文が含まれる場合、ローマ字(hepburn) を上段、ひらがな(hira) を下段として原文メッセージの上に 2 段のルビを表示できます。翻訳行には現段階ではルビを付与しません。
|
||||
|
||||
## 有効化条件
|
||||
- 原文 `message` が存在し空文字列でない。
|
||||
- `model.createOverlayImageSmallLog` 内で自動的に `convertMessageToTransliteration(..., hiragana=True, romaji=True)` を呼び出しトークン生成。
|
||||
- 生成されたトークンに `hepburn` または `hira` が含まれる。
|
||||
|
||||
## 設定キー (`config.OVERLAY_SMALL_LOG_SETTINGS`)
|
||||
| キー | 型 | 初期値 | 説明 |
|
||||
| ---- | --- | ------ | ---- |
|
||||
| ruby_font_scale | float | 0.5 | ルビ文字サイズ倍率 (原文フォントサイズ * 倍率)。安全範囲 0.05〜3.0 |
|
||||
| ruby_line_spacing | int | 4 | ローマ字行とひらがな行の垂直スペース (px)。0〜200 |
|
||||
|
||||
## レイアウト仕様
|
||||
1. ルビブロック (romaji 上 / hiragana 下) を中央揃えで描画。
|
||||
2. その下に従来の本文テキストボックスを縦方向に連結。
|
||||
3. フォントファミリは本文と同一 (言語に対応する NotoSans 系)。
|
||||
4. ルビが存在しない場合は従来表示のみ。
|
||||
|
||||
## フォールバック
|
||||
- ルビ生成中に例外が発生した場合はログを記録し、ルビ無しで本文のみ表示。
|
||||
- トークンが空の場合(両方 False など)は従来表示。
|
||||
|
||||
## 今後の拡張候補
|
||||
- 翻訳行へのルビ付与オプション。
|
||||
- トークン単位での幅センタリングと折り返し。
|
||||
- 高度な幅計測 (可変幅フォント対応改善)。
|
||||
|
||||
## 簡易テスト
|
||||
`src-python/overlay_ruby_test.py` を実行すると `overlay_small_ruby_test.png` が生成され、縦順と配置を確認できます。
|
||||
|
||||
```bash
|
||||
# PowerShell (仮想環境有効化後)
|
||||
python src-python/overlay_ruby_test.py
|
||||
```
|
||||
|
||||
## 注意
|
||||
UI スケーリングは OpenVR 側の表示サイズのみ変更し、画像内部フォントサイズは直接変更しません。ルビの視認性が低い場合は `ruby_font_scale` を調整してください。
|
||||
Reference in New Issue
Block a user