Oculus - stingray.Oculus ネームスペース リファレンス - Stingray Lua API リファレンス

stingray.Oculus ネームスペース リファレンス

説明

このオブジェクトは、Oculus インタフェースへのアクセスを提供します。

関数

パラメータ
この関数はパラメータを受け入れません。
戻り値
この関数は値を返しません。
パラメータ

controller :

integer

コントローラ タイプ[Oculus.CONTROLLER_LEFT_TOUCH、 Oculus.CONTROLLER_RIGHT_TOUCH、Oculus.CONTROLLER_REMOTE、Oculus.CONTROLLER_XBOX]

button :

integer

コントローラ ボタン[Oculus.BUTTON_A、Oculus.BUTTON_B、Oculus.BUTTON_X、Oculus.BUTTON_Y、Oculus.BUTTON_RTRIGGER、Oculus.BUTTON_RSHOULDER、BUTTON_RTHUMB、Oculus.BUTTON_LTRIGGER、Oculus.BUTTON_LSHOULDER、BUTTON_LTHUMB、Oculus.BUTTON_UP、Oculus.BUTTON_DOWN、Oculus.BUTTON_LEFT、Oculus.BUTTON_RIGHT、Oculus.BUTTON_ENTER、Oculus.BUTTON_BACK]

戻り値

boolean

指定したボタンがコントローラで保持されている場合は true を返し、それ以外の場合は false を返します。

パラメータ

controller :

integer

追跡されるコントローラ タイプ[Oculus.CONTROLLER_LEFT_TOUCH または Oculus.CONTROLLER_RIGHT_TOUCH]

戻り値

stingray.Matrix4x4

コントローラのローカル ポーズ

コントローラが追跡されていない場合は、ID マトリックスが返されます。

パラメータ

controller :

integer

コントローラ タイプ[Oculus.CONTROLLER_LEFT_TOUCH、 Oculus.CONTROLLER_RIGHT_TOUCH、Oculus.CONTROLLER_REMOTE、Oculus.CONTROLLER_XBOX]

button :

integer

コントローラ ボタン[Oculus.BUTTON_A、Oculus.BUTTON_B、Oculus.BUTTON_X、Oculus.BUTTON_Y、Oculus.BUTTON_RTRIGGER、Oculus.BUTTON_RSHOULDER、BUTTON_RTHUMB、Oculus.BUTTON_LTRIGGER、Oculus.BUTTON_LSHOULDER、BUTTON_LTHUMB、Oculus.BUTTON_UP、Oculus.BUTTON_DOWN、Oculus.BUTTON_LEFT、Oculus.BUTTON_RIGHT、Oculus.BUTTON_ENTER、Oculus.BUTTON_BACK]

戻り値

boolean

指定したボタンがコントローラで押されている場合は true を返し、それ以外の場合は false を返します。

パラメータ

controller :

integer

コントローラ タイプ[Oculus.CONTROLLER_LEFT_TOUCH、Oculus.CONTROLLER_RIGHT_TOUCH、Oculus.CONTROLLER_XBOX]

frequency :

number

0.0 ~ 1.0 のパルス周波数です。現在の有効値は 0.0、0.5、および 1.0のみです。その他の値は、これらの値のいずれかに固定されます。

amplitude :

number

0.0 ~ 1.0 のパルスの振幅です。

戻り値
この関数は値を返しません。
パラメータ

controller :

integer

コントローラ タイプ[Oculus.CONTROLLER_LEFT_TOUCH、 Oculus.CONTROLLER_RIGHT_TOUCH、Oculus.CONTROLLER_REMOTE、Oculus.CONTROLLER_XBOX]

button :

integer

コントローラ ボタン[Oculus.BUTTON_A、Oculus.BUTTON_B、Oculus.BUTTON_X、Oculus.BUTTON_Y、Oculus.BUTTON_RTRIGGER、Oculus.BUTTON_RSHOULDER、BUTTON_RTHUMB、Oculus.BUTTON_LTRIGGER、Oculus.BUTTON_LSHOULDER、BUTTON_LTHUMB、Oculus.BUTTON_UP、Oculus.BUTTON_DOWN、Oculus.BUTTON_LEFT、Oculus.BUTTON_RIGHT、Oculus.BUTTON_ENTER、Oculus.BUTTON_BACK]

