TiltFive.GameBoard Class Reference

Represents the game board. More...

Inheritance diagram for TiltFive.GameBoard:

Classes
struct	GameboardDimensions
struct	GameboardExtents
	Represents the distances from the gameboard tracking origin to the borders of the gameboard's viewable area. More...

Public Types
enum class	Edge { Near , Far , Left , Right }
	Represents cardinal positions around the gameboard (i.e. the centers of the edges of the gameboard), relative to a user positioned at the near (default) edge. More...
enum class	Corner { FarLeft , FarRight , NearLeft , NearRight }
	Represents ordinal positions around the gameboard, relative to a user positioned at the near (default) edge. More...

Public Member Functions
bool	TransformPose (Vector3 positionInGameboardSpace, Quaternion rotationToGameboardSpace, PlayerIndex playerIndex, out Vector3 positionInWorldSpace, out Quaternion rotationToWorldSpace)
	Transforms the provided pose from gameboard space to world space. More...
bool	TransformPose (Pose poseInGameboardSpace, PlayerIndex playerIndex, out Pose poseInWorldSpace)
	Transforms the provided pose from gameboard space to world space. More...
bool	TransformPoint (Vector3 pointInGameboardSpace, PlayerIndex playerIndex, out Vector3 pointInWorldSpace)
	Transforms the provided position from gameboard space to world space. More...
bool	InverseTransformPose (Vector3 positionInWorldSpace, Quaternion rotationToWorldSpace, PlayerIndex playerIndex, out Vector3 positionInGameboardSpace, out Quaternion rotationToGameboardSpace)
	Transforms the provided pose from world space to gameboard space. More...
bool	InverseTransformPose (Pose poseInWorldSpace, PlayerIndex playerIndex, out Pose poseInGameboardSpace)
	Transforms the provided pose from world space to gameboard space. More...
bool	InverseTransformPoint (Vector3 pointInWorldSpace, PlayerIndex playerIndex, out Vector3 pointInGameboardSpace)
	Transforms the provided position from world space to gameboard space. More...
Public Member Functions inherited from TiltFive.UniformScaleTransform
void	Awake ()

Static Public Member Functions
static bool	TryGetGameboardType (out GameboardType gameboardType)
	Attempts to check the latest glasses pose for the current gameboard type, such as LE, XE, or none. More...
static bool	TryGetGameboardType (PlayerIndex playerIndex, out GameboardType gameboardType)
static bool	TryGetGameboardDimensions (GameboardType gameboardType, out GameboardDimensions gameboardDimensions)
	Attempts to obtain the physical dimensions for a particular gameboard type. More...
static bool	TryGetGameboardExtents (GameboardType gameboardType, out GameboardExtents gameboardExtents)
	Attempts to obtain the physical dimensions for a particular gameboard type. More...

Public Attributes
bool	ShowGizmo
	Shows the game board gizmo in the editor. More...
bool	ShowGrid
float	GridHeightOffset = 0f
bool	StickyHeightOffset = true
float	GizmoOpacity = 0.75f
	Sets the opacity of the game board gizmo in the editor. More...
GameboardType	GameboardType
	The gameboard configuration, such as LE, XE, or folded XE. More...

Static Private Attributes
static Dictionary< PlayerIndex, GameboardType >	playerGameboards = new Dictionary<PlayerIndex, GameboardType>()

Additional Inherited Members
Protected Member Functions inherited from TiltFive.UniformScaleTransform
void	UnifyScale ()
	Synchronizes the component values of the game object's local scale vector (e.g. [1,2,3] becomes [3,3,3]). More...
Properties inherited from TiltFive.UniformScaleTransform
float	localScale [get, set]
	The size of the object as a single float value, rather than a scale vector. More...
Vector3	position [get, set]
	The position vector for the associated transform. More...
Quaternion	rotation [get, set]
	The rotation vector for the associated transform. More...

Detailed Description

Represents the game board.

Definition at line 28 of file GameBoard.cs.

Member Enumeration Documentation

Corner

enum TiltFive.GameBoard.Corner

strong

Represents ordinal positions around the gameboard, relative to a user positioned at the near (default) edge.

Enumerator
FarLeft
FarRight
NearLeft
NearRight

Definition at line 135 of file GameBoard.cs.

        {
            FarLeft,
            FarRight,
            NearLeft,
            NearRight
        }

Edge

enum TiltFive.GameBoard.Edge

strong

