vrImmersiveInteractionService

クラス vrImmersiveInteractionService

(vrBaseService を継承)

このサービスを使用すると、VRED に組み込まれているすべての没入型デバイスのインタラクションをすべて管理できます。これらのインタラクションをアクティブまたは非アクティブにするメソッドや、これらの設定を調整するメソッドが含まれています。

概要

関数:
信号:

関数

vrImmersiveInteractionService.activateGroundCalibrationMode(rightHand)

地面のキャリブレーションを開始します。

パラメータ:rightHand (bool) –

vrImmersiveInteractionService.createMultiMarker(multiMarkerName, markerNames, markerType)

複数の標準マーカーのポーズを平均化することによって、マルチ マーカーを作成します。

パラメータ:
  • multiMarkerName (string): マルチ マーカーに付ける名前。自由に選択できる
  • markerNames (List[string]): マルチ マーカーを構成するマーカーの名前
  • markerType (vrXRealityTypes.MarkerTypes): マルチ マーカーを構成するマーカーのタイプ
戻り値:
戻り値の型:

vrdMultiMarker

vrImmersiveInteractionService.getActiveHMDSupportsHandTracking()

戻り値:

ハンド トラッキングがサポートされている場合は True
戻り値の型:

bool

vrImmersiveInteractionService.getAutoCreateCollisionObjects()

衝突オブジェクトが自動的に作成されるかどうかを返します。

戻り値:衝突オブジェクトが自動的に作成される場合は true。
戻り値の型:bool

vrImmersiveInteractionService.getControllerVisualizationMode()

現在のコントローラの可視化モードを返します。

戻り値:現在の可視化モード
戻り値の型:vrVRInputDeviceTypes.VisualizationMode

vrImmersiveInteractionService.getControlMode()

現在のコントロール モードを返します。

戻り値:現在のコントロール モード
戻り値の型:vrImmersiveInteractionTypes.ControlMode

vrImmersiveInteractionService.getDetectedMarkers(markerType)

検出されたすべてのマーカーのうち、指定したタイプのものを取得します。

パラメータ:markerType (vrXRealityTypes.MarkerTypes): マーカーのタイプ
戻り値:検出されたマーカー
戻り値の型:List[vrdMarker]

vrImmersiveInteractionService.getHandTrackingEnabled()
戻り値:ハンド トラッキングが有効な場合は True
戻り値の型:bool

vrImmersiveInteractionService.getHandTrackingOffset()
戻り値:頭からトラッカーまでのトラッキング オフセット
戻り値の型:QMatrix4x4

vrImmersiveInteractionService.getHandTrackingType()
戻り値:現在のハンド トラッキング タイプ
戻り値の型:vrHandTypes.HandTrackingType

vrImmersiveInteractionService.getMarker(name, markerType)

既に検出されたマーカーを取得します。

パラメータ:
戻り値:

マーカー(名前とタイプの組み合わせが検出されない場合は null マーカー)
戻り値の型:

vrdMarker

vrImmersiveInteractionService.getMinMarkerConfidence()

「setMinMarkerConfidence」も参照してください。

戻り値:最小のマーカー信頼度
戻り値の型:float

vrImmersiveInteractionService.getPointerRayScaleRange()
戻り値:ポインタ レイのスケール範囲[min, max]。値が 1.0 の場合は、100 パーセントのスケールになります。
戻り値の型:QVector2D

vrImmersiveInteractionService.getPointerScalingDistance()
戻り値:シーン単位のポインタ スケール距離
戻り値の型:float

vrImmersiveInteractionService.getPointerSphereScaleRange()
戻り値:ポインタ球のスケール範囲[min, max]。値が 1.0 の場合は、100 パーセントのスケールになります。
戻り値の型:QVector2D

vrImmersiveInteractionService.getPreferredTooltipsMode()

開始時にツールチップを表示するかどうかを返します。

戻り値:ツールチップを表示する必要がある場合は true
戻り値の型:bool

vrImmersiveInteractionService.getRelativeTeleportOrientation()

方向の角度を手首の絶対的な回転から取得するのか、それとも相対的な回転から取得するのかを返します。

