Tilt Five™ Unity API  1.4.1
Public Attributes | Static Public Attributes | Properties | List of all members
TiltFive.GlassesSettings Class Reference

GlassesSettings encapsulates all configuration data used by the Glasses' tracking runtime to compute the Head Pose and apply it to the Camera. More...

Inheritance diagram for TiltFive.GlassesSettings:
TiltFive.TrackableSettings

Public Attributes

Camera headPoseCamera
 The main camera used for rendering the Scene when the glasses are unavailable, and the gameobject used for the glasses pose. More...
 
GameObject objectTemplate
 The object used as a template for creating the base Game Object when a specific playerIndex connects. More...
 
bool cloneCameraTemplateChildren = false
 Whether or not the camera template's child gameobjects should be cloned during eye camera instantiation at runtime. More...
 
LayerMask cullingMask = ~0
 The culling mask to be used by the eye cameras for this pair of glasses. More...
 
float nearClipPlane = MIN_NEAR_CLIP_DISTANCE_IN_METERS
 The near clip plane in physical space (meters), to adjust for content scale and gameboard size More...
 
float farClipPlane = 100f
 The far clip plane in physical space (meters), to adjust for content scale and gameboard size More...
 
bool overrideFOV = false
 
float customFOV = DEFAULT_FOV
 
GlassesMirrorMode glassesMirrorMode = GlassesMirrorMode.LeftEye
 
bool usePreviewPose = true
 
Transform previewPose
 
string friendlyName = DEFAULT_FRIENDLY_NAME
 
- Public Attributes inherited from TiltFive.TrackableSettings
bool RejectUntrackedPositionData = true
 
TrackingFailureMode FailureMode = TrackingFailureMode.FreezePosition
 

Static Public Attributes

const float MIN_FOV = 35f
 
const float MAX_FOV = 64f
 
const float DEFAULT_FOV = 48f
 
const float DEFAULT_IPD_UGBD = 0.059f
 
const float MIN_NEAR_CLIP_DISTANCE_IN_METERS = 0.1f
 
static readonly string DEFAULT_FRIENDLY_NAME = "Tilt Five Glasses"
 

Properties

Camera cameraTemplate [get, set]
 The camera used as a template for creating the eye cameras at runtime. More...
 
float fieldOfView [get]
 

Additional Inherited Members

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

Detailed Description

GlassesSettings encapsulates all configuration data used by the Glasses' tracking runtime to compute the Head Pose and apply it to the Camera.

Definition at line 27 of file GlassesSettings.cs.

Member Data Documentation

◆ cloneCameraTemplateChildren

bool TiltFive.GlassesSettings.cloneCameraTemplateChildren = false

Whether or not the camera template's child gameobjects should be cloned during eye camera instantiation at runtime.

Definition at line 113 of file GlassesSettings.cs.

Referenced by TiltFive.SplitStereoCamera.InstantiateEyeCameras().

◆ cullingMask

LayerMask TiltFive.GlassesSettings.cullingMask = ~0

The culling mask to be used by the eye cameras for this pair of glasses.

Definition at line 118 of file GlassesSettings.cs.

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

◆ customFOV

float TiltFive.GlassesSettings.customFOV = DEFAULT_FOV

Definition at line 131 of file GlassesSettings.cs.

◆ DEFAULT_FOV

const float TiltFive.GlassesSettings.DEFAULT_FOV = 48f
static

Definition at line 38 of file GlassesSettings.cs.

◆ DEFAULT_FRIENDLY_NAME

readonly string TiltFive.GlassesSettings.DEFAULT_FRIENDLY_NAME = "Tilt Five Glasses"
static

Definition at line 49 of file GlassesSettings.cs.

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

◆ DEFAULT_IPD_UGBD

const float TiltFive.GlassesSettings.DEFAULT_IPD_UGBD = 0.059f
static

Definition at line 43 of file GlassesSettings.cs.

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

◆ farClipPlane

float TiltFive.GlassesSettings.farClipPlane = 100f

The far clip plane in physical space (meters), to adjust for content scale and gameboard size

Definition at line 128 of file GlassesSettings.cs.

Referenced by TiltFive.SplitStereoCamera.OnPreRender(), TiltFive.SplitStereoCamera.SyncFields(), and TiltFive.Glasses.GlassesCore.Update().

