TiltFive.TiltFiveManager Class Reference

The Tilt Five manager. More...

Inheritance diagram for TiltFive.TiltFiveManager:

Public Member Functions
bool	NeedsDriverUpdate ()
	Check if a driver update is needed.
float	GetScaleToUWRLD_UGBD ()
Pose	GetGameboardPose ()
Camera	GetEyeCamera ()
uint	GetSupportedPlayerCount ()
bool	IsActiveAndEnabled ()
float	GetScaleToUWRLD_UGBD ()
Pose	GetGameboardPose ()
Camera	GetEyeCamera ()
uint	GetSupportedPlayerCount ()
bool	IsActiveAndEnabled ()

Public Attributes
ScaleSettings	scaleSettings
	The scale conversion runtime configuration data.
GameBoardSettings	gameBoardSettings
	The game board runtime configuration data.
GlassesSettings	glassesSettings
	The glasses runtime configuration data.
WandSettings	primaryWandSettings
WandSettings	secondaryWandSettings
SpectatorSettings	spectatorSettings = new SpectatorSettings()
	The spectator camera's runtime configuration data.
LogSettings	logSettings = new LogSettings()
	The log settings.

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

Properties
WandSettings	leftWandSettings [get, set]
	The wand runtime configuration data for the left hand wand.
WandSettings	rightWandSettings [get, set]
	The wand runtime configuration data for the right hand wand.
Properties inherited from TiltFive.SingletonComponent< TiltFiveManager >
static T	Instance [get]

Private Member Functions
void	Update ()
	Update this instance.
void	LateUpdate ()
	Update this instance after all components have finished executing their Update() functions.
void	GetLatestPoseData ()
	Obtains the latest pose for all trackable objects.
void	OnEnable ()
	Called when the GameObject is enabled.
void	OnDisable ()
void	OnDestroy ()
void	OnApplicationQuit ()
void	RefreshSpectatorSettings ()
void	RefreshPlayerSettings ()

Static Private Member Functions
static void	Quit ()
static void	RunOnStart ()

Private Attributes
bool	needsDriverUpdateNotifiedOnce = false
bool	needsDriverUpdateErroredOnce = false
PlayerSettings	playerSettings = new PlayerSettings()

Detailed Description

The Tilt Five manager.

Definition at line 45 of file TiltFiveManager.cs.

Member Function Documentation

Awake()

override void TiltFive.TiltFiveManager.Awake ( )

protectedvirtual

Awake this instance.

Reimplemented from TiltFive.SingletonComponent< TiltFiveManager >.

Definition at line 117 of file TiltFiveManager.cs.

        {
            base.Awake();
 
            // Apply log settings
            Log.LogLevel = logSettings.level;
            Log.TAG = logSettings.TAG;
 
            if (!Display.SetApplicationInfo())
            {
                Log.Warn("Failed to send application info to the T5 Control Panel.");
                enabled = false;
            }
 
            RefreshPlayerSettings();
 
            spectatorSettings.spectatorCamera = glassesSettings.cameraTemplate;
            spectatorSettings.glassesMirrorMode = glassesSettings.glassesMirrorMode;
            spectatorSettings.spectatedPlayer = playerSettings.PlayerIndex;
        }

References TiltFive.GlassesSettings.cameraTemplate, TiltFive.GlassesSettings.glassesMirrorMode, TiltFive.TiltFiveManager.glassesSettings, TiltFive.Logging.LogSettings.level, TiltFive.TiltFiveManager.logSettings, TiltFive.PlayerSettings.PlayerIndex, TiltFive.TiltFiveManager.playerSettings, TiltFive.TiltFiveManager.RefreshPlayerSettings(), TiltFive.Display.SetApplicationInfo(), TiltFive.Logging.LogSettings.TAG, and TiltFive.Logging.Log.Warn().

GetEyeCamera()

Camera TiltFive.TiltFiveManager.GetEyeCamera

(

)

Implements TiltFive.ISceneInfo.

Definition at line 470 of file TiltFiveManager.cs.

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