戻り値:相対的な回転を使用するかどうかを示すフラグ
戻り値の型:bool

vrImmersiveInteractionService.getShowTrackedHandsInMR()
戻り値:トラッキングした手の可視化が複合現実モードで表示される場合は true
戻り値の型:bool

vrImmersiveInteractionService.getTeleportAvailability()

テレポートを使用できるレンダリング モードを取得します。

戻り値:サポートされるモード
戻り値の型:List[vrXRealityTypes.XRRenderMode]

vrImmersiveInteractionService.getTeleportGroundHeight()

[地面の上]テレポート モードで使用される地面の高さを返します。

戻り値:地面の高さ(シーン単位)
戻り値の型:float

vrImmersiveInteractionService.getTeleportGroundMode()

現在の地面へのテレポート モードを返します。

戻り値:地面モード
戻り値の型:vrImmersiveInteractionTypes.TeleportGroundMode

vrImmersiveInteractionService.getTeleportRange()

テレポートの最大距離を返します。

戻り値:最大距離(シーン単位)
戻り値の型:float

vrImmersiveInteractionService.getUseBoundingBoxCollisionObjects()

自動的に作成された衝突オブジェクトのバウンディング ボックスのコライダを使用するかどうかを返します。

戻り値:バウンディング ボックスのコライダが使用されている場合は true、凸型ハル コライダが使用されている場合は false
戻り値の型:bool

vrImmersiveInteractionService.hideControllerMessage(message)

コントローラ メッセージを非表示にします。

パラメータ:message (vrdNode): メッセージの vrdNode。

vrImmersiveInteractionService.isHandTrackingGestureEnabled(message)

ハンド トラッキングがアクティブな場合に VRED が手のジェスチャを検出するかどうかを取得します。

パラメータ:
  • gesture (vrHandTypes.HandTrackingGesture): 確認するジェスチャ
  • leftHand (bool): 左手のジェスチャの場合は true、右手のジェスチャの場合は false
戻り値:ジェスチャが有効な場合は true、それ以外の場合は false
戻り値の型:bool

vrImmersiveInteractionService.isHmdActive()

HMD (VR)表示モードがアクティブかどうかを確認します。

戻り値:HMD モードの場合は True
戻り値の型:bool

vrImmersiveInteractionService.pickingMoved(hit)

ポインタ移動イベントをトリガします。

パラメータ:hit (vrdRayIntersection): レイ交差オブジェクト。

vrImmersiveInteractionService.pickingPressed(hit)

ポインタ ボタン押下イベントをトリガします。

パラメータ:hit (vrdRayIntersection): レイ交差オブジェクト。

vrImmersiveInteractionService.pickingReleased(hit)

ポインタ ボタン リリース イベントをトリガします。

パラメータ:hit (vrdRayIntersection): レイ交差オブジェクト。

vrImmersiveInteractionService.setAutoCreateCollisionObjects(automatic)

タッチセンサーおよび Web エンジンの衝突オブジェクト作成機能を有効にするかどうかを切り替えます。

パラメータ:automatic (bool): 自動作成を有効にします。

vrImmersiveInteractionService.setControllerVisualizationMode(mode)

HMD コントローラのビジュアライゼーション モードを設定します。

パラメータ:mode (vrVRInputDeviceTypes.VisualizationMode): ビジュアライゼーション モード

vrImmersiveInteractionService.setControlMode(mode)

コントロール モードと対応するボタンのマッピングを、没入型インタラクション用に設定します。

パラメータ:mode (vrImmersiveInteractionTypes.ControlMode): コントロール モード

vrImmersiveInteractionService.setDefaultInteractionsActive(active)

すべての組み込みインタラクション ツール(テレポート、ポインタ)をアクティブまたは非アクティブにします。

パラメータ:active (bool): アクティブにする場合は true、非アクティブにする場合は false。

vrImmersiveInteractionService.setHandTrackingEnabled(value)

VR コントローラの代わりに、ハンド トラッキング デバイスを使用します。

パラメータ:value (bool): True の場合は、ハンド トラッキング デバイスを使用します。

