Unity SDK Docs 1.5.0-beta.6
Loading...
Searching...
No Matches
TiltFive.GameBoardSettings Class Reference
Inheritance diagram for TiltFive.GameBoardSettings:
TiltFive.TrackableSettings

Public Attributes

GameBoard currentGameBoard
 The gameboard is the window into the game world, as well as the origin about which the glasses/wand are tracked.
GameObject physicalGameboardOrigin
 A GameObject whose pose is driven by the gameboard's orientation in physical space, relative to a gameboard laying flat on a table perpendicular to gravity.
bool copyPlayerOneGameboard = true
Public Attributes inherited from TiltFive.TrackableSettings
bool RejectUntrackedPositionData = true
TrackingFailureMode FailureMode = TrackingFailureMode.FreezePosition

Properties

float gameBoardScale [get]
 The gameboard's scale multiplies the perceived size of objects in the scene.
Vector3 gameBoardCenter [get]
 The gameboard position or focal position offset.
Vector3 gameBoardRotation [get]
 The gameboard rotation or focal rotational offset.
GameboardType gameboardType [get]
 The gameboard configuration, such as LE, XE, or folded XE.

Additional Inherited Members

Public Types inherited from TiltFive.TrackableSettings
enum  TrackingFailureMode { FreezePosition = 0 , FreezePositionAndRotation = 1 , SnapToDefault = 2 }

Detailed Description

Definition at line 24 of file GameBoardSettings.cs.

Member Data Documentation

◆ copyPlayerOneGameboard

bool TiltFive.GameBoardSettings.copyPlayerOneGameboard = true

Definition at line 94 of file GameBoardSettings.cs.

◆ currentGameBoard

GameBoard TiltFive.GameBoardSettings.currentGameBoard

The gameboard is the window into the game world, as well as the origin about which the glasses/wand are tracked.

It can be useful to modify the gameboard's location for cinematic purposes, such as following an object (such as a player's avatar) in the scene. This avoids the need to directly modify the positions/orientations of the glasses or wand, which track the player's movements relative to the game board.

Definition at line 35 of file GameBoardSettings.cs.

◆ physicalGameboardOrigin

GameObject TiltFive.GameBoardSettings.physicalGameboardOrigin

A GameObject whose pose is driven by the gameboard's orientation in physical space, relative to a gameboard laying flat on a table perpendicular to gravity.

Parenting GameObjects under physicalGameboardOrigin> makes it easy to pin them to the gameboard's surface or edges, even when the gameboard is mounted on a wall or at strange angles.

Definition at line 44 of file GameBoardSettings.cs.

Property Documentation

◆ gameBoardCenter

Vector3 TiltFive.GameBoardSettings.gameBoardCenter
get

The gameboard position or focal position offset.

Definition at line 81 of file GameBoardSettings.cs.

◆ gameBoardRotation

Vector3 TiltFive.GameBoardSettings.gameBoardRotation
get

The gameboard rotation or focal rotational offset.

Definition at line 86 of file GameBoardSettings.cs.

◆ gameBoardScale

float TiltFive.GameBoardSettings.gameBoardScale
get

The gameboard's scale multiplies the perceived size of objects in the scene.

When scaling the world to fit on the gameboard, it can be useful to think in terms of zoom (e.g. 2x, 10x, etc) rather than fussing with absolute units using and . Directly modifying the gameboard's scale is convenient for cinematics, tweening/animation, and other use cases in which zooming in/out may be desirable.

Definition at line 76 of file GameBoardSettings.cs.

◆ gameboardType

GameboardType TiltFive.GameBoardSettings.gameboardType
get

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

Definition at line 92 of file GameBoardSettings.cs.


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