ドキュメント

Unity Engine

Unity Engine

Unity XR入力

VRおよびARのデバイス コントロールと機能にアクセスします。
読み終わるまでの所要時間 36 分最終更新 6日前

Unityユーザー マニュアルのこのセクションでは、VR、AR、Windows MR(複合現実)アプリケーション向けにUnityがサポートするすべての入力デバイスについて説明します。このページでは、以下のトピックについて説明します。
XRプラットフォームには、ユーザーインタラクションを設計する際に利用できる、豊富な種類の入力機能があります。アプリケーションは、位置、回転、タッチ、ボタン、ジョイスティック、および指センサーを参照する特定のデータを使用できます。ただし、これらの入力機能へのアクセスはプラットフォームによって大きく異なります。例えば、デスクトップVRヘッドセットにはわずかな違いがありますが、VR対応のデスクトップ プラットフォームとスタンドアロン モバイル ヘッドセットでは、さらに大きな違いがあります。
Unity は、 InputFeatureUsage と呼ばれる C# 構造体を提供しています。これは、任意のプラットフォームでユーザー入力にアクセスするための物理デバイス制御 (ボタンやトリガーなど) の標準セットを定義します。これらのヘルプは、名前で入力タイプを識別するのに役立ちます。各
InputFeatureUsage
の定義については、XR.入力.CommonUsages を参照してください。
各
InputFeatureUsage
は、一般的な入力アクションまたはタイプに対応しています。例えば、Unity では、
trigger
と呼ばれる
InputFeatureUsage
は、使用する XR プラットフォームに関係なく、人差し指で制御する 1 軸の入力として定義されます。
InputFeatureUsage
を使用すると、その名前を使用して
trigger
ステートを取得できます。そのため、従来の Unity Input System に軸(または XR プラットフォームによってはボタン)を設定する必要はありません。

XR 入力マッピング

以下の表は、標準コントローラー
InputFeatureUsage
名と、一般的なXRシステムのコントローラーへのマップ方法を示しています。

InputFeatureUsage

特徴タイプ

古い機能入力インデックス(左コントローラー/右コントローラー)

WMR

Oculus

GearVR

白昼夢

OpenVR(フル)

Vive

Oculus via OpenVR

WMR via OpenVR

primary2DAxis2D 軸20+30+10 = 60タッチパッドジョイスティックタッチパッドタッチパッドTrackpad/Joystickトラックパッドジョイスティックジョイスティック
trigger軸"25270591"Trigger (トリガー)Trigger (トリガー)Trigger (トリガー)Trigger (トリガー)Trigger (トリガー)Trigger (トリガー)Trigger (トリガー)Trigger (トリガー)
grip軸"25270591"グリップグリップバンパーグリップグリップグリップグリップ
secondary2DAxis2D 軸20+30+10 = 60ジョイスティックタッチパッド
secondary2DAxisClickボタン"25270591"ジョイスティック - クリック
primaryButtonボタン"25270591"[X/A] - 押すアプリケーションプライマリプライマリ(サンドイッチボタン)(1)プライマリ (Y/B)メニュー
primaryTouchボタン"25270591"[X/A] - タッチ
secondaryButtonボタン"25270591"[Y/B] - 押す代替代替 (X/A)
secondaryTouchボタン"25270591"[Y/B] - タッチ
gripButtonボタン"25270591"グリップ - 押すグリップ - 押すグリップ - 押すグリップ - 押すグリップ - 押すグリップ - 押す
triggerButtonボタン"25270591"トリガー - 押すトリガー - 押すトリガー - 押すトリガー - 押すトリガー - 押すトリガー - 押すトリガー - タッチトリガー - 押す
menuButtonボタン"25270591"メニュー開始 (左コントコントローラーのみ)
primary2DAxisClickボタン"25270591"タッチパッド - クリックサムスティック - 押すタッチパッド - 押すタッチパッド - 押すトラックパッド/ジョイスティック - 押すトラックパッド - 押すジョイスティック - 押すタッチパッド - 押す
primary2DAxisTouchボタン"25270591"タッチパッド - タッチサムスティック - タッチタッチパッド - タッチタッチパッド - タッチトラックパッド/ジョイスティック - タッチトラックパッド - タッチジョイスティック - タッチタッチパッド - タッチ
batteryLevel軸battery.level
userPresenceボタンユーザープレゼンスユーザープレゼンス
(1) サンドイッチボタンは Vive メニューボタンを指します。このボタンは、クロスプラットフォームアプリケーションをより適切に処理するために、menuButton ではなく primaryButton にマップされます。
各
InputFeatureUsage
の定義については、XR.Input.CommonUsages を参照してください。

