Internal Wand core runtime. More...

Inheritance diagram for TiltFive.Wand.WandCore:

Public Member Functions
	WandCore (GlassesHandle glassesHandle, ControllerIndex controllerIndex)

virtual void	GetLatestInputs ()

bool	GetButton (WandButton button)

bool	TryGetButton (WandButton button, out bool pressed)

bool	GetButtonDown (WandButton button)

bool	TryGetButtonDown (WandButton button, out bool buttonDown)

bool	GetButtonUp (WandButton button)

bool	TryGetButtonUp (WandButton button, out bool buttonUp)

Vector2	GetStickTilt ()

bool	TryGetStickTilt (out Vector2 stickTilt)

float	GetTrigger ()

bool	TryGetTrigger (out float triggerDisplacement)

new void	Reset (WandSettings wandSettings)

virtual new void	Update (WandSettings wandSettings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings)

virtual void	Dispose ()

Public Attributes
readonly GlassesHandle	glassesHandle

readonly ControllerIndex	controllerIndex

Pose	fingertipsPose_GameboardSpace = new Pose(DEFAULT_WAND_POSITION_GAME_BOARD_SPACE, Quaternion.identity)

Pose	aimPose_GameboardSpace = new Pose(DEFAULT_WAND_POSITION_GAME_BOARD_SPACE, Quaternion.identity)

Pose	fingertipsPose_UnityWorldSpace

Pose	aimPose_UnityWorldSpace

Protected Member Functions
override void	SetDefaultPoseGameboardSpace (WandSettings settings)

override void	SetPoseUnityWorldSpace (ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings)
	Sets the pose values of the tracked object in Unity World Space.

override bool	TryCheckConnected (out bool connected)
	Determines whether the tracked object is still connected.

override bool	TryGetStateFromPlugin (out T5_ControllerState controllerState, out bool poseIsValid, GameBoardSettings gameBoardSettings)