vrImmersiveInteractionService.setHandTrackingGestureEnabled(gesture, leftHand, enable)

ハンド トラッキングがアクティブな場合に VRED が手のジェスチャを検出するかどうかを設定します。

パラメータ:
  • gesture (vrHandTypes.HandTrackingGesture): 有効または無効にするジェスチャ
  • leftHand (bool): 左手のジェスチャの場合は true、右手のジェスチャの場合は false
  • enable (bool): ジェスチャを有効にする場合は true、無効にする場合は false

vrImmersiveInteractionService.setHandTrackingOffset(offset)

HMD のトラッキング デバイスのマウント ポイント。

パラメータ:offset (QMatrix4x4): HMD からトラッカーへのトランスフォームを記述するマトリックス

vrImmersiveInteractionService.setHandTrackingType(type)

使用するハンド トラッキング デバイスの種類を設定します。

パラメータ:type (vrHandTypes.HandTrackingType): 使用するトラッキング デバイス

vrImmersiveInteractionService.setInteractionActive(name, active)

指定したインタラクション ツールをアクティブまたは非アクティブにします。組み込みインタラクションには、「テレポート」、「ポインタ」という名前が付いています。

パラメータ:
  • name (string): インタラクションの識別子
  • active (bool): アクティブにする場合は true、非アクティブにする場合は false。

vrImmersiveInteractionService.setMarkerTrackingType(markerIds, trackingType)

「vrdMarker.setTrackingType」も参照してください。

パラメータ:
  • markerIds (List[integer]): トラッキング タイプが設定されるマーカーの ID。
  • trackingType (vrXRealityTypes.MarkerTrackingTypes): マーカーに使用するトラッキングのタイプ。移動されるマーカーには予測マーカーを使用し、所定位置に留まるマーカーには静的マーカーを使用します。

vrImmersiveInteractionService.setMinMarkerConfidence(confidence)

最小のマーカー信頼度を設定します。信頼度が低いマーカーが検出された場合、マーカーは無視されます。更新されたデータの信頼度が低い場合、システムで既に認識されているマーカーは更新されません。

パラメータ:confidence (float): 最小の信頼度

vrImmersiveInteractionService.setPointerRayScaleRange(value)

ポインタ レイの最小スケール値と最大スケール値を設定します。値が 1.0 の場合は、100 パーセントのスケールになります。

パラメータ:value (QVector2D): スケール範囲が[min, max]の浮動小数点値。

vrImmersiveInteractionService.setPointerScalingDistance(value)

ポインタ スケールが 100% になる距離を設定します。

パラメータ:value (float): シーン単位のスケール距離

vrImmersiveInteractionService.setPointerSphereScaleRange(value)

ポインタ球の最小スケール値と最大スケール値を設定します。値が 1.0 の場合は、100 パーセントのスケールになります。

パラメータ:value (QVector2D): スケール範囲が[min, max]の浮動小数点値。

vrImmersiveInteractionService.setPreferredControllerVisualizeMode(mode)

手の既定のビジュアライゼーション スタイルを切り替えます。

パラメータ:mode (vrVRInputDeviceTypes.VisualizationMode): 手またはコントローラを有効にします

vrImmersiveInteractionService.setPreferredTooltipsMode(show)

セッションの開始時にツールチップを表示するかどうかを切り替えます。

パラメータ:show (bool): ツールチップを表示します。

vrImmersiveInteractionService.setRelativeTeleportOrientation(isRelative)

方向の角度を手首の絶対的な回転から取得するのか、それとも相対的な回転から取得するのかを設定します。

パラメータ:isRelative (bool): 相対的な回転を使用するかどうかを示します

vrImmersiveInteractionService.setShowTrackedHandsInMR(showHands)

VRED で、トラッキングした手の可視化を複合現実モードで表示するかどうかを設定します。

パラメータ:showHands (bool): 手を表示する必要がある場合は true、それ以外の場合は false

vrImmersiveInteractionService.setTeleportAvailability(modes)

テレポートを使用できるレンダリング モードを設定します。

