Tilt Five Unity SDK 1.4.2
Loading...
Searching...
No Matches
TiltFive.TrackableCore< TSettings, TState > Class Template Referenceabstract

Protected Member Functions

void Reset (TSettings settings)
virtual void Update (TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
void SetDefaultPoseGameboardSpace (TSettings settings)
 Gets the default pose of the tracked object.
void SetPoseGameboardSpace (in TState state, TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
 Sets the pose values of the tracked object in Unity World Space.
void SetInvalidPoseGameboardSpace (in TState state, TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
 Sets the pose values of the tracked object in Unity World Space when we already know the pose is invalid.
void SetPoseUnityWorldSpace (ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
 Sets the pose values of the tracked object in Unity World Space.
bool TryCheckConnected (out bool connected)
 Determines whether the tracked object is still connected.
bool TryGetStateFromPlugin (out TState state, out bool poseIsValid)
 Gets the latest pose for the tracked object from the native plugin.
void SetDrivenObjectTransform (TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
 Sets the pose of the object(s) being driven by TrackableCore.

Static Protected Member Functions

static Vector3 ConvertPosSTAGEToUSTAGE (Vector3 pos_STAGE)
static Pose GameboardToWorldSpace (Pose pose_GameboardSpace, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
static Vector3 GameboardToWorldSpace (Vector3 pos_USTAGE, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
static Vector3 WorldToGameboardSpace (Vector3 pos_UWRLD, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
static Quaternion GameboardToWorldSpace (Quaternion rotToUSTAGE_OBJ, GameBoardSettings gameboardSettings)
static Quaternion WorldToGameboardSpace (Quaternion rotToUWRLD_OBJ, GameBoardSettings gameboardSettings)

Protected Attributes

Pose pose_USTAGE
Pose pose_UWRLD
bool isTracked = false
bool isConnected = false
Pose gameboardPose_UWRLD
 The pose of the gameboard reference frame w.r.t. the Unity world-space reference frame.

Properties

Pose Pose_GameboardSpace [get]
 The pose of the trackable w.r.t. the gameboard reference frame.
Pose Pose_UnityWorldSpace [get]
 The Pose of the trackable in Unity world space.
bool IsTracked [get]
 Whether or not the trackable is being tracked.
bool IsConnected [get]
 Whether or not the trackable is connected.

Member Function Documentation

◆ ConvertPosSTAGEToUSTAGE()

Vector3 TiltFive.TrackableCore< TSettings, TState >.ConvertPosSTAGEToUSTAGE ( Vector3 pos_STAGE)
inlinestaticprotected

◆ GameboardToWorldSpace() [1/3]

Pose TiltFive.TrackableCore< TSettings, TState >.GameboardToWorldSpace ( Pose pose_GameboardSpace,
ScaleSettings scaleSettings,
GameBoardSettings gameboardSettings )
inlinestaticprotected

◆ GameboardToWorldSpace() [2/3]

Quaternion TiltFive.TrackableCore< TSettings, TState >.GameboardToWorldSpace ( Quaternion rotToUSTAGE_OBJ,
GameBoardSettings gameboardSettings )
inlinestaticprotected

◆ GameboardToWorldSpace() [3/3]

Vector3 TiltFive.TrackableCore< TSettings, TState >.GameboardToWorldSpace ( Vector3 pos_USTAGE,
ScaleSettings scaleSettings,
GameBoardSettings gameboardSettings )
inlinestaticprotected

◆ Reset()

void TiltFive.TrackableCore< TSettings, TState >.Reset ( TSettings settings)
inlineprotected

◆ SetDefaultPoseGameboardSpace()

void TiltFive.TrackableCore< TSettings, TState >.SetDefaultPoseGameboardSpace ( TSettings settings)
abstractprotected

Gets the default pose of the tracked object.

Parameters
settings
Returns

◆ SetDrivenObjectTransform()

void TiltFive.TrackableCore< TSettings, TState >.SetDrivenObjectTransform ( TSettings settings,
ScaleSettings scaleSettings,
GameBoardSettings gameboardSettings )
abstractprotected

Sets the pose of the object(s) being driven by TrackableCore.

Parameters
settings
scaleSettings
gameboardSettings

◆ SetInvalidPoseGameboardSpace()

void TiltFive.TrackableCore< TSettings, TState >.SetInvalidPoseGameboardSpace ( in TState state,
TSettings settings,
ScaleSettings scaleSettings,
GameBoardSettings gameboardSettings )
abstractprotected

Sets the pose values of the tracked object in Unity World Space when we already know the pose is invalid.

Parameters
state
settings
scaleSettings
gameboardSettings

◆ SetPoseGameboardSpace()

void TiltFive.TrackableCore< TSettings, TState >.SetPoseGameboardSpace ( in TState state,
TSettings settings,
ScaleSettings scaleSettings,
GameBoardSettings gameboardSettings )
abstractprotected

Sets the pose values of the tracked object in Unity World Space.

Parameters
state
settings
scaleSettings
gameboardSettings

◆ SetPoseUnityWorldSpace()

void TiltFive.TrackableCore< TSettings, TState >.SetPoseUnityWorldSpace ( ScaleSettings scaleSettings,
GameBoardSettings gameboardSettings )
abstractprotected

Sets the pose values of the tracked object in Unity World Space.

Parameters
scaleSettings
gameboardSettings

◆ TryCheckConnected()

bool TiltFive.TrackableCore< TSettings, TState >.TryCheckConnected ( out bool connected)
abstractprotected

Determines whether the tracked object is still connected.

Parameters
connected
Returns

◆ TryGetStateFromPlugin()

bool TiltFive.TrackableCore< TSettings, TState >.TryGetStateFromPlugin ( out TState state,
out bool poseIsValid )
abstractprotected

Gets the latest pose for the tracked object from the native plugin.

Parameters
state
poseIsValid
gameboardSettings
Returns

◆ Update()

virtual void TiltFive.TrackableCore< TSettings, TState >.Update ( TSettings settings,
ScaleSettings scaleSettings,
GameBoardSettings gameboardSettings )
inlineprotectedvirtual

◆ WorldToGameboardSpace() [1/2]

Quaternion TiltFive.TrackableCore< TSettings, TState >.WorldToGameboardSpace ( Quaternion rotToUWRLD_OBJ,
GameBoardSettings gameboardSettings )
inlinestaticprotected

◆ WorldToGameboardSpace() [2/2]

Vector3 TiltFive.TrackableCore< TSettings, TState >.WorldToGameboardSpace ( Vector3 pos_UWRLD,
ScaleSettings scaleSettings,
GameBoardSettings gameboardSettings )
inlinestaticprotected

Member Data Documentation

◆ gameboardPose_UWRLD

Pose TiltFive.TrackableCore< TSettings, TState >.gameboardPose_UWRLD
protected

The pose of the gameboard reference frame w.r.t. the Unity world-space reference frame.

◆ isConnected

bool TiltFive.TrackableCore< TSettings, TState >.isConnected = false
protected

◆ isTracked

bool TiltFive.TrackableCore< TSettings, TState >.isTracked = false
protected

◆ pose_USTAGE

Pose TiltFive.TrackableCore< TSettings, TState >.pose_USTAGE
protected

◆ pose_UWRLD

Pose TiltFive.TrackableCore< TSettings, TState >.pose_UWRLD
protected

Property Documentation

◆ IsConnected

bool TiltFive.TrackableCore< TSettings, TState >.IsConnected
get

Whether or not the trackable is connected.

◆ IsTracked

bool TiltFive.TrackableCore< TSettings, TState >.IsTracked
get

Whether or not the trackable is being tracked.

◆ Pose_GameboardSpace

Pose TiltFive.TrackableCore< TSettings, TState >.Pose_GameboardSpace
get

The pose of the trackable w.r.t. the gameboard reference frame.

◆ Pose_UnityWorldSpace

Pose TiltFive.TrackableCore< TSettings, TState >.Pose_UnityWorldSpace
get

The Pose of the trackable in Unity world space.

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