The Tilt Five manager. More...

Inheritance diagram for TiltFive.TiltFiveManager2:

Public Member Functions
bool	NeedsDriverUpdate ()
	Check if a driver update is needed. More...

bool	TryGetPlayerSettings (PlayerIndex playerIndex, out PlayerSettings playerSettings)
	Gets the player settings for the specified player. More...

float	GetScaleToUWRLD_UGBD ()

Pose	GetGameboardPose ()

Camera	GetEyeCamera ()

uint	GetSupportedPlayerCount ()

bool	IsActiveAndEnabled ()

Public Attributes
PlayerSettings[]	allPlayerSettings = new PlayerSettings[PlayerSettings.MAX_SUPPORTED_PLAYERS]

uint	supportedPlayerCount = 3

SpectatorSettings	spectatorSettings = new SpectatorSettings()
	The spectator camera's runtime configuration data. More...

GraphicsSettings	graphicsSettings = new GraphicsSettings()
	Project-wide graphics settings related to Tilt Five. More...

LogSettings	logSettings = new LogSettings()
	The log settings. More...

Protected Member Functions
override void	Awake ()
	Awake this instance. More...

Properties
PlayerSettings	playerOneSettings `[get]`
	The first player's runtime configuration data. More...

PlayerSettings	playerTwoSettings `[get]`
	The second player's runtime configuration data. More...

PlayerSettings	playerThreeSettings `[get]`
	The third player's runtime configuration data. More...

PlayerSettings	playerFourSettings `[get]`
	The fourth player's runtime configuration data. More...

Properties inherited from TiltFive.SingletonComponent< TiltFiveManager2 >
static T	Instance `[get]`

Private Member Functions
void	Update ()
	Update this instance. More...

void	LateUpdate ()
	Update this instance after all components have finished executing their Update() functions. More...

void	OnEnable ()
	Called when the GameObject is enabled. More...

void	OnDisable ()

void	OnDestroy ()

void	OnApplicationQuit ()

void	RefreshSpectatorSettings ()

Static Private Member Functions
static void	Quit ()

static void	RunOnStart ()

Private Attributes
bool	needsDriverUpdateNotifiedOnce = false

bool	needsDriverUpdateErroredOnce = false

Static Private Attributes
static bool	upgradeInProgress = false

Detailed Description

The Tilt Five manager.

Definition at line 45 of file TiltFiveManager2.cs.

Member Function Documentation

◆ Awake()

override void TiltFive.TiltFiveManager2.Awake ( )

protectedvirtual

Awake this instance.

Reimplemented from TiltFive.SingletonComponent< TiltFiveManager2 >.

Definition at line 153 of file TiltFiveManager2.cs.

         {
             base.Awake();
  
             // Apply log settings
             Log.LogLevel = logSettings.level;
             Log.TAG = logSettings.TAG;
  
             // Store graphics settings
             graphicsSettings.applicationTargetFramerate = Application.targetFrameRate;
             graphicsSettings.applicationVSyncCount = QualitySettings.vSyncCount;
  
             if (!SystemControl.SetPlatformContext())
             {
                 Log.Warn("Failed to set application context.");
                 enabled = false;
             }
  
             if (!SystemControl.SetApplicationInfo())
             {
                 Log.Warn("Failed to send application info to the T5 Service.");
                 enabled = false;
             }
  
             // Initialize the player settings if necessary
             for (int i = 0; i < allPlayerSettings.Length; i++)
             {
                 var currentPlayerSettings = allPlayerSettings[i];
                 if(currentPlayerSettings == null)
                 {
                     allPlayerSettings[i] = new PlayerSettings() { PlayerIndex = (PlayerIndex) i + 1 };
                 }
             }
         }

References TiltFive.TiltFiveManager2.allPlayerSettings, TiltFive.TiltFiveManager2.graphicsSettings, TiltFive.Logging.LogSettings.level, TiltFive.Logging.Log.LogLevel, TiltFive.TiltFiveManager2.logSettings, TiltFive.Logging.LogSettings.TAG, TiltFive.Logging.Log.TAG, and TiltFive.Logging.Log.Warn().

◆ GetEyeCamera()

