TiltFive.Glasses.BaseGlassesCore Class Reference

Inheritance diagram for TiltFive.Glasses.BaseGlassesCore:

Public Member Functions
	BaseGlassesCore (GlassesHandle glassesHandle, T5_GlassesPoseUsage glassesPoseUsage, string name)
virtual void	Dispose ()

Public Attributes
GlassesHandle	glassesHandle
GameObject	headPoseRoot

Protected Member Functions
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
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 Member Functions
Pose	GetPoseGameboardSpace (T5_GlassesPose glassesPose)

Private Attributes
T5_GlassesPoseUsage	glassesPoseUsage
readonly Vector3	DEFAULT_GLASSES_POSITION_GAME_BOARD_SPACE = new Vector3(0f, 0.5f, -0.5f)
	The default position of the glasses relative to the board.
readonly Quaternion	DEFAULT_GLASSES_ROTATION_GAME_BOARD_SPACE = Quaternion.Euler(new Vector3(-45f, 0f, 0f))
	The default rotation of the glasses relative to the board.

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

Definition at line 575 of file Glasses.cs.

Constructor & Destructor Documentation

BaseGlassesCore()

TiltFive.Glasses.BaseGlassesCore.BaseGlassesCore	(	GlassesHandle	glassesHandle,
		T5_GlassesPoseUsage	glassesPoseUsage,
		string	name
	)

Definition at line 602 of file Glasses.cs.

            {
                this.glassesHandle = glassesHandle;
                this.glassesPoseUsage = glassesPoseUsage;
                headPoseRoot = new GameObject(name);
            }

Member Function Documentation

Dispose()

virtual void TiltFive.Glasses.BaseGlassesCore.Dispose ( )

virtual

Reimplemented in TiltFive.Glasses.GlassesCore.

Definition at line 612 of file Glasses.cs.

            {
                GameObject.Destroy(headPoseRoot);
            }

Referenced by TiltFive.Glasses.GlassesCore.Dispose().

GetPoseGameboardSpace()

Pose TiltFive.Glasses.BaseGlassesCore.GetPoseGameboardSpace ( T5_GlassesPose  glassesPose )

private

Definition at line 759 of file Glasses.cs.

            {
                // Unity reference frames:
                //
                // UGLS        - Unity GLaSses local space.
                //               +x right, +y up, +z forward
                // UGBD        - Unity Gameboard space.
                //               +x right, +y up, +z forward
                //
                // Tilt Five reference frames:
                //
                // DC          - Our right-handed version of Unity's default camera space.
                //               +x right, +y up, +z backward
                // GBD         - Gameboard space.
                //               +x right, +y forward, +z up
 
                Quaternion rotToDC_GBD = Quaternion.AngleAxis((-Mathf.PI / 2f) * Mathf.Rad2Deg, Vector3.right);
 
                Quaternion rotToGBD_DC = Quaternion.Inverse(rotToDC_GBD);
 
                Quaternion rotToGLS_GBD = glassesPose.RotationToGLS_GBD;
 
                Quaternion rotToGLS_DC = rotToGLS_GBD * rotToGBD_DC;
 
                Quaternion rotToUGBD_UGLS = new Quaternion(rotToGLS_DC.x, rotToGLS_DC.y, -rotToGLS_DC.z, rotToGLS_DC.w);
 
                // Swap from right-handed (T5 internal) to left-handed (Unity) coord space.
                Vector3 posOfUGLS_UGBD = ConvertPosGBDToUGBD(glassesPose.PosOfGLS_GBD);
 
                return new Pose(posOfUGLS_UGBD, rotToUGBD_UGLS);
            }

References TiltFive.T5_GlassesPose.PosOfGLS_GBD, and TiltFive.T5_GlassesPose.RotationToGLS_GBD.

SetDefaultPoseGameboardSpace()

override void TiltFive.Glasses.BaseGlassesCore.SetDefaultPoseGameboardSpace ( GlassesSettings  settings )

protected

Definition at line 632 of file Glasses.cs.

            {
                pose_UGBD = new Pose(
                    DEFAULT_GLASSES_POSITION_GAME_BOARD_SPACE,
                    DEFAULT_GLASSES_ROTATION_GAME_BOARD_SPACE);
            }

