The Glasses API and runtime. More...

Inheritance diagram for TiltFive.Glasses:

Classes
class	BaseGlassesCore

class	GlassesCore
	Internal Glasses core runtime. More...

class	GlassesPreviewCore
	Trackable core for the smoothed glasses preview pose. More...

Public Types
enum	AREyes { EYE_LEFT = 0 , EYE_RIGHT , EYE_MAX }

Static Public Member Functions
static bool	headPoseUpdated (PlayerIndex playerIndex=PlayerIndex.One)
	Returns a boolean indication that the head pose was successfully updated.

static void	Reset (GlassesSettings glassesSettings, SpectatorSettings spectatorSettings=null, PlayerIndex playerIndex=PlayerIndex.None)
	Reset this T:TiltFive.Glasses.

static bool	Validate (GlassesSettings glassesSettings, SpectatorSettings spectatorSettings=null, PlayerIndex playerIndex=PlayerIndex.One)
	Validates the specified glassesSettings with the specified glasses core.

static void	Update (GlassesSettings glassesSettings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings)
	Updates this T:TiltFive.Glasses.

static bool	IsTracked (PlayerIndex playerIndex=PlayerIndex.One)
	Indicate if the specified glasses are tracked.

static bool	IsConnected (PlayerIndex playerIndex=PlayerIndex.One)
	Indicate if the specified glasses are connected.

static bool	TryGetFriendlyName (PlayerIndex playerIndex, out string friendlyName)

static bool	TryGetPose (PlayerIndex playerIndex, out Pose pose)
	Attempts to get the position and orientation of the specified player's glasses.

static bool	TryGetPreviewPose (PlayerIndex playerIndex, out Pose pose)
	Attempts to get the position and orientation of the specified player's glasses, smoothed for on-screen preview.

static GameObject	GetPoseRoot (PlayerIndex playerIndex)

static Camera	GetLeftEye (PlayerIndex playerIndex)

static Camera	GetRightEye (PlayerIndex playerIndex)

static void	ScanForGlasses ()

Properties
static bool	updated `[get]`
	Gets a value indicating whether this T:TiltFive.Glasses is updated.

static bool	configured `[get]`
	Gets a value indicating whether this T:TiltFive.Glasses is configured.

static Vector3	position `[get]`
	Gets the head pose position.

static Quaternion	rotation `[get]`
	Gets the head pose rotation.

static Vector3	forward `[get]`
	Gets the head orientation's forward vector.

static Vector3	right `[get]`
	Gets the head orientation's right vector.

static Vector3	up `[get]`
	Gets the head orientation's up vector.

static Vector3	leftEyePosition `[get]`
	Gets the left eye position.

static Vector3	rightEyePosition `[get]`
	Gets the right eye position.

static bool	glassesAvailable `[get, private set]`
	Indicates whether the glasses are plugged in and functioning.

Properties inherited from TiltFive.Singleton< Glasses >
static T	Instance `[get]`

Static Private Member Functions
static GameObject	GetPoseRoot (GlassesHandle glassesHandle)

static Camera	GetLeftEye (GlassesHandle glassesHandle)

static Camera	GetRightEye (GlassesHandle glassesHandle)

static GlassesCore	GetPlayerOneGlassesCore ()

static bool	TryGetSpectatorSettings (out SpectatorSettings spectatorSettings)

Private Attributes
Dictionary< GlassesHandle, GlassesCore >	glassesCores = new Dictionary<GlassesHandle, GlassesCore>()
	The glasses core runtimes.

HashSet< GlassesHandle >	incomingHandles = new HashSet<GlassesHandle>()

HashSet< GlassesHandle >	lostHandles = new HashSet<GlassesHandle>()

GlassesHandle?	defaultGlassesHandle
	The identifier for the first detected pair of glasses.

Additional Inherited Members
Protected Member Functions inherited from TiltFive.Singleton< Glasses >
	Singleton ()