Camera TiltFive.TiltFiveManager2.GetEyeCamera ( )

Implements TiltFive.ISceneInfo.

Definition at line 685 of file TiltFiveManager2.cs.

         {
             return Glasses.GetLeftEye(PlayerIndex.One);
         }

References TiltFive.Glasses.GetLeftEye().

◆ GetGameboardPose()

Pose TiltFive.TiltFiveManager2.GetGameboardPose ( )

Implements TiltFive.ISceneInfo.

Definition at line 680 of file TiltFiveManager2.cs.

         {
             return new Pose(playerOneSettings.gameboardSettings.gameBoardCenter, Quaternion.Euler(playerOneSettings.gameboardSettings.gameBoardRotation));
         }

References TiltFive.GameBoardSettings.gameBoardCenter, TiltFive.GameBoardSettings.gameBoardRotation, TiltFive.PlayerSettings.gameboardSettings, and TiltFive.TiltFiveManager2.playerOneSettings.

◆ GetScaleToUWRLD_UGBD()

float TiltFive.TiltFiveManager2.GetScaleToUWRLD_UGBD ( )

Implements TiltFive.ISceneInfo.

Definition at line 675 of file TiltFiveManager2.cs.

         {
             return playerOneSettings.scaleSettings.GetScaleToUWRLD_UGBD(playerOneSettings.gameboardSettings.gameBoardScale);
         }

References TiltFive.GameBoardSettings.gameBoardScale, TiltFive.PlayerSettings.gameboardSettings, TiltFive.ScaleSettings.GetScaleToUWRLD_UGBD(), TiltFive.TiltFiveManager2.playerOneSettings, and TiltFive.PlayerSettings.scaleSettings.

◆ GetSupportedPlayerCount()

uint TiltFive.TiltFiveManager2.GetSupportedPlayerCount ( )

Implements TiltFive.ISceneInfo.

Definition at line 690 of file TiltFiveManager2.cs.

         {
             return supportedPlayerCount;
         }

References TiltFive.TiltFiveManager2.supportedPlayerCount.

◆ IsActiveAndEnabled()

bool TiltFive.TiltFiveManager2.IsActiveAndEnabled ( )

Implements TiltFive.ISceneInfo.

Definition at line 695 of file TiltFiveManager2.cs.

         {
             return isActiveAndEnabled;
         }

◆ LateUpdate()

void TiltFive.TiltFiveManager2.LateUpdate ( )

private

Update this instance after all components have finished executing their Update() functions.

Definition at line 281 of file TiltFiveManager2.cs.

         {
             // Trackables should be updated just before rendering occurs,
             // after all Update() calls are completed.
             // This allows any Game Board movements to be finished before we base the
             // Glasses/Wand poses off of its pose, preventing perceived jittering.
             for (int i = 0; i < supportedPlayerCount; i++)
             {
                 var playerSettings = allPlayerSettings[i];
                 if (playerSettings != null)
                 {
                     Player.Update(playerSettings, spectatorSettings);
                 }
             }
         }

References TiltFive.TiltFiveManager2.allPlayerSettings, TiltFive.TiltFiveManager2.spectatorSettings, and TiltFive.TiltFiveManager2.supportedPlayerCount.

◆ NeedsDriverUpdate()

bool TiltFive.TiltFiveManager2.NeedsDriverUpdate ( )

Check if a driver update is needed.

Note that this can also return false if this has not yet been able to connect to the Tilt Five driver service (compatibility state unknown), so this may need to be called multiple times in that case. This only returns true if we can confirm that the driver is incompatible.

If it is necessary to distinguish between unknown and compatible, use GetServiceCompatibility directly.