Represents cardinal positions around the gameboard (i.e. the centers of the edges of the gameboard), relative to a user positioned at the near (default) edge.

Enumerator
Near	The near edge of the gameboard. This is the side of the gameboard with the T5 logo.
Far	The far edge of the gameboard. This edge is positioned opposite the near edge.
Left	The left edge of the gameboard. From the perspective of a user sitting at the near edge of the gameboard, this edge is to their left.
Right	The right edge of the gameboard. From the perspective of a user sitting at the near edge of the gameboard, this edge is to their right.

Definition at line 106 of file GameBoard.cs.

        {
            Near,
            Far,
            Left,
            Right
        }

Member Function Documentation

InverseTransformPoint()

bool TiltFive.GameBoard.InverseTransformPoint	(	Vector3	pointInWorldSpace,
		PlayerIndex	playerIndex,
		out Vector3	pointInGameboardSpace
	)

Transforms the provided position from world space to gameboard space.

Parameters

pointInWorldSpace	A position in Unity world space.
playerIndex	The player whose content scale settings should be considered while converting between spaces. This is necessary because multiple players with differing scale settings may share the same gameboard.
pointInGameboardSpace	The resulting point in gameboard space.

Returns

Returns false and sets pointInGameboardSpace to Vector3.zero if the function failed while calculating the transformed point; returns true otherwise. This function can fail if playerIndex is invalid.

Definition at line 532 of file GameBoard.cs.

        {
            if (!Player.TryGetSettings(playerIndex, out var playerSettings))
            {
                pointInGameboardSpace = Vector3.zero;
                return false;
            }
 
            pointInGameboardSpace = InverseTransformPoint(pointInWorldSpace, playerSettings.scaleSettings);
            return true;
        }

References TiltFive.Player.TryGetSettings().

InverseTransformPose() [1/2]

bool TiltFive.GameBoard.InverseTransformPose	(	Pose	poseInWorldSpace,
		PlayerIndex	playerIndex,
		out Pose	poseInGameboardSpace
	)

Transforms the provided pose from world space to gameboard space.

Parameters

poseInWorldSpace	A position and orientation in Unity world space.
playerIndex	The player whose content scale settings should be considered while converting between spaces. This is necessary because multiple players with differing scale settings may share the same gameboard.
poseInGameboardSpace	The resulting position and orientation in gameboard space.

Returns

Returns false and sets poseInGameboardSpace to an empty pose if the function failed while calculating the transformed pose; returns true otherwise. This function can fail if playerIndex is invalid.

Definition at line 510 of file GameBoard.cs.

        {
            if (!Player.TryGetSettings(playerIndex, out var playerSettings))
            {
                poseInGameboardSpace = new Pose();
                return false;
            }
 
            poseInGameboardSpace = InverseTransformPose(poseInWorldSpace, playerSettings.scaleSettings);
            return true;
        }

References TiltFive.GameBoard.InverseTransformPose(), and TiltFive.Player.TryGetSettings().

InverseTransformPose() [2/2]

bool TiltFive.GameBoard.InverseTransformPose	(	Vector3	positionInWorldSpace,
		Quaternion	rotationToWorldSpace,
		PlayerIndex	playerIndex,
		out Vector3	positionInGameboardSpace,
		out Quaternion	rotationToGameboardSpace
	)

Transforms the provided pose from world space to gameboard space.

Parameters

positionInWorldSpace	A position in Unity world space.
rotationToWorldSpace	An orientation in Unity world space.
playerIndex	The player whose content scale settings should be considered while converting between spaces. This is necessary because multiple players with differing scale settings may share the same gameboard.
positionInGameboardSpace	The resulting position in gameboard space.
rotationToGameboardSpace	The resulting orientation in gameboard space.

Returns

Returns false and sets positionInGameboardSpace and rotationToGameboardSpace to default values if the function failed while calculating the transformed pose; returns true otherwise. This function can fail if playerIndex is invalid.

Definition at line 485 of file GameBoard.cs.

        {
            if (!Player.TryGetSettings(playerIndex, out var playerSettings))
            {
                positionInGameboardSpace = Vector3.zero;
                rotationToGameboardSpace = Quaternion.identity;
                return false;
            }
 
            InverseTransformPose(positionInWorldSpace, rotationToWorldSpace, playerSettings.scaleSettings,
                out positionInGameboardSpace, out rotationToGameboardSpace);
            return true;
        }

