Tilt Five™ Unity API  1.3.0
 
Loading...
Searching...
No Matches
TiltFive Namespace Reference

Namespaces

namespace  Logging
 

Classes

class  AllAxesBoolean
 
struct  ARProjectionFrustum
 
class  AxesBoolean
 
class  CameraImage
 The Camera Frame API and runtime. More...
 
class  Display
 
class  DisplayHelper
 
class  DisplaySettings
 Display settings constants. More...
 
class  DontDestroyOnLoad
 
class  GameBoard
 Represents the game board. More...
 
class  GameBoardSettings
 
class  Glasses
 The Glasses API and runtime. More...
 
struct  GlassesHandle
 
class  GlassesSettings
 GlassesSettings encapsulates all configuration data used by the Glasses' tracking runtime to compute the Head Pose and apply it to the Camera. More...
 
class  Input
 Provides access to Wand inputs. More...
 
interface  ISceneInfo
 
struct  Length
 
class  NativePlugin
 
class  Player
 Provides access to player settings and functionality. More...
 
class  PlayerSettings
 
class  ScaleSettings
 ScaleSettings contains the scale data used to translate between Unity units and the user's physical space. More...
 
class  Singleton
 
class  SingletonComponent
 
class  SpectatorSettings
 
class  SplitStereoCamera
 
class  SplitStereoTextures
 
struct  T5_Bool
 Represents a boolean value. More...
 
struct  T5_CameraStreamConfig
 Camera Stream Configuration. More...
 
struct  T5_CamImage
 Represents a wrapper on a buffer comtaining a camera image. More...
 
struct  T5_ControllerState
 Contains wand related information (Pose, Buttons, Trigger, Stick, Battery) More...
 
struct  T5_FrameInfo
 Render information to be used with NativePlugin.QueueStereoImages(T5_FrameInfo) More...
 
struct  T5_GameboardSize
 Physical dimensions of a gameboard, in meters. More...
 
struct  T5_GlassesPose
 Headset pose information to be retrieved with NativePlugin.GetGlassesPose(ref T5_GlassesPose) More...
 
struct  T5_Position
 Represents a three dimensional position.
 
struct  T5_Rotation
 Represents a quaternion rotation.
 
struct  T5_StringUTF8
 Represents a string value. More...
 
struct  T5_VCI
 Represents the image rectangle in the normalized (z=1) image space of the virtual cameras.
 
class  TiltFiveManager
 The Tilt Five manager. More...
 
class  TiltFiveManager2
 The Tilt Five manager. More...
 
class  TiltFiveSingletonHelper
 
class  TrackableCore
 
class  TrackableSettings
 
class  UniformScaleTransform
 Enforces uniform scaling by setting the x, y, and z scale components of the associated transform to be equal. More...
 
class  UnityExtensions
 
class  Wand
 The Wand API and runtime. More...
 
class  WandSettings
 Wand Settings encapsulates all configuration data used by the Wand's tracking runtime to compute the Wand Pose and apply it to the driven GameObject. More...
 

Enumerations

enum  ServiceCompatibility : Int32 { Incompatible = 0 , Compatible = 1 , Unknown = 2 }
 Whether the running service is compatible. More...
 
enum  PlayerIndex {
  None = 0 , One = 1 , Two = 2 , Three = 3 ,
  Four = 4
}
 The Player index (e.g. Player One, Player Two, etc) More...
 
enum  ControllerIndex : Int32 { Right = 0 , Left = 1 , Primary = Right , Secondary = Left }
 Since wands are all physically identical (they have no "handedness"), it doesn't make sense to address them using "left" or "right". Instead we use hand dominance, and allow applications to swap the dominant and offhand wand according to the user's preference. More...
 
enum  GameboardType : Int32 { GameboardType_None = 1 , GameboardType_LE = 2 , GameboardType_XE = 3 , GameboardType_XE_Raised = 4 }
 The type of Gameboard being tracked by the glasses. More...
 
enum  ControllerPosition : Int32 { Grip = 0 , Fingertips = 1 , Aim = 2 }
 Points of interest along the wand controller, such as the handle position or wand tip. More...
 
enum  T5_Hand : byte { Unknown = 0 , Left = 1 , Right = 2 }
 Reported wand hand. More...
 
enum  T5_GlassesPoseUsage : Int32 { GlassesPresentation = 1 , SpectatorPresentation = 2 }
 Glasses pose usage indicator. More...
 
enum  GlassesMirrorMode { None , LeftEye , RightEye , Stereoscopic }
 
enum  LengthUnit {
  Kilometers , Smoots , Meters , Attoparsecs ,
  Centimeters , MegaBeardSeconds , Millimeters , Miles ,
  Furlongs , Yards , Feet , Inches
}
 

Enumeration Type Documentation

◆ ControllerIndex

Since wands are all physically identical (they have no "handedness"), it doesn't make sense to address them using "left" or "right". Instead we use hand dominance, and allow applications to swap the dominant and offhand wand according to the user's preference.

Enumerator
Right 

The wand held in the player's right hand.

Left 

The wand held in the player's left hand.