Definition at line 308 of file TiltFiveManager2.cs.

         {
             if (!needsDriverUpdateErroredOnce)
             {
                 try
                 {
                     ServiceCompatibility compatibility = SystemControl.GetServiceCompatibility();
                     bool needsUpdate = compatibility == ServiceCompatibility.Incompatible;
  
                     if (needsUpdate)
                     {
                         if (!needsDriverUpdateNotifiedOnce)
                         {
                             Log.Warn("Incompatible Tilt Five service. Please update driver package.");
                             needsDriverUpdateNotifiedOnce = true;
                         }
                     }
                     else
                     {
                         // Not incompatible. Reset the incompatibility warning.
                         needsDriverUpdateNotifiedOnce = false;
                     }
                     return needsUpdate;
                 }
                 catch (System.DllNotFoundException e)
                 {
                     Log.Info(
                         "Could not connect to Tilt Five plugin for compatibility check: {0}",
                         e.Message);
                     needsDriverUpdateErroredOnce = true;
                 }
                 catch (System.Exception e)
                 {
                     Log.Error(e.Message);
                     needsDriverUpdateErroredOnce = true;
                 }
             }
  
             // Failed to communicate with Tilt Five plugin at some point, so don't know whether
             // an update is needed or not.  Just say no.
             return false;
         }

References TiltFive.Logging.Log.Error(), TiltFive.Logging.Log.Info(), TiltFive.TiltFiveManager2.needsDriverUpdateErroredOnce, TiltFive.TiltFiveManager2.needsDriverUpdateNotifiedOnce, and TiltFive.Logging.Log.Warn().

Referenced by TiltFive.TiltFiveManager2.Update().

◆ OnApplicationQuit()

void TiltFive.TiltFiveManager2.OnApplicationQuit ( )

private

Definition at line 494 of file TiltFiveManager2.cs.

         {
             OnDisable();
         }

References TiltFive.TiltFiveManager2.OnDisable().

◆ OnDestroy()

void TiltFive.TiltFiveManager2.OnDestroy ( )

private

Definition at line 489 of file TiltFiveManager2.cs.

         {
             Player.OnDisable();
         }

◆ OnDisable()

void TiltFive.TiltFiveManager2.OnDisable ( )

private

Definition at line 480 of file TiltFiveManager2.cs.

         {
 #if UNITY_2019_1_OR_NEWER && INPUTSYSTEM_AVAILABLE
             InputSystem.onBeforeUpdate -= OnBeforeUpdate;
             //Input.OnDisable();
 #endif
             Player.OnDisable();
         }

Referenced by TiltFive.TiltFiveManager2.OnApplicationQuit().

◆ OnEnable()

void TiltFive.TiltFiveManager2.OnEnable ( )

private

Called when the GameObject is enabled.

Definition at line 438 of file TiltFiveManager2.cs.

         {
             try
             {
                 // TODO: change this to something in the settings drawer once that exists
                 NativePlugin.SetMaxDesiredGlasses((byte)GlassesSettings.MAX_SUPPORTED_GLASSES_COUNT);
             }
             catch (System.DllNotFoundException e)
             {
                 Log.Info(
                     "Could not connect to Tilt Five plugin for setting max glasses: {0}",
                     e.Message);
             }
             catch (System.Exception e)
             {
                 Log.Error(e.Message);
             }
  
             // Initialize the player settings if necessary
             for (int i = 0; i < allPlayerSettings.Length; i++)
             {
                 var currentPlayerSettings = allPlayerSettings[i];
                 if (currentPlayerSettings == null)
                 {
                     allPlayerSettings[i] = new PlayerSettings() { PlayerIndex = (PlayerIndex)i + 1 };
                 }
             }
  
             for (int i = 0; i < supportedPlayerCount; i++)
             {
                 var playerSettings = allPlayerSettings[i];
                 if (playerSettings != null)
                 {
                     Player.Reset(playerSettings, spectatorSettings);
                 }
             }
  
 #if UNITY_2019_1_OR_NEWER && INPUTSYSTEM_AVAILABLE
             InputSystem.onBeforeUpdate += OnBeforeUpdate;
 #endif
         }

References TiltFive.TiltFiveManager2.allPlayerSettings, TiltFive.Logging.Log.Error(), TiltFive.Logging.Log.Info(), TiltFive.TiltFiveManager2.spectatorSettings, and TiltFive.TiltFiveManager2.supportedPlayerCount.

◆ Quit()

static void TiltFive.TiltFiveManager2.Quit ( )

staticprivate