入力デバイスへのアクセス

InputDevice は、コントローラー、携帯電話、ヘッドセットなどの物理デバイスを表します。デバイストラッキング、ボタン、ジョイスティック、その他の入力コントロールに関する情報を含めることができます。
InputDevice
API の詳細については、InputDevice のドキュメントを参照してください。
XR.InputDevices クラスを使用して、XR システムに現在接続されている入力デバイスにアクセスします。接続されているすべてのデバイスのリストを取得するには、 InputDevices.GetDevices を使用します。
var inputDevices = new List<UnityEngine.XR.InputDevice>();UnityEngine.XR.InputDevices.GetDevices(inputDevices);Foreach (inputDevices の var デバイス){ Debug.Log(string.Format("Device found with name '{0}' and role '{1}'", device.name, device.role.ToString()));}
入力デバイスは、XR システムによって切断されるまで、複数のフレームで有効です。InputDevice.IsValid プロパティを使用して、
InputDevice
がまだアクティブなコントローラーを表しているかどうかを確認します。
入力デバイスにアクセスするには、以下を行います。
  • Characteristics (特徴):
  • ロール
  • XRノード

特性による入力デバイスへのアクセス

デバイスの特性は、デバイスの能力や用途 (ヘッドマウントかどうか例えば) を表します。InputDeviceCharacteristics は、特定の仕様に適合するデバイスを検索するためにコードに追加できる一連のフラグです。以下の特性でデバイスをフィルターできます。

デバイス

特徴

HeadMountedデバイスはユーザーの頭に装着されています。デバイストラッキングとセンターアイトラッキングがあります。このフラグは、ヘッドマウント ディスプレイ(HMD)を識別するために最もよく使用されます。
カメラデバイスはカメラ トラッキング機能を備えています。
HeldInHandユーザーはデバイスを手に持っています。
HandTrackingデバイスは物理的に追跡された手を表します。デバイストラッキング機能があり、ハンドデータとボーンデータが含まれている場合があります。
EyeTrackingデバイスはアイトラッキングを実行でき、EyesData 機能を備えています。
TrackedDeviceデバイスは 3D スペースで追跡できます。デバイストラッキングがあります。
コントローラーデバイスはボタンと軸の入力データを持ち、コントコントローラーとして使用できます。
TrackingReferenceデバイスは静的トラッキングリファレンスオブジェクトを表します。デバイストラッキングがありますが、トラッキンデータは変更しないでください。
左この特性を HeldInHand 特性または HandTracking 特性と組み合わせて使用して、デバイスを左手に関連付けられていると識別します。
右この特性を HeldInHand 特性またはハンドトラッキング特性と組み合わせて使用して、デバイスを右手に関連付けられていると識別します。
Simulated6DOFデバイスは 6DOF データを報告しますが、3DOF センサーしか持ちません。Unity は位置データをシミュレーションします。
XR プロバイダー プラグインは、これらの特性を報告します。外観は InputDevice.Characteristics で確認できます。デバイスは、複数の特性を持つことができ、多くの場合、ビット フラグでフィルターしてアクセスできます。
InputDevices.GetDevicesWithCharacteristics は、特定の特性セットを持つすべてのデバイスを検索する方法を提供します。例えば、システムで使用可能な Left、HeldInHand、コントローラー InputDevices を以下のコードで検索できます。
var leftHandedControllers = new List<UnityEngine.XR.InputDevice>();var desiredCharacteristics = UnityEngine.XR.InputDeviceCharacteristics.HeldInHand | UnityEngine.XR.InputDeviceCharacteristics.Left | UnityEngine.XR.InputDeviceCharacteristics.Controller;UnityEngine.XR.InputDevices.GetDevicesWithCharacteristics(desiredCharacteristics, leftHandedControllers);Foreach (leftHandedControllers の var デバイス){ Debug.Log(string.Format("Device name '{0}' has characteristics '{1}'", device.name, device.characteristics.ToString()));}
この機能が検出するデバイスには、少なくとも指定された特性が含まれていますが、追加の特性が含まれている場合があります。例えば、左手のコントローラーの外観は InputDeviceCharacteristic.Left のみで、InputDeviceCharacteristic.コントローラーは検索できません。