Primary 
Secondary 

Definition at line 511 of file NativePlugin.cs.

512 {
516 Right = 0,
517
521 Left = 1,
522
523 [Obsolete("ControllerIndex.Primary is deprecated, please update to use left/right based on user preference instead.")]
524 Primary = Right,
525
526 [Obsolete("ControllerIndex.Secondary is deprecated, please update to use left/right based on user preference instead.")]
527 Secondary = Left,
528 }
@ Right
The wand held in the player's right hand.
@ Left
The wand held in the player's left hand.

◆ ControllerPosition

Points of interest along the wand controller, such as the handle position or wand tip.

Enumerator
Grip 

The center of the wand handle.

Fingertips 

The typical resting position of the player's fingertips, near the wand joystick and trigger.

Aim 

The tip of the wand.

Definition at line 579 of file NativePlugin.cs.

580 {
584 Grip = 0,
585
589 Fingertips = 1,
590
594 Aim = 2
595 }
@ Fingertips
The typical resting position of the player's fingertips, near the wand joystick and trigger.
@ Aim
The tip of the wand.
@ Grip
The center of the wand handle.

◆ GameboardType

enum TiltFive.GameboardType : Int32

The type of Gameboard being tracked by the glasses.

Enumerator
GameboardType_None 

No Gameboard at all.

If the glasses pose is in respect to GameboardType.GameboardType_None

GameboardType_LE 

The LE Gameboard.

GameboardType_XE 

The XE Gameboard, laid out flat.

GameboardType_XE_Raised 

The XE Gameboard, folded upward using its kickstand.

Definition at line 533 of file NativePlugin.cs.

534 {
542
547
552
557 }
@ GameboardType_None
No Gameboard at all.
@ GameboardType_LE
The LE Gameboard.
@ GameboardType_XE
The XE Gameboard, laid out flat.
@ GameboardType_XE_Raised
The XE Gameboard, folded upward using its kickstand.

◆ GlassesMirrorMode

Enumerator
None 
LeftEye 
RightEye 
Stereoscopic 

Definition at line 23 of file SpectatorSettings.cs.

◆ LengthUnit

Enumerator
Kilometers 
Smoots 
Meters 
Attoparsecs 
Centimeters 
MegaBeardSeconds 
Millimeters 
Miles 
Furlongs 
Yards 
Feet 
Inches 

Definition at line 21 of file Length.cs.

22 {
24 [Tooltip("A smoot is the height of Oliver R. Smoot, equivalent to 5ft 7in or 1.702m.")]
25 Smoots,
26 Meters,
27 [Tooltip("An attoparsec is one quintillionth of a parsec, or slightly more than 3cm.")]
30 [Tooltip("A mega beard-second is one million beard-seconds (the distance a typical beard grows in one second, about 5nm), or about 5mm.")]
33 Miles,
34 [Tooltip("A furlong is 220 yards.")]
36 Yards,
37 Feet,
38 Inches
39 }

◆ PlayerIndex

The Player index (e.g. Player One, Player Two, etc)

Enumerator
None 
One 
Two 
Three 
Four 

Definition at line 497 of file NativePlugin.cs.

498 {
499 [HideInInspector]
500 None = 0,
501 One = 1,
502 Two = 2,
503 Three = 3,
504 Four = 4
505 }

◆ ServiceCompatibility

Whether the running service is compatible.

Enumerator
Incompatible 
Compatible 
Unknown 

Definition at line 476 of file NativePlugin.cs.

477 {
478 // <summary>
479 // The running service is incompatible with this client.
480 // </summary>
481 Incompatible = 0,
482
483 // <summary>
484 // The running service is compatible with this client.
485 // </summary>
486 Compatible = 1,
487
488 // <summary>
489 // Don't know yet whether the running service is compatible with this client.
490 // </summary>
491 Unknown = 2,
492 }

◆ T5_GlassesPoseUsage

Glasses pose usage indicator.

Enumerator
GlassesPresentation 

The pose will be used to render images to be presented on the glasses.

Querying a glasses pose for this usage will return a pose prediction intended to account for the render and presentation latency. The predicted pose is prone to include errors, and the rendered images may appear very jittery if they are displayed on a device other than the glasses. When displayed via the glasses, the on-glasses image stabilization compensates for this prediction error, so the image should not appear jittery.

SpectatorPresentation 

The pose will be used to render images to be presented on a device other than the glasses, such at the host system's primary display.

Querying a glasses pose for this usage will return a pose with less noise than that intended for presentation via the glasses.

Definition at line 621 of file NativePlugin.cs.

622 {
634
644 }
@ SpectatorPresentation
The pose will be used to render images to be presented on a device other than the glasses,...
@ GlassesPresentation
The pose will be used to render images to be presented on the glasses.

◆ T5_Hand

enum TiltFive.T5_Hand : byte

Reported wand hand.

Enumerator
Unknown 

Hand unknown.

Left 

Left hand.

Right 

Right hand.

Definition at line 600 of file NativePlugin.cs.

601 {
605 Unknown = 0,
606
610 Left = 1,
611
615 Right = 2,
616 }