Definition at line 504 of file TiltFiveManager2.cs.

         {
             try
             {
                 NativePlugin.UnloadWorkaround();
             }
             catch (System.DllNotFoundException)
             {
                 // nothing to report on quit if the plugin isn't present
             }
             catch (System.Exception e)
             {
                 Log.Error(e.Message);
             }
         }

References TiltFive.Logging.Log.Error().

Referenced by TiltFive.TiltFiveManager2.RunOnStart().

◆ RefreshSpectatorSettings()

void TiltFive.TiltFiveManager2.RefreshSpectatorSettings ( )

private

Definition at line 526 of file TiltFiveManager2.cs.

         {
             // Warn developers if they've left the spectatorCamera field empty
             // TiltFiveManager2's custom inspector should already warn them in the editor, but this warns them again at runtime.
             if (spectatorSettings.spectatorCamera == null)
             {
                 Log.Warn("No spectator camera detected in TiltFiveManager2's spectator settings. A spectator camera is required.");
             }
  
             // Make sure that the spectated player isn't set to a player index higher than what TiltFiveManager2 supports
             var highestSupportedPlayer = (PlayerIndex)supportedPlayerCount;
             if (spectatorSettings.spectatedPlayer > highestSupportedPlayer)
             {
                 Log.Warn($"Invalid spectatorSettings.spectatedPlayer [{spectatorSettings.spectatedPlayer}]. TiltFiveManager2 currently only supports up to Player {highestSupportedPlayer}.");
                 spectatorSettings.spectatedPlayer = highestSupportedPlayer;
             }
         }

References TiltFive.SpectatorSettings.spectatedPlayer, TiltFive.SpectatorSettings.spectatorCamera, TiltFive.TiltFiveManager2.spectatorSettings, TiltFive.TiltFiveManager2.supportedPlayerCount, and TiltFive.Logging.Log.Warn().

Referenced by TiltFive.TiltFiveManager2.Update().

◆ RunOnStart()

static void TiltFive.TiltFiveManager2.RunOnStart ( )

staticprivate

Definition at line 521 of file TiltFiveManager2.cs.

         {
             Application.quitting += Quit;
         }

References TiltFive.TiltFiveManager2.Quit().

◆ TryGetPlayerSettings()

bool TiltFive.TiltFiveManager2.TryGetPlayerSettings	(	PlayerIndex	playerIndex,
		out PlayerSettings	playerSettings
	)

Gets the player settings for the specified player.

Parameters

playerIndex
playerSettings

Returns: Returns false and sets playerSettings to null if an invalid player index is provided.

Definition at line 357 of file TiltFiveManager2.cs.

         {
             switch (playerIndex)
             {
                 case PlayerIndex.One:
                     playerSettings = playerOneSettings;
                     return true;
                 case PlayerIndex.Two:
                     playerSettings = playerTwoSettings;
                     return true;
                 case PlayerIndex.Three:
                     playerSettings = playerThreeSettings;
                     return true;
                 case PlayerIndex.Four:
                     playerSettings = playerFourSettings;
                     return true;
                 default:
                     playerSettings = null;
                     return false;
             }
         }

References TiltFive.TiltFiveManager2.playerFourSettings, TiltFive.TiltFiveManager2.playerOneSettings, TiltFive.TiltFiveManager2.playerThreeSettings, and TiltFive.TiltFiveManager2.playerTwoSettings.

Referenced by TiltFive.Player.TryGetSettings().

◆ Update()

void TiltFive.TiltFiveManager2.Update ( )

private

Update this instance.