戻り値

number

指定したコントローラ ボタンの最初のアナログ値です。値が未使用の場合は、0.0 が返されます。

number

指定したコントローラ ボタンの 2 番目のアナログ値です。値が未使用の場合は、0.0 が返されます。

Oculus.BUTTON_RTHUMB または Oculus BUTTON_LTHUMB が要求された場合は、x および y のアナログ位置が返されます。それ以外の場合、その他のボタンは、最初の値がアナログ値(0 ~ 1 の間で変化)を含むのに対して、2 番目は常に 0 です。

パラメータ

controller :

integer

コントローラ タイプ[Oculus.CONTROLLER_LEFT_TOUCH、 Oculus.CONTROLLER_RIGHT_TOUCH、Oculus.CONTROLLER_REMOTE、Oculus.CONTROLLER_XBOX]

button :

integer

コントローラ ボタン[Oculus.BUTTON_A、Oculus.BUTTON_B、Oculus.BUTTON_X、Oculus.BUTTON_Y、Oculus.BUTTON_RTRIGGER、Oculus.BUTTON_RSHOULDER、BUTTON_RTHUMB、Oculus.BUTTON_LTRIGGER、Oculus.BUTTON_LSHOULDER、BUTTON_LTHUMB、Oculus.BUTTON_UP、Oculus.BUTTON_DOWN、Oculus.BUTTON_LEFT、Oculus.BUTTON_RIGHT、Oculus.BUTTON_ENTER、Oculus.BUTTON_BACK]

戻り値

boolean

指定したボタンがコントローラで解放されている場合は true を返し、それ以外の場合は false を返します。

パラメータ

touch :

integer

タッチしているコントローラ ボタン[ Oculus.TOUCH_A, Oculus.TOUCH_B、Oculus.TOUCH_RTHUMB、Oculus.TOUCH_RTHUMBREST、Oculus.TOUCH_RTHUMBUP、Oculus.TOUCH_RTRIGGER、Oculus.TOUCH_RPOINTING、Oculus.TOUCH_X、Oculus.TOUCH_Y、Oculus.TOUCH_LTHUMB、Oculus.TOUCH_LSHOULDER、Oculus.TOUCH_LTHUMBUP、Oculus.TOUCH_LTRIGGER、Oculus.TOUCH_LPOINTING ]

戻り値

boolean

指定したボタンがコントローラで触れられている場合は true を返し、それ以外の場合は false を返します。

タッチ機能があるのは OCULUS TOUCH コントローラのみであることに注意してください。

パラメータ

touch :

integer

タッチしているコントローラ ボタン[ Oculus.TOUCH_A, Oculus.TOUCH_B、Oculus.TOUCH_RTHUMB、Oculus.TOUCH_RTHUMBREST、Oculus.TOUCH_RTHUMBUP、Oculus.TOUCH_RTRIGGER、Oculus.TOUCH_RPOINTING、Oculus.TOUCH_X、Oculus.TOUCH_Y、Oculus.TOUCH_LTHUMB、Oculus.TOUCH_LSHOULDER、Oculus.TOUCH_LTHUMBUP、Oculus.TOUCH_LTRIGGER、Oculus.TOUCH_LPOINTING ]

戻り値

boolean

指定したボタンがコントローラで触れられている場合は true を返し、それ以外の場合は false を返します。

タッチ機能があるのは OCULUS TOUCH コントローラのみであることに注意してください。

パラメータ

controller :

integer

追跡されるコントローラ タイプ[Oculus.CONTROLLER_LEFT_TOUCH または Oculus.CONTROLLER_RIGHT_TOUCH]

戻り値

stingray.Matrix4x4

コントローラのワールド ポーズ

コントローラが追跡されていない場合は、ID マトリックスが返されます。

パラメータ

name :

string

レイヤ名です。

layer_rt :

string

レイヤのレンダー ターゲット名です。

戻り値
この関数は値を返しません。

これは、ヘッドアップ ディスプレイ、テキスト情報、オブジェクト ラベルなどに便利です。

パラメータ

enabled :

boolean

有効状態のフラグです。

戻り値
この関数は値を返しません。
パラメータ