References TiltFive.Player.TryGetSettings().

Referenced by TiltFive.GameBoard.InverseTransformPose().

TransformPoint()

bool TiltFive.GameBoard.TransformPoint	(	Vector3	pointInGameboardSpace,
		PlayerIndex	playerIndex,
		out Vector3	pointInWorldSpace
	)

Transforms the provided position from gameboard space to world space.

Parameters

pointInGameboardSpace	A point in gameboard space.
playerIndex	The player whose content scale settings should be considered while converting between spaces. This is necessary because multiple players with differing scale settings may share the same gameboard.
pointInWorldSpace	The resulting point in Unity world space.

Returns

Returns false and sets pointInWorldSpace to Vector3.zero if the function failed while calculating the transformed point; returns true otherwise. This function can fail if playerIndex is invalid.

Definition at line 461 of file GameBoard.cs.

        {
            if (!Player.TryGetSettings(playerIndex, out var playerSettings))
            {
                pointInWorldSpace = Vector3.zero;
                return false;
            }
 
            pointInWorldSpace = TransformPoint(pointInGameboardSpace, playerSettings.scaleSettings);
            return true;
        }

References TiltFive.Player.TryGetSettings().

TransformPose() [1/2]

bool TiltFive.GameBoard.TransformPose	(	Pose	poseInGameboardSpace,
		PlayerIndex	playerIndex,
		out Pose	poseInWorldSpace
	)

Transforms the provided pose from gameboard space to world space.

Parameters

poseInGameboardSpace	A position and orientation in gameboard space.
playerIndex	The player whose content scale settings should be considered while converting between spaces. This is necessary because multiple players with differing scale settings may share the same gameboard.
poseInWorldSpace	The resulting position and orientation in Unity world space.

Returns

Returns false and sets poseInWorldSpace to an empty pose if the function failed while calculating the transformed pose; returns true otherwise. This function can fail if playerIndex is invalid.

Definition at line 439 of file GameBoard.cs.

        {
            if (!Player.TryGetSettings(playerIndex, out var playerSettings))
            {
                poseInWorldSpace = new Pose();
                return false;
            }
 
            poseInWorldSpace = TransformPose(poseInGameboardSpace, playerSettings.scaleSettings);
            return true;
        }

References TiltFive.GameBoard.TransformPose(), and TiltFive.Player.TryGetSettings().

TransformPose() [2/2]

bool TiltFive.GameBoard.TransformPose	(	Vector3	positionInGameboardSpace,
		Quaternion	rotationToGameboardSpace,
		PlayerIndex	playerIndex,
		out Vector3	positionInWorldSpace,
		out Quaternion	rotationToWorldSpace
	)

Transforms the provided pose from gameboard space to world space.

Parameters

positionInGameboardSpace	A position in gameboard space.
rotationToGameboardSpace	An orientation in gameboard space.
playerIndex	The player whose content scale settings should be considered while converting between spaces. This is necessary because multiple players with differing scale settings may share the same gameboard.
positionInWorldSpace	The resulting position in Unity world space.
rotationToWorldSpace	The resulting orientation in Unity world space.

Returns

Returns false and sets positionInGameboardSpace and rotationToWorldSpace to default values if the function failed while calculating the transformed pose; returns true otherwise. This function can fail if playerIndex is invalid.

Definition at line 414 of file GameBoard.cs.

        {
            if (!Player.TryGetSettings(playerIndex, out var playerSettings))
            {
                positionInWorldSpace = Vector3.zero;
                rotationToWorldSpace = Quaternion.identity;
                return false;
            }
 
            TransformPose(positionInGameboardSpace, rotationToGameboardSpace, playerSettings.scaleSettings,
                out positionInWorldSpace, out rotationToWorldSpace);
            return true;
        }

References TiltFive.Player.TryGetSettings().

Referenced by TiltFive.GameBoard.TransformPose().

TryGetGameboardDimensions()

static bool TiltFive.GameBoard.TryGetGameboardDimensions ( GameboardType  gameboardType, out GameboardDimensions  gameboardDimensions  )

static

Attempts to obtain the physical dimensions for a particular gameboard type.

Parameters

gameboardType
gameboardDimensions

Returns

Returns dimensions for GameboardType.GameboardType_LE if it fails.

