Internal Glasses core runtime. More...

Inheritance diagram for TiltFive.Glasses.GlassesCore:

Public Member Functions
	GlassesCore (GlassesHandle glassesHandle)

override void	Dispose ()

void	Reset (GlassesSettings glassesSettings, SpectatorSettings spectatorSettings)
	Reset this T:TiltFive.Glasses.GlassesCore

bool	Validate (GlassesSettings glassesSettings, SpectatorSettings spectatorSettings)
	Tests this T:TiltFive.Glasses.GlassesCore for validity with the parameterized T:TiltFive.Glasses.GlassesSettings

bool	TryGetFriendlyName (out string friendlyName)

virtual void	Update (GlassesSettings glassesSettings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings, SpectatorSettings spectatorSettings)
	Updates this T:TiltFive.Glasses.GlassesCore

Public Member Functions inherited from TiltFive.Glasses.BaseGlassesCore
	BaseGlassesCore (GlassesHandle glassesHandle, T5_GlassesPoseUsage glassesPoseUsage, string name)

virtual void	Dispose ()

Public Attributes
PlayerIndex	playerIndex

GameObject	baseObject

string	friendlyName

bool	configured = false
	Configuration ready indicator.

Dictionary< AREyes, Vector3 >	eyePositions

Dictionary< AREyes, Quaternion >	eyeRotations

GlassesPreviewCore	previewCore

Public Attributes inherited from TiltFive.Glasses.BaseGlassesCore
GlassesHandle	glassesHandle

GameObject	headPoseRoot

Protected Member Functions
override void	SetDrivenObjectTransform (GlassesSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings)

Protected Member Functions inherited from TiltFive.Glasses.BaseGlassesCore
override void	Update (GlassesSettings glassesSettings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings)
	Updates this T:TiltFive.Glasses.BaseGlassesCore

override void	SetDefaultPoseGameboardSpace (GlassesSettings settings)

override void	SetPoseUnityWorldSpace (ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings)
	Sets the pose values of the tracked object in Unity World Space.

override bool	TryCheckConnected (out bool connected)
	Determines whether the tracked object is still connected.

override bool	TryGetStateFromPlugin (out T5_GlassesPose glassesPose, out bool poseIsValid, GameBoardSettings gameBoardSettings)