Definition at line 223 of file TiltFiveManager2.cs.

         {
 #if !UNITY_2019_1_OR_NEWER || !INPUTSYSTEM_AVAILABLE
             NeedsDriverUpdate();
             Player.ScanForNewPlayers(); // Should only be executed once per frame
             Wand.GetLatestInputs();     // Should only be executed once per frame
 #endif
             RefreshSpectatorSettings();
             Display.ApplyGraphicsSettings(graphicsSettings);
  
             for (int i = 0; i < supportedPlayerCount; i++)
             {
                 var playerSettings = allPlayerSettings[i];
                 if (playerSettings != null)
                 {
                     Player.Update(playerSettings, spectatorSettings);
                 }
             }
  
             var spectatedPlayer = spectatorSettings.spectatedPlayer;
             if (Glasses.TryGetPreviewPose(spectatedPlayer, out var spectatedPlayerPose))
             {
                 spectatorSettings.spectatorCamera?.transform.SetPositionAndRotation(
                     spectatedPlayerPose.position,
                     spectatedPlayerPose.rotation);
             }
  
 #if UNITY_2019_1_OR_NEWER && INPUTSYSTEM_AVAILABLE
             var devices = InputUser.GetUnpairedInputDevices();
             if (devices.Count > 0)
             {
                 foreach (InputDevice dev in devices)
                 {
                     if (dev is WandDevice)
                     {
                         var headPoseRoot = Glasses.GetPoseRoot(((WandDevice)dev).playerIndex);
  
                         if (headPoseRoot != null)
                         {
                             var playerInput = headPoseRoot.GetComponentInChildren<PlayerInput>();
  
                             if (playerInput != null && playerInput.user.valid)
                             {
                                 Log.Warn($"Unpaired Wand Device [{((WandDevice)dev).ControllerIndex}] found and paired to Player [{((WandDevice)dev).playerIndex}].");
                                 InputUser.PerformPairingWithDevice(dev, playerInput.user);
                                 playerInput.user.ActivateControlScheme("XR");
                             }
                         }
                     }
                 }
             }
 #endif
         }

References TiltFive.TiltFiveManager2.allPlayerSettings, TiltFive.Glasses.GetPoseRoot(), TiltFive.TiltFiveManager2.graphicsSettings, TiltFive.TiltFiveManager2.NeedsDriverUpdate(), TiltFive.TiltFiveManager2.RefreshSpectatorSettings(), TiltFive.SpectatorSettings.spectatedPlayer, TiltFive.SpectatorSettings.spectatorCamera, TiltFive.TiltFiveManager2.spectatorSettings, TiltFive.TiltFiveManager2.supportedPlayerCount, TiltFive.Glasses.TryGetPreviewPose(), and TiltFive.Logging.Log.Warn().

Member Data Documentation

◆ allPlayerSettings

PlayerSettings [] TiltFive.TiltFiveManager2.allPlayerSettings = new PlayerSettings[PlayerSettings.MAX_SUPPORTED_PLAYERS]

Definition at line 107 of file TiltFiveManager2.cs.

Referenced by TiltFive.TiltFiveManager2.Awake(), TiltFive.TiltFiveManager2.LateUpdate(), TiltFive.TiltFiveManager2.OnEnable(), and TiltFive.TiltFiveManager2.Update().

◆ graphicsSettings

GraphicsSettings TiltFive.TiltFiveManager2.graphicsSettings = new GraphicsSettings()

Project-wide graphics settings related to Tilt Five.

Definition at line 119 of file TiltFiveManager2.cs.

Referenced by TiltFive.TiltFiveManager2.Awake(), and TiltFive.TiltFiveManager2.Update().

◆ logSettings

LogSettings TiltFive.TiltFiveManager2.logSettings = new LogSettings()

The log settings.

Definition at line 124 of file TiltFiveManager2.cs.

Referenced by TiltFive.TiltFiveManager2.Awake().

◆ needsDriverUpdateErroredOnce

bool TiltFive.TiltFiveManager2.needsDriverUpdateErroredOnce = false

private

Definition at line 137 of file TiltFiveManager2.cs.

Referenced by TiltFive.TiltFiveManager2.NeedsDriverUpdate().

◆ needsDriverUpdateNotifiedOnce

bool TiltFive.TiltFiveManager2.needsDriverUpdateNotifiedOnce = false

private

Definition at line 136 of file TiltFiveManager2.cs.

Referenced by TiltFive.TiltFiveManager2.NeedsDriverUpdate().

◆ spectatorSettings

SpectatorSettings TiltFive.TiltFiveManager2.spectatorSettings = new SpectatorSettings()

The spectator camera's runtime configuration data.

Definition at line 114 of file TiltFiveManager2.cs.

Referenced by TiltFive.TiltFiveManager2.LateUpdate(), TiltFive.TiltFiveManager2.OnEnable(), TiltFive.TiltFiveManager2.RefreshSpectatorSettings(), and TiltFive.TiltFiveManager2.Update().

