TaiZhouCangChu_VRanime/Assets/HTC.UnityPlugin/VRModule/VRModuleBase.cs

600 lines
28 KiB
C#

//========= Copyright 2016-2023, HTC Corporation. All rights reserved. ===========
using HTC.UnityPlugin.Utility;
using System;
using System.Collections.Generic;
using System.Text.RegularExpressions;
using UnityEngine;
namespace HTC.UnityPlugin.VRModuleManagement
{
public partial class VRModule : SingletonBehaviour<VRModule>
{
public abstract class ModuleBase
{
protected enum DefaultModuleOrder
{
Simulator = 1,
UnityNativeVR,
UnityXR,
SteamVR,
OculusVR,
DayDream,
WaveVR,
}
[Obsolete("Module should set their own MAX_DEVICE_COUNT, use EnsureDeviceStateLength to set, VRModule.GetDeviceStateCount() to get")]
protected const uint MAX_DEVICE_COUNT = VRModule.MAX_DEVICE_COUNT;
protected const uint INVALID_DEVICE_INDEX = VRModule.INVALID_DEVICE_INDEX;
protected const RegexOptions REGEX_OPTIONS = RegexOptions.IgnoreCase | RegexOptions.Singleline
#if NET_STANDARD_2_0
| RegexOptions.Compiled
#endif
;
private static readonly Regex s_viveRgx = new Regex("^.*(vive|htc).*$", REGEX_OPTIONS);
private static readonly Regex s_viveCosmosRgx = new Regex("^.*(cosmos).*$", REGEX_OPTIONS);
private static readonly Regex s_focus3Rgx = new Regex("focus[\\s_\\-]*3", REGEX_OPTIONS);
private static readonly Regex s_ver3Rgx = new Regex("^.*3.0.*$", REGEX_OPTIONS);
private static readonly Regex s_oculusRgx = new Regex("^.*(oculus|quest).*$", REGEX_OPTIONS);
private static readonly Regex s_questRgx = new Regex("quest", REGEX_OPTIONS);
private static readonly Regex s_quest2Rgx = new Regex("quest[\\s_\\-]*2", REGEX_OPTIONS);
private static readonly Regex s_indexRgx = new Regex("^.*(index|knuckles).*$", REGEX_OPTIONS);
private static readonly Regex s_knucklesRgx = new Regex("^.*(knu_ev1).*$", REGEX_OPTIONS);
private static readonly Regex s_daydreamRgx = new Regex("^.*(daydream).*$", REGEX_OPTIONS);
private static readonly Regex s_wmrRgx = new Regex("(^.*(asus|acer|dell|lenovo|hp|samsung|windowsmr|windows).*(mr|$))|spatial", REGEX_OPTIONS);
private static readonly Regex s_magicLeapRgx = new Regex("^.*(magicleap).*$", REGEX_OPTIONS);
private static readonly Regex s_waveVrRgx = new Regex("^.*(wvr|wave).*$", REGEX_OPTIONS);
private static readonly Regex s_khrRgx = new Regex("^.*(khr).*$", REGEX_OPTIONS);
private static readonly Regex s_leftRgx = new Regex("^.*(left|_l).*$", REGEX_OPTIONS);
private static readonly Regex s_rightRgx = new Regex("^.*(right|_r).*$", REGEX_OPTIONS);
private struct WVRCtrlProfile
{
public Regex reg;
public VRModuleDeviceModel model;
public VRModuleInput2DType input2D;
}
private static WVRCtrlProfile[] s_wvrCtrlProfiles = new WVRCtrlProfile[]
{
// WVR_CONTROLLER_FINCH3DOF_2_0_PAC_20_9_DARK
new WVRCtrlProfile { reg = new Regex("pac", REGEX_OPTIONS), model = VRModuleDeviceModel.ViveFlowPhoneController, input2D = VRModuleInput2DType.TouchpadOnly },
// WVR_CONTROLLER_FINCH3DOF_2_0
new WVRCtrlProfile { reg = new Regex("finch", REGEX_OPTIONS), model = VRModuleDeviceModel.ViveFocusFinch, input2D = VRModuleInput2DType.TouchpadOnly },
// WVR_CONTROLLER_ASPEN_MI6_1, WVR_CONTROLLER_ASPEN_XA_XB
new WVRCtrlProfile { reg = new Regex("aspen", REGEX_OPTIONS), model = VRModuleDeviceModel.ViveFocusChirp, input2D = VRModuleInput2DType.TouchpadOnly },
// WVR_CR_Left_001
new WVRCtrlProfile { reg = new Regex("cr.+left", REGEX_OPTIONS), model = VRModuleDeviceModel.ViveFocus3ControllerLeft, input2D = VRModuleInput2DType.JoystickOnly },
// WVR_CR_Right_001
new WVRCtrlProfile { reg = new Regex("cr.+right", REGEX_OPTIONS), model = VRModuleDeviceModel.ViveFocus3ControllerRight, input2D = VRModuleInput2DType.JoystickOnly },
// Wave Tracker0 HTC-211012-Tracker0, Wave Tracker1 HTC-211012-Tracker1
new WVRCtrlProfile { reg = new Regex("^.*(tracker).*$", REGEX_OPTIONS), model = VRModuleDeviceModel.ViveWristTracker, input2D = VRModuleInput2DType.None },
};
public bool isActivated { get; private set; }
public virtual int moduleOrder { get { return moduleIndex; } }
public abstract int moduleIndex { get; }
// reserved device index, so any device index less then this will not be occupied by submodule
public virtual uint reservedDeviceIndex { get { return HMD_DEVICE_INDEX; } }
public virtual bool ShouldActiveModule() { return false; }
public void Activated()
{
isActivated = true;
OnActivated();
}
public void Deactivated()
{
isActivated = false;
OnDeactivated();
}
public virtual void OnActivated() { }
public virtual void OnDeactivated() { }
public virtual bool HasInputFocus() { return true; }
public virtual uint GetLeftControllerDeviceIndex() { return INVALID_DEVICE_INDEX; }
public virtual uint GetRightControllerDeviceIndex() { return INVALID_DEVICE_INDEX; }
public virtual void UpdateTrackingSpaceType() { }
public virtual void Update() { }
public virtual void FixedUpdate() { }
public virtual void LateUpdate() { }
public virtual void BeforeRenderUpdate() { }
[Obsolete]
public virtual void UpdateDeviceState(IVRModuleDeviceState[] prevState, IVRModuleDeviceStateRW[] currState) { }
public virtual void TriggerViveControllerHaptic(uint deviceIndex, ushort durationMicroSec = 500) { TriggerHapticVibration(deviceIndex, 0.000001f * (float)durationMicroSec); }
public virtual void TriggerHapticVibration(uint deviceIndex, float durationSeconds = 0.01f, float frequency = 85f, float amplitude = 0.125f, float startSecondsFromNow = 0f) { }
protected void InvokeInputFocusEvent(bool value)
{
VRModule.InvokeInputFocusEvent(value);
}
protected void InvokeControllerRoleChangedEvent()
{
VRModule.InvokeControllerRoleChangedEvent();
}
protected uint GetDeviceStateLength()
{
return Instance.GetDeviceStateLength();
}
protected void EnsureDeviceStateLength(uint capacity)
{
Instance.EnsureDeviceStateLength(capacity);
}
protected bool TryGetValidDeviceState(uint index, out IVRModuleDeviceState prevState, out IVRModuleDeviceStateRW currState)
{
return Instance.TryGetValidDeviceState(index, out prevState, out currState);
}
protected void EnsureValidDeviceState(uint index, out IVRModuleDeviceState prevState, out IVRModuleDeviceStateRW currState)
{
Instance.EnsureValidDeviceState(index, out prevState, out currState);
}
// this function will skip VRModule.HMD_DEVICE_INDEX (preserved index for HMD)
protected uint FindAndEnsureUnusedNotHMDDeviceState(out IVRModuleDeviceState prevState, out IVRModuleDeviceStateRW currState)
{
return Instance.FindAndEnsureUnusedNotHMDDeviceState(out prevState, out currState);
}
protected void FlushDeviceState()
{
Instance.ModuleFlushDeviceState();
}
protected void ProcessConnectedDeviceChanged()
{
Instance.ModuleConnectedDeviceChanged();
}
protected void ProcessDevicePoseChanged()
{
InvokeNewPosesEvent();
}
protected void ProcessDeviceInputChanged()
{
InvokeNewInputEvent();
}
protected static void SetupKnownDeviceModel(IVRModuleDeviceStateRW deviceState)
{
if (s_viveRgx.IsMatch(deviceState.modelNumber) || s_viveRgx.IsMatch(deviceState.renderModelName))
{
switch (deviceState.deviceClass)
{
case VRModuleDeviceClass.HMD:
deviceState.deviceModel = VRModuleDeviceModel.ViveHMD;
return;
case VRModuleDeviceClass.Controller:
if (s_viveCosmosRgx.IsMatch(deviceState.modelNumber))
{
if (s_leftRgx.IsMatch(deviceState.renderModelName))
{
deviceState.deviceModel = VRModuleDeviceModel.ViveCosmosControllerLeft;
}
else if (s_rightRgx.IsMatch(deviceState.renderModelName))
{
deviceState.deviceModel = VRModuleDeviceModel.ViveCosmosControllerRight;
}
deviceState.input2DType = VRModuleInput2DType.JoystickOnly;
}
else if (s_focus3Rgx.IsMatch(deviceState.modelNumber))
{
if (s_leftRgx.IsMatch(deviceState.modelNumber))
{
deviceState.deviceModel = VRModuleDeviceModel.ViveFocus3ControllerLeft;
}
else if (s_rightRgx.IsMatch(deviceState.modelNumber))
{
deviceState.deviceModel = VRModuleDeviceModel.ViveFocus3ControllerRight;
}
deviceState.input2DType = VRModuleInput2DType.JoystickOnly;
}
else
{
deviceState.deviceModel = VRModuleDeviceModel.ViveController;
deviceState.input2DType = VRModuleInput2DType.TouchpadOnly;
}
return;
case VRModuleDeviceClass.GenericTracker:
if (s_ver3Rgx.IsMatch(deviceState.modelNumber))
{
deviceState.deviceModel = VRModuleDeviceModel.ViveTracker3;
}
else
{
deviceState.deviceModel = VRModuleDeviceModel.ViveTracker;
}
return;
case VRModuleDeviceClass.TrackingReference:
deviceState.deviceModel = VRModuleDeviceModel.ViveBaseStation;
return;
}
}
else if (s_oculusRgx.IsMatch(deviceState.modelNumber))
{
switch (deviceState.deviceClass)
{
case VRModuleDeviceClass.HMD:
deviceState.deviceModel = VRModuleDeviceModel.OculusHMD;
return;
case VRModuleDeviceClass.Controller:
{
var modelNumWithHmd = GetDeviceState(HMD_DEVICE_INDEX).modelNumber + " " + deviceState.modelNumber;
if (s_quest2Rgx.IsMatch(modelNumWithHmd))
{
deviceState.deviceModel = s_leftRgx.IsMatch(modelNumWithHmd) ? VRModuleDeviceModel.OculusQuest2ControllerLeft : VRModuleDeviceModel.OculusQuest2ControllerRight;
deviceState.input2DType = VRModuleInput2DType.JoystickOnly;
return;
}
else if (s_questRgx.IsMatch(modelNumWithHmd) || modelNumWithHmd.Contains("Rift S"))
{
deviceState.deviceModel = s_leftRgx.IsMatch(modelNumWithHmd) ? VRModuleDeviceModel.OculusQuestOrRiftSControllerLeft : VRModuleDeviceModel.OculusQuestOrRiftSControllerRight;
deviceState.input2DType = VRModuleInput2DType.JoystickOnly;
return;
}
else if (modelNumWithHmd.Contains("Touch"))
{
deviceState.deviceModel = s_leftRgx.IsMatch(modelNumWithHmd) ? VRModuleDeviceModel.OculusTouchLeft : VRModuleDeviceModel.OculusTouchRight;
deviceState.input2DType = VRModuleInput2DType.JoystickOnly;
return;
}
else if (modelNumWithHmd.Contains("Go"))
{
deviceState.deviceModel = VRModuleDeviceModel.OculusGoController;
deviceState.input2DType = VRModuleInput2DType.TouchpadOnly;
return;
}
else if (modelNumWithHmd.Contains("Gear"))
{
deviceState.deviceModel = VRModuleDeviceModel.OculusGearVrController;
deviceState.input2DType = VRModuleInput2DType.TouchpadOnly;
return;
}
}
break;
case VRModuleDeviceClass.TrackingReference:
deviceState.deviceModel = VRModuleDeviceModel.OculusSensor;
return;
}
}
else if (s_wmrRgx.IsMatch(deviceState.modelNumber) || s_wmrRgx.IsMatch(deviceState.renderModelName))
{
switch (deviceState.deviceClass)
{
case VRModuleDeviceClass.HMD:
deviceState.deviceModel = VRModuleDeviceModel.WMRHMD;
return;
case VRModuleDeviceClass.Controller:
if (s_leftRgx.IsMatch(deviceState.modelNumber))
{
deviceState.deviceModel = VRModuleDeviceModel.WMRControllerLeft;
deviceState.input2DType = VRModuleInput2DType.Both;
return;
}
else if (s_rightRgx.IsMatch(deviceState.modelNumber))
{
deviceState.deviceModel = VRModuleDeviceModel.WMRControllerRight;
deviceState.input2DType = VRModuleInput2DType.Both;
return;
}
break;
}
}
else if (s_indexRgx.IsMatch(deviceState.modelNumber) || s_indexRgx.IsMatch(deviceState.renderModelName))
{
switch (deviceState.deviceClass)
{
case VRModuleDeviceClass.HMD:
deviceState.deviceModel = VRModuleDeviceModel.IndexHMD;
return;
case VRModuleDeviceClass.Controller:
deviceState.input2DType = VRModuleInput2DType.TouchpadOnly;
if (s_leftRgx.IsMatch(deviceState.renderModelName))
{
if (s_knucklesRgx.IsMatch(deviceState.renderModelName))
{
deviceState.deviceModel = VRModuleDeviceModel.KnucklesLeft;
}
else
{
deviceState.deviceModel = VRModuleDeviceModel.IndexControllerLeft;
#if VIU_STEAMVR_2_0_0_OR_NEWER || (UNITY_2019_3_OR_NEWER && VIU_XR_GENERAL_SETTINGS)
deviceState.input2DType = VRModuleInput2DType.Both;
#endif
}
}
else if (s_rightRgx.IsMatch(deviceState.renderModelName))
{
if (s_knucklesRgx.IsMatch(deviceState.renderModelName))
{
deviceState.deviceModel = VRModuleDeviceModel.KnucklesRight;
}
else
{
deviceState.deviceModel = VRModuleDeviceModel.IndexControllerRight;
#if VIU_STEAMVR_2_0_0_OR_NEWER || (UNITY_2019_3_OR_NEWER && VIU_XR_GENERAL_SETTINGS)
deviceState.input2DType = VRModuleInput2DType.Both;
#endif
}
}
return;
case VRModuleDeviceClass.TrackingReference:
deviceState.deviceModel = VRModuleDeviceModel.ViveBaseStation;
return;
}
}
else if (s_daydreamRgx.IsMatch(deviceState.modelNumber))
{
switch (deviceState.deviceClass)
{
case VRModuleDeviceClass.HMD:
deviceState.deviceModel = VRModuleDeviceModel.DaydreamHMD;
return;
case VRModuleDeviceClass.Controller:
deviceState.deviceModel = VRModuleDeviceModel.DaydreamController;
deviceState.input2DType = VRModuleInput2DType.TrackpadOnly;
return;
}
}
else if (s_magicLeapRgx.IsMatch(deviceState.modelNumber))
{
switch (deviceState.deviceClass)
{
case VRModuleDeviceClass.HMD:
deviceState.deviceModel = VRModuleDeviceModel.MagicLeapHMD;
return;
case VRModuleDeviceClass.Controller:
deviceState.deviceModel = VRModuleDeviceModel.MagicLeapController;
deviceState.input2DType = VRModuleInput2DType.TouchpadOnly;
return;
}
}
else if (s_waveVrRgx.IsMatch(deviceState.modelNumber))
{
switch (deviceState.deviceClass)
{
case VRModuleDeviceClass.HMD:
deviceState.deviceModel = VRModuleDeviceModel.ViveFocusHMD;
return;
case VRModuleDeviceClass.Controller:
{
foreach (var p in s_wvrCtrlProfiles)
{
if (p.reg.IsMatch(deviceState.modelNumber))
{
deviceState.deviceModel = p.model;
deviceState.input2DType = p.input2D;
return;
}
}
}
break;
case VRModuleDeviceClass.GenericTracker:
{
foreach (var p in s_wvrCtrlProfiles)
{
if (p.reg.IsMatch(deviceState.modelNumber))
{
deviceState.deviceModel = p.model;
deviceState.input2DType = p.input2D;
return;
}
}
}
break;
}
}
else if (s_khrRgx.IsMatch(deviceState.modelNumber))
{
switch (deviceState.deviceClass)
{
case VRModuleDeviceClass.Controller:
deviceState.deviceModel = VRModuleDeviceModel.KhronosSimpleController;
break;
}
}
deviceState.deviceModel = VRModuleDeviceModel.Unknown;
deviceState.input2DType = VRModuleInput2DType.Unknown;
}
public static bool AxisToPress(bool previousPressedState, float currentAxisValue, float setThreshold, float unsetThreshold)
{
return previousPressedState ? currentAxisValue > unsetThreshold : currentAxisValue >= setThreshold;
}
}
private sealed class DefaultModule : ModuleBase
{
public override int moduleIndex { get { return (int)VRModuleActiveEnum.None; } }
}
public abstract class SubmoduleBase
{
public class Collection
{
private List<SubmoduleBase> modules = new List<SubmoduleBase>();
public Collection(params SubmoduleBase[] modules)
{
if (modules != null && modules.Length > 0)
{
foreach (var m in modules)
{
if (m != null) { this.modules.Add(m); }
}
}
}
public void AddModule(SubmoduleBase module, params SubmoduleBase[] modules)
{
if (module != null) { this.modules.Add(module); }
if (modules != null && modules.Length > 0)
{
foreach (var m in modules)
{
if (m != null) { this.modules.Add(module); }
}
}
}
public void ActivateAllModules()
{
for (int i = 0, imax = modules.Count; i < imax; ++i)
{
if (modules[i].ShouldActiveModule())
{
modules[i].Activate();
}
}
}
public void DeactivateAllModules()
{
for (int i = 0, imax = modules.Count; i < imax; ++i)
{
modules[i].Deactivate();
}
}
public void UpdateAllModulesActivity()
{
for (int i = 0, imax = modules.Count; i < imax; ++i)
{
if (modules[i].isActivated)
{
if (!modules[i].ShouldActiveModule()) { modules[i].Deactivate(); }
}
else
{
if (modules[i].ShouldActiveModule()) { modules[i].Activate(); }
}
}
}
public void UpdateModulesDeviceConnectionAndPoses()
{
for (int i = 0, imax = modules.Count; i < imax; ++i)
{
if (modules[i].isActivated)
{
modules[i].OnUpdateDeviceConnectionAndPoses();
}
}
}
public void UpdateModulesDeviceInput()
{
for (int i = 0, imax = modules.Count; i < imax; ++i)
{
if (modules[i].isActivated)
{
modules[i].OnUpdateDeviceInput();
}
}
}
public uint GetFirstRightHandedIndex()
{
if (modules.Count > 0)
{
var indexMax = Instance.GetDeviceStateLength();
for (int i = 0, imax = modules.Count; i < imax; ++i)
{
var index = modules[i].GetRightHandedIndex();
if (index < indexMax) { return index; }
}
}
return INVALID_DEVICE_INDEX;
}
public uint GetFirstLeftHandedIndex()
{
if (modules.Count > 0)
{
var indexMax = Instance.GetDeviceStateLength();
for (int i = 0, imax = modules.Count; i < imax; ++i)
{
var index = modules[i].GetLeftHandedIndex();
if (index < indexMax) { return index; }
}
}
return INVALID_DEVICE_INDEX;
}
}
public bool isActivated { get; private set; }
public virtual bool ShouldActiveModule() { return false; }
public void Activate()
{
if (!isActivated)
{
isActivated = true;
OnActivated();
}
}
public void Deactivate()
{
if (isActivated)
{
isActivated = false;
OnDeactivated();
}
}
protected virtual void OnActivated() { }
protected virtual void OnDeactivated() { }
protected virtual void OnUpdateDeviceConnectionAndPoses() { }
protected virtual void OnUpdateDeviceInput() { }
public virtual uint GetRightHandedIndex() { return INVALID_DEVICE_INDEX; }
public virtual uint GetLeftHandedIndex() { return INVALID_DEVICE_INDEX; }
protected uint GetDeviceStateLength()
{
return Instance.GetDeviceStateLength();
}
protected bool TryGetValidDeviceState(uint index, out IVRModuleDeviceState prevState, out IVRModuleDeviceStateRW currState)
{
return Instance.TryGetValidDeviceState(index, out prevState, out currState);
}
protected void EnsureValidDeviceState(uint index, out IVRModuleDeviceState prevState, out IVRModuleDeviceStateRW currState)
{
Instance.EnsureValidDeviceState(index, out prevState, out currState);
}
// this function will skip VRModule.HMD_DEVICE_INDEX (preserved index for HMD)
protected uint FindAndEnsureUnusedNotHMDDeviceState(out IVRModuleDeviceState prevState, out IVRModuleDeviceStateRW currState)
{
return Instance.FindAndEnsureUnusedNotHMDDeviceState(out prevState, out currState);
}
}
}
}