役割による入力デバイスへのアクセス

デバイスの役割は、入力デバイスの一般的な機能を表します。デバイスの役割を指定するには、InputDeviceRole 列挙型を使用します。定義されているロールは以下のとおりです。

ロール

説明

GameControllerコンソールスタイルのゲームコントローラー。
ジェネリックヘッドマウントディスプレイやモバイルデバイスなど、コアXRデバイスを表すデバイス。
HardwareTrackerトラッキング デバイス。
LeftHandedユーザーの左手に関連づけられているデバイス。
RightHandedユーザーの右手に関連づけられているデバイス。
TrackingReferenceOculusトラッキング カメラなど、他のデバイスを追跡するデバイス。
XR プロバイダープラグインはこれらのロールを報告しますが、プロバイダーによってデバイスの編成が異なる可能性があります。また、ユーザーは手を切り替えることができるため、役割の割り当てがユーザーが入力デバイスを持つ手と一致しない場合があります。例えばユユーザーンコントローラートローラーできます。コントローラー
GetDevicesWithRole は、特定の
InputDeviceRole
を持つデバイスのリストを提供します。例えば、
InputDeviceRole.GameController
を使用して、接続されている任意の
GameController
デバイスを取得できます。
var gameControllers = new List<UnityEngine.XR.InputDevice>();UnityEngine.XR.InputDevices.GetDevicesWithRole(UnityEngine.XR.InputDeviceRole.GameController, gameControllers);Foreach (gameControllers の var デバイス){ Debug.Log(string.Format("Device name '{0}' has role '{1}'", device.name, device.role.ToString()));}

XRノードによる入力デバイスへのアクセス

XR ノードは、XR システムの物理的例、ユーザーの頭の位置、右手と左手、Oculus カメラなどのトラッキングリファレンス) を表します。
XRNode 列挙型は、以下のノードを定義します。

XRノード

説明

CenterEyeユーザーの目の瞳孔の間の点。
GameControllerコンソールスタイルのゲームコントローラー。アプリは複数のゲームコントローラーデバイスを持つことができます。
HardwareTrackerハードウェア トラッキング デバイス。通常はユーザーまたは物理アイテムにアタッチされます。複数のハードウェアトラッカーノードが存在できます。
--headXRシステムによって計算されるユーザーの頭の中心点。
LeftEyeユーザーの左目。
LeftHandユーザーの左手。
RightEyeユーザーの右目。
RightHandユーザーの右手。
TrackingReferenceOculus カメラなどのトラッキング参照位置。複数のトラッキングリファレンスノードが存在できます。
InputDevices.GetDevicesAtXRNode を使用して、特定の
XRNode
に関連付けられたデバイスのリストを取得します。以下の例は、左手用コントローラーの取得方法を示しています。
var leftHandDevices = new List<UnityEngine.XR.InputDevice>();UnityEngine.XR.InputDevices.GetDevicesAtXRNode(UnityEngine.XR.XRNode.LeftHand, leftHandDevices);if(leftHandDevices.Count == 1){ UnityEngine.XR.InputDevice device = leftHandDevices[0]; Debug.Log(string.Format("Device name '{0}' with role '{1}'", device.name, device.role.ToString()));}else if(leftHandDevices.Count > 1){ Debug.Log("Found more than one left hand!");}

デバイスの接続と切断のリッスン