override void	SetPoseGameboardSpace (in T5_ControllerState controllerState, WandSettings wandSettings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

override void	SetInvalidPoseGameboardSpace (in T5_ControllerState t5_ControllerState, WandSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
	Handle setting the wand pose when we know the controller state isn't valid.

override void	SetDrivenObjectTransform (WandSettings wandSettings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings)

Quaternion	CalculateRotation (Quaternion rotToWND_GBD)

void	ProcessTrackingData (Vector3 gripPosition_UGBD, Vector3 fingertipsPosition_UGBD, Vector3 aimPosition_UGBD, Quaternion rotToUGBD_WND, WandSettings wandSettings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings, out Pose gripPose_UGBD, out Pose fingertipsPose_UGBD, out Pose aimPose_UGBD)

Pose	FilterTrackingPointPose (Pose staleGripPointPose, Pose staleTrackingPointPose, Pose newTrackingPointPose, float trackingPointOffsetDistance, WandSettings settings)

Protected Member Functions inherited from TiltFive.TrackableCore< WandSettings, T5_ControllerState >
void	Reset (TSettings settings)

virtual void	Update (TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

abstract void	SetDefaultPoseGameboardSpace (TSettings settings)
	Gets the default pose of the tracked object.

abstract void	SetPoseGameboardSpace (in TState state, TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
	Sets the pose values of the tracked object in Unity World Space.

abstract 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.

abstract void	SetPoseUnityWorldSpace (ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
	Sets the pose values of the tracked object in Unity World Space.

abstract bool	TryCheckConnected (out bool connected)
	Determines whether the tracked object is still connected.

abstract bool	TryGetStateFromPlugin (out TState state, out bool poseIsValid, GameBoardSettings gameboardSettings)
	Gets the latest pose for the tracked object from the native plugin.

abstract void	SetDrivenObjectTransform (TSettings settings, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)
	Sets the pose of the object(s) being driven by TrackableCore.

Static Protected Member Functions
static Pose	GetDefaultPoseGameboardSpace (WandSettings settings)

Static Protected Member Functions inherited from TiltFive.TrackableCore< WandSettings, T5_ControllerState >
static Vector3	ConvertPosGBDToUGBD (Vector3 pos_GBD)

static Pose	GameboardToWorldSpace (Pose pose_GameboardSpace, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

static Vector3	GameboardToWorldSpace (Vector3 pos_UGBD, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

static Quaternion	GameboardToWorldSpace (Quaternion rotToUGBD_OBJ, GameBoardSettings gameboardSettings)

static Vector3	WorldToGameboardSpace (Vector3 pos_UWRLD, ScaleSettings scaleSettings, GameBoardSettings gameboardSettings)

static Quaternion	WorldToGameboardSpace (Quaternion rotToUWRLD_OBJ, GameBoardSettings gameboardSettings)

Protected Attributes
T5_ControllerState?	currentState

T5_ControllerState?	previousState

Protected Attributes inherited from TiltFive.TrackableCore< WandSettings, T5_ControllerState >
Pose	pose_UGBD

Pose	pose_UWRLD

bool	isTracked

bool	isConnected

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

Properties
Pose	gripPose_UnityWorldSpace `[get]`

Properties inherited from TiltFive.TrackableCore< WandSettings, T5_ControllerState >
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.

Detailed Description

Internal Wand core runtime.

Definition at line 640 of file Wand.cs.

Constructor & Destructor Documentation

◆ WandCore()

TiltFive.Wand.WandCore.WandCore	(	GlassesHandle	glassesHandle,
		ControllerIndex	controllerIndex
	)

Definition at line 662 of file Wand.cs.

            {
                this.glassesHandle = glassesHandle;
                this.controllerIndex = controllerIndex;
 
                Glasses.TryGetFriendlyName(glassesHandle, out var friendlyName);
                Log.Info($"Glasses {glassesHandle} (\"{friendlyName}\") {Enum.GetName(typeof(ControllerIndex), controllerIndex)} Wand connected");
            }

References TiltFive.Wand.WandCore.controllerIndex, TiltFive.Wand.WandCore.glassesHandle, TiltFive.Logging.Log.Info(), and TiltFive.Glasses.TryGetFriendlyName().

Member Function Documentation

◆ CalculateRotation()

Quaternion TiltFive.Wand.WandCore.CalculateRotation ( Quaternion rotToWND_GBD )

protected

Definition at line 944 of file Wand.cs.

            {
                Quaternion rotToDW_GBD = Quaternion.AngleAxis(90f, Vector3.right);
                Quaternion rotToGBD_DW = Quaternion.Inverse(rotToDW_GBD);
                Quaternion rotToWND_DW = rotToWND_GBD * rotToGBD_DW;
                Quaternion rotToUGBD_UWND = new Quaternion(rotToWND_DW.x, -rotToWND_DW.y, rotToWND_DW.z, rotToWND_DW.w);
                return rotToUGBD_UWND;
            }

Referenced by TiltFive.Wand.WandCore.SetPoseGameboardSpace().

◆ Dispose()

virtual void TiltFive.Wand.WandCore.Dispose ( )

virtual

Definition at line 934 of file Wand.cs.

            {
                Log.Info($"Glasses {glassesHandle} {controllerIndex} Wand disconnected");
            }

References TiltFive.Logging.Log.Info().

◆ FilterTrackingPointPose()

Pose TiltFive.Wand.WandCore.FilterTrackingPointPose	(	Pose	staleGripPointPose,
		Pose	staleTrackingPointPose,
		Pose	newTrackingPointPose,
		float	trackingPointOffsetDistance,
		WandSettings	settings
	)

protected

Definition at line 985 of file Wand.cs.

            {
                if (!isTracked && settings.RejectUntrackedPositionData)
                {
                    switch (settings.FailureMode)
                    {
                        default:
                        // If we have an undefined FailureMode for some reason, fall through to FreezePosition
                        case TrackableSettings.TrackingFailureMode.FreezePosition:
                            // We need to determine where to put each tracking point.
                            // We only want to freeze the position of the grip point while allowing the other
                            // points to rotate around it, colinear to the grip point's forward vector.
                            var extrapolatedPosition = staleGripPointPose.position +
                                Quaternion.Inverse(newTrackingPointPose.rotation) * Vector3.forward * trackingPointOffsetDistance;
                            return new Pose(extrapolatedPosition, newTrackingPointPose.rotation);
                        case TrackableSettings.TrackingFailureMode.FreezePositionAndRotation:
                            return staleTrackingPointPose;
                        case TrackableSettings.TrackingFailureMode.SnapToDefault:
                            return GetDefaultPoseGameboardSpace(settings);
                    }
                }
                else
                {
                    return newTrackingPointPose;
                }
            }

References TiltFive.TrackableSettings.FailureMode, TiltFive.Wand.WandCore.GetDefaultPoseGameboardSpace(), TiltFive.TrackableCore< WandSettings, T5_ControllerState >.isTracked, and TiltFive.TrackableSettings.RejectUntrackedPositionData.

Referenced by TiltFive.Wand.WandCore.ProcessTrackingData().

◆ GetButton()

bool TiltFive.Wand.WandCore.GetButton ( WandButton button )

Definition at line 692 of file Wand.cs.

            {
                // If the wand isn't connected, GetButton() should return a default value of false.
                return currentState?.GetButton(button) ?? false;
            }

References TiltFive.Wand.WandCore.currentState.

◆ GetButtonDown()

bool TiltFive.Wand.WandCore.GetButtonDown ( WandButton button )

Definition at line 706 of file Wand.cs.

            {
 
                // If the current wand state is null, the wand isn't connected.
                // If so, let the application assume the user isn't pressing the button currently.
                var pressed = currentState?.GetButton(button) ?? false;
 
                // If the previous wand state is null, the wand wasn't connected.
                // If so, let the application assume the user wasn't pressing the button last frame.
                var previouslyPressed = previousState?.GetButton(button) ?? false;
 
                // The wand could potentially connect while the user is holding a button, so just report the button state.
                if (!previousState.HasValue && currentState.HasValue)
                {
                    return pressed;
                }
                // Return true if the button is currently pressed, but was unpressed on the previous frame.
                return pressed && !previouslyPressed;
            }

References TiltFive.Wand.WandCore.currentState, and TiltFive.Wand.WandCore.previousState.

Referenced by TiltFive.Wand.WandCore.TryGetButtonDown().

◆ GetButtonUp()

bool TiltFive.Wand.WandCore.GetButtonUp ( WandButton button )

Definition at line 733 of file Wand.cs.

            {
                // If the current wand state is null, the wand isn't connected.
                // If so, let the application assume the user isn't pressing the button currently.
                var pressed = currentState?.GetButton(button) ?? false;
 
                // If the previous wand state is null, the wand wasn't connected.
                // If so, let the application assume the user wasn't pressing the button last frame.
                var previouslyPressed = previousState?.GetButton(button) ?? false;
 
                // Return true if the button is currently released, but was pressed on the previous frame.
                return previousState.HasValue
                    ? !pressed && previouslyPressed
                    // If the current state exists but the previous state was null, the wand has just connected.
                    // There's no way for the button to be pressed during the previous frame,
                    // so there's no way for the button to have been released this frame. Always return false.
                    : false;
            }

References TiltFive.Wand.WandCore.currentState, and TiltFive.Wand.WandCore.previousState.

Referenced by TiltFive.Wand.WandCore.TryGetButtonUp().

◆ GetDefaultPoseGameboardSpace()

static Pose TiltFive.Wand.WandCore.GetDefaultPoseGameboardSpace ( WandSettings settings )

staticprotected

Definition at line 810 of file Wand.cs.

            {
                Vector3 defaultPosition = DEFAULT_WAND_POSITION_GAME_BOARD_SPACE;
 
                defaultPosition += DEFAULT_WAND_HANDEDNESS_OFFSET_GAME_BOARD_SPACE
                    * (settings.controllerIndex == ControllerIndex.Right ? 1f : -1f);
                return new Pose(defaultPosition, DEFAULT_WAND_ROTATION_GAME_BOARD_SPACE);
            }

References TiltFive.Wand.DEFAULT_WAND_HANDEDNESS_OFFSET_GAME_BOARD_SPACE, TiltFive.Wand.DEFAULT_WAND_POSITION_GAME_BOARD_SPACE, and TiltFive.Wand.DEFAULT_WAND_ROTATION_GAME_BOARD_SPACE.

Referenced by TiltFive.Wand.WandCore.FilterTrackingPointPose(), and TiltFive.Wand.WandCore.SetDefaultPoseGameboardSpace().

◆ GetLatestInputs()

virtual void TiltFive.Wand.WandCore.GetLatestInputs ( )

virtual

Definition at line 671 of file Wand.cs.

            {
                previousState = currentState;
 
                try
                {
                    T5_ControllerState state = new T5_ControllerState();
 
                    var result = NativePlugin.GetControllerState(glassesHandle, controllerIndex, ref state);
 
                    currentState = (result == 0)
                        ? state
                        : (T5_ControllerState?)null;
                }
                catch (Exception e)
                {
                    currentState = null;
                    Log.Error(e.Message);
                }
            }

References TiltFive.Wand.WandCore.controllerIndex, TiltFive.Wand.WandCore.currentState, TiltFive.Logging.Log.Error(), TiltFive.NativePlugin.GetControllerState(), TiltFive.Wand.WandCore.glassesHandle, and TiltFive.Wand.WandCore.previousState.

◆ GetStickTilt()

Vector2 TiltFive.Wand.WandCore.GetStickTilt ( )

Definition at line 759 of file Wand.cs.

            {
                return currentState?.Stick ?? Vector2.zero;
            }

References TiltFive.Wand.WandCore.currentState, and TiltFive.T5_ControllerState.Stick.

Referenced by TiltFive.Wand.WandCore.TryGetStickTilt().

◆ GetTrigger()

float TiltFive.Wand.WandCore.GetTrigger ( )

Definition at line 770 of file Wand.cs.

            {
                return currentState?.Trigger ?? 0.0f;
            }

References TiltFive.Wand.WandCore.currentState, and TiltFive.T5_ControllerState.Trigger.

Referenced by TiltFive.Wand.WandCore.TryGetTrigger().

◆ ProcessTrackingData()

void TiltFive.Wand.WandCore.ProcessTrackingData	(	Vector3	gripPosition_UGBD,
		Vector3	fingertipsPosition_UGBD,
		Vector3	aimPosition_UGBD,
		Quaternion	rotToUGBD_WND,
		WandSettings	wandSettings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameBoardSettings,
		out Pose	gripPose_UGBD,
		out Pose	fingertipsPose_UGBD,
		out Pose	aimPose_UGBD
	)

protected

Definition at line 953 of file Wand.cs.

            {
                var incomingGripPose_UGBD = new Pose(gripPosition_UGBD, rotToUGBD_WND);
                var incomingFingertipsPose_UGBD = new Pose(fingertipsPosition_UGBD, rotToUGBD_WND);
                var incomingAimPose_UGBD = new Pose(aimPosition_UGBD, rotToUGBD_WND);
 
                // Get the distance between the tracking points and the grip point.
                // Currently, when a pose is considered invalid, the position and rotation reported by the native plugin are completely zero'd out.
                // This crunches the tracking points together unless we consider the stale positions from the previous frame.
                // It also means that we don't get the desired behavior for TrackingFailureMode.FreezePosition,
                // in which the wand position freezes while still showing rotation values reported by the IMU.
                // TODO: In the native plugin, even for invalid poses (both wand and glasses, which are also affected),
                // include an offset for the tracking points, and pass through rotation data.
                var staleGripPose_UGBD = pose_UGBD;
                var staleFingertipsPose_UGBD = fingertipsPose_GameboardSpace;
                var staleAimPose_UGBD = aimPose_GameboardSpace;
 
                var gripPointOffsetDistance = 0f;
                var fingertipsPointOffsetDistance = Mathf.Max((fingertipsPosition_UGBD - gripPosition_UGBD).magnitude,
                    (staleFingertipsPose_UGBD.position - staleGripPose_UGBD.position).magnitude);
                var aimPointOffsetDistance = Mathf.Max((aimPosition_UGBD - gripPosition_UGBD).magnitude,
                    (staleAimPose_UGBD.position - staleGripPose_UGBD.position).magnitude);
 
                // Handle invalid poses
                gripPose_UGBD = FilterTrackingPointPose(staleGripPose_UGBD, staleGripPose_UGBD, incomingGripPose_UGBD, gripPointOffsetDistance, wandSettings);
                fingertipsPose_UGBD = FilterTrackingPointPose(staleGripPose_UGBD, staleFingertipsPose_UGBD, incomingFingertipsPose_UGBD, fingertipsPointOffsetDistance, wandSettings);
                aimPose_UGBD = FilterTrackingPointPose(staleGripPose_UGBD, staleAimPose_UGBD, incomingAimPose_UGBD, aimPointOffsetDistance, wandSettings);
 
            }

References TiltFive.Wand.WandCore.aimPose_GameboardSpace, TiltFive.Wand.WandCore.FilterTrackingPointPose(), TiltFive.Wand.WandCore.fingertipsPose_GameboardSpace, and TiltFive.TrackableCore< WandSettings, T5_ControllerState >.pose_UGBD.

Referenced by TiltFive.Wand.WandCore.SetPoseGameboardSpace().

◆ Reset()

new void TiltFive.Wand.WandCore.Reset ( WandSettings wandSettings )

Definition at line 786 of file Wand.cs.

            {
                base.Reset(wandSettings);
            }

◆ SetDefaultPoseGameboardSpace()

override void TiltFive.Wand.WandCore.SetDefaultPoseGameboardSpace ( WandSettings settings )

protected

Definition at line 802 of file Wand.cs.

            {
                pose_UGBD = GetDefaultPoseGameboardSpace(settings);
                // We don't have a good offset that we can use for default fingertips/aim poses, so just use the default pose for everything
                fingertipsPose_GameboardSpace = pose_UGBD;
                aimPose_GameboardSpace = pose_UGBD;
            }

References TiltFive.Wand.WandCore.aimPose_GameboardSpace, TiltFive.Wand.WandCore.fingertipsPose_GameboardSpace, TiltFive.Wand.WandCore.GetDefaultPoseGameboardSpace(), and TiltFive.TrackableCore< WandSettings, T5_ControllerState >.pose_UGBD.

◆ SetDrivenObjectTransform()

override void TiltFive.Wand.WandCore.SetDrivenObjectTransform	(	WandSettings	wandSettings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameBoardSettings
	)

protected

Definition at line 916 of file Wand.cs.

            {
                if (wandSettings.GripPoint != null)
                {
                    wandSettings.GripPoint.transform.SetPositionAndRotation(gripPose_UnityWorldSpace.position, gripPose_UnityWorldSpace.rotation);
                }
 
                if (wandSettings.FingertipPoint != null)
                {
                    wandSettings.FingertipPoint.transform.SetPositionAndRotation(fingertipsPose_UnityWorldSpace.position, fingertipsPose_UnityWorldSpace.rotation);
                }
 
                if (wandSettings.AimPoint != null)
                {
                    wandSettings.AimPoint.transform.SetPositionAndRotation(aimPose_UnityWorldSpace.position, aimPose_UnityWorldSpace.rotation);
                }
            }

References TiltFive.WandSettings.AimPoint, TiltFive.Wand.WandCore.aimPose_UnityWorldSpace, TiltFive.WandSettings.FingertipPoint, TiltFive.Wand.WandCore.fingertipsPose_UnityWorldSpace, TiltFive.WandSettings.GripPoint, and TiltFive.Wand.WandCore.gripPose_UnityWorldSpace.

◆ SetInvalidPoseGameboardSpace()

override void TiltFive.Wand.WandCore.SetInvalidPoseGameboardSpace	(	in T5_ControllerState	t5_ControllerState,
		WandSettings	settings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

protected

Handle setting the wand pose when we know the controller state isn't valid.

Parameters

t5_ControllerState	The invalid state. It can still be useful if we want to use its rotation values.
settings
scaleSettings
gameboardSettings

Definition at line 911 of file Wand.cs.

            {
                SetPoseGameboardSpace(t5_ControllerState, settings, scaleSettings, gameboardSettings);
            }

References TiltFive.Wand.WandCore.SetPoseGameboardSpace().

◆ SetPoseGameboardSpace()

override void TiltFive.Wand.WandCore.SetPoseGameboardSpace	(	in T5_ControllerState	controllerState,
		WandSettings	wandSettings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

protected

Definition at line 877 of file Wand.cs.

            {
                // Unity reference frames:
                //
                // UWND        - Unity WaND local space.
                //               +x right, +y up, +z forward
                // UGBD        - Unity Gameboard space.
                //               +x right, +y up, +z forward
                //
                // Tilt Five reference frames:
                //
                // DW          - Our right-handed version of Unity's default wand space.
                //               +x right, +y down, +z forward
                // GBD         - Gameboard space.
                //               +x right, +y forward, +z up
 
                Vector3 gripPosition_UGBD = ConvertPosGBDToUGBD(controllerState.GripPos_GBD);
                Vector3 fingertipsPosition_UGBD = ConvertPosGBDToUGBD(controllerState.FingertipsPos_GBD);
                Vector3 aimPosition_UGBD = ConvertPosGBDToUGBD(controllerState.AimPos_GBD);
                var rotation_UGBD = CalculateRotation(controllerState.RotToWND_GBD);
 
                ProcessTrackingData(gripPosition_UGBD, fingertipsPosition_UGBD, aimPosition_UGBD,
                    rotation_UGBD, wandSettings, scaleSettings, gameboardSettings,
                    out pose_UGBD, out fingertipsPose_GameboardSpace, out aimPose_GameboardSpace);
            }

References TiltFive.Wand.WandCore.aimPose_GameboardSpace, TiltFive.Wand.WandCore.CalculateRotation(), TiltFive.TrackableCore< WandSettings, T5_ControllerState >.ConvertPosGBDToUGBD(), TiltFive.Wand.WandCore.fingertipsPose_GameboardSpace, TiltFive.TrackableCore< WandSettings, T5_ControllerState >.pose_UGBD, and TiltFive.Wand.WandCore.ProcessTrackingData().

Referenced by TiltFive.Wand.WandCore.SetInvalidPoseGameboardSpace().

◆ SetPoseUnityWorldSpace()

override void TiltFive.Wand.WandCore.SetPoseUnityWorldSpace	(	ScaleSettings	scaleSettings,
		GameBoardSettings	gameboardSettings
	)

protectedvirtual

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

Parameters

scaleSettings
gameboardSettings

Implements TiltFive.TrackableCore< WandSettings, T5_ControllerState >.

Definition at line 819 of file Wand.cs.

            {
                pose_UWRLD = GameboardToWorldSpace(pose_UGBD, scaleSettings, gameBoardSettings);
                fingertipsPose_UnityWorldSpace = GameboardToWorldSpace(fingertipsPose_GameboardSpace, scaleSettings, gameBoardSettings);
                aimPose_UnityWorldSpace = GameboardToWorldSpace(aimPose_GameboardSpace, scaleSettings, gameBoardSettings);
            }

References TiltFive.Wand.WandCore.aimPose_GameboardSpace, TiltFive.Wand.WandCore.aimPose_UnityWorldSpace, TiltFive.Wand.WandCore.fingertipsPose_GameboardSpace, TiltFive.Wand.WandCore.fingertipsPose_UnityWorldSpace, TiltFive.TrackableCore< WandSettings, T5_ControllerState >.GameboardToWorldSpace(), TiltFive.TrackableCore< WandSettings, T5_ControllerState >.pose_UGBD, and TiltFive.TrackableCore< WandSettings, T5_ControllerState >.pose_UWRLD.

◆ TryCheckConnected()

override bool TiltFive.Wand.WandCore.TryCheckConnected ( out bool connected )

protectedvirtual

Determines whether the tracked object is still connected.

Parameters

connected

Returns

Implements TiltFive.TrackableCore< WandSettings, T5_ControllerState >.

Definition at line 826 of file Wand.cs.

            {
                if (!wandAvailabilityErroredOnce)
                {
                    try
                    {
                        T5_Bool wandAvailable = false;
                        int result = NativePlugin.GetWandAvailability(glassesHandle, ref wandAvailable, controllerIndex);
 
                        if (result == 0)
                        {
                            isConnected = wandAvailable;
                            connected = wandAvailable;
                            return true;
                        }
                    }
                    catch (DllNotFoundException e)
                    {
                        Log.Info("Could not connect to Tilt Five plugin for wand: {0}", e.Message);
                        wandAvailabilityErroredOnce = true;
                    }
                    catch (Exception e)
                    {
                        Log.Error(
                            "Failed to connect to Tilt Five plugin for wand availability: {0}",
                            e.ToString());
                        wandAvailabilityErroredOnce = true;
                    }
                }
 
                isConnected = false;
                connected = false;
                return false;
            }

References TiltFive.Wand.WandCore.controllerIndex, TiltFive.Logging.Log.Error(), TiltFive.NativePlugin.GetWandAvailability(), TiltFive.Wand.WandCore.glassesHandle, TiltFive.Logging.Log.Info(), TiltFive.TrackableCore< WandSettings, T5_ControllerState >.isConnected, and TiltFive.Wand.wandAvailabilityErroredOnce.

◆ TryGetButton()

bool TiltFive.Wand.WandCore.TryGetButton	(	WandButton	button,
		out bool	pressed
	)

Definition at line 698 of file Wand.cs.

            {
                pressed = currentState?.GetButton(button) ?? false;
 
                // If the wand isn't connected, TryGetButton() should fail.
                return currentState.HasValue;
            }

References TiltFive.Wand.WandCore.currentState.

◆ TryGetButtonDown()

bool TiltFive.Wand.WandCore.TryGetButtonDown	(	WandButton	button,
		out bool	buttonDown
	)

Definition at line 726 of file Wand.cs.

            {
                // Even if this operation fails, give buttonDown a default value.
                buttonDown = GetButtonDown(button);
                return currentState.HasValue;
            }

References TiltFive.Wand.WandCore.currentState, and TiltFive.Wand.WandCore.GetButtonDown().

◆ TryGetButtonUp()

bool TiltFive.Wand.WandCore.TryGetButtonUp	(	WandButton	button,
		out bool	buttonUp
	)

Definition at line 752 of file Wand.cs.

            {
                // Even if this operation fails, give buttonUp a default value.
                buttonUp = GetButtonUp(button);
                return currentState.HasValue;
            }

References TiltFive.Wand.WandCore.currentState, and TiltFive.Wand.WandCore.GetButtonUp().

◆ TryGetStateFromPlugin()

override bool TiltFive.Wand.WandCore.TryGetStateFromPlugin	(	out T5_ControllerState	controllerState,
		out bool	poseIsValid,
		GameBoardSettings	gameBoardSettings
	)

protected

Definition at line 861 of file Wand.cs.

            {
                if (!TryGetWandControlsState(glassesHandle, out var controllerStateResult, controllerIndex))
                {
                    poseIsValid = false;
                    controllerState = new T5_ControllerState();
 
                    return false;
                }
 
                controllerState = controllerStateResult.Value;
                poseIsValid = Glasses.IsTracked(glassesHandle) && controllerState.PoseValid;
 
                return true;
            }

References TiltFive.Wand.WandCore.controllerIndex, TiltFive.Wand.WandCore.glassesHandle, and TiltFive.Glasses.IsTracked().

◆ TryGetStickTilt()

bool TiltFive.Wand.WandCore.TryGetStickTilt ( out Vector2 stickTilt )

Definition at line 764 of file Wand.cs.

            {
                stickTilt = GetStickTilt();
                return currentState.HasValue;
            }

References TiltFive.Wand.WandCore.currentState, and TiltFive.Wand.WandCore.GetStickTilt().

◆ TryGetTrigger()

bool TiltFive.Wand.WandCore.TryGetTrigger ( out float triggerDisplacement )

Definition at line 775 of file Wand.cs.

            {
                triggerDisplacement = GetTrigger();
                return currentState.HasValue;
            }

References TiltFive.Wand.WandCore.currentState, and TiltFive.Wand.WandCore.GetTrigger().

◆ Update()

virtual new void TiltFive.Wand.WandCore.Update	(	WandSettings	wandSettings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameBoardSettings
	)

virtual

Definition at line 791 of file Wand.cs.

            {
                if (wandSettings == null)
                {
                    Log.Error("WandSettings configuration required for Wand tracking updates.");
                    return;
                }
 
                base.Update(wandSettings, scaleSettings, gameBoardSettings);
            }

References TiltFive.Logging.Log.Error().

Member Data Documentation

◆ aimPose_GameboardSpace

Pose TiltFive.Wand.WandCore.aimPose_GameboardSpace = new Pose(DEFAULT_WAND_POSITION_GAME_BOARD_SPACE, Quaternion.identity)

Definition at line 648 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.ProcessTrackingData(), TiltFive.Wand.WandCore.SetDefaultPoseGameboardSpace(), TiltFive.Wand.WandCore.SetPoseGameboardSpace(), and TiltFive.Wand.WandCore.SetPoseUnityWorldSpace().

◆ aimPose_UnityWorldSpace

Pose TiltFive.Wand.WandCore.aimPose_UnityWorldSpace

Definition at line 652 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.SetDrivenObjectTransform(), and TiltFive.Wand.WandCore.SetPoseUnityWorldSpace().

◆ controllerIndex

readonly ControllerIndex TiltFive.Wand.WandCore.controllerIndex

Definition at line 645 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.GetLatestInputs(), TiltFive.Wand.WandCore.TryCheckConnected(), TiltFive.Wand.WandCore.TryGetStateFromPlugin(), and TiltFive.Wand.WandCore.WandCore().

◆ currentState

T5_ControllerState? TiltFive.Wand.WandCore.currentState

protected

Definition at line 654 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.GetButton(), TiltFive.Wand.WandCore.GetButtonDown(), TiltFive.Wand.WandCore.GetButtonUp(), TiltFive.Wand.WandCore.GetLatestInputs(), TiltFive.Wand.WandCore.GetStickTilt(), TiltFive.Wand.WandCore.GetTrigger(), TiltFive.Wand.WandCore.TryGetButton(), TiltFive.Wand.WandCore.TryGetButtonDown(), TiltFive.Wand.WandCore.TryGetButtonUp(), TiltFive.Wand.WandCore.TryGetStickTilt(), and TiltFive.Wand.WandCore.TryGetTrigger().

◆ fingertipsPose_GameboardSpace

Pose TiltFive.Wand.WandCore.fingertipsPose_GameboardSpace = new Pose(DEFAULT_WAND_POSITION_GAME_BOARD_SPACE, Quaternion.identity)

Definition at line 647 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.ProcessTrackingData(), TiltFive.Wand.WandCore.SetDefaultPoseGameboardSpace(), TiltFive.Wand.WandCore.SetPoseGameboardSpace(), and TiltFive.Wand.WandCore.SetPoseUnityWorldSpace().

◆ fingertipsPose_UnityWorldSpace

Pose TiltFive.Wand.WandCore.fingertipsPose_UnityWorldSpace

Definition at line 651 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.SetDrivenObjectTransform(), and TiltFive.Wand.WandCore.SetPoseUnityWorldSpace().

◆ glassesHandle

readonly GlassesHandle TiltFive.Wand.WandCore.glassesHandle

Definition at line 644 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.GetLatestInputs(), TiltFive.Wand.WandCore.TryCheckConnected(), TiltFive.Wand.WandCore.TryGetStateFromPlugin(), and TiltFive.Wand.WandCore.WandCore().

◆ previousState

T5_ControllerState? TiltFive.Wand.WandCore.previousState

protected

Definition at line 655 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.GetButtonDown(), TiltFive.Wand.WandCore.GetButtonUp(), and TiltFive.Wand.WandCore.GetLatestInputs().

Property Documentation

◆ gripPose_UnityWorldSpace

Pose TiltFive.Wand.WandCore.gripPose_UnityWorldSpace

get

Definition at line 650 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.SetDrivenObjectTransform().

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

Wand.cs

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ WandCore()

Member Function Documentation

◆ CalculateRotation()

◆ Dispose()

◆ FilterTrackingPointPose()

◆ GetButton()

◆ GetButtonDown()

◆ GetButtonUp()

◆ GetDefaultPoseGameboardSpace()

◆ GetLatestInputs()

◆ GetStickTilt()

◆ GetTrigger()

◆ ProcessTrackingData()

◆ Reset()

◆ SetDefaultPoseGameboardSpace()

◆ SetDrivenObjectTransform()

◆ SetInvalidPoseGameboardSpace()

◆ SetPoseGameboardSpace()

◆ SetPoseUnityWorldSpace()

◆ TryCheckConnected()

◆ TryGetButton()

◆ TryGetButtonDown()

◆ TryGetButtonUp()

◆ TryGetStateFromPlugin()

◆ TryGetStickTilt()

◆ TryGetTrigger()

◆ Update()

Member Data Documentation

◆ aimPose_GameboardSpace

◆ aimPose_UnityWorldSpace

◆ controllerIndex

◆ currentState

◆ fingertipsPose_GameboardSpace

◆ fingertipsPose_UnityWorldSpace

◆ glassesHandle

◆ previousState

Property Documentation

◆ gripPose_UnityWorldSpace