Detailed Description

The Glasses API and runtime.

Definition at line 34 of file Glasses.cs.

Member Enumeration Documentation

◆ AREyes

enum TiltFive.Glasses.AREyes

Enumerator
EYE_LEFT
EYE_RIGHT
EYE_MAX

Definition at line 56 of file Glasses.cs.

        {
            EYE_LEFT = 0,
            EYE_RIGHT,
            EYE_MAX,
        }

Member Function Documentation

◆ GetLeftEye() [1/2]

static Camera TiltFive.Glasses.GetLeftEye ( GlassesHandle glassesHandle )

staticprivate

Definition at line 523 of file Glasses.cs.

        {
            if (!Instance.glassesCores.TryGetValue(glassesHandle, out var glassesCore))
            {
                return null;
            }
            return glassesCore.leftEye;
        }

◆ GetLeftEye() [2/2]

static Camera TiltFive.Glasses.GetLeftEye ( PlayerIndex playerIndex )

static

Definition at line 305 of file Glasses.cs.

        {
            if (!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                return null;
            }
            return GetLeftEye(glassesHandle);
        }

References TiltFive.Glasses.GetLeftEye().

Referenced by TiltFive.TiltFiveManager.GetEyeCamera(), TiltFive.TiltFiveManager2.GetEyeCamera(), and TiltFive.Glasses.GetLeftEye().

◆ GetPlayerOneGlassesCore()

static GlassesCore TiltFive.Glasses.GetPlayerOneGlassesCore ( )

staticprivate

Definition at line 542 of file Glasses.cs.

        {
            if(Player.TryGetGlassesHandle(PlayerIndex.One, out var glassesHandle)
                && Instance.glassesCores.TryGetValue(glassesHandle, out var glassesCore))
            {
                return glassesCore;
            }
            return null;
        }

◆ GetPoseRoot() [1/2]

static GameObject TiltFive.Glasses.GetPoseRoot ( GlassesHandle glassesHandle )

staticprivate

Definition at line 514 of file Glasses.cs.

        {
            if (!Instance.glassesCores.TryGetValue(glassesHandle, out var glassesCore))
            {
                return null;
            }
            return glassesCore.headPose.gameObject;
        }

◆ GetPoseRoot() [2/2]

static GameObject TiltFive.Glasses.GetPoseRoot ( PlayerIndex playerIndex )

static

Definition at line 296 of file Glasses.cs.

        {
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                return null;
            }
            return GetPoseRoot(glassesHandle);
        }

References TiltFive.Glasses.GetPoseRoot().

Referenced by TiltFive.Glasses.GetPoseRoot().

◆ GetRightEye() [1/2]

static Camera TiltFive.Glasses.GetRightEye ( GlassesHandle glassesHandle )

staticprivate

Definition at line 532 of file Glasses.cs.

        {
            if (!Instance.glassesCores.TryGetValue(glassesHandle, out var glassesCore))
            {
                return null;
            }
 
            return glassesCore.rightEye;
        }

◆ GetRightEye() [2/2]

static Camera TiltFive.Glasses.GetRightEye ( PlayerIndex playerIndex )

static

Definition at line 314 of file Glasses.cs.

        {
            if (!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                return null;
            }
            return GetRightEye(glassesHandle);
        }

References TiltFive.Glasses.GetRightEye().

Referenced by TiltFive.Glasses.GetRightEye().

◆ headPoseUpdated()

static bool TiltFive.Glasses.headPoseUpdated ( PlayerIndex playerIndex = PlayerIndex::One )

static

Returns a boolean indication that the head pose was successfully updated.

Returns: true, if the head pose was updated, false otherwise.

Parameters

glassesHandle The specified glasses. If null is provided, this uses the default glasses.