入力デバイスはフレーム間で一貫していますが、いつでも接続または切断できます。デバイスがプラットフォームに接続されているかどうかを繰り返し確認しないようにするには、 InputDevices.deviceConnected と InputDevices.deviceDisconnected を使用して、デバイスの接続または切断をアプリケーションに通知します。また、新しく接続された入力デバイスへのリファレンスも提供されます。
これらの参照は複数のフレームにわたって保持できるため、デバイスが切断されたり、使用できなくなったりします。デバイスの入力がまだ使用可能かどうかを確認するには、 InputDevice.isValid を使用します。入力デバイスにアクセスするスクリプトは、デバイスの使用を試みる前に、各フレームの開始時にこれをチェックする必要があります。

入力デバイスでの入力機能へのアクセス

トリガー ボタンのステートなどの入力特徴は、特定の InputDevice から読み取ることができます。例えば、右トリガーのステートを読み取るには、次の手順に従います。
  1. InputDeviceRole.RightHanded または XRNode.RightHand を使用して、右利きデバイスのインスタンスを取得します。
  2. 正しいデバイスを取得したら、 InputDevice.TryGetFeatureValue メソッドを使用して現在のステートにアクセスします。
TryGetFeatureValue()
は特徴の現在値へのアクセスを試み、以下を返します。
  • true:指定された特徴値の取得に成功した場合
  • false:現在のデバイスが指定された特徴をサポートしない場合、またはデバイスが無効の場合(つまり、コントローラーがアクティブでなくなった場合)。
特定のボタン、タッチ入力、またはジョイスティック軸の値を取得するには、CommonUsages クラスを使用します。
CommonUsages
には、位置や回転などのトラッキング機能だけでなく、XR 入力マッピング テーブルの各
InputFeatureUsage
が含まれます。以下のコード例では、 CommonUsages.triggerButton を使用して、ユーザーが現在特定の
InputDevice
インスタンスのトリガーボタンを押しているかどうかを検出します。
bool triggerValue;if (device.TryGetFeatureValue(UnityEngine.XR.CommonUsages.triggerButton, out triggerValue) && triggerValue){ Debug.Log("Trigger button is pressed.");}
InputDevice.TryGetFeatureUsages メソッドを使用して、デバイスが提供するすべての
InputFeatureUsage
のリストを取得することもできます。この関数は、特徴を説明する type と name プロパティを持つ InputFeatureUsage アイテムのリストを返します。以下の例では、特定の入力デバイスが提供するすべてのブーリアン機能を列挙します。
var inputFeatures = new List<UnityEngine.XR.InputFeatureUsage>();if (device.TryGetFeatureUsages(inputFeatures)){ Foreach(inputFeatures の var 特徴) { if (feature.type == typeof(bool)) { ブーリアン featureValue; if (device.TryGetFeatureValue(feature.As<bool>(), out featureValue)) { Debug.Log(string.Format("Bool feature {0}'s value is {1}", feature.name, featureValue.ToString())); } } }}

primaryButton の例