References TiltFive.Glasses.GetLeftEye().

GetGameboardPose()

Pose TiltFive.TiltFiveManager.GetGameboardPose

(

)

Implements TiltFive.ISceneInfo.

Definition at line 465 of file TiltFiveManager.cs.

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

References TiltFive.GameBoardSettings.gameBoardCenter, TiltFive.GameBoardSettings.gameBoardRotation, and TiltFive.TiltFiveManager.gameBoardSettings.

GetLatestPoseData()

void TiltFive.TiltFiveManager.GetLatestPoseData ( )

private

Obtains the latest pose for all trackable objects.

Definition at line 206 of file TiltFiveManager.cs.

        {
            Glasses.Update(glassesSettings, scaleSettings, gameBoardSettings);
            Wand.Update(leftWandSettings, scaleSettings, gameBoardSettings);
            Wand.Update(rightWandSettings, scaleSettings, gameBoardSettings);
        }

References TiltFive.TiltFiveManager.gameBoardSettings, TiltFive.TiltFiveManager.glassesSettings, TiltFive.TiltFiveManager.leftWandSettings, TiltFive.TiltFiveManager.rightWandSettings, TiltFive.TiltFiveManager.scaleSettings, TiltFive.Glasses.Update(), and TiltFive.Wand.Update().

GetScaleToUWRLD_UGBD()

float TiltFive.TiltFiveManager.GetScaleToUWRLD_UGBD

(

)

Implements TiltFive.ISceneInfo.

Definition at line 460 of file TiltFiveManager.cs.

        {
            return scaleSettings.GetScaleToUWRLD_UGBD(gameBoardSettings.gameBoardScale);
        }

References TiltFive.GameBoardSettings.gameBoardScale, TiltFive.TiltFiveManager.gameBoardSettings, TiltFive.ScaleSettings.GetScaleToUWRLD_UGBD(), and TiltFive.TiltFiveManager.scaleSettings.

GetSupportedPlayerCount()

uint TiltFive.TiltFiveManager.GetSupportedPlayerCount

(

)

Implements TiltFive.ISceneInfo.

Definition at line 475 of file TiltFiveManager.cs.

        {
            return 1;   // TODO: Change this if we decide to include spectators with TiltFiveManager
        }

Referenced by TiltFive.TiltFiveManager.OnEnable(), and TiltFive.TiltFiveManager.RefreshSpectatorSettings().

IsActiveAndEnabled()

bool TiltFive.TiltFiveManager.IsActiveAndEnabled

(

)

Implements TiltFive.ISceneInfo.

Definition at line 480 of file TiltFiveManager.cs.

        {
            return isActiveAndEnabled;
        }

LateUpdate()

void TiltFive.TiltFiveManager.LateUpdate ( )

private

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

Definition at line 194 of file TiltFiveManager.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.
            Player.Update(playerSettings, spectatorSettings);
        }

References TiltFive.TiltFiveManager.playerSettings, and TiltFive.TiltFiveManager.spectatorSettings.

NeedsDriverUpdate()

