このオブジェクトは、Oculus インタフェースへのアクセスを提供します。
その他の関連リファレンス項目
この参照ページは、次の概要トピックと関連付けられています
この関数はパラメータを受け入れません。 |
この関数は値を返しません。 |
![]() |
clear_layers ( )![]() すべてのレイヤを消去します。
|
この関数はパラメータを受け入れません。 |
この関数は値を返しません。 |
![]() |
controller_held ( controller, button ) : boolean![]() 指定したコントローラ用に指定したボタンがこのフレームを保持していたかどうかに応じて、true または false を返します。
|
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_local_pose ( controller ) : stingray.Matrix4x4![]() 指定したコントローラのローカル ポーズを返します。
|
controller : | integer | 追跡されるコントローラ タイプ[Oculus.CONTROLLER_LEFT_TOUCH または Oculus.CONTROLLER_RIGHT_TOUCH] |
コントローラのローカル ポーズ |
コントローラが追跡されていない場合は、ID マトリックスが返されます。
![]() |
controller_pressed ( controller, button ) : boolean![]() 指定したコントローラ用に指定したボタンがこのフレームを押していたかどうかに応じて、true または false を返します。
|
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_pulse ( controller, frequency, amplitude )![]() 指定されたコントローラの触覚パルスをトリガします。
|
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_released ( controller, button ) : number, number![]() 指定したコントローラ ボタンのアナログ値を返します。
|
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_released ( controller, button ) : boolean![]() 指定したコントローラ用に指定したボタンがこのフレームを解放したかどうかに応じて、true または false を返します。
|
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_touched ( touch ) : 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 コントローラのみであることに注意してください。
![]() |
controller_touched ( touch ) : 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 コントローラのみであることに注意してください。
![]() |
controller_world_pose ( controller ) : stingray.Matrix4x4![]() 指定したコントローラのワールド ポーズを返します。
|
controller : | integer | 追跡されるコントローラ タイプ[Oculus.CONTROLLER_LEFT_TOUCH または Oculus.CONTROLLER_RIGHT_TOUCH] |
コントローラのワールド ポーズ |
コントローラが追跡されていない場合は、ID マトリックスが返されます。
![]() |
create_layer ( name, layer_rt )![]() HMD の正面に、頭部に固定された矩形として表示されるモノスコープのような画像を作成します。
|
name : | string | レイヤ名です。 |
layer_rt : | string | レイヤのレンダー ターゲット名です。 |
この関数は値を返しません。 |
これは、ヘッドアップ ディスプレイ、テキスト情報、オブジェクト ラベルなどに便利です。
![]() |
enable ( enabled )![]() Oculus デバイスへのレンダリングを有効または無効にします。
|
enabled : | boolean | 有効状態のフラグです。 |
この関数は値を返しません。 |
![]() |
eye_info ( eye ) : table![]() 指定された目についての情報を含むテーブルを返します。
|
eye : | integer | クエリーする目(stingray.Oculus.EYE_LEFT または stingray.Oculus.EYE_RIGHT) |
table |
目の情報が入力されたテーブルです。 |
![]() |
hmd_info ( ) : table![]() HMD の情報を含むテーブルを返します。
|
この関数はパラメータを受け入れません。 |
table |
Oculus HMD の情報が入力されたテーブルです。 |
![]() |
hmd_local_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4![]() HMD の頭、左目、および右目のローカル ポーズを返します。
|
この関数はパラメータを受け入れません。 |
頭のローカル ポーズ | |
左目のローカル ポーズ | |
右目のローカル ポーズ |
![]() |
hmd_world_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4![]() HMD の頭、左目、および右目のワールド ポーズを返します。
|
この関数はパラメータを受け入れません。 |
頭のワールド ポーズ | |
左目のワールド ポーズ | |
右目のワールド ポーズ |
追跡されていない場合は、恒等行列が返されます。
![]() |
initialize ( render_target, camera, world, flags ) : boolean![]() Oculus VR システムを初期化します。
|
render_target : | string | 立体視のレンダー ターゲット名です。 |
camera : | 立体視レンダリングに使用するカメラです。 | |
world : | カメラを含むワールドです。 | |
flags : | integer? | (オプション) フラグを初期化します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
boolean |
Oculus VR が適切に初期化された場合は true を返し、それ以外の場合は false を返します。 |
![]() |
link_node_to_tracker ( unit, node, world, type, index )![]() VR トラッカーによって自動的に更新されるようにするため、Unit ノードをリンクします。
|
unit : | トラッカーにリンクするユニット | |
node : | integer | そのユニット内でリンクされているシーン グラフ ノード |
world : | ユニットを含むワールド | |
type : | integer | トラッカー リンクのタイプ(Oculus.LINK_HMD または Oculus.LINK_CONTROLLER) |
index : | integer? | Oculus.LINK_HMD を使用している場合は、オプションのインデックス(Oculus.EYE_LEFT または Oculus.EYE_RIGHT、 インデックスを省略した場合は単に HMD にリンクする)です。Oculus.LINK_CONTROLLER を使用している場合はコントローラのインデックス(Oculus.CONTROLLER_LEFT_TOUCH または Oculus.CONTROLLER_RIGHT_TOUCH)です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
この関数は値を返しません。 |
![]() |
profile ( ) : table![]() 現在のアクティブなプロファイル データを含むテーブルを返します。
|
この関数はパラメータを受け入れません。 |
table |
Oculus Configuration Utility を使用して、現在のプロファイル データ セットが入力されたテーブルです。 |
より具体的には、プレイヤーの高さ、目の高さ、瞳孔間距離および首から目までの距離をメートル単位で返します。
![]() |
recenter ( )![]() センサの位置および方向を中心に配置しなおします。
|
この関数はパラメータを受け入れません。 |
この関数は値を返しません。 |
![]() |
remove_layer ( name )![]() 指定されたレイヤを削除します。
|
name : | string | レイヤ名です。 |
この関数は値を返しません。 |
![]() |
set_camera ( camera, world )![]() 新しいカメラを Oculus VR に設定します。
|
camera : | 立体視レンダリングに使用するカメラです。 | |
world : | カメラを含むワールドです。 |
この関数は値を返しません。 |
これは、ゲーム内で新しいワールドを作成し、それを VR に移行する場合に便利です。
![]() |
set_high_quality_layer ( name, hq_enabled )![]() 指定されたレイヤのコンポジタで 4x 異方性サンプリングを有効または無効にします。
|
name : | string | 高品質のレンダー パスに設定するレイヤの名前。 |
hq_enabled : | boolean | このレイヤが高品質のレンダー パスを使用する必要があるかどうかを指定します。 |
この関数は値を返しません。 |
![]() |
set_layer_dimensions ( name, width, height )![]() レイヤ クアッドの寸法を設定します。
|
name : | string | 更新するレイヤの名前。 |
width : | number | メートル単位のレイヤのクアッドの幅 |
height : | 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 )![]() 指定されているポーズを既定のトラッキング空間のポーズとして設定します。
|
pose : | トラッキング空間のポーズ |
この関数は値を返しません。 |
廃止予定です。代わりに OculusVR.set_tracking_space(Vector3, Quaternion, Vector3) を使用してください。
![]() |
shutdown ( )![]() Oculus VR システムをシャットダウンします。
|
この関数はパラメータを受け入れません。 |
この関数は値を返しません。 |
![]() |
tracking_space_pose ( ) : stingray.Matrix4x4![]() トラッキング空間のポーズを返します。
|
![]() |
tracking_space_scale ( ) : stingray.Vector3![]() トラッキング スペースのスケールを返します。
|
![]() |
unlink_node_from_tracker ( unit, node )![]() VR トラッカーによって自動的に更新されているユニット ノードをリンク解除します。
|
unit : | VR トラッカーからリンク解除するユニット | |
node : | integer | リンク解除するユニット内のシーン グラフ ノード |
この関数は値を返しません。 |
![]() |
valid_session ( ) : boolean![]() |
この関数はパラメータを受け入れません。 |
boolean |
デバイス セッションが有効な場合は true を返します。デスクトップでは、これは Oculus.initialize の後に発生し、モバイルでは、これは Oculus.enable の後に発生します。 |