eye :

integer

クエリーする目(stingray.Oculus.EYE_LEFT または stingray.Oculus.EYE_RIGHT)

戻り値

table

目の情報が入力されたテーブルです。

パラメータ
この関数はパラメータを受け入れません。
戻り値

table

Oculus HMD の情報が入力されたテーブルです。

パラメータ
この関数はパラメータを受け入れません。
戻り値

stingray.Matrix4x4

頭のローカル ポーズ

stingray.Matrix4x4

左目のローカル ポーズ

stingray.Matrix4x4

右目のローカル ポーズ

パラメータ
この関数はパラメータを受け入れません。
戻り値

stingray.Matrix4x4

頭のワールド ポーズ

stingray.Matrix4x4

左目のワールド ポーズ

stingray.Matrix4x4

右目のワールド ポーズ

追跡されていない場合は、恒等行列が返されます。

パラメータ

render_target :

string

立体視のレンダー ターゲット名です。

camera :

stingray.Camera

立体視レンダリングに使用するカメラです。

world :

stingray.World

カメラを含むワールドです。

flags :

integer?

(オプション) フラグを初期化します。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値

boolean

Oculus VR が適切に初期化された場合は true を返し、それ以外の場合は false を返します。

パラメータ
この関数はパラメータを受け入れません。
戻り値

table

Oculus Configuration Utility を使用して、現在のプロファイル データ セットが入力されたテーブルです。

より具体的には、プレイヤーの高さ、目の高さ、瞳孔間距離および首から目までの距離をメートル単位で返します。

パラメータ
この関数はパラメータを受け入れません。
戻り値
この関数は値を返しません。
パラメータ

name :

string

レイヤ名です。

戻り値
この関数は値を返しません。
パラメータ

camera :

stingray.Camera

立体視レンダリングに使用するカメラです。

world :

stingray.World

カメラを含むワールドです。

戻り値
この関数は値を返しません。

これは、ゲーム内で新しいワールドを作成し、それを VR に移行する場合に便利です。

パラメータ

name :

string

高品質のレンダー パスに設定するレイヤの名前。

hq_enabled :

boolean

このレイヤが高品質のレンダー パスを使用する必要があるかどうかを指定します。

戻り値
この関数は値を返しません。
パラメータ

name :

string

更新するレイヤの名前。

width :

number

メートル単位のレイヤのクアッドの幅

height :

number

メートル単位のレイヤのクアッドの高さ

戻り値
この関数は値を返しません。

既定では、レイヤは横幅 1 メートルのクアッドにレンダリングされます。

パラメータ

name :

string

更新するレイヤの名前。

pose :

stingray.Matrix4x4

レイヤ中央のポーズです。

headlocked :

boolean

レイヤ ポーズを HMD を基準(頭部に固定)にするか、または追跡の原点を基準にするかを指定します。

戻り値
この関数は値を返しません。

既定では、ポーズは HMD の 0.5m 前に、頭部に固定されます。

パラメータ

name :

string

レイヤの名前です。

visible :

boolean

このレイヤを表示するかどうかを指定します。

戻り値
この関数は値を返しません。
パラメータ

position :

stingray.Vector3

トラッキング空間の位置

rotation :

stingray.Quaternion

トラッキング空間の回転

scale :

stingray.Vector3

トラッキング空間のスケール

戻り値
この関数は値を返しません。
パラメータ

pose :

stingray.Matrix4x4

トラッキング空間のポーズ

戻り値
この関数は値を返しません。

廃止予定です。代わりに OculusVR.set_tracking_space(Vector3, Quaternion, Vector3) を使用してください。

パラメータ
この関数はパラメータを受け入れません。
戻り値
この関数は値を返しません。
パラメータ
この関数はパラメータを受け入れません。
戻り値

stingray.Matrix4x4

トラッキング空間のポーズ

パラメータ
この関数はパラメータを受け入れません。
戻り値

stingray.Vector3

トラッキング空間のスケール

パラメータ
この関数はパラメータを受け入れません。
戻り値

boolean

デバイス セッションが有効な場合は true を返します。デスクトップでは、これは Oculus.initialize の後に発生し、モバイルでは、これは Oculus.enable の後に発生します。