Definition at line 133 of file Glasses.cs.

        {
            if(playerIndex == PlayerIndex.None || !Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                return false;
            }
 
            return Instance.glassesCores.TryGetValue(glassesHandle, out var glassesCore)
                && glassesCore.TrackingUpdated;
        }

References TiltFive.Singleton< Glasses >.Instance.

◆ IsConnected()

static bool TiltFive.Glasses.IsConnected ( PlayerIndex playerIndex = PlayerIndex::One )

static

Indicate if the specified glasses are connected.

Returns: true if the glasses are connected, false otherwise.

Parameters

glassesHandle Glasses handle to check.

Definition at line 231 of file Glasses.cs.

        {
            return Player.TryGetGlassesHandle(playerIndex, out var glassesHandle)
                && IsConnected(glassesHandle);
        }

References TiltFive.Glasses.IsConnected().

Referenced by TiltFive.Glasses.IsConnected().

◆ IsTracked()

static bool TiltFive.Glasses.IsTracked ( PlayerIndex playerIndex = PlayerIndex::One )

static

Indicate if the specified glasses are tracked.

Returns: true if the glasses are tracked, false otherwise.

Parameters

playerIndex If not provided, the Player 1's glasses are checked.

Definition at line 220 of file Glasses.cs.

        {
            return Player.TryGetGlassesHandle(playerIndex, out var glassesHandle)
                && IsTracked(glassesHandle);
        }

References TiltFive.Glasses.IsTracked().

Referenced by TiltFive.Glasses.IsTracked(), and TiltFive.Wand.WandCore.TryGetStateFromPlugin().

◆ Reset()

static void TiltFive.Glasses.Reset	(	GlassesSettings	glassesSettings,
		SpectatorSettings	spectatorSettings = `null`,
		PlayerIndex	playerIndex = `PlayerIndex::None`
	)

static

Reset this T:TiltFive.Glasses.

Parameters

glassesSettings	Glasses settings for configuring the specified glassesCore.
playerIndex	The specified player. If None is provided, this resets all glasses.

Definition at line 149 of file Glasses.cs.

        {
            if(spectatorSettings == null && !TryGetSpectatorSettings(out spectatorSettings))
            {
                Log.Error("Glasses.Reset() could not find any spectator settings.");
                return;
            }
 
            // If playerIndex is none, reset all glasses
            if(playerIndex == PlayerIndex.None)
            {
                foreach (var glassesCore in Instance.glassesCores.Values)
                {
                    glassesCore.Reset(glassesSettings, spectatorSettings);
                }
                return;
            }
 
            if(Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                Reset(glassesSettings, spectatorSettings, glassesHandle);
            }
        }

References TiltFive.Logging.Log.Error(), TiltFive.Singleton< Glasses >.Instance, TiltFive.Glasses.Reset(), and TiltFive.Glasses.TryGetSpectatorSettings().

Referenced by TiltFive.TiltFiveManager.OnEnable(), and TiltFive.Glasses.Reset().

◆ ScanForGlasses()

static void TiltFive.Glasses.ScanForGlasses ( )

static