◆ supportedPlayerCount

uint TiltFive.TiltFiveManager2.supportedPlayerCount = 3

Definition at line 109 of file TiltFiveManager2.cs.

Referenced by TiltFive.TiltFiveManager2.GetSupportedPlayerCount(), TiltFive.TiltFiveManager2.LateUpdate(), TiltFive.TiltFiveManager2.OnEnable(), TiltFive.TiltFiveManager2.RefreshSpectatorSettings(), and TiltFive.TiltFiveManager2.Update().

◆ upgradeInProgress

bool TiltFive.TiltFiveManager2.upgradeInProgress = false

staticprivate

Definition at line 139 of file TiltFiveManager2.cs.

Property Documentation

◆ playerFourSettings

PlayerSettings TiltFive.TiltFiveManager2.playerFourSettings

get

The fourth player's runtime configuration data.

Definition at line 95 of file TiltFiveManager2.cs.

         {
             get
             {
                 if (allPlayerSettings[3] == null)
                 {
                     allPlayerSettings[3] = new PlayerSettings() { PlayerIndex = PlayerIndex.Four };
                 }
                 return allPlayerSettings[3];
             }
         }

Referenced by TiltFive.TiltFiveManager2.TryGetPlayerSettings().

◆ playerOneSettings

PlayerSettings TiltFive.TiltFiveManager2.playerOneSettings

get

The first player's runtime configuration data.

Definition at line 50 of file TiltFiveManager2.cs.

         {
             get
             {
                 if(allPlayerSettings[0] == null)
                 {
                     allPlayerSettings[0] = new PlayerSettings() { PlayerIndex = PlayerIndex.One };
                 }
                 return allPlayerSettings[0];
             }
         }

Referenced by TiltFive.TiltFiveManager2.GetGameboardPose(), TiltFive.TiltFiveManager2.GetScaleToUWRLD_UGBD(), and TiltFive.TiltFiveManager2.TryGetPlayerSettings().

◆ playerThreeSettings

PlayerSettings TiltFive.TiltFiveManager2.playerThreeSettings

get

The third player's runtime configuration data.

Definition at line 80 of file TiltFiveManager2.cs.

         {
             get
             {
                 if (allPlayerSettings[2] == null)
                 {
                     allPlayerSettings[2] = new PlayerSettings() { PlayerIndex = PlayerIndex.Three };
                 }
                 return allPlayerSettings[2];
             }
         }

Referenced by TiltFive.TiltFiveManager2.TryGetPlayerSettings().

◆ playerTwoSettings

PlayerSettings TiltFive.TiltFiveManager2.playerTwoSettings

get

The second player's runtime configuration data.

Definition at line 65 of file TiltFiveManager2.cs.

         {
             get
             {
                 if (allPlayerSettings[1] == null)
                 {
                     allPlayerSettings[1] = new PlayerSettings() { PlayerIndex = PlayerIndex.Two };
                 }
                 return allPlayerSettings[1];
             }
         }

Referenced by TiltFive.TiltFiveManager2.TryGetPlayerSettings().

The documentation for this class was generated from the following file:

TiltFiveManager2.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ Awake()

◆ GetEyeCamera()

◆ GetGameboardPose()

◆ GetScaleToUWRLD_UGBD()

◆ GetSupportedPlayerCount()

◆ IsActiveAndEnabled()

◆ LateUpdate()

◆ NeedsDriverUpdate()

◆ OnApplicationQuit()

◆ OnDestroy()

◆ OnDisable()

◆ OnEnable()

◆ Quit()

◆ RefreshSpectatorSettings()

◆ RunOnStart()

◆ TryGetPlayerSettings()

◆ Update()

Member Data Documentation

◆ allPlayerSettings

◆ graphicsSettings

◆ logSettings

◆ needsDriverUpdateErroredOnce

◆ needsDriverUpdateNotifiedOnce

◆ spectatorSettings

◆ supportedPlayerCount

◆ upgradeInProgress

Property Documentation

◆ playerFourSettings

◆ playerOneSettings

◆ playerThreeSettings

◆ playerTwoSettings