bool TiltFive.TiltFiveManager.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 224 of file TiltFiveManager.cs.

        {
            if (!needsDriverUpdateErroredOnce)
            {
                try
                {
                    ServiceCompatibility compatibility = NativePlugin.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.NativePlugin.GetServiceCompatibility(), TiltFive.Logging.Log.Info(), TiltFive.TiltFiveManager.needsDriverUpdateErroredOnce, TiltFive.TiltFiveManager.needsDriverUpdateNotifiedOnce, and TiltFive.Logging.Log.Warn().

Referenced by TiltFive.TiltFiveManager.Update().

OnApplicationQuit()

void TiltFive.TiltFiveManager.OnApplicationQuit ( )

private

Definition at line 308 of file TiltFiveManager.cs.

        {
            OnDisable();
        }

References TiltFive.TiltFiveManager.OnDisable().

OnDestroy()

void TiltFive.TiltFiveManager.OnDestroy ( )

private

Definition at line 303 of file TiltFiveManager.cs.

        {
            Player.OnDisable();
        }

OnDisable()

void TiltFive.TiltFiveManager.OnDisable ( )

private

Definition at line 295 of file TiltFiveManager.cs.

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

Referenced by TiltFive.TiltFiveManager.OnApplicationQuit().

OnEnable()

void TiltFive.TiltFiveManager.OnEnable ( )

private

Called when the GameObject is enabled.

Definition at line 270 of file TiltFiveManager.cs.

        {
            try
            {
                NativePlugin.SetMaxDesiredGlasses((byte)GetSupportedPlayerCount());
            }
            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);
            }
 
            Player.OnEnable(GetSupportedPlayerCount());
            Glasses.Reset(glassesSettings);
 
#if UNITY_2019_1_OR_NEWER && INPUTSYSTEM_AVAILABLE
            InputSystem.onBeforeUpdate += OnBeforeUpdate;
#endif
        }

References TiltFive.Logging.Log.Error(), TiltFive.TiltFiveManager.GetSupportedPlayerCount(), TiltFive.TiltFiveManager.glassesSettings, TiltFive.Logging.Log.Info(), TiltFive.Glasses.Reset(), and TiltFive.NativePlugin.SetMaxDesiredGlasses().

Quit()

static void TiltFive.TiltFiveManager.Quit ( )

staticprivate

Definition at line 318 of file TiltFiveManager.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(), and TiltFive.NativePlugin.UnloadWorkaround().

Referenced by TiltFive.TiltFiveManager.RunOnStart().

RefreshPlayerSettings()

void TiltFive.TiltFiveManager.RefreshPlayerSettings ( )

private

Definition at line 363 of file TiltFiveManager.cs.

        {
            /* In an initial implementation of TiltFiveManager's internal PlayerSettings object, we initialized
            * a new PlayerSettings in Awake() and set its internal settings objects to TiltFiveManager's internal settings objects.
            *
            * However, this introduced a bug. The settings values in TiltFiveManager's custom inspector couldn't be
            * modified when the editor was in play mode, which would be a fairly significant quality of life issue for developers.
            *
            * I'm a bit fuzzy on the underlying mechanism, but the issue seemed to be that in the TiltFiveManager's
            * custom inspector code, the SerializedProperty API (for GlassesSettings, WandSettings, ScaleSettings, etc)
            * couldn't apply edits to the underlying settings objects if they were owned/shared by multiple parent classes
            * (e.g. the same GlassesSettings can't be owned by both a TiltFiveManager and a PlayerSettings without
            * breaking SerializedProperty's ability to modify the GlassesSettings).
            *
            * So the fix was to stop sharing.
            * Instead of building a PlayerSettings internally on Awake() that uses TiltFiveManager's existing settings objects,
            * we build one that has its own unique internal settings objects, and any time an edit gets made,
            * OnValidate() does a shallow copy to those objects using RefreshPlayerSettings(). */
 
            if(playerSettings == null)
            {
                return;
            }
            playerSettings.PlayerIndex = PlayerIndex.One;
 
            if (glassesSettings != null)
            {
                playerSettings.glassesSettings = glassesSettings.Copy();
            }
            if (rightWandSettings != null)
            {
                playerSettings.rightWandSettings = rightWandSettings.Copy();
            }
            if (leftWandSettings != null)
            {
                playerSettings.leftWandSettings = leftWandSettings.Copy();
            }
            if (gameBoardSettings != null)
            {
                playerSettings.gameboardSettings = gameBoardSettings.Copy();
            }
            if (scaleSettings != null)
            {
                playerSettings.scaleSettings = scaleSettings.Copy();
            }
        }

References TiltFive.TiltFiveManager.gameBoardSettings, TiltFive.TiltFiveManager.glassesSettings, TiltFive.TiltFiveManager.leftWandSettings, TiltFive.TiltFiveManager.playerSettings, TiltFive.TiltFiveManager.rightWandSettings, and TiltFive.TiltFiveManager.scaleSettings.

Referenced by TiltFive.TiltFiveManager.Awake().

RefreshSpectatorSettings()

void TiltFive.TiltFiveManager.RefreshSpectatorSettings ( )

private

Definition at line 340 of file TiltFiveManager.cs.

        {
            // Warn developers if they've left the glassesSettings camera template field empty, since it's still required for the original TiltFiveManager
            if(glassesSettings.cameraTemplate == null)
            {
                Log.Warn("No camera template detected in TiltFiveManager's glassesSettings. A camera template is required.");
            }
 
            // We don't expose any global settings like SpectatorSettings in TiltFiveManager's custom inspector,
            // though they're still accessible from scripts.
            // Just synchronize spectatorSettings from TiltFiveManager's glassesSettings as needed.
            spectatorSettings.spectatorCamera = glassesSettings.cameraTemplate;
            spectatorSettings.glassesMirrorMode = glassesSettings.glassesMirrorMode;
 
            // Make sure that the spectated player isn't set to a player index higher than what TiltFiveManager supports
            var highestSupportedPlayer = (PlayerIndex)GetSupportedPlayerCount();
            if (spectatorSettings.spectatedPlayer > highestSupportedPlayer)
            {
                Log.Warn($"Invalid spectatorSettings.spectatedPlayer [{spectatorSettings.spectatedPlayer}]. TiltFiveManager only supports one player.");
                spectatorSettings.spectatedPlayer = highestSupportedPlayer;
            }
        }

References TiltFive.GlassesSettings.cameraTemplate, TiltFive.TiltFiveManager.GetSupportedPlayerCount(), TiltFive.GlassesSettings.glassesMirrorMode, TiltFive.TiltFiveManager.glassesSettings, TiltFive.SpectatorSettings.spectatedPlayer, TiltFive.TiltFiveManager.spectatorSettings, and TiltFive.Logging.Log.Warn().

Referenced by TiltFive.TiltFiveManager.Update().

RunOnStart()

static void TiltFive.TiltFiveManager.RunOnStart ( )

staticprivate

Definition at line 335 of file TiltFiveManager.cs.

        {
            Application.quitting += Quit;
        }

References TiltFive.TiltFiveManager.Quit().

Update()

void TiltFive.TiltFiveManager.Update ( )

private

Update this instance.

Definition at line 171 of file TiltFiveManager.cs.

        {
#if !UNITY_2019_1_OR_NEWER || !INPUTSYSTEM_AVAILABLE
            NeedsDriverUpdate();
            Player.ScanForNewPlayers();
            Wand.GetLatestInputs();     // Should only be executed once per frame
#endif
            RefreshSpectatorSettings();
            Player.Update(playerSettings, spectatorSettings);
 
            var spectatedPlayer = spectatorSettings.spectatedPlayer;
            if (Glasses.TryGetPreviewPose(spectatedPlayer, out var spectatedPlayerPose))
            {
                spectatorSettings.spectatorCamera?.transform.SetPositionAndRotation(
                    spectatedPlayerPose.position,
                    spectatedPlayerPose.rotation);
            }
        }

References TiltFive.TiltFiveManager.NeedsDriverUpdate(), TiltFive.TiltFiveManager.playerSettings, TiltFive.TiltFiveManager.RefreshSpectatorSettings(), TiltFive.SpectatorSettings.spectatedPlayer, TiltFive.SpectatorSettings.spectatorCamera, TiltFive.TiltFiveManager.spectatorSettings, and TiltFive.Glasses.TryGetPreviewPose().

Member Data Documentation

gameBoardSettings

GameBoardSettings TiltFive.TiltFiveManager.gameBoardSettings

The game board runtime configuration data.

Definition at line 55 of file TiltFiveManager.cs.

Referenced by TiltFive.TiltFiveManager.GetGameboardPose(), TiltFive.TiltFiveManager.GetLatestPoseData(), TiltFive.TiltFiveManager.GetScaleToUWRLD_UGBD(), and TiltFive.TiltFiveManager.RefreshPlayerSettings().

glassesSettings

GlassesSettings TiltFive.TiltFiveManager.glassesSettings

The glasses runtime configuration data.

Definition at line 60 of file TiltFiveManager.cs.

Referenced by TiltFive.TiltFiveManager.Awake(), TiltFive.TiltFiveManager.GetLatestPoseData(), TiltFive.TiltFiveManager.OnEnable(), TiltFive.TiltFiveManager.RefreshPlayerSettings(), and TiltFive.TiltFiveManager.RefreshSpectatorSettings().

logSettings

LogSettings TiltFive.TiltFiveManager.logSettings = new LogSettings()

The log settings.

Definition at line 98 of file TiltFiveManager.cs.

Referenced by TiltFive.TiltFiveManager.Awake().

needsDriverUpdateErroredOnce

bool TiltFive.TiltFiveManager.needsDriverUpdateErroredOnce = false

private

Definition at line 109 of file TiltFiveManager.cs.

Referenced by TiltFive.TiltFiveManager.NeedsDriverUpdate().

needsDriverUpdateNotifiedOnce

bool TiltFive.TiltFiveManager.needsDriverUpdateNotifiedOnce = false

private

Definition at line 108 of file TiltFiveManager.cs.

Referenced by TiltFive.TiltFiveManager.NeedsDriverUpdate().

playerSettings

PlayerSettings TiltFive.TiltFiveManager.playerSettings = new PlayerSettings()

private

Definition at line 112 of file TiltFiveManager.cs.

Referenced by TiltFive.TiltFiveManager.Awake(), TiltFive.TiltFiveManager.LateUpdate(), TiltFive.TiltFiveManager.RefreshPlayerSettings(), and TiltFive.TiltFiveManager.Update().

primaryWandSettings

WandSettings TiltFive.TiltFiveManager.primaryWandSettings

Definition at line 66 of file TiltFiveManager.cs.

scaleSettings

ScaleSettings TiltFive.TiltFiveManager.scaleSettings

The scale conversion runtime configuration data.

Definition at line 50 of file TiltFiveManager.cs.

Referenced by TiltFive.TiltFiveManager.GetLatestPoseData(), TiltFive.TiltFiveManager.GetScaleToUWRLD_UGBD(), and TiltFive.TiltFiveManager.RefreshPlayerSettings().

secondaryWandSettings

WandSettings TiltFive.TiltFiveManager.secondaryWandSettings

Definition at line 68 of file TiltFiveManager.cs.

spectatorSettings

SpectatorSettings TiltFive.TiltFiveManager.spectatorSettings = new SpectatorSettings()

The spectator camera's runtime configuration data.

Definition at line 93 of file TiltFiveManager.cs.

Referenced by TiltFive.TiltFiveManager.LateUpdate(), TiltFive.TiltFiveManager.RefreshSpectatorSettings(), and TiltFive.TiltFiveManager.Update().

Property Documentation

leftWandSettings

WandSettings TiltFive.TiltFiveManager.leftWandSettings

getset

The wand runtime configuration data for the left hand wand.

Definition at line 73 of file TiltFiveManager.cs.

                                             {
            #pragma warning disable 618 // this is for compatibility; disable obsolete warning
            get => secondaryWandSettings;
            set => secondaryWandSettings = value;
            #pragma warning restore 618
        }

Referenced by TiltFive.TiltFiveManager.GetLatestPoseData(), and TiltFive.TiltFiveManager.RefreshPlayerSettings().

rightWandSettings

WandSettings TiltFive.TiltFiveManager.rightWandSettings

getset

The wand runtime configuration data for the right hand wand.

Definition at line 83 of file TiltFiveManager.cs.

                                              {
            #pragma warning disable 618 // this is for compatibility; disable obsolete warning
            get => primaryWandSettings;
            set => primaryWandSettings = value;
            #pragma warning restore 618
        }

Referenced by TiltFive.TiltFiveManager.GetLatestPoseData(), and TiltFive.TiltFiveManager.RefreshPlayerSettings().

---

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

• TiltFiveManager.cs