Definition at line 323 of file Glasses.cs.

        {
            // Enumerate the available glasses provided by the native plugin
            UInt64[] glassesHandles = new UInt64[GlassesSettings.MAX_SUPPORTED_GLASSES_COUNT];
            Debug.Assert(glassesHandles.Length <= Byte.MaxValue);
            byte glassesCount = (byte)glassesHandles.Length;
            int result = 0;
 
            try
            {
                var refreshResult = NativePlugin.RefreshGlassesAvailable();
                result = NativePlugin.GetGlassesHandles(ref glassesCount, glassesHandles);
            }
            catch (System.Exception e)
            {
                Log.Error($"Error getting glasses handles: {e.Message}");
            }
 
            // Add/Remove entries from the glassesCores dictionary
            var glassesCores = Instance.glassesCores;
            var incomingHandles = Instance.incomingHandles;
            var lostHandles = Instance.lostHandles;
 
            incomingHandles.Clear();
            lostHandles.Clear();
 
            // If we ran into a problem getting the glasses handles, all bets are off — just tear down the now-useless glasses cores.
            if (result != 0)
            {
                foreach (var keyValuePair in glassesCores)
                {
                    var lostHandle = keyValuePair.Key;
                    var glassesCore = keyValuePair.Value;
 
                    glassesCore.Dispose();
                    lostHandles.Add(lostHandle);
                }
                glassesCores.Clear();
            }
            else
            {
                // Add newly connected glasses
                for (int i = 0; i < glassesCount; i++)
                {
                    incomingHandles.Add(glassesHandles[i]);
 
                    // If we don't already have a glassesCore for this handle,
                    // and we still have an available player slot, then create a glassesCore.
                    if (!glassesCores.ContainsKey(glassesHandles[i]) && !Player.AllSupportedPlayersConnected())
                    {
#if UNITY_2019_1_OR_NEWER && INPUTSYSTEM_AVAILABLE
                        glassesCores[glassesHandles[i]] = new GlassesDeviceCore(glassesHandles[i]);
#else
                        glassesCores[glassesHandles[i]] = new GlassesCore(glassesHandles[i]);
#endif
                    }
                }
 
                // Prune disconnected glasses
                foreach (var currentHandle in glassesCores.Keys)
                {
                    if (!incomingHandles.Contains(currentHandle))
                    {
                        lostHandles.Add(currentHandle);
                    }
                }
                foreach (var lostHandle in lostHandles)
                {
                    glassesCores[lostHandle].Dispose();
                    glassesCores.Remove(lostHandle);
                }
            }
 
            // If we don't have a default glasses ID yet, assign the first one we got from the native plugin as the default.
            if (!Instance.defaultGlassesHandle.HasValue && result == 0 && glassesCount > 0)
            {
                Instance.defaultGlassesHandle = glassesHandles[0];
            }
 
            // If defaultGlassesId isn't valid anymore, reset its value.
            if (Instance.defaultGlassesHandle.HasValue && !glassesCores.ContainsKey(Instance.defaultGlassesHandle.Value))
            {
                Instance.defaultGlassesHandle = null;
            }
        }

References TiltFive.NativePlugin.GetGlassesHandles(), and TiltFive.NativePlugin.RefreshGlassesAvailable().

◆ TryGetFriendlyName()

static bool TiltFive.Glasses.TryGetFriendlyName	(	PlayerIndex	playerIndex,
		out string	friendlyName
	)

static

Definition at line 250 of file Glasses.cs.

        {
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                friendlyName = null;
                return false;
            }
 
            return TryGetFriendlyName(glassesHandle, out friendlyName);
        }

References TiltFive.Glasses.TryGetFriendlyName().

Referenced by TiltFive.Glasses.TryGetFriendlyName(), and TiltFive.Wand.WandCore.WandCore().

◆ TryGetPose()

static bool TiltFive.Glasses.TryGetPose	(	PlayerIndex	playerIndex,
		out Pose	pose
	)

static

Attempts to get the position and orientation of the specified player's glasses.

Parameters

playerIndex
pose

Returns: Returns false along with an empty pose if something goes wrong.

Definition at line 267 of file Glasses.cs.

        {
            if(Player.TryGetGlassesHandle(playerIndex, out var glassesHandle) && Instance.glassesCores.TryGetValue(glassesHandle, out var glassesCore))
            {
                pose = glassesCore.Pose_UnityWorldSpace;
                return true;
            }
            pose = new Pose();
            return false;
        }

References TiltFive.Singleton< Glasses >.Instance.

◆ TryGetPreviewPose()

static bool TiltFive.Glasses.TryGetPreviewPose	(	PlayerIndex	playerIndex,
		out Pose	pose
	)

static

Attempts to get the position and orientation of the specified player's glasses, smoothed for on-screen preview.