Definition at line 344 of file GameBoard.cs.

        {
            if(gameboardType == GameboardType.GameboardType_None)
            {
                gameboardDimensions = new GameboardDimensions();
                return false;
            }
 
            // Default to the LE gameboard dimensions in meters.
            T5_GameboardSize gameboardSize = GameboardExtents.GAMEBOARD_SIZE_LE;
            int result = NativePlugin.T5_RESULT_UNKNOWN_ERROR;
 
            try
            {
                result = NativePlugin.GetGameboardDimensions(gameboardType, ref gameboardSize);
            }
            catch (Exception e)
            {
                Log.Error(e.Message);
            }
 
            gameboardDimensions = new GameboardDimensions(gameboardSize);
 
            return result == NativePlugin.T5_RESULT_SUCCESS;
        }

References TiltFive.Logging.Log.Error().

TryGetGameboardExtents()

static bool TiltFive.GameBoard.TryGetGameboardExtents ( GameboardType  gameboardType, out GameboardExtents  gameboardExtents  )

static

Attempts to obtain the physical dimensions for a particular gameboard type.

Parameters

gameboardType
gameboardExtents

Returns

Returns true on successful gameboard extents retrieval, and false otherwise. Use this return value to determine whether gameboardExtents is valid.

Definition at line 377 of file GameBoard.cs.

        {
            if(gameboardType == GameboardType.GameboardType_None)
            {
                gameboardExtents = new GameboardExtents();
                return false;
            }
 
            T5_GameboardSize gameboardSize = new T5_GameboardSize();
            int result = NativePlugin.T5_RESULT_UNKNOWN_ERROR;
 
            try
            {
                result = NativePlugin.GetGameboardDimensions(gameboardType, ref gameboardSize);
            }
            catch (Exception e)
            {
                Log.Error(e.Message);
            }
 
            gameboardExtents = new GameboardExtents(gameboardSize);
 
            return result == NativePlugin.T5_RESULT_SUCCESS;
        }

References TiltFive.Logging.Log.Error().

TryGetGameboardType() [1/2]

static bool TiltFive.GameBoard.TryGetGameboardType ( out GameboardType  gameboardType )

static

Attempts to check the latest glasses pose for the current gameboard type, such as LE, XE, or none.

Parameters

gameboardType

Output gameboard type. Contains GameboardType.GameboardType_None if no pose was provided, which can happen if the user looks away and the head tracking camera loses sight of the gameboard.

Returns

Returns true on successful pose retrieval, false otherwise.

Definition at line 318 of file GameBoard.cs.

        {
            return TryGetGameboardType(PlayerIndex.One, out gameboardType);
        }

TryGetGameboardType() [2/2]

static bool TiltFive.GameBoard.TryGetGameboardType ( PlayerIndex  playerIndex, out GameboardType  gameboardType  )

static

Definition at line 323 of file GameBoard.cs.

        {
            // Return false and a default gameboard if the player is nonexistent or disconnected.
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle)
                || !playerGameboards.TryGetValue(playerIndex, out var currentGameboardType))
            {
                gameboardType = GameboardType.GameboardType_None;
                return false;
            }
 
            gameboardType = currentGameboardType;
            return true;
        }

References TiltFive.GameBoard.playerGameboards.

Member Data Documentation

GameboardType

GameboardType TiltFive.GameBoard.GameboardType

The gameboard configuration, such as LE, XE, or folded XE.

Definition at line 57 of file GameBoard.cs.

GizmoOpacity

float TiltFive.GameBoard.GizmoOpacity = 0.75f

Sets the opacity of the game board gizmo in the editor.

Definition at line 50 of file GameBoard.cs.

GridHeightOffset

float TiltFive.GameBoard.GridHeightOffset = 0f

Definition at line 41 of file GameBoard.cs.

playerGameboards

Dictionary<PlayerIndex, GameboardType> TiltFive.GameBoard.playerGameboards = new Dictionary<PlayerIndex, GameboardType>()

staticprivate

Definition at line 95 of file GameBoard.cs.

Referenced by TiltFive.GameBoard.TryGetGameboardType().

ShowGizmo

bool TiltFive.GameBoard.ShowGizmo

Shows the game board gizmo in the editor.

Definition at line 36 of file GameBoard.cs.

ShowGrid

bool TiltFive.GameBoard.ShowGrid

Definition at line 39 of file GameBoard.cs.

StickyHeightOffset

bool TiltFive.GameBoard.StickyHeightOffset = true

Definition at line 42 of file GameBoard.cs.

---

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

• GameBoard.cs