5efa9c37d6
- Created detailed documentation for the device_manager, model, model_extra, osc, overlay, overlay_image, transcription, translation, transliteration, utils, watchdog, and websocket modules. - Added a comprehensive run events payloads document outlining the payloads sent during various run events in the controller. - Included runtime instructions and dependencies for setting up the project in a Windows environment. - Introduced a mypy configuration file to manage type checking and ignore errors in specific modules temporarily.
32 lines
1.7 KiB
Markdown
32 lines
1.7 KiB
Markdown
# overlay.py — OpenVR オーバーレイ管理
|
||
|
||
目的: OpenVR を使ったオーバーレイ表示（複数サイズ: small/large）を管理する `Overlay` クラスを提供します。
|
||
|
||
主要メソッド:
|
||
- __init__(self, settings_dict)
|
||
- init(self) -> None
|
||
- startOverlay(self) -> None
|
||
- shutdownOverlay(self) -> None
|
||
- reStartOverlay(self) -> None
|
||
- updateImage(self, img: PIL.Image.Image, size: str) -> None
|
||
- updateOpacity(self, opacity: float, size: str, with_fade: bool = False) -> None
|
||
- updateUiScaling(self, ui_scaling: float, size: str) -> None
|
||
- updatePosition(self, x_pos, y_pos, z_pos, x_rotation, y_rotation, z_rotation, tracker, size) -> None
|
||
- mainloop(self) -> None # アニメーション / フェード評価ループ
|
||
|
||
使用上の注意:
|
||
- OpenVR (SteamVR) が稼働していることが前提です。`checkSteamvrRunning()` で `vrmonitor.exe` の存在チェックを行います。
|
||
- 例外が発生した場合は `errorLogging()` を呼んでスタックトレースを残します。
|
||
|
||
## モジュール構成（補足）
|
||
|
||
- overlay.py — OpenVR を使ったオーバーレイ管理。Overlay クラスは複数サイズ（small/large）を扱い、位置/回転/透明度/フェードを制御する。
|
||
- overlay_image.py — PIL を使ってオーバーレイに表示する画像を生成（テキストボックス、ログレイアウト、フォント管理）。
|
||
- overlay_utils.py — 行列演算や座標変換ユーティリティ。
|
||
|
||
注意点:
|
||
- OpenVR（SteamVR）に依存。SteamVR が動作していることが前提。
|
||
- フォントファイルは repo の fonts フォルダか、ランタイム内パスを探索して読み込む。
|
||
- 生成画像は RGBA バイト列に変換され `overlay.setOverlayRaw` で渡される。
|
||
|