コントローラー構成が異なると、さまざまな機能にアクセスできます。例えば、1 つのシステム上に複数のコントローラがある場合や、異なるシステム上に異なるコントローラがある場合、または SDK が異なる同じコントローラ上に異なるボタンがある場合などです。この多様性により、XRシステムの範囲からの入力のサポートがより複雑になります。Unity
InputFeatureUsage
API は、プラットフォームに依存しない入力の取得に役立ちます。
以下の例では、どのコントローラーまたは入力デバイスが提供するかにかかわらず、
primaryButton
という
InputFeatureUsage
にアクセスします。この例には、接続時に
primaryButton
の使用可能なデバイスをスキャンするクラスが含まれています。クラスは、接続されているデバイス上で特徴の値を監視して、値が変更された場合、クラスは UnityEvent を送信します。
このクラスを使用するには、シーン内のすべてのゲームオブジェクトにコンポーネントとして追加します。例を次に示します。
using System.Collections.Generic;using UnityEngine;using UnityEngine.Events;using UnityEngine.XR;[System.Serializable]public class PrimaryButtonEvent :UnityEvent<bool> { }public class PrimaryButtonWatcher :MonoBehaviour{ public PrimaryButtonEvent primaryButtonPress; private bool lastButtonState = false; プライベートリスト<InputDevice> devicesWithPrimaryButton; private void Awake() { if (primaryButtonPress == null) { primaryButtonPress = new PrimaryButtonEvent(); } devicesWithPrimaryButton = new List<InputDevice>(); } void OnEnable() { リスト<InputDevice> allDevices = new リスト<InputDevice>(); InputDevices.GetDevices(allDevices); Foreach(すべてのデバイスの InputDevice デバイス) InputDevices_deviceConnected(device); InputDevices.deviceConnected += InputDevices_deviceConnected; InputDevices.deviceDisconnected += InputDevices_deviceDisconnected; } private void OnDisable() { InputDevices.deviceConnected -= InputDevices_deviceConnected; InputDevices.deviceDisconnected -= InputDevices_deviceDisconnected; devicesWithPrimaryButton.Clear(); } private void InputDevices_deviceConnected(InputDevice device) { ブーリアン discardedValue; if (device.TryGetFeatureValue(CommonUsages.primaryButton, out discardedValue)) { devicesWithPrimaryButton.Add(デバイス); // 主ボタンを持つデバイスを追加します。 } } private void InputDevices_deviceDisconnected(InputDevice device) { if (devicesWithPrimaryButton.Contains(device)) devicesWithPrimaryButton.Remove(device); } void Update() { bool tempState = false; Foreach (devicesWithPrimaryButton の var デバイス) { bool primaryButtonState = false; tempState = デバイス.TryGetFeatureValue(CommonUsages.primaryButton, out primaryButtonState) // 値を取得しました && primaryButtonState // the value we got || tempState; // 他のコントローラからの累積結果 } if (tempState != lastButtonState) // Button state changed since last frame { primaryButtonPress.Invoke(tempState); lastButtonState = tempState; } }}
以下の
PrimaryReactor
クラスは、主ボタンの押下を検出し、押下に反応して親ゲームオブジェクトを回転させる
PrimaryButtonWatcher
を使用します。このクラスを使用するには、キューブなどの表示されているゲームオブジェクトに追加し、
PrimaryButtonWatcher
リファレンスを Watcher プロパティにドラッグします。
using System.Collections;using UnityEngine;public class PrimaryReactor :MonoBehaviour{ public PrimaryButtonWatcher watcher; public bool IsPressed = false; // used to display button state in the Unity Inspector window public Vector3 rotationAngle = new Vector3(45, 45, 45); public float rotationDuration = 0.25f; // seconds private クォータニオン offRotation; private クォータニオン onRotation; private コルーチン Rotator; void Start() { watcher.primaryButtonPress.AddListener(onPrimaryButtonEvent); offRotation = this.transform.rotation; onRotation = Quaternion.Euler(rotationAngle) * offRotation; } public void onPrimaryButtonEvent(bool pressed) { IsPressed = pressed; if (rotator != null) StopCoroutine(rotator); if (pressed) rotator = StartCoroutine(AnimateRotation(this.transform.rotation, onRotation)); else rotator = StartCoroutine(AnimateRotation(this.transform.rotation, offRotation)); } private IEnumerator AnimateRotation(Quaternion fromRotation, Quaternion toRotation) { float t = 0; while (t < rotationDuration) { transform.rotation = Quaternion.Lerp(fromRotation, toRotation, t / rotationDuration); t += Time.deltaTime; yield return null; } }}

データへのアクセス

InputDevices はハンドトラッキングデバイスをサポート。ハンドトラッキングデバイスは常に:
ハンドトラッキンデータは、Hand オブジェクトと最大 21 のボーン入力機能で構成されます。各ボーンには、位置と向き、および階層内の親ボーンと子ボーンの両方への参照があります。Hand オブジェクトは、ルート ボーン、または個々の指のボーンのリストのいずれかを取得できます。
Hand.TryGetRootBone がルートボーンを取得すると、手首の真上にあるボーンを表すオブジェクトが取得されます。個々の指を表すボーンのリストを取得することもできます。Hand.TryGetFingerBones を呼び出すと、指を表すボーンのリストが、指関節から先端まで返されます。

データへのアクセス

入力デバイスはアイトラッキングデバイスとハンドトラッキングデバイスをサポートします。アイトラッキングは、左目と右目の位置、ユーザーが見ている 3D スペース内の位置、および個々の目が点滅している量で構成されます。データ型は Eyes です。デバイスから取得するには、 CommonUsages.eyesData を使用します。

XRInputSubsystem と InputDevice アソシエーション

Unityは、古い機能のInput Systemと、2019.2で導入されたXRプラグイン アーキテクチャの2つの入力システムを提供します。新しい設定では、各 InputDevice は XRInputSubsystem に関連付けられます。これらのサブシステム オブジェクトは、特定の入力デバイスに関連付けられていないグローバル入力動作をコントロールします(例えば、トラッキング元の管理やトラッキング対象デバイスの再センタリングなど)。
各 InputDevice には、関連するサブシステムへのリファレンスが含まれています。このリファレンスは、デバイスが統合プラットフォームからのものである場合は null です。また、すべてのアクティブな XRInputSubsystem オブジェクトは SubsystemManager.GetInstances<XRInputSubsystem> で取得でき、各 XRInputSubsystem は XRInputSubsystem.TryGetInputDevices でデバイスを取得できます。
入力サブシステムを使用して、UnityEngine.XR.XRInputSubsystem を持つデバイスを最新にできます。Recenter は、すべてのデバイスの新しい原点として HMD の現在の位置を設定します。デバイスを再センタリングできない場合、またはプラットフォームが再センタリングをサポートしていない場合は false を返します。
トラッキング境界を取得するには、TryGetBoundaryPoints を使用します。これは、右回りに並べられた一連の 3D ポイントで構成されます。Y 値はフロア レベルにあり、コンテンツとインタラクションを配置するユーザー指定の「セーフ ゾーン」をマークします。XRInputSubsystem.boundaryChanged を使用して、この境界の変更をリッスンできます。
XRInputSubsystem は、トラッキングの原点モードも担当します。このモードでは、トラッキングワールドの原点の位置に関するコンテキストが提供されます。Unity は以下のトラッキング元のモードをサポートします。
  • デバイス原点の位置は、プライマリ ディスプレイ デバイスの最初の既知の位置です。多くの場合、HMD または電話機です。
  • 床:原点の位置はフロアの既知の位置です。
  • トラッキングリファレンス:原点の位置は、TrackingReference 特性が設定された InputDevice 上にあります。
  • UNKNOWNトラッキング元のタイプは不明です。これは、システム障害またはトラッキング オリジンモードのサポートの欠如が原因である可能性があります。
トラッキングオリジンモードの管理に使用できる API は 3 つあります。

古い機能のInput SystemによるXR入力

入力と XR.InputTracking で構成される古い機能 Input System を使用して、XR 入力機能を取得することもできます。これを行うには、このページの XR 入力マッピング テーブルにある古い機能の入力インデックスを使用します。
プレイヤー設定

?

の入力セクション(メニュー:編集 >
プロジェクト設定

?

> 入力)、軸マッピングを作成して、入力名から軸インデックスにプラットフォームデバイスの特徴に応じた適切なマッピングを追加します。ボタンまたは軸の値を取得するには、 Input.GetAxis または Input.GetButton を使用し、マップされた軸またはボタン名を渡します。
ボタン軸とジョイスティック軸の使用方法の詳細は、InputManager のドキュメントを参照してください。

ハプティクス

InputDevice に触覚イベントを送信できます。ハプティクスは、振幅と継続時間を伴うインパルスの形式をとります。
すべてのプラットフォームがすべてのタイプの触覚をサポートするわけではありませんが、デバイスに触覚機能をクエリできます。以下の例では、右手用の入力デバイスを取得し、そのデバイスが触覚に対応しているかどうかを確認し、対応していればインパルスを再生します。
リスト<UnityEngine.XR.InputDevice> デバイス = new リスト<UnityEngine.XR.InputDevice>(); UnityEngine.XR.InputDevices.GetDevicesWithRole(UnityEngine.XR.InputDeviceRole.RightHanded, devices);Foreach (デバイス内の var デバイス){ UnityEngine.XR.HapticCapabilities capabilities; if (device.TryGetHapticCapabilities(out capabilities)) { if (capabilities.supportsImpulse) { uint チャンネル = 0; float 振幅 = 0.5f; float 継続時間 = 1.0f; device.SendHapticImpulse(channel, amplitude, duration); } }}