TiltFive Namespace Reference

Namespaces
namespace	Logging

Classes
class	NativePlugin
struct	T5_Bool
	Represents a boolean value.
struct	T5_Position
	Represents a three dimensional position.
struct	T5_Rotation
	Represents a quaternion rotation.
struct	GlassesHandle
struct	T5_GlassesPose
	Headset pose information to be retrieved with NativePlugin.GetGlassesPose(ref T5_GlassesPose)
struct	T5_CamImage
	Represents a wrapper on a buffer comtaining a camera image. More...
struct	T5_CameraStreamConfig
	Camera Stream Configuration. More...
struct	T5_ControllerState
	Contains wand related information (Pose, Buttons, Trigger, Stick, Battery)
struct	T5_VCI
	Represents the image rectangle in the normalized (z=1) image space of the virtual cameras
struct	T5_FrameInfo
	Render information to be used with NativePlugin.QueueStereoImages(T5_FrameInfo)
struct	T5_StringUTF8
	Represents a string value.
struct	T5_GameboardSize
	Physical dimensions of a gameboard, in meters. More...
class	SystemControl
class	GameBoard
	Represents the game board. More...
class	CameraImage
	The Camera Frame API and runtime. More...
class	AxesBoolean
class	AllAxesBoolean
struct	ARProjectionFrustum
class	Display
class	DisplayHelper
class	Glasses
	The Glasses API and runtime. More...
class	DisplaySettings
	Display settings constants. More...
class	SplitStereoCamera
class	SplitStereoTextures
class	Player
	Provides access to player settings and functionality. More...
class	TrackableCore
class	Input
	Provides access to Wand inputs 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...
class	Wand
	The Wand API and runtime. More...
class	GameBoardSettings
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	GraphicsSettings
	GraphicsSettings encapsulates configuration data related to the project's graphics settings, such as target framerate, vsync, etc. More...
class	PlayerSettings
class	ScaleSettings
	ScaleSettings contains the scale data used to translate between Unity units and the user's physical space. More...
class	SpectatorSettings
class	TrackableSettings
class	TiltFiveManager
	The Tilt Five manager. More...
class	TiltFiveManager2
	The Tilt Five manager. More...
class	DontDestroyOnLoad
struct	Length
class	MeshAssets
	Handles functionality relating to mesh assets provided in the Tilt Five Unity SDK. More...
class	Singleton
class	SingletonComponent
interface	ISceneInfo
class	TiltFiveSingletonHelper
class	UniformScaleTransform
	Enforces uniform scaling by setting the x, y, and z scale components of the associated transform to be equal. More...
class	UnityExtensions

Enumerations
enum class	ServiceCompatibility : Int32 { Incompatible = 0 , Compatible = 1 , Unknown = 2 }
	Whether the running service is compatible. More...
enum class	PlayerIndex {   None = 0 , One = 1 , Two = 2 , Three = 3 ,   Four = 4 }
	The Player index (e.g. Player One, Player Two, etc) More...
enum class	ControllerIndex : Int32 { Right = 0 , Left = 1 , Primary = -1 , Secondary = -2 }
	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 class	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 class	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 class	T5_Hand : byte { Unknown = 0 , Left = 1 , Right = 2 }
	Reported wand hand More...
enum class	GlassesMirrorMode { None , LeftEye , RightEye , Stereoscopic }
enum class	LengthUnit {   Kilometers , Smoots , Meters , Attoparsecs ,   Centimeters , MegaBeardSeconds , Millimeters , Miles ,   Furlongs , Yards , Feet , Inches }

Enumeration Type Documentation

ControllerIndex

enum TiltFive.ControllerIndex : Int32

strong

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 528 of file NativePlugin.cs.

    {
        Right = 0,
 
        Left = 1,
 
        [Obsolete("ControllerIndex.Primary is obsolete, please update to use left/right based on user preference instead.", true)]
        Primary = -1,
 
        [Obsolete("ControllerIndex.Secondary is obsolete, please update to use left/right based on user preference instead.", true)]
        Secondary = -2,
    }

ControllerPosition

enum TiltFive.ControllerPosition : Int32

strong

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 634 of file NativePlugin.cs.

    {
        Grip = 0,
 
        Fingertips = 1,
 
        Aim = 2
    }

GameboardType

enum TiltFive.GameboardType : Int32

strong

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 550 of file NativePlugin.cs.

    {
        GameboardType_None = 1,
 
        GameboardType_LE = 2,
 
        GameboardType_XE = 3,
 
        GameboardType_XE_Raised = 4,
    }

GlassesMirrorMode

enum TiltFive.GlassesMirrorMode

strong

Enumerator
None
LeftEye
RightEye
Stereoscopic

Definition at line 23 of file SpectatorSettings.cs.

    {
        None,
        LeftEye,
        RightEye,
        Stereoscopic
    }

LengthUnit

enum TiltFive.LengthUnit

strong

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

Definition at line 21 of file Length.cs.

    {
        Kilometers,
        [Tooltip("A smoot is the height of Oliver R. Smoot, equivalent to 5ft 7in or 1.702m.")]
        Smoots,
        Meters,
        [Tooltip("An attoparsec is one quintillionth of a parsec, or slightly more than 3cm.")]
        Attoparsecs,
        Centimeters,
        [Tooltip("A mega beard-second is one million beard-seconds (the distance a typical beard grows in one second, about 5nm), or about 5mm.")]
        MegaBeardSeconds,
        Millimeters,
        Miles,
        [Tooltip("A furlong is 220 yards.")]
        Furlongs,
        Yards,
        Feet,
        Inches
    }

PlayerIndex

enum TiltFive.PlayerIndex

strong

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

Enumerator
None
One
Two
Three
Four

Definition at line 514 of file NativePlugin.cs.

    {
        [HideInInspector]
        None = 0,
        One = 1,
        Two = 2,
        Three = 3,
        Four = 4
    }

ServiceCompatibility

enum TiltFive.ServiceCompatibility : Int32

strong

Whether the running service is compatible.

Enumerator
Incompatible
Compatible
Unknown

Definition at line 493 of file NativePlugin.cs.

    {
        // <summary>
        // The running service is incompatible with this client.
        // </summary>
        Incompatible = 0,
 
        // <summary>
        // The running service is compatible with this client.
        // </summary>
        Compatible = 1,
 
        // <summary>
        // Don't know yet whether the running service is compatible with this client.
        // </summary>
        Unknown = 2,
    }

T5_Hand

enum TiltFive.T5_Hand : byte

strong

Reported wand hand

Enumerator
Unknown	Hand unknown
Left	Left hand
Right	Right hand

Definition at line 655 of file NativePlugin.cs.

    {
        Unknown = 0,
 
        Left = 1,
 
        Right = 2,
    }