◆ friendlyName

string TiltFive.GlassesSettings.friendlyName = DEFAULT_FRIENDLY_NAME

Definition at line 141 of file GlassesSettings.cs.

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

◆ glassesMirrorMode

GlassesMirrorMode TiltFive.GlassesSettings.glassesMirrorMode = GlassesMirrorMode.LeftEye

Definition at line 136 of file GlassesSettings.cs.

Referenced by TiltFive.TiltFiveManager.Awake(), and TiltFive.TiltFiveManager.RefreshSpectatorSettings().

◆ headPoseCamera

Camera TiltFive.GlassesSettings.headPoseCamera

The main camera used for rendering the Scene when the glasses are unavailable, and the gameobject used for the glasses pose.

Definition at line 78 of file GlassesSettings.cs.

◆ MAX_FOV

const float TiltFive.GlassesSettings.MAX_FOV = 64f
static

Definition at line 37 of file GlassesSettings.cs.

◆ MIN_FOV

const float TiltFive.GlassesSettings.MIN_FOV = 35f
static

Definition at line 36 of file GlassesSettings.cs.

◆ MIN_NEAR_CLIP_DISTANCE_IN_METERS

const float TiltFive.GlassesSettings.MIN_NEAR_CLIP_DISTANCE_IN_METERS = 0.1f
static

Definition at line 47 of file GlassesSettings.cs.

◆ nearClipPlane

float TiltFive.GlassesSettings.nearClipPlane = MIN_NEAR_CLIP_DISTANCE_IN_METERS

The near clip plane in physical space (meters), to adjust for content scale and gameboard size

Definition at line 123 of file GlassesSettings.cs.

Referenced by TiltFive.SplitStereoCamera.OnPreRender(), TiltFive.SplitStereoCamera.SyncFields(), and TiltFive.Glasses.GlassesCore.Update().

◆ objectTemplate

GameObject TiltFive.GlassesSettings.objectTemplate

The object used as a template for creating the base Game Object when a specific playerIndex connects.

Definition at line 98 of file GlassesSettings.cs.

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

◆ overrideFOV

bool TiltFive.GlassesSettings.overrideFOV = false

Definition at line 130 of file GlassesSettings.cs.

◆ previewPose

Transform TiltFive.GlassesSettings.previewPose

Definition at line 139 of file GlassesSettings.cs.

Referenced by TiltFive.Glasses.BaseGlassesCore.SetDrivenObjectTransform(), and TiltFive.Glasses.BaseGlassesCore.SetInvalidPoseGameboardSpace().

◆ usePreviewPose

bool TiltFive.GlassesSettings.usePreviewPose = true

Definition at line 138 of file GlassesSettings.cs.

Referenced by TiltFive.Glasses.BaseGlassesCore.SetDrivenObjectTransform(), and TiltFive.Glasses.BaseGlassesCore.SetInvalidPoseGameboardSpace().

Property Documentation

◆ cameraTemplate

Camera TiltFive.GlassesSettings.cameraTemplate
getset

The camera used as a template for creating the eye cameras at runtime.

Alias for the obsolete field headPoseCamera.

Definition at line 88 of file GlassesSettings.cs.

88  {
89  #pragma warning disable 618 // this is for compatibility; disable obsolete warning
90  get { return headPoseCamera; }
91  set { headPoseCamera = value; }
92  #pragma warning restore 618
93  }
TiltFive.GlassesSettings.headPoseCamera
Camera headPoseCamera
The main camera used for rendering the Scene when the glasses are unavailable, and the gameobject use...
Definition: GlassesSettings.cs:78

Referenced by TiltFive.TiltFiveManager.Awake(), TiltFive.TiltFiveManager.RefreshSpectatorSettings(), TiltFive.Glasses.GlassesCore.Update(), and TiltFive.Glasses.GlassesCore.Validate().

◆ fieldOfView

float TiltFive.GlassesSettings.fieldOfView
get

Definition at line 132 of file GlassesSettings.cs.

Referenced by TiltFive.SplitStereoCamera.OnPreRender(), TiltFive.SplitStereoCamera.PresentStereoImages(), TiltFive.SplitStereoCamera.SyncFields(), and TiltFive.Glasses.GlassesCore.Update().

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