パラメータ:modes (List[vrXRealityTypes.XRRenderMode]): テレポートが既定に従ってアクティブになっているモード。

vrImmersiveInteractionService.setTeleportGroundHeight(height)

[地面の上]テレポート モードの地面の高さを設定します。

パラメータ:height (float): 高さ(シーン単位)

vrImmersiveInteractionService.setTeleportGroundMode(mode)

シーン ジオメトリ上にテレポートするのか、それとも仮想的な地面上にのみテレポートするのかを設定します。

パラメータ:mode (vrImmersiveInteractionTypes.TeleportGroundMode): 地面モード

vrImmersiveInteractionService.setTeleportRange(range)

テレポートの最大距離を設定します。

パラメータ:range (float): 最大距離(シーン単位)

vrImmersiveInteractionService.setUseBoundingBoxCollisionObjects(useBoundingBox)

自動的に作成された衝突オブジェクトのバウンディング ボックスのコライダを有効にします。

これは、パフォーマンス上の理由から便利です。バウンディング ボックスのコライダは既定の凸型ハル コライダよりも計算は速くなりますが、精度は低くなります。

パラメータ:useBoundingBox (bool): バウンディング ボックスのコライダを有効にする場合は true、凸型ハル コライダを使用する場合は false

vrImmersiveInteractionService.setViewpointMode(adjustHeight, adjustOrientation=True, adjustPosition=True)

ビューポイント選択に対する既定の動作を変更します。実際のカメラの位置は、ビューポイントのトランスフォームに HMD のトランスフォームを加えた位置になります。調整が有効な場合は、調整後のカメラの位置に HMD の位置を加えた位置が、ビューポイントの位置、高さ、または方向と正確に一致するように、カメラの位置が変更されます。

パラメータ:
  • adjustHeight (bool): True の場合、ユーザはビューポイントの高さまで移動します。
  • adjustOrientation (bool): True の場合、ユーザはビューポイントの方向を向きます。
  • adjustPosition (bool): True の場合、ユーザはビューポイントの位置まで移動します。

vrImmersiveInteractionService.showControllerMessage(data, rightHand)

指定したデータに応じてコントローラ メッセージを表示します。

パラメータ:
  • data (vrdDeviceMessageData): メッセージ データ。
  • rightHand (bool): 右手または左手に表示します。
戻り値:

メッセージの vrdNode。
戻り値の型:

vrdNode

信号

vrImmersiveInteractionService.automaticCollisionObjectCreationChanged(automatic)

衝突オブジェクトの自動作成の基本設定が変更された場合に内容を通知します。

パラメータ:automatic (bool): 新しい基本設定

vrImmersiveInteractionService.controllerVisualizationModeChanged(mode)

ハンド ビジュアライゼーション スタイルが変更された場合に内容について通知します。

パラメータ:mode (vrVRInputDeviceTypes.VisualizationMode): 新しいビジュアライゼーション スタイル。

vrImmersiveInteractionService.hmdStatusChanged(active)

この信号は、HMD (VR)表示モードのオン/オフが切り替わったときにトリガされます。

パラメータ:active (bool): HMD モードがオンに切り替わっている場合は True

vrImmersiveInteractionService.markersDetected(markers)

この信号は、最小のマーカー信頼度以上の信頼度を持つ新しいマーカーが検出されたときにトリガされます。

パラメータ:markers (List[vrdMarker]): 検出されたマーカー

vrImmersiveInteractionService.markersUpdated(markers)

この信号は、最小のマーカー信頼度以上の信頼度を持つ新しいマーカーが検出されたときにトリガされます。

パラメータ:markers (List[vrdMarker]): 検出されたマーカー

vrImmersiveInteractionService.showTooltipsOnStartChanged(show)

起動時にツールチップの表示が変更された場合に内容について通知します。

パラメータ:show (bool): ツールチップを表示する必要があります

vrImmersiveInteractionService.teleportGroundModeChanged(mode)

地面へのテレポート モードが変更された場合に内容について通知します。

パラメータ:mode (vrImmersiveInteractionTypes.TeleportGroundMode): 新しい地面モード
親ページ: VRED Python API v2