Parameters

playerIndex
pose

Returns: Returns false along with an empty pose if something goes wrong.

Definition at line 285 of file Glasses.cs.

        {
            if (Player.TryGetGlassesHandle(playerIndex, out var glassesHandle) && Instance.glassesCores.TryGetValue(glassesHandle, out var glassesCore))
            {
                pose = glassesCore.previewCore.Pose_UnityWorldSpace;
                return true;
            }
            pose = new Pose();
            return false;
        }

References TiltFive.Singleton< Glasses >.Instance.

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

◆ TryGetSpectatorSettings()

static bool TiltFive.Glasses.TryGetSpectatorSettings ( out SpectatorSettings spectatorSettings )

staticprivate

Definition at line 552 of file Glasses.cs.

        {
            if (TiltFiveSingletonHelper.TryGetISceneInfo(out var sceneInfo))
            {
                if (sceneInfo is TiltFiveManager2 tiltFiveManager2)
                {
                    spectatorSettings = tiltFiveManager2.spectatorSettings;
                    return true;
                }
 
                if (sceneInfo is TiltFiveManager tiltFiveManager)
                {
                    spectatorSettings = tiltFiveManager.spectatorSettings;
                    return true;
                }
            }
 
            spectatorSettings = null;
            return false;
        }

References TiltFive.TiltFiveSingletonHelper.TryGetISceneInfo().

Referenced by TiltFive.Glasses.Reset(), TiltFive.Glasses.Update(), and TiltFive.Glasses.Validate().

◆ Update()

static void TiltFive.Glasses.Update	(	GlassesSettings	glassesSettings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameBoardSettings
	)

static

Updates this T:TiltFive.Glasses.

Parameters

glassesSettings Glasses settings for the update.

Definition at line 201 of file Glasses.cs.

        {
            if(!TryGetSpectatorSettings(out var spectatorSettings))
            {
                return;
            }
 
            // Update the glasses cores
            foreach (var glassesCore in Instance.glassesCores.Values)
            {
                glassesCore.Update(glassesSettings, scaleSettings, gameBoardSettings, spectatorSettings);
            }
        }

References TiltFive.Singleton< Glasses >.Instance, and TiltFive.Glasses.TryGetSpectatorSettings().

Referenced by TiltFive.TiltFiveManager.GetLatestPoseData(), and TiltFive.Player.PlayerCore.GetLatestPoseData().

◆ Validate()

static bool TiltFive.Glasses.Validate	(	GlassesSettings	glassesSettings,
		SpectatorSettings	spectatorSettings = `null`,
		PlayerIndex	playerIndex = `PlayerIndex::One`
	)

static

Validates the specified glassesSettings with the specified glasses core.

Returns: true, if the glasses core is valid with the given settings, false otherwise.

Parameters

glassesSettings	Glasses settings.
playerIndex	The specified glasses to validate. If None is provided, this uses the default glasses.

Definition at line 182 of file Glasses.cs.

        {
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                return false;
            }
 
            if(spectatorSettings == null && !TryGetSpectatorSettings(out spectatorSettings))
            {
                return false;
            }
 
            return Validate(glassesSettings, spectatorSettings, glassesHandle);
        }

References TiltFive.Glasses.TryGetSpectatorSettings(), and TiltFive.Glasses.Validate().

Referenced by TiltFive.Glasses.Validate().

Member Data Documentation

◆ defaultGlassesHandle

GlassesHandle? TiltFive.Glasses.defaultGlassesHandle

private

The identifier for the first detected pair of glasses.

Definition at line 49 of file Glasses.cs.

◆ glassesCores

Dictionary<GlassesHandle, GlassesCore> TiltFive.Glasses.glassesCores = new Dictionary<GlassesHandle, GlassesCore>()

private

The glasses core runtimes.

Definition at line 41 of file Glasses.cs.

◆ incomingHandles