override void	SetPoseGameboardSpace (in T5_GlassesPose glassesPose, GlassesSettings glassesSettings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

override void	SetInvalidPoseGameboardSpace (in T5_GlassesPose glassesPose, GlassesSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

override void	SetDrivenObjectTransform (GlassesSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings)

Protected Member Functions inherited from TiltFive.TrackableCore< GlassesSettings, T5_GlassesPose >
void	Reset (TSettings settings)

virtual void	Update (TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

abstract void	SetDefaultPoseGameboardSpace (TSettings settings)
	Gets the default pose of the tracked object.

abstract void	SetPoseGameboardSpace (in TState state, TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
	Sets the pose values of the tracked object in Unity World Space.

abstract void	SetInvalidPoseGameboardSpace (in TState state, TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
	Sets the pose values of the tracked object in Unity World Space when we already know the pose is invalid.

abstract void	SetPoseUnityWorldSpace (ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
	Sets the pose values of the tracked object in Unity World Space.

abstract bool	TryCheckConnected (out bool connected)
	Determines whether the tracked object is still connected.

abstract bool	TryGetStateFromPlugin (out TState state, out bool poseIsValid, GameBoardSettings gameboardSettings)
	Gets the latest pose for the tracked object from the native plugin.

abstract void	SetDrivenObjectTransform (TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
	Sets the pose of the object(s) being driven by TrackableCore.

Properties
bool	TrackingUpdated = false `[get, private set]`
	Gets a value indicating whether this T:TiltFive.Glasses.GlassesCore tracking was successfully updated.

Properties inherited from TiltFive.Glasses.BaseGlassesCore
Transform	headPose `[get]`

Properties inherited from TiltFive.TrackableCore< GlassesSettings, T5_GlassesPose >
Pose	Pose_GameboardSpace `[get]`
	The pose of the trackable w.r.t. the gameboard reference frame.

Pose	Pose_UnityWorldSpace `[get]`
	The Pose of the trackable in Unity world space.

bool	IsTracked `[get]`
	Whether or not the trackable is being tracked.

bool	IsConnected `[get]`
	Whether or not the trackable is connected.

Private Attributes
SplitStereoCamera	splitStereoCamera = null
	The split stereo camera implementation used in lieu of XRSettings.

Additional Inherited Members
Static Protected Member Functions inherited from TiltFive.TrackableCore< GlassesSettings, T5_GlassesPose >
static Vector3	ConvertPosGBDToUGBD (Vector3 pos_GBD)

static Pose	GameboardToWorldSpace (Pose pose_GameboardSpace, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

static Vector3	GameboardToWorldSpace (Vector3 pos_UGBD, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

static Quaternion	GameboardToWorldSpace (Quaternion rotToUGBD_OBJ, GameBoardSettings gameboardSettings)

static Vector3	WorldToGameboardSpace (Vector3 pos_UWRLD, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

static Quaternion	WorldToGameboardSpace (Quaternion rotToUWRLD_OBJ, GameBoardSettings gameboardSettings)

Protected Attributes inherited from TiltFive.TrackableCore< GlassesSettings, T5_GlassesPose >
Pose	pose_UGBD

Pose	pose_UWRLD

bool	isTracked

bool	isConnected

Pose	gameboardPos_UWRLD
	The pose of the gameboard reference frame w.r.t. the Unity world-space reference frame.

Detailed Description

Internal Glasses core runtime.

Definition at line 824 of file Glasses.cs.

Constructor & Destructor Documentation

◆ GlassesCore()

TiltFive.Glasses.GlassesCore.GlassesCore ( GlassesHandle glassesHandle )

Definition at line 849 of file Glasses.cs.

                                                            :
                base(glassesHandle, T5_GlassesPoseUsage.GlassesPresentation, $"Glasses {glassesHandle}")
            {
                if(!Player.TryGetPlayerIndex(glassesHandle, out playerIndex))
                {
                    Player.TryAddPlayer(glassesHandle, out playerIndex);
                }
                previewCore = new GlassesPreviewCore(glassesHandle);
                CameraImage.Initialize(glassesHandle);
 
                Log.Info($"Glasses {glassesHandle} connected.");
            }

References TiltFive.Logging.Log.Info().

Member Function Documentation

◆ Dispose()

override void TiltFive.Glasses.GlassesCore.Dispose ( )

virtual

Reimplemented from TiltFive.Glasses.BaseGlassesCore.

Definition at line 862 of file Glasses.cs.

            {
                GameObject.Destroy(splitStereoCamera);
                GameObject.Destroy(baseObject);
                CameraImage.RemoveCore(glassesHandle);
                previewCore.Dispose();
 
                base.Dispose();
 
                Log.Info($"Glasses {glassesHandle} (\"{friendlyName}\") disconnected");
            }

References TiltFive.Glasses.BaseGlassesCore.Dispose(), and TiltFive.Logging.Log.Info().

◆ Reset()

void TiltFive.Glasses.GlassesCore.Reset	(	GlassesSettings	glassesSettings,
		SpectatorSettings	spectatorSettings
	)

Reset this T:TiltFive.Glasses.GlassesCore

Parameters

glassesSettings	Glasses settings for configuring the instance.
spectatorSettings	Spectator settings for configuring the instance.

Definition at line 893 of file Glasses.cs.

            {
                base.Reset(glassesSettings);
 
                configured = false;
 
                if(null == spectatorSettings.spectatorCamera)
                {
                    Log.Error($"Required Camera assignment missing from { spectatorSettings.GetType() }.  Check Spectator settings in Tilt Five Manager");
                    return;
                }
 
#if UNITY_EDITOR
                if (glassesSettings.tiltFiveXR)
                {
#endif
                    //if the splitScreenCamera does not exist already.
                    if (null == splitStereoCamera)
                    {
                        //get the head pose camera's GameObject
                        GameObject spectatorCameraObject = spectatorSettings.spectatorCamera.gameObject;
 
                        // Initialize the SplitStereoCamera
                        splitStereoCamera = spectatorCameraObject.AddComponent<SplitStereoCamera>();
                        if (null == headPoseRoot)
                        {
 
                            headPoseRoot = new GameObject($"Glasses {glassesHandle}");
                            previewCore = new GlassesPreviewCore(glassesHandle);
                        }
                        if (glassesSettings.objectTemplate && null == baseObject)
                        {
                            baseObject = GameObject.Instantiate(glassesSettings.objectTemplate);
                            baseObject.transform.parent = headPoseRoot.transform;
                            baseObject.name = $"{baseObject.transform.parent.name} - Prefab {playerIndex}";
 
#if UNITY_2019_1_OR_NEWER && INPUTSYSTEM_AVAILABLE
                            // If the provided prefab includes a playerInput, we assume the developer
                            // is trying to use the input system to manage/enumerate their players.
                            // Warn the developer that they should include a PlayerInputManager
                            // if there isn't one already.
                            var playerInput = baseObject.GetComponentInChildren<PlayerInput>();
                            var playerInputManager = GameObject.FindObjectOfType<PlayerInputManager>();
                            if (playerInput != null && playerInputManager == null)
                            {
                                Log.Warn("No PlayerInputManager detected. " +
                                    "Add a PlayerInputManager to the scene to enable the Input System " +
                                    "to enumerate players as T5 devices connect/disconnect.");
                            }
 
                            if (playerInput != null && playerInput.actions != null && playerInput.actions.controlSchemes.Count < 1)
                            {
                                // Control Schemes appear to be very important when creating an InputUser.
                                // This isn't well-documented, but this can be a problem when working with a brand new empty Action Map.
                                // If the action map doesn't include any defined schemes, User #1 (the second user)
                                // will not be created in the Input System, and it isn't an obvious thing to debug.
                                // Warn the developer if the action map they provide doesn't have any schemes defined yet.
                                Log.Warn("The prefab provided to TiltFiveManager2 appears to have a PlayerInput component " +
                                    "with an action map assigned, but the provided action map has no defined control schemes. " +
                                    "This may cause the input system to fail to create a new InputUser for players 2 and beyond. " +
                                    "Consider defining a control scheme in the provided action map.");
                            }
#endif
                        }
 
                        splitStereoCamera.Initialize(headPoseRoot, glassesSettings, spectatorSettings);
                    }
#if UNITY_EDITOR
                }
#endif //UNITY_EDITOR
 
                TryGetFriendlyName(out friendlyName);
 
                configured = true;
            }

References TiltFive.Logging.Log.Error(), TiltFive.SplitStereoCamera.Initialize(), TiltFive.GlassesSettings.objectTemplate, TiltFive.SpectatorSettings.spectatorCamera, and TiltFive.Logging.Log.Warn().

◆ SetDrivenObjectTransform()

override void TiltFive.Glasses.GlassesCore.SetDrivenObjectTransform	(	GlassesSettings	settings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameBoardSettings
	)

protected

Definition at line 1136 of file Glasses.cs.

            {
                base.SetDrivenObjectTransform(settings, scaleSettings, gameBoardSettings);
            }

◆ TryGetFriendlyName()

bool TiltFive.Glasses.GlassesCore.TryGetFriendlyName ( out string friendlyName )

Definition at line 986 of file Glasses.cs.

            {
                T5_StringUTF8 friendlyNameResult = "";
                int result = 1;
 
                try
                {
                    result = NativePlugin.GetGlassesFriendlyName(glassesHandle, ref friendlyNameResult);
                }
                catch (System.Exception e)
                {
                    Log.Error($"Error getting friendly name: {e.Message}");
                }
                finally
                {
                    friendlyName = (result == 0)
                    ? friendlyNameResult
                    : null;
 
                    // Unfortunately we can't use a "using" block for friendlyNameResult
                    // since "using" parameters are readonly, preventing us from passing it via "ref".
                    // We do the next best thing with try-finally and dispose of it here.
                    friendlyNameResult.Dispose();
                }
 
                return result == 0;
            }

References TiltFive.T5_StringUTF8.Dispose(), TiltFive.Logging.Log.Error(), and TiltFive.NativePlugin.GetGlassesFriendlyName().

◆ Update()

virtual void TiltFive.Glasses.GlassesCore.Update	(	GlassesSettings	glassesSettings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameBoardSettings,
		SpectatorSettings	spectatorSettings
	)

virtual

Updates this T:TiltFive.Glasses.GlassesCore

Parameters

glassesSettings Glasses settings for the update.

Definition at line 1018 of file Glasses.cs.

            {
                TrackingUpdated = false;
 
                if (null == glassesSettings)
                {
                    Log.Error("GlassesSettings configuration required for Glasses tracking Update.");
                    return;
                }
 
                if (null == splitStereoCamera)
                {
                    Log.Error($"Stereo camera(s) missing from Glasses {glassesHandle} - aborting Update.");
                    return;
                }
 
                if (glassesSettings.cameraTemplate != splitStereoCamera.cameraTemplate)
                {
                    Log.Warn("Found mismatched template Cameras in GlassesCore Update - should call Reset.");
                    return;
                }
 
                if (spectatorSettings != splitStereoCamera.spectatorSettings)
                {
                    Log.Warn("Found mismatched spectator settings in GlassesCore Update - should call Reset.");
                    return;
                }
 
                // Obtain the latest glasses poses.
                base.Update(glassesSettings, scaleSettings, gameBoardSettings);
                previewCore.Update(glassesSettings, scaleSettings, gameBoardSettings);
 
                // Check whether the glasses are plugged in and available.
                glassesAvailable = isConnected;
                splitStereoCamera.glassesHandle = glassesHandle;
                splitStereoCamera.enabled = glassesAvailable;
 
                // Sync settings with splitStereoCamera
                splitStereoCamera.glassesSettings = glassesSettings;
                splitStereoCamera.spectatorSettings = spectatorSettings;
 
                // Enable spectating for player specified in the spectator settings, if they're available.
                splitStereoCamera.UseSpectatorCamera = Player.IsConnected(spectatorSettings.spectatedPlayer)
                    && Player.TryGetGlassesHandle(spectatorSettings.spectatedPlayer, out var spectatorGlassesHandle)
                    && spectatorGlassesHandle == glassesHandle;
 
                // Get the glasses pose in Unity world-space.
                float scaleToUGBD_UWRLD = scaleSettings.physicalMetersPerWorldSpaceUnit * gameBoardSettings.gameBoardScale;
                float scaleToUWRLD_UGBD = scaleSettings.GetScaleToUWRLD_UGBD(gameBoardSettings.gameBoardScale);
 
                // Set the game board transform on the SplitStereoCamera.
                splitStereoCamera.posUGBD_UWRLD = gameboardPos_UWRLD.position;
                splitStereoCamera.rotToUGBD_UWRLD = gameboardPos_UWRLD.rotation;
                splitStereoCamera.scaleToUGBD_UWRLD = scaleToUGBD_UWRLD;
 
                // TODO: Revisit native XR support.
 
                // NOTE: We do this because "Mock HMD" in UNITY_2017_0_2_OR_NEWER
                // the fieldOfView is locked to 111.96 degrees (Vive emulation),
                // so setting custom projection matrices is broken. If Unity
                // opens the API to custom settings, we can go back to native XR
                // support.
 
                // Manual split screen 'new glasses' until the day Unity lets
                // me override their Mock HMD settings.
 
                // compute half ipd translation
                float ipd_UGBD = GlassesSettings.DEFAULT_IPD_UGBD;
                if(!Display.GetGlassesIPD(glassesHandle, ref ipd_UGBD) && glassesAvailable)
                {
                    Log.Error("Failed to obtain Glasses IPD");
                }
                float ipd_UWRLD = scaleToUWRLD_UGBD * ipd_UGBD;
                Vector3 eyeOffset = (headPose.right.normalized * (ipd_UWRLD * 0.5f));
 
                // set the left eye camera offset from the head by the half ipd amount (-)
                eyePositions[AREyes.EYE_LEFT] = headPose.position - eyeOffset;
                eyeRotations[AREyes.EYE_LEFT] = headPose.rotation;
 
                // set the right eye camera offset from the head by the half ipd amount (+)
                eyePositions[AREyes.EYE_RIGHT] = headPose.position + eyeOffset;
                eyeRotations[AREyes.EYE_RIGHT] = headPose.rotation;
 
                Camera leftEyeCamera = splitStereoCamera.leftEyeCamera;
                if (null != leftEyeCamera)
                {
                    GameObject leftEye = leftEyeCamera.gameObject;
                    leftEye.transform.position = eyePositions[AREyes.EYE_LEFT];
                    leftEye.transform.rotation = eyeRotations[AREyes.EYE_LEFT];
 
                    //make sure projection fields are synchronized to the head camera.
                    leftEyeCamera.nearClipPlane = glassesSettings.nearClipPlane / scaleToUGBD_UWRLD;
                    leftEyeCamera.farClipPlane = glassesSettings.farClipPlane / scaleToUGBD_UWRLD;
                    leftEyeCamera.fieldOfView = glassesSettings.fieldOfView;
                    leftEyeCamera.cullingMask = glassesSettings.cullingMask;
                }
 
                Camera rightEyeCamera = splitStereoCamera.rightEyeCamera;
                if (null != rightEyeCamera)
                {
                    GameObject rightEye = rightEyeCamera.gameObject;
                    rightEye.transform.position = eyePositions[AREyes.EYE_RIGHT];
                    rightEye.transform.rotation = eyeRotations[AREyes.EYE_RIGHT];
 
                    //make sure projection fields are synchronized to the head camera.
                    rightEyeCamera.nearClipPlane = glassesSettings.nearClipPlane / scaleToUGBD_UWRLD;
                    rightEyeCamera.farClipPlane = glassesSettings.farClipPlane / scaleToUGBD_UWRLD;
                    rightEyeCamera.fieldOfView = glassesSettings.fieldOfView;
                    rightEyeCamera.cullingMask = glassesSettings.cullingMask;
                }
 
                // TODO: Poll less frequently by plumbing t5_hmdGetChangedParams up to Unity.
                if (!TryGetFriendlyName(out glassesSettings.friendlyName))
                {
                    glassesSettings.friendlyName = GlassesSettings.DEFAULT_FRIENDLY_NAME;
                }
            }

References TiltFive.SplitStereoCamera.cameraTemplate, TiltFive.GlassesSettings.cameraTemplate, TiltFive.GlassesSettings.cullingMask, TiltFive.GlassesSettings.DEFAULT_FRIENDLY_NAME, TiltFive.GlassesSettings.DEFAULT_IPD_UGBD, TiltFive.Logging.Log.Error(), TiltFive.GlassesSettings.fieldOfView, TiltFive.GlassesSettings.friendlyName, TiltFive.GameBoardSettings.gameBoardScale, TiltFive.Display.GetGlassesIPD(), TiltFive.ScaleSettings.GetScaleToUWRLD_UGBD(), TiltFive.Player.IsConnected(), TiltFive.SplitStereoCamera.leftEyeCamera, TiltFive.SplitStereoCamera.rightEyeCamera, TiltFive.SpectatorSettings.spectatedPlayer, TiltFive.Glasses.GlassesPreviewCore.Update(), and TiltFive.Logging.Log.Warn().

◆ Validate()

bool TiltFive.Glasses.GlassesCore.Validate	(	GlassesSettings	glassesSettings,
		SpectatorSettings	spectatorSettings
	)

Tests this T:TiltFive.Glasses.GlassesCore for validity with the parameterized T:TiltFive.Glasses.GlassesSettings

Returns: true, if valid, false otherwise.

Parameters

glassesSettings Glasses settings.

Definition at line 975 of file Glasses.cs.

            {
                bool valid = true;
 
                valid &= splitStereoCamera != null
                    && glassesSettings.cameraTemplate == splitStereoCamera.cameraTemplate
                    && spectatorSettings == splitStereoCamera.spectatorSettings;
 
                return valid;
            }

Member Data Documentation

◆ baseObject

GameObject TiltFive.Glasses.GlassesCore.baseObject

Definition at line 827 of file Glasses.cs.

◆ configured

bool TiltFive.Glasses.GlassesCore.configured = false

Configuration ready indicator.

Definition at line 833 of file Glasses.cs.

◆ eyePositions

Dictionary<AREyes, Vector3> TiltFive.Glasses.GlassesCore.eyePositions

Initial value:

= new Dictionary<AREyes, Vector3>()
            {
                { AREyes.EYE_LEFT, new Vector3() },
                { AREyes.EYE_RIGHT, new Vector3() }
            }

Definition at line 835 of file Glasses.cs.

◆ eyeRotations

Dictionary<AREyes, Quaternion> TiltFive.Glasses.GlassesCore.eyeRotations

Initial value:

= new Dictionary<AREyes, Quaternion>()
            {
                { AREyes.EYE_LEFT, new Quaternion() },
                { AREyes.EYE_RIGHT, new Quaternion() }
            }

Definition at line 841 of file Glasses.cs.

◆ friendlyName

string TiltFive.Glasses.GlassesCore.friendlyName

Definition at line 828 of file Glasses.cs.

◆ playerIndex

PlayerIndex TiltFive.Glasses.GlassesCore.playerIndex

Definition at line 826 of file Glasses.cs.

◆ previewCore

GlassesPreviewCore TiltFive.Glasses.GlassesCore.previewCore

Definition at line 847 of file Glasses.cs.

◆ splitStereoCamera

SplitStereoCamera TiltFive.Glasses.GlassesCore.splitStereoCamera = null

private

The split stereo camera implementation used in lieu of XRSettings.

Definition at line 883 of file Glasses.cs.

Property Documentation

◆ TrackingUpdated

bool TiltFive.Glasses.GlassesCore.TrackingUpdated = false

getprivate set

Gets a value indicating whether this T:TiltFive.Glasses.GlassesCore tracking was successfully updated.

true if tracking updated; otherwise, false.

Definition at line 878 of file Glasses.cs.

878{ get; private set; } = false;

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

Glasses.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GlassesCore()

Member Function Documentation

◆ Dispose()

◆ Reset()

◆ SetDrivenObjectTransform()

◆ TryGetFriendlyName()

◆ Update()

◆ Validate()

Member Data Documentation

◆ baseObject

◆ configured

◆ eyePositions

◆ eyeRotations

◆ friendlyName

◆ playerIndex

◆ previewCore

◆ splitStereoCamera

Property Documentation

◆ TrackingUpdated