Protected Member Functions
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.

Static Protected Member Functions
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 Vector3	WorldToGameboardSpace (Vector3 pos_UWRLD, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

static Quaternion	GameboardToWorldSpace (Quaternion rotToUGBD_OBJ, GameBoardSettings gameboardSettings)

static Quaternion	WorldToGameboardSpace (Quaternion rotToUWRLD_OBJ, GameBoardSettings gameboardSettings)

Protected Attributes
Pose	pose_UGBD

Pose	pose_UWRLD

bool	isTracked = false

bool	isConnected = false

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

Properties
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.

Detailed Description

Type Constraints

TSettings

:

TrackableSettings

Definition at line 22 of file TrackableCore.cs.

Member Function Documentation

◆ ConvertPosGBDToUGBD()

static Vector3 TiltFive.TrackableCore< TSettings, TState >.ConvertPosGBDToUGBD ( Vector3 pos_GBD )

staticprotected

Definition at line 99 of file TrackableCore.cs.

        {
            // Swap Y and Z to change between GBD and UGBD
            var pos_UGBD = new Vector3(pos_GBD.x, pos_GBD.z, pos_GBD.y);
            return pos_UGBD;
        }

◆ GameboardToWorldSpace() [1/3]

static Pose TiltFive.TrackableCore< TSettings, TState >.GameboardToWorldSpace	(	Pose	pose_GameboardSpace,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

staticprotected

Definition at line 106 of file TrackableCore.cs.

        {
            float scaleToUWRLD_UGBD = scaleSettings.GetScaleToUWRLD_UGBD(gameboardSettings.gameBoardScale);
 
            Vector3 pos_UWRLD = gameboardSettings.currentGameBoard.rotation *
                (scaleToUWRLD_UGBD * pose_GameboardSpace.position) + gameboardSettings.gameBoardCenter;
 
            Quaternion rotToUWRLD_OBJ = GameboardToWorldSpace(pose_GameboardSpace.rotation, gameboardSettings);
 
            return new Pose(pos_UWRLD, rotToUWRLD_OBJ);
        }

References TiltFive.GameBoardSettings.gameBoardCenter, TiltFive.GameBoardSettings.gameBoardScale, TiltFive.TrackableCore< TSettings, TState >.GameboardToWorldSpace(), and TiltFive.ScaleSettings.GetScaleToUWRLD_UGBD().

Referenced by TiltFive.TrackableCore< TSettings, TState >.GameboardToWorldSpace().

◆ GameboardToWorldSpace() [2/3]

static Quaternion TiltFive.TrackableCore< TSettings, TState >.GameboardToWorldSpace	(	Quaternion	rotToUGBD_OBJ,
		GameBoardSettings	gameboardSettings
	)

staticprotected

Definition at line 140 of file TrackableCore.cs.

        {
            var rotToUWRLD_UGBD = gameboardSettings.currentGameBoard.rotation;
            var rotToUWRLD_OBJ = rotToUWRLD_UGBD * rotToUGBD_OBJ;
 
            return rotToUWRLD_OBJ;
        }

References TiltFive.GameBoardSettings.currentGameBoard, and TiltFive.UniformScaleTransform.rotation.

◆ GameboardToWorldSpace() [3/3]

static Vector3 TiltFive.TrackableCore< TSettings, TState >.GameboardToWorldSpace	(	Vector3	pos_UGBD,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

staticprotected

Definition at line 119 of file TrackableCore.cs.

        {
            float scaleToUWRLD_UGBD = scaleSettings.GetScaleToUWRLD_UGBD(gameboardSettings.gameBoardScale);
 
            return gameboardSettings.currentGameBoard.rotation *
                (scaleToUWRLD_UGBD * pos_UGBD) + gameboardSettings.gameBoardCenter;
        }

References TiltFive.GameBoardSettings.gameBoardCenter, TiltFive.GameBoardSettings.gameBoardScale, and TiltFive.ScaleSettings.GetScaleToUWRLD_UGBD().

◆ Reset()

void TiltFive.TrackableCore< TSettings, TState >.Reset ( TSettings settings )

protected

Definition at line 61 of file TrackableCore.cs.

        {
            SetDefaultPoseGameboardSpace(settings);
            isTracked = false;
        }

References TiltFive.TrackableCore< TSettings, TState >.isTracked, and TiltFive.TrackableCore< TSettings, TState >.SetDefaultPoseGameboardSpace().

◆ SetDefaultPoseGameboardSpace()

abstract void TiltFive.TrackableCore< TSettings, TState >.SetDefaultPoseGameboardSpace ( TSettings settings )

protectedpure virtual

Gets the default pose of the tracked object.

Parameters

settings

Returns

Referenced by TiltFive.TrackableCore< TSettings, TState >.Reset().

◆ SetDrivenObjectTransform()

abstract void TiltFive.TrackableCore< TSettings, TState >.SetDrivenObjectTransform	(	TSettings	settings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

protectedpure virtual

Sets the pose of the object(s) being driven by TrackableCore.

Parameters

settings
scaleSettings
gameboardSettings

Referenced by TiltFive.TrackableCore< TSettings, TState >.Update().

◆ SetInvalidPoseGameboardSpace()

abstract void TiltFive.TrackableCore< TSettings, TState >.SetInvalidPoseGameboardSpace	(	in TState	state,
		TSettings	settings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

protectedpure virtual

Sets the pose values of the tracked object in Unity World Space when we already know the pose is invalid.

Parameters

state
settings
scaleSettings
gameboardSettings

Referenced by TiltFive.TrackableCore< TSettings, TState >.Update().

◆ SetPoseGameboardSpace()

abstract void TiltFive.TrackableCore< TSettings, TState >.SetPoseGameboardSpace	(	in TState	state,
		TSettings	settings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

protectedpure virtual

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

Parameters

state
settings
scaleSettings
gameboardSettings

Referenced by TiltFive.TrackableCore< TSettings, TState >.Update().

◆ SetPoseUnityWorldSpace()

abstract void TiltFive.TrackableCore< TSettings, TState >.SetPoseUnityWorldSpace	(	ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

protectedpure virtual

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

Parameters

scaleSettings
gameboardSettings

Implemented in TiltFive.Glasses.BaseGlassesCore, and TiltFive.Wand.WandCore.

Referenced by TiltFive.TrackableCore< TSettings, TState >.Update().

◆ TryCheckConnected()

abstract bool TiltFive.TrackableCore< TSettings, TState >.TryCheckConnected ( out bool connected )

protectedpure virtual

Determines whether the tracked object is still connected.

Parameters

connected

Returns

Implemented in TiltFive.Glasses.BaseGlassesCore, and TiltFive.Wand.WandCore.

Referenced by TiltFive.TrackableCore< TSettings, TState >.Update().

◆ TryGetStateFromPlugin()

abstract bool TiltFive.TrackableCore< TSettings, TState >.TryGetStateFromPlugin	(	out TState	state,
		out bool	poseIsValid,
		GameBoardSettings	gameboardSettings
	)

protectedpure virtual

Gets the latest pose for the tracked object from the native plugin.

Parameters

state
poseIsValid
gameboardSettings

Returns

Referenced by TiltFive.TrackableCore< TSettings, TState >.Update().

◆ Update()

virtual void TiltFive.TrackableCore< TSettings, TState >.Update	(	TSettings	settings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

protectedvirtual

Definition at line 68 of file TrackableCore.cs.

        {
            if(settings == null)
            {
                Log.Error("TrackableSettings configuration required for tracking updates.");
                return;
            }
 
            // Get the game board pose.
            gameboardPos_UWRLD = new Pose(gameboardSettings.gameBoardCenter,
                Quaternion.Inverse(gameboardSettings.currentGameBoard.rotation));
 
            var successfullyConnected = TryCheckConnected(out isConnected) && isConnected;
            var successfullyGotState = TryGetStateFromPlugin(out var state, out bool poseIsValid, gameboardSettings);
 
            if (successfullyConnected && successfullyGotState && poseIsValid)
            {
                isTracked = true;
                SetPoseGameboardSpace(state, settings, scaleSettings, gameboardSettings);
            }
            else
            {
                isTracked = false;
                SetInvalidPoseGameboardSpace(state, settings, scaleSettings, gameboardSettings);
            }
 
            SetPoseUnityWorldSpace(scaleSettings, gameboardSettings);
 
            SetDrivenObjectTransform(settings, scaleSettings, gameboardSettings);
        }

◆ WorldToGameboardSpace() [1/2]

static Quaternion TiltFive.TrackableCore< TSettings, TState >.WorldToGameboardSpace	(	Quaternion	rotToUWRLD_OBJ,
		GameBoardSettings	gameboardSettings
	)

staticprotected

Definition at line 148 of file TrackableCore.cs.

        {
            var rotToUWRLD_UGBD = gameboardSettings.currentGameBoard.rotation;
            var rotToUGBD_UWRLD = Quaternion.Inverse(rotToUWRLD_UGBD);
            var rotToUGBD_OBJ = rotToUGBD_UWRLD * rotToUWRLD_OBJ;
 
            return rotToUGBD_OBJ;
 
        }

References TiltFive.GameBoardSettings.currentGameBoard, and TiltFive.UniformScaleTransform.rotation.

◆ WorldToGameboardSpace() [2/2]

static Vector3 TiltFive.TrackableCore< TSettings, TState >.WorldToGameboardSpace	(	Vector3	pos_UWRLD,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

staticprotected

Definition at line 128 of file TrackableCore.cs.

        {
            float scaleToUWRLD_UGBD = scaleSettings.GetScaleToUWRLD_UGBD(gameboardSettings.gameBoardScale);
            var rotToUWRLD_UGBD = gameboardSettings.currentGameBoard.rotation;
            var pos_UGBD = pos_UWRLD - gameboardSettings.gameBoardCenter;
            pos_UGBD = Quaternion.Inverse(rotToUWRLD_UGBD) * pos_UGBD;
            pos_UGBD /= scaleToUWRLD_UGBD;
 
            return pos_UGBD;
        }

References TiltFive.GameBoardSettings.currentGameBoard, TiltFive.GameBoardSettings.gameBoardCenter, TiltFive.GameBoardSettings.gameBoardScale, TiltFive.ScaleSettings.GetScaleToUWRLD_UGBD(), and TiltFive.UniformScaleTransform.rotation.

Member Data Documentation

◆ gameboardPos_UWRLD

Pose TiltFive.TrackableCore< TSettings, TState >.gameboardPos_UWRLD

protected

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

Definition at line 54 of file TrackableCore.cs.

Referenced by TiltFive.TrackableCore< TSettings, TState >.Update().

◆ isConnected

bool TiltFive.TrackableCore< TSettings, TState >.isConnected = false

protected

Definition at line 48 of file TrackableCore.cs.

Referenced by TiltFive.TrackableCore< TSettings, TState >.Update().

◆ isTracked

bool TiltFive.TrackableCore< TSettings, TState >.isTracked = false

protected

Definition at line 42 of file TrackableCore.cs.

Referenced by TiltFive.TrackableCore< TSettings, TState >.Reset(), and TiltFive.TrackableCore< TSettings, TState >.Update().

◆ pose_UGBD

Pose TiltFive.TrackableCore< TSettings, TState >.pose_UGBD

protected

Definition at line 30 of file TrackableCore.cs.

◆ pose_UWRLD

Pose TiltFive.TrackableCore< TSettings, TState >.pose_UWRLD

protected

Definition at line 36 of file TrackableCore.cs.

Property Documentation

◆ IsConnected

bool TiltFive.TrackableCore< TSettings, TState >.IsConnected

get

Whether or not the trackable is connected.

Definition at line 47 of file TrackableCore.cs.

47{ get => isConnected; }

◆ IsTracked

bool TiltFive.TrackableCore< TSettings, TState >.IsTracked

get

Whether or not the trackable is being tracked.

Definition at line 41 of file TrackableCore.cs.

41{ get => isTracked; }

◆ Pose_GameboardSpace

Pose TiltFive.TrackableCore< TSettings, TState >.Pose_GameboardSpace

get

The pose of the trackable w.r.t. the gameboard reference frame.

Definition at line 29 of file TrackableCore.cs.

29{ get => pose_UGBD; }

TiltFive.TrackableCore.pose_UGBD

Pose pose_UGBD

Definition: TrackableCore.cs:30

◆ Pose_UnityWorldSpace

Pose TiltFive.TrackableCore< TSettings, TState >.Pose_UnityWorldSpace

get

The Pose of the trackable in Unity world space.

Definition at line 35 of file TrackableCore.cs.

35{ get => pose_UWRLD; }

TiltFive.TrackableCore.pose_UWRLD

Pose pose_UWRLD

Definition: TrackableCore.cs:36

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

TrackableCore.cs

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ ConvertPosGBDToUGBD()

◆ GameboardToWorldSpace() [1/3]

◆ GameboardToWorldSpace() [2/3]

◆ GameboardToWorldSpace() [3/3]

◆ Reset()

◆ SetDefaultPoseGameboardSpace()

◆ SetDrivenObjectTransform()

◆ SetInvalidPoseGameboardSpace()

◆ SetPoseGameboardSpace()

◆ SetPoseUnityWorldSpace()

◆ TryCheckConnected()

◆ TryGetStateFromPlugin()

◆ Update()

◆ WorldToGameboardSpace() [1/2]

◆ WorldToGameboardSpace() [2/2]

Member Data Documentation

◆ gameboardPos_UWRLD

◆ isConnected

◆ isTracked

◆ pose_UGBD

◆ pose_UWRLD

Property Documentation

◆ IsConnected

◆ IsTracked

◆ Pose_GameboardSpace

◆ Pose_UnityWorldSpace