SetDrivenObjectTransform()

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

protected

Definition at line 724 of file Glasses.cs.

            {
                if (!isTracked && settings.RejectUntrackedPositionData)
                {
                    switch (settings.FailureMode)
                    {
                        case TrackableSettings.TrackingFailureMode.FreezePosition:
                            headPose.SetPositionAndRotation(headPose.position, pose_UWRLD.rotation);
                            break;
                        // If we want to freeze both position and rotation when tracking is lost, things are easy - just do nothing.
                        case TrackableSettings.TrackingFailureMode.FreezePositionAndRotation:
                            break;
                        // Otherwise, we may want to keep the legacy behavior of snapping to a default position when tracking is lost.
                        case TrackableSettings.TrackingFailureMode.SnapToDefault:
                            // TODO: Rethink the existence of the preview pose? Is that a separate tracking failure mode?
                            if (settings.usePreviewPose)
                            {
                                headPose.SetPositionAndRotation(
                                    settings.previewPose.position,
                                    settings.previewPose.rotation);
                            }
                            // Otherwise do nothing and let the developer control the head pose camera themselves.
                            // It will be up to them to let go once head tracking kicks in again.
                            break;
                    }
                }
                else    // Either things are working well and we're tracked, or we don't care about invalid data and want to display it regardless.
                {
                    headPose.SetPositionAndRotation(pose_UWRLD.position, pose_UWRLD.rotation);
                }
            }

References TiltFive.TrackableSettings.FailureMode, TiltFive.GlassesSettings.previewPose, TiltFive.TrackableSettings.RejectUntrackedPositionData, and TiltFive.GlassesSettings.usePreviewPose.

SetInvalidPoseGameboardSpace()

override void TiltFive.Glasses.BaseGlassesCore.SetInvalidPoseGameboardSpace ( in T5_GlassesPose  glassesPose, GlassesSettings  settings, ScaleSettings  scaleSettings, GameBoardSettings  gameboardSettings  )

protected

Definition at line 687 of file Glasses.cs.

            {
                var newPose_GameboardSpace = GetPoseGameboardSpace(glassesPose);
 
                if (!isTracked && settings.RejectUntrackedPositionData)
                {
                    switch (settings.FailureMode)
                    {
                        case TrackableSettings.TrackingFailureMode.FreezePosition:
                            pose_UGBD = new Pose(pose_UGBD.position, newPose_GameboardSpace.rotation);
                            break;
                        // If we want to freeze both position and rotation when tracking is lost, things are easy - just do nothing.
                        case TrackableSettings.TrackingFailureMode.FreezePositionAndRotation:
                            break;
                        // Otherwise, we may want to keep the legacy behavior of snapping to a default position when tracking is lost.
                        case TrackableSettings.TrackingFailureMode.SnapToDefault:
                            // TODO: Rethink the existence of the preview pose? Is that a separate tracking failure mode?
                            if (settings.usePreviewPose)
                            {
                                pose_UGBD = new Pose(WorldToGameboardSpace(settings.previewPose.position, scaleSettings, gameboardSettings),
                                    WorldToGameboardSpace(settings.previewPose.rotation, gameboardSettings));
                            }
                            // Otherwise do nothing and let the developer control the head pose camera themselves.
                            // It will be up to them to let go once head tracking kicks in again.
                            break;
                    }
                }
                else    // Either things are working well and we're tracked, or we don't care about invalid data and want to display it regardless.
                {
                    pose_UGBD = newPose_GameboardSpace;
                }
            }

References TiltFive.TrackableSettings.FailureMode, TiltFive.GlassesSettings.previewPose, TiltFive.TrackableSettings.RejectUntrackedPositionData, and TiltFive.GlassesSettings.usePreviewPose.

SetPoseGameboardSpace()

override void TiltFive.Glasses.BaseGlassesCore.SetPoseGameboardSpace ( in T5_GlassesPose  glassesPose, GlassesSettings  glassesSettings, ScaleSettings  scaleSettings, GameBoardSettings  gameboardSettings  )

protected

Definition at line 678 of file Glasses.cs.

            {
                pose_UGBD = GetPoseGameboardSpace(glassesPose);
            }

SetPoseUnityWorldSpace()