HashSet<GlassesHandle> TiltFive.Glasses.incomingHandles = new HashSet<GlassesHandle>()

private

Definition at line 43 of file Glasses.cs.

◆ lostHandles

HashSet<GlassesHandle> TiltFive.Glasses.lostHandles = new HashSet<GlassesHandle>()

private

Definition at line 44 of file Glasses.cs.

Property Documentation

◆ configured

bool TiltFive.Glasses.configured

staticget

Gets a value indicating whether this T:TiltFive.Glasses is configured.

true if player 1's glasses are connected and they've been configured; otherwise, false.

Definition at line 79 of file Glasses.cs.

◆ forward

Vector3 TiltFive.Glasses.forward

staticget

Gets the head orientation's forward vector.

The forward vector of player 1's glasses (if connected, otherwise the default forward vector)

Definition at line 94 of file Glasses.cs.

◆ glassesAvailable

bool TiltFive.Glasses.glassesAvailable

staticgetprivate set

Indicates whether the glasses are plugged in and functioning.

Definition at line 120 of file Glasses.cs.

120{ get; private set; }

◆ leftEyePosition

Vector3 TiltFive.Glasses.leftEyePosition

staticget

Gets the left eye position.

The left eye position of player 1's glasses (if connected, otherwise the zero vector)

Definition at line 110 of file Glasses.cs.

◆ position

Vector3 TiltFive.Glasses.position

staticget

Gets the head pose position.

The position of player 1's glasses (if connected, otherwise a zero vector)

Definition at line 84 of file Glasses.cs.

◆ right

Vector3 TiltFive.Glasses.right

staticget

Gets the head orientation's right vector.

The right vector of player 1's glasses (if connected, otherwise the default right vector)

Definition at line 99 of file Glasses.cs.

◆ rightEyePosition

Vector3 TiltFive.Glasses.rightEyePosition

staticget

Gets the right eye position.

The right eye position of player 1's glasses (if connected, otherwise the zero vector)

Definition at line 115 of file Glasses.cs.

◆ rotation

Quaternion TiltFive.Glasses.rotation

staticget

Gets the head pose rotation.

The rotation of player 1's glasses (if connected, otherwise the identity quaternion)

Definition at line 89 of file Glasses.cs.

◆ up

Vector3 TiltFive.Glasses.up

staticget

Gets the head orientation's up vector.

The up vector of player 1's glasses (if connected, otherwise the default up vector)

Definition at line 104 of file Glasses.cs.

◆ updated

bool TiltFive.Glasses.updated

staticget

Gets a value indicating whether this T:TiltFive.Glasses is updated.

true if player 1's glasses are connected and their glasses pose has been updated; otherwise, false.

Definition at line 73 of file Glasses.cs.

Referenced by TiltFive.SplitStereoCamera.SyncTransform().

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

Glasses.cs

Classes

Public Types

Static Public Member Functions

Properties

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AREyes

Member Function Documentation

◆ GetLeftEye() [1/2]

◆ GetLeftEye() [2/2]

◆ GetPlayerOneGlassesCore()

◆ GetPoseRoot() [1/2]

◆ GetPoseRoot() [2/2]

◆ GetRightEye() [1/2]

◆ GetRightEye() [2/2]

◆ headPoseUpdated()

◆ IsConnected()

◆ IsTracked()

◆ Reset()

◆ ScanForGlasses()

◆ TryGetFriendlyName()

◆ TryGetPose()

◆ TryGetPreviewPose()

◆ TryGetSpectatorSettings()

◆ Update()

◆ Validate()

Member Data Documentation

◆ defaultGlassesHandle

◆ glassesCores

◆ incomingHandles

◆ lostHandles

Property Documentation

◆ configured

◆ forward

◆ glassesAvailable

◆ leftEyePosition

◆ position

◆ right

◆ rightEyePosition

◆ rotation

◆ up

◆ updated