SteamVR - stingray.SteamVR ネームスペース リファレンス - Stingray Lua API リファレンス
説明
このオブジェクトは、SteamVR インタフェースへのアクセスを提供します。
関連サンプル コード 
その他の関連リファレンス項目
この参照ページは、次の概要トピックと関連付けられています
関数
| この関数はパラメータを受け入れません。 |
| この関数は値を返しません。 |
 |
clear_layers ( ) すべてのレイヤを消去します。
|
| この関数はパラメータを受け入れません。 |
| この関数は値を返しません。 |
| |
controller_held ( controller, button ) : boolean指定したコントローラ用に指定したボタンがこのフレームを保持していたかどうかに応じて、true または false を返します。
|
controller : | integer | コントローラのインデックス |
button : | integer | コントローラ ボタン [SteamVR.BUTTON_SYSTEM, SteamVR.BUTTON_MENU, SteamVR.BUTTON_GRIP, SteamVR.BUTTON_TOUCH and SteamVR.BUTTON_TRIGGER SteamVR.BUTTON_TOUCH_UP, SteamVR.BUTTON_TOUCH_DOWN, SteamVR.BUTTON_TOUCH_LEFT, SteamVR.BUTTON_TOUCH_RIGHT] |
boolean |
指定したボタンがコントローラで保持されている場合は true を返し、それ以外の場合は false を返します。 |
| |
controller_local_pose ( index ) : stingray.Matrix4x4指定したコントローラのローカル ポーズを返します。
|
index : | integer | コントローラのインデックス |
|
コントローラのローカル ポーズ |
コントローラが追跡されていない場合は、ID マトリックスが返されます。
| |
controller_pressed ( controller, button ) : boolean指定したコントローラ用に指定したボタンがこのフレームを押していたかどうかに応じて、true または false を返します。
|
controller : | integer | コントローラのインデックス |
button : | integer | コントローラ ボタン [SteamVR.BUTTON_SYSTEM, SteamVR.BUTTON_MENU, SteamVR.BUTTON_GRIP, SteamVR.BUTTON_TOUCH and SteamVR.BUTTON_TRIGGER SteamVR.BUTTON_TOUCH_UP, SteamVR.BUTTON_TOUCH_DOWN, SteamVR.BUTTON_TOUCH_LEFT, SteamVR.BUTTON_TOUCH_RIGHT] |
boolean |
指定したボタンがコントローラで押されている場合は true を返し、それ以外の場合は false を返します。 |
| |
controller_pulse ( index, seconds )指定されたコントローラの触覚パルスをトリガします。
|
index : | integer | コントローラのインデックス |
seconds : | number | 秒単位で示すパルスの時間で、パルスの最大長は 0.003999 秒です。 |
| この関数は値を返しません。 |
これは、振動を発生させるすべてのフレームで呼び出す必要があります。この関数に指定したパルスの時間が、実際の振動の強さになります。
| |
controller_released ( controller, button ) : boolean指定したコントローラ用に指定したボタンがこのフレームを解放したかどうかに応じて、true または false を返します。
|
controller : | integer | コントローラのインデックス |
button : | integer | コントローラ ボタン [SteamVR.BUTTON_SYSTEM, SteamVR.BUTTON_MENU, SteamVR.BUTTON_GRIP, SteamVR.BUTTON_TOUCH and SteamVR.BUTTON_TRIGGER SteamVR.BUTTON_TOUCH_UP, SteamVR.BUTTON_TOUCH_DOWN, SteamVR.BUTTON_TOUCH_LEFT, SteamVR.BUTTON_TOUCH_RIGHT] |
boolean |
指定したボタンがコントローラで解放されている場合は true を返し、それ以外の場合は false を返します。 |
| |
controller_setup ( unit, root, material )ジオメトリ バッファを一杯にして指定したマテリアルを適用することで、コントローラを設定および作成します。
|
unit : | コントローラ ユニット | |
root : | string | ジオメトリのルートの名前 |
material : | string | マテリアルの名前 |
| この関数は値を返しません。 |
| |
controller_touched ( controller, button ) : boolean指定したコントローラ用に指定したボタンがこのフレームを触れているかどうかに応じて、true または false を返します。
|
controller : | integer | コントローラのインデックス |
button : | integer | コントローラ ボタン [SteamVR.BUTTON_SYSTEM, SteamVR.BUTTON_MENU, SteamVR.BUTTON_GRIP, SteamVR.BUTTON_TOUCH and SteamVR.BUTTON_TRIGGER SteamVR.BUTTON_TOUCH_UP, SteamVR.BUTTON_TOUCH_DOWN, SteamVR.BUTTON_TOUCH_LEFT, SteamVR.BUTTON_TOUCH_RIGHT] |
boolean |
指定したボタンがコントローラで触れられている場合は true を返し、それ以外の場合は false を返します。 |
SteamVR.BUTTON_TOUCH には、現在これらのイベントだけしかないため、注意してください。その他のボタンが要求された場合は、false が返されます。
| |
controller_untouched ( controller, button ) : boolean指定したコントローラ用に指定したボタンがこのフレームを触れていないかどうかに応じて、true または false を返します。
|
controller : | integer | コントローラのインデックス |
button : | integer | コントローラ ボタン [SteamVR.BUTTON_SYSTEM, SteamVR.BUTTON_MENU, SteamVR.BUTTON_GRIP, SteamVR.BUTTON_TOUCH and SteamVR.BUTTON_TRIGGER SteamVR.BUTTON_TOUCH_UP, SteamVR.BUTTON_TOUCH_DOWN, SteamVR.BUTTON_TOUCH_LEFT, SteamVR.BUTTON_TOUCH_RIGHT] |
boolean |
指定したボタンがコントローラで触れられていない場合は true を返し、それ以外の場合は false を返します。 |
SteamVR.BUTTON_TOUCH には、現在これらのイベントだけしかないため、注意してください。その他のボタンが要求された場合は、false が返されます。
| |
controller_value ( controller, button ) : number, number指定したコントローラ ボタンのアナログ値を返します。
|
controller : | integer | コントローラのインデックス |
button : | integer | コントローラ ボタン [SteamVR.BUTTON_SYSTEM, SteamVR.BUTTON_MENU, SteamVR.BUTTON_GRIP, SteamVR.BUTTON_TOUCH and SteamVR.BUTTON_TRIGGER SteamVR.BUTTON_TOUCH_UP, SteamVR.BUTTON_TOUCH_DOWN, SteamVR.BUTTON_TOUCH_LEFT, SteamVR.BUTTON_TOUCH_RIGHT] |
number |
指定したコントローラ ボタンの最初のアナログ値です。使用されていない場合は、0.0 が返されます。 |
number |
指定したコントローラ ボタンの 2 番目のアナログ値です。使用されていない場合は、0.0 が返されます。 |
SteamVR.BUTTON_TOUCH が要求された場合、x および y アナログ ポジションが返されます。それ以外の場合、その他のボタンは、最初の値がアナログ値(0 ～ 1 の間で変化)を含むのに対して、2 番目は常に 0 です。
| |
controller_world_pose ( index ) : stingray.Matrix4x4指定したコントローラのワールド ポーズを返します。
|
index : | integer | コントローラのインデックス |
|
コントローラのワールド ポーズ |
コントローラが追跡されていない場合は、ID マトリックスが返されます。
| |
create_layer ( name, layer_rt )仮想世界の中の特定のポーズおよびサイズの矩形として表示されるモノスコープのような画像を作成します。
|
name : | string | レイヤ名です。 |
layer_rt : | string | レイヤのレンダー ターゲット名です。 |
| この関数は値を返しません。 |
これは、ヘッドアップ ディスプレイ、テキスト情報、オブジェクト ラベルなどに便利です。
| |
fade_to_color ( color, seconds )HMD のビューを特定の色にフェードします。
|
color : | フェード イン/アウトする色 | |
seconds : | number | フェード イン/アウトする時間 |
| この関数は値を返しません。 |
このカラーは、color パラメータに入れて渡したカラー オブジェクトを作成するときに、stingray.Color() に渡したアルファ パラメータに基づいてシーンの上部でフェードします。この関数の「最初の」パラメータにはアルファ値を指定する必要があります。
たとえば、フェード カラーを即座に除去するには、完全に透明なカラーに 0 秒の時間で「フェード」します。
stingray.SteamVR.fade_to_color(stingray.Color(0, 0, 0, 0), 0)
2 秒間で半透明の青にフェードするには:
stingray.SteamVR.fade_to_color(stingray.Color(127, 0, 0, 255), 2) -- Alpha = 127, Blue = 255
5 秒間で完全に不透明な白にフェードするには:
stingray.SteamVR.fade_to_color(stingray.Color(255, 255, 255, 255), 5)
| |
hmd_local_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4HMD の頭、左目、および右目のローカル ポーズを返します。
|
| この関数はパラメータを受け入れません。 |
|
頭のローカル ポーズ | |
|
左目のローカル ポーズ | |
|
右目のローカル ポーズ |
追跡されていない場合は、恒等行列が返されます。
| |
hmd_world_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4HMD の頭、左目、および右目のワールド ポーズを返します。
|
| この関数はパラメータを受け入れません。 |
|
頭のワールド ポーズ | |
|
左目のワールド ポーズ | |
|
右目のワールド ポーズ |
追跡されていない場合は、恒等行列が返されます。
| |
initialize ( render_target, camera, world, flags ) : booleanSteamVR システムを初期化します。
|
render_target : | string | 立体視のレンダー ターゲット名です。 |
camera : | 立体視レンダリングに使用するカメラです。 | |
world : | カメラを含むワールドです。 | |
flags : | integer? | (オプション) フラグを初期化します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
boolean |
SteamVR が適切に初期化された場合は true を返し、それ以外の場合は false を返します。 |
| |
is_hmd_tracked ( index ) : boolean指定したコントローラが追跡されているかどうかを返します。
|
index : | integer | コントローラのインデックス |
boolean |
指定したインデックスを持つコントローラが現在追跡されている場合は true を返し、それ以外の場合は false を返します。 |
| |
is_hmd_tracked ( ) : booleanHMD が追跡されているかどうかを返します。
|
| この関数はパラメータを受け入れません。 |
boolean |
HMD が現在追跡されている場合は true を返し、それ以外の場合は false を返します。 |
| |
link_node_to_tracker ( unit, node, world, type, index )VR トラッカーによって自動的に更新されるようにするため、Unit ノードをリンクします。
|
unit : | トラッカーにリンクするユニット | |
node : | integer | そのユニット内でリンクされているシーン グラフ ノード |
world : | ユニットを含むワールド | |
type : | integer | トラッカー リンクのタイプ(SteamVR.LINK_HMD または SteamVR.LINK_CONTROLLER) |
index : | integer? | SteamVR.LINK_HMD を使用している場合は、オプションのインデックス(SteamVR.EYE_LEFT または SteamVR.EYE_RIGHT、インデックスを省略した場合は単に HMD にリンクする)です。それ以外の場合はコントローラ インデックスです。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
remove_layer ( name )指定されたレイヤを削除します。
|
name : | string | レイヤ名です。 |
| この関数は値を返しません。 |
| |
set_camera ( camera, world )SteamVR に新しいカメラを設定します。
|
camera : | 立体視レンダリングに使用するカメラです。 | |
world : | カメラを含むワールドです。 |
| この関数は値を返しません。 |
これは、ゲーム内で新しいワールドを作成し、それを VR に移行する場合に便利です。
| |
set_high_quality_layer ( name, hq_enabled, curved, min_curve, max_curve )レイヤで高品質のレンダーパス、およびそれによって有効化されている高品質オプションを使用するかどうかを指定します。
|
name : | string | 高品質のレンダー パスに設定するレイヤの名前。 |
hq_enabled : | boolean | このレイヤが高品質のレンダー パスを使用する必要があるかどうかを指定します。 |
curved : | boolean? | (オプション) レイヤを曲げるかどうか(高品質なレンダリングのみ)。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
min_curve : | number? | (オプション) レイヤが最も大きくカーブする距離(m)です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
max_curve : | number? | (オプション) レイヤが最も小さくカーブする距離(m)です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
1 度にサポートされる高品質のレイヤは 1 つだけです。
| |
set_layer_dimensions ( name, width )レイヤ クアッドの幅を設定します(m)。
|
name : | string | 更新するレイヤの名前。 |
width : | number | メートル単位のレイヤのクアッドの幅 |
| この関数は値を返しません。 |
既定では、レイヤは横幅 1 メートルのクアッドにレンダリングされます。
| |
set_layer_pose ( name, pose, headlocked )レイヤ ポーズを設定します。
|
name : | string | 更新するレイヤの名前。 |
pose : | レイヤ中央のポーズです。 | |
headlocked : | boolean | レイヤ ポーズを HMD を基準(頭部に固定)にするか、またはワールド空間を基準にするかを指定します。 |
| この関数は値を返しません。 |
既定では、ポーズは HMD の 0.5m 前に、頭部に固定されます。
| |
set_layer_visibility ( name, visible )レイヤを表示するか非表示にするかを指定します。
|
name : | string | レイヤの名前です。 |
visible : | boolean | このレイヤを表示するかどうかを指定します。 |
| この関数は値を返しません。 |
| |
set_tracking_space ( position, rotation, scale )トラッキング空間のポーズを設定します
|
position : | トラッキング空間の位置 | |
rotation : | トラッキング空間の回転 | |
scale : | トラッキング空間のスケール |
| この関数は値を返しません。 |
関連サンプル コード
| |
set_tracking_space_pose ( pose )指定されているポーズを既定のトラッキング空間のポーズとして設定します。廃止予定です。代わりに SteamVR.set_tracking_space(Vector3, Quaternion, Vector3)を使用してください。
|
| |
shutdown ( )SteamVR システムをシャットダウンします。
|
| この関数はパラメータを受け入れません。 |
| この関数は値を返しません。 |
| |
tracking_space_local_rectangle ( ) : stingray.Vector3, stingray.Vector3, stingray.Vector3, stingray.Vector3トラッキング空間のローカル空間の矩形の角を返します。
|
| この関数はパラメータを受け入れません。 |
|
コーナー 1 のローカル位置です。 | |
|
コーナー 2 のローカル位置です。 | |
|
コーナー 3 のローカル位置です。 | |
|
コーナー 4 のローカル位置です。 |
コーナーは、反時計回りの順序になっており、立ち位置中心(0,0,0)は、トラッキング空間の中心となっています。各コーナーの z 値は、ローカル空間で 0 です(フロア上)。
| |
tracking_space_pose ( ) : stingray.Matrix4x4トラッキング空間のポーズを返します。
|
| |
tracking_space_scale ( ) : stingray.Vector3トラッキング スペースのスケールを返します。
|
| |
tracking_space_size ( ) : number, numberトラッキング空間のサイズ(幅、深さ)を返します。
|
| この関数はパラメータを受け入れません。 |
number |
トラッキング空間の幅 |
number |
トラッキング空間の深さ |
| |
tracking_space_world_rectangle ( ) : stingray.Vector3, stingray.Vector3, stingray.Vector3, stingray.Vector3トラッキング空間のワールド空間の矩形の角を返します。
|
| この関数はパラメータを受け入れません。 |
|
コーナー 1 のワールド位置です。 | |
|
コーナー 2 のワールド位置です。 | |
|
コーナー 3 のワールド位置です。 | |
|
コーナー 4 のワールド位置です。 |
コーナーは反時計回りであり、定義済みのトラッキング空間のポーズの周りに中心が置かれます。
| |
unlink_node_from_tracker ( unit, node )VR トラッカーによって自動的に更新されているユニット ノードをリンク解除します。
|
unit : | VR トラッカーからリンク解除するユニット | |
node : | integer | リンク解除するユニット内のシーン グラフ ノード |
| この関数は値を返しません。 |