override void TiltFive.Glasses.BaseGlassesCore.SetPoseUnityWorldSpace ( ScaleSettings  scaleSettings, GameBoardSettings  gameboardSettings  )

protectedvirtual

Sets the pose values of the tracked object in Unity World Space.

Parameters

scaleSettings
gameboardSettings

Implements TiltFive.TrackableCore< GlassesSettings, T5_GlassesPose >.

Definition at line 639 of file Glasses.cs.

            {
                pose_UWRLD = GameboardToWorldSpace(pose_UGBD, scaleSettings, gameBoardSettings);
            }

TryCheckConnected()

override bool TiltFive.Glasses.BaseGlassesCore.TryCheckConnected ( out bool  connected )

protectedvirtual

Determines whether the tracked object is still connected.

Parameters

connected

Returns

Implements TiltFive.TrackableCore< GlassesSettings, T5_GlassesPose >.

Definition at line 646 of file Glasses.cs.

            {
                connected = IsConnected(glassesHandle);
                return connected;
            }

TryGetStateFromPlugin()

override bool TiltFive.Glasses.BaseGlassesCore.TryGetStateFromPlugin ( out T5_GlassesPose  glassesPose, out bool  poseIsValid, GameBoardSettings  gameBoardSettings  )

protected

Definition at line 652 of file Glasses.cs.

            {
                T5_GlassesPose glassesPoseResult = new T5_GlassesPose { };
 
                int result = 1;
                try
                {
                    result = NativePlugin.GetGlassesPose(
                        glassesHandle,
                        ref glassesPoseResult,
                        glassesPoseUsage);
                }
                catch (System.Exception e)
                {
                    Log.Error(e.Message);
                }
 
                GameBoard.SetGameboardType(glassesHandle, glassesPoseResult.GameboardType);
                poseIsValid = result == 0 && glassesPoseResult.GameboardType != GameboardType.GameboardType_None;
                glassesPose = glassesPoseResult;
                return result == 0;
            }

References TiltFive.Logging.Log.Error(), TiltFive.T5_GlassesPose.GameboardType, and TiltFive.NativePlugin.GetGlassesPose().

Update()

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

protected

Updates this T:TiltFive.Glasses.BaseGlassesCore

Parameters

glassesSettings	Glasses settings for the update.
scaleSettings	Scale settings for the update.
gameBoardSettings	Gameboard settings for the update.

Definition at line 623 of file Glasses.cs.

            {
                // Obtain the latest glasses pose.
                base.Update(glassesSettings, scaleSettings, gameBoardSettings);
            }

Member Data Documentation

DEFAULT_GLASSES_POSITION_GAME_BOARD_SPACE

readonly Vector3 TiltFive.Glasses.BaseGlassesCore.DEFAULT_GLASSES_POSITION_GAME_BOARD_SPACE = new Vector3(0f, 0.5f, -0.5f)

private

The default position of the glasses relative to the board.

The glasses camera will snap back to this position if the glasses are unavailable. If different behavior is desired in this scenario, a different camera should be used.

Definition at line 591 of file Glasses.cs.

DEFAULT_GLASSES_ROTATION_GAME_BOARD_SPACE

readonly Quaternion TiltFive.Glasses.BaseGlassesCore.DEFAULT_GLASSES_ROTATION_GAME_BOARD_SPACE = Quaternion.Euler(new Vector3(-45f, 0f, 0f))

private

The default rotation of the glasses relative to the board.

The glasses camera will snap back to this rotation if the glasses are unavailable. If different behavior is desired in this scenario, a different camera should be used.

Definition at line 600 of file Glasses.cs.

glassesHandle

GlassesHandle TiltFive.Glasses.BaseGlassesCore.glassesHandle

Definition at line 577 of file Glasses.cs.

glassesPoseUsage

T5_GlassesPoseUsage TiltFive.Glasses.BaseGlassesCore.glassesPoseUsage

private

Definition at line 582 of file Glasses.cs.

headPoseRoot

GameObject TiltFive.Glasses.BaseGlassesCore.headPoseRoot

Definition at line 579 of file Glasses.cs.

Property Documentation

headPose

Transform TiltFive.Glasses.BaseGlassesCore.headPose

get

Definition at line 580 of file Glasses.cs.

---

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

• Glasses.cs