The Wand API and runtime. More...

Inheritance diagram for TiltFive.Wand:

Classes
class	WandCore
	Internal Wand core runtime. More...

struct	WandPair

Static Public Member Functions
static void	Update (WandSettings wandSettings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings, PlayerIndex playerIndex=PlayerIndex.One)

static void	ScanForWands ()

static Vector3	GetPosition (ControllerIndex controllerIndex=ControllerIndex.Right, ControllerPosition controllerPosition=ControllerPosition.Grip, PlayerIndex playerIndex=PlayerIndex.One)
	Gets the position of the wand in world space.

static Quaternion	GetRotation (ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Gets the rotation of the wand in world space.

static bool	IsTracked (ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)

static bool	TryCheckConnected (out bool connected, PlayerIndex playerIndex, ControllerIndex controllerIndex=ControllerIndex.Right)
	Gets the connection status of the indicated wand.

Private Member Functions
WandCore	ObtainWandCore (GlassesHandle glassesHandle, ControllerIndex controllerIndex)

Static Private Member Functions
static bool	TryScanForWands ()

static bool	TryGetWandAvailability (out bool connected, GlassesHandle glassesHandle, ControllerIndex controllerIndex)

Private Attributes
Dictionary< GlassesHandle, WandPair >	wandCores = new Dictionary<GlassesHandle, WandPair>()
	The collection of WandCores. GlassesHandles are mapped to pairs of right/left WandCores.

HashSet< GlassesHandle >	incomingHandles = new HashSet<GlassesHandle>()

HashSet< GlassesHandle >	lostHandles = new HashSet<GlassesHandle>()

HashSet< WandCore >	lostWands = new HashSet<WandCore>()

Static Private Attributes
static readonly Vector3	DEFAULT_WAND_POSITION_GAME_BOARD_SPACE = new Vector3(0f, 0.25f, -0.25f)
	The default position of the wand relative to the board.

static readonly Vector3	DEFAULT_WAND_HANDEDNESS_OFFSET_GAME_BOARD_SPACE = new Vector3(0.125f, 0f, 0f)
	A left/right offset to the default wand position, depending on handedness.

static readonly Quaternion	DEFAULT_WAND_ROTATION_GAME_BOARD_SPACE = Quaternion.Euler(new Vector3(-33f, 0f, 0f))
	The default rotation of the wand relative to the board.

static DateTime	lastScanAttempt = System.DateTime.MinValue

static readonly double	wandScanRate = 0.5d

static bool	wandAvailabilityErroredOnce = false

static int	currentFrame = -1

Additional Inherited Members
Protected Member Functions inherited from TiltFive.Singleton< Wand >
	Singleton ()

Properties inherited from TiltFive.Singleton< Wand >
static T	Instance `[get]`

Detailed Description

The Wand API and runtime.

Definition at line 55 of file Wand.cs.

Member Function Documentation

◆ GetPosition()

static Vector3 TiltFive.Wand.GetPosition	(	ControllerIndex	controllerIndex = `ControllerIndex::Right`,
		ControllerPosition	controllerPosition = `ControllerPosition::Grip`,
		PlayerIndex	playerIndex = `PlayerIndex::One`
	)

static

Gets the position of the wand in world space.

Parameters

controllerIndex
controllerPosition
glassesHandle	The specified glasses. If null is provided, this uses the default glasses.

Returns: If the indicated wand is not connected, this returns the zero vector.

Definition at line 304 of file Wand.cs.

        {
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle)
                || !Instance.wandCores.TryGetValue(glassesHandle, out var wandPair)
                || !wandPair.TryGet(controllerIndex, out var wandCore))
            {
                return Vector3.zero;
            }
 
            switch (controllerPosition)
            {
                case ControllerPosition.Fingertips:
                    return wandCore.fingertipsPose_UnityWorldSpace.position;
                case ControllerPosition.Aim:
                    return wandCore.aimPose_UnityWorldSpace.position;
                case ControllerPosition.Grip:
                    return wandCore.Pose_UnityWorldSpace.position;
                default:
                    return Vector3.zero;
            }
        }

References TiltFive.Singleton< Wand >.Instance.

◆ GetRotation()

static Quaternion TiltFive.Wand.GetRotation	(	ControllerIndex	controllerIndex = `ControllerIndex::Right`,
		PlayerIndex	playerIndex = `PlayerIndex::One`
	)

static

Gets the rotation of the wand in world space.

Parameters

controllerIndex
glassesHandle	The specified glasses. If null is provided, this uses the default glasses.

Returns: If the indicated wand is not connected, this returns the identity quaternion.

Definition at line 335 of file Wand.cs.

        {
            if (!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle)
                || !Instance.wandCores.TryGetValue(glassesHandle, out var wandPair)
                || !wandPair.TryGet(controllerIndex, out var wandCore))
            {
                return Quaternion.identity;
            }
 
            return wandCore.Pose_UnityWorldSpace.rotation;
        }

References TiltFive.Singleton< Wand >.Instance.

◆ IsTracked()

static bool TiltFive.Wand.IsTracked	(	ControllerIndex	controllerIndex = `ControllerIndex::Right`,
		PlayerIndex	playerIndex = `PlayerIndex::One`
	)

static

Definition at line 347 of file Wand.cs.

        {
            if (!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle)
                || !Instance.wandCores.TryGetValue(glassesHandle, out var wandPair)
                || !wandPair.TryGet(controllerIndex, out var wandCore))
            {
                return false;
            }
 
            return wandCore.IsTracked;
        }

References TiltFive.Singleton< Wand >.Instance.

◆ ObtainWandCore()

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

private

Definition at line 604 of file Wand.cs.

        {
            WandCore wandCore = null;
            var glassesAlreadyMonitored = wandCores.TryGetValue(glassesHandle, out var wandPair);
 
            // Ask the native plugin whether this wand is currently connected.
            if (TryGetWandAvailability(out var wandConnected, glassesHandle, controllerIndex) && wandConnected)
            {
                // If we're not already monitoring this wand, go ahead and create a corresponding WandCore.
                if (!glassesAlreadyMonitored || !wandPair.TryGet(controllerIndex, out wandCore))
                {
#if UNITY_2019_1_OR_NEWER && INPUTSYSTEM_AVAILABLE
                    wandCore = new WandDeviceCore(glassesHandle, controllerIndex);
#else
                    wandCore = new WandCore(glassesHandle, controllerIndex);
#endif
                }
                return wandCore;
            }
            // If this wand is disconnected and we were previously monitoring it, mark it as disconnected
            else if(glassesAlreadyMonitored && wandPair.TryGet(controllerIndex, out var lostWandCore))
            {
                lostWands.Add(lostWandCore);
            }
 
            return wandCore;
        }

References TiltFive.Wand.lostWands, TiltFive.Wand.TryGetWandAvailability(), and TiltFive.Wand.wandCores.

◆ ScanForWands()

static void TiltFive.Wand.ScanForWands ( )

static

Definition at line 204 of file Wand.cs.

        {
            // Tell the native plugin to search for wands.
            TryScanForWands();
 
            // Obtain the latest set of connected glasses
            var connectedGlassesHandles = Glasses.GetAllConnectedGlassesHandles();
 
            // Add/Remove entries from the wandCores dictionary depending on which glasses appeared/disappeared
            // ---------------------------------------------------
            var wandCores = Instance.wandCores;
            var incomingHandles = Instance.incomingHandles;
            var lostHandles = Instance.lostHandles;
            var lostWands = Instance.lostWands;
 
            incomingHandles.Clear();
            lostHandles.Clear();
            lostWands.Clear();
 
            // Add newly connected wands
            for (int i = 0; i < connectedGlassesHandles.Length; i++)
            {
                var glassesHandle = connectedGlassesHandles[i];
                incomingHandles.Add(glassesHandle);
 
                var rightWandCore = Instance.ObtainWandCore(glassesHandle, ControllerIndex.Right);
                var leftWandCore = Instance.ObtainWandCore(glassesHandle, ControllerIndex.Left);
 
                // Obtain and store a pair of WandCores to associate with this GlassesHandle.
                // If either wand is unavailable, we'll just store null.
                // This will also clear any WandCores that represented a now-disconnected wand.
                wandCores[glassesHandle] = new WandPair(rightWandCore, leftWandCore);
            }
 
            // Prune disconnected wands
            foreach(var glassesHandle in wandCores.Keys)
            {
                // If a pair of glasses disconnects, save its handle for the next foreach loop below
                if(!incomingHandles.Contains(glassesHandle))
                {
                    lostHandles.Add(glassesHandle);
                }
                // otherwise, check if its wands are still connected.
                else
                {
                    if(wandCores.TryGetValue(glassesHandle, out var wandPair))
                    {
                        if(wandPair.TryGet(ControllerIndex.Left, out var leftWandCore)
                            && (!TryGetWandAvailability(out bool leftWandConnected, glassesHandle, ControllerIndex.Left) || !leftWandConnected))
                        {
                            lostWands.Add(leftWandCore);
                        }
                        if (wandPair.TryGet(ControllerIndex.Right, out var rightWandCore)
                            && (!TryGetWandAvailability(out bool rightWandConnected, glassesHandle, ControllerIndex.Right) || !rightWandConnected))
                        {
                            lostWands.Add(rightWandCore);
                        }
                    }
                }
            }
 
            foreach(var lostHandle in lostHandles)
            {
                var lostWandPair = wandCores[lostHandle];
 
                if (lostWandPair.TryGet(ControllerIndex.Right, out var lostRightWand))
                {
                    lostWands.Add(lostRightWand);
                }
 
                if (lostWandPair.TryGet(ControllerIndex.Left, out var lostLeftWand))
                {
                    lostWands.Add(lostLeftWand);
                }
                wandCores.Remove(lostHandle);
            }
 
            foreach (var lostWand in lostWands)
            {
                lostWand.Dispose();
            }
        }

References TiltFive.Wand.incomingHandles, TiltFive.Singleton< Wand >.Instance, TiltFive.Wand.lostHandles, TiltFive.Wand.lostWands, TiltFive.Wand.TryGetWandAvailability(), TiltFive.Wand.TryScanForWands(), and TiltFive.Wand.wandCores.

Referenced by TiltFive.Input.Input().

◆ TryCheckConnected()

static bool TiltFive.Wand.TryCheckConnected	(	out bool	connected,
		PlayerIndex	playerIndex,
		ControllerIndex	controllerIndex = `ControllerIndex::Right`
	)

static

Gets the connection status of the indicated wand.

Parameters

connected
playerIndex
controllerIndex

Returns: Returns false if something went wrong while attempting to check wand connectivity.

Definition at line 366 of file Wand.cs.

        {
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle)
                || !Instance.wandCores.TryGetValue(glassesHandle, out var wandPair)
                || !wandPair.TryGet(controllerIndex, out var wandCore))
            {
                connected = false;
                return false;
            }
 
            connected = wandCore.IsConnected;
            return true;
        }

References TiltFive.Singleton< Wand >.Instance.

Referenced by TiltFive.Input.GetWandAvailability().

◆ TryGetWandAvailability()

static bool TiltFive.Wand.TryGetWandAvailability	(	out bool	connected,
		GlassesHandle	glassesHandle,
		ControllerIndex	controllerIndex
	)

staticprivate

Definition at line 395 of file Wand.cs.

        {
            if (!wandAvailabilityErroredOnce)
            {
                try
                {
                    T5_Bool wandAvailable = false;
                    int result = NativePlugin.GetWandAvailability(glassesHandle, ref wandAvailable, controllerIndex);
 
                    if (result == 0)
                    {
                        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;
                }
            }
 
            connected = false;
            return false;
        }

References TiltFive.Logging.Log.Error(), TiltFive.NativePlugin.GetWandAvailability(), TiltFive.Logging.Log.Info(), and TiltFive.Wand.wandAvailabilityErroredOnce.

Referenced by TiltFive.Wand.ObtainWandCore(), and TiltFive.Wand.ScanForWands().

◆ TryScanForWands()

static bool TiltFive.Wand.TryScanForWands ( )

staticprivate

Definition at line 170 of file Wand.cs.

        {
            var currentTime = System.DateTime.Now;
            var timeSinceLastScan = currentTime - lastScanAttempt;
 
            // Scan for wands if necessary.
            // TODO: Implement more robust disconnect detection, communicate wand availability events to users, offer user option to swap wands.
            if (timeSinceLastScan.TotalSeconds >= wandScanRate
                && (!Input.GetWandAvailability(ControllerIndex.Right) || !Input.GetWandAvailability(ControllerIndex.Left)))
            {
                int result = 1;
 
                try
                {
                    result = NativePlugin.ScanForWands();
                }
                catch (System.DllNotFoundException e)
                {
                    Log.Info(
                        "Could not connect to Tilt Five plugin to scan for wands: {0}",
                        e);
                }
                catch (Exception e)
                {
                    Log.Error(e.Message);
                }
 
                lastScanAttempt = currentTime;
                return (0 == result);
            }
 
            return false;
        }

References TiltFive.Logging.Log.Error(), TiltFive.Input.GetWandAvailability(), TiltFive.Logging.Log.Info(), TiltFive.Wand.lastScanAttempt, TiltFive.NativePlugin.ScanForWands(), and TiltFive.Wand.wandScanRate.

Referenced by TiltFive.Wand.ScanForWands().

◆ Update()

static void TiltFive.Wand.Update	(	WandSettings	wandSettings,
		ScaleSettings	scaleSettings,
		GameBoardSettings	gameBoardSettings,
		PlayerIndex	playerIndex = `PlayerIndex::One`
	)

static

Definition at line 152 of file Wand.cs.

        {
            // Update the relevant WandCore
            if (Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                Update(glassesHandle, wandSettings, scaleSettings, gameBoardSettings);
            }
        }

References TiltFive.Wand.Update().

Referenced by TiltFive.TiltFiveManager.GetLatestPoseData(), TiltFive.Player.PlayerCore.GetLatestPoseData(), and TiltFive.Wand.Update().

Member Data Documentation

◆ currentFrame

int TiltFive.Wand.currentFrame = -1

staticprivate

Definition at line 104 of file Wand.cs.

◆ DEFAULT_WAND_HANDEDNESS_OFFSET_GAME_BOARD_SPACE

readonly Vector3 TiltFive.Wand.DEFAULT_WAND_HANDEDNESS_OFFSET_GAME_BOARD_SPACE = new Vector3(0.125f, 0f, 0f)

staticprivate

A left/right offset to the default wand position, depending on handedness.

Definition at line 74 of file Wand.cs.

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

◆ DEFAULT_WAND_POSITION_GAME_BOARD_SPACE

readonly Vector3 TiltFive.Wand.DEFAULT_WAND_POSITION_GAME_BOARD_SPACE = new Vector3(0f, 0.25f, -0.25f)

staticprivate

The default position of the wand relative to the board.

The wand GameObject will snap back to this position if the glasses and/or wand are unavailable.

Definition at line 70 of file Wand.cs.

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

◆ DEFAULT_WAND_ROTATION_GAME_BOARD_SPACE

readonly Quaternion TiltFive.Wand.DEFAULT_WAND_ROTATION_GAME_BOARD_SPACE = Quaternion.Euler(new Vector3(-33f, 0f, 0f))

staticprivate

The default rotation of the wand relative to the board.

The wand GameObject will snap back to this rotation if the glasses are unavailable. If different behavior is desired in this scenario, a different camera should be used.

Definition at line 83 of file Wand.cs.

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

◆ incomingHandles

HashSet<GlassesHandle> TiltFive.Wand.incomingHandles = new HashSet<GlassesHandle>()

private

Definition at line 87 of file Wand.cs.

Referenced by TiltFive.Wand.ScanForWands().

◆ lastScanAttempt

DateTime TiltFive.Wand.lastScanAttempt = System.DateTime.MinValue

staticprivate

Definition at line 95 of file Wand.cs.

Referenced by TiltFive.Wand.TryScanForWands().

◆ lostHandles

HashSet<GlassesHandle> TiltFive.Wand.lostHandles = new HashSet<GlassesHandle>()

private

Definition at line 89 of file Wand.cs.

Referenced by TiltFive.Wand.ScanForWands().

◆ lostWands

HashSet<WandCore> TiltFive.Wand.lostWands = new HashSet<WandCore>()

private

Definition at line 91 of file Wand.cs.

Referenced by TiltFive.Wand.ObtainWandCore(), and TiltFive.Wand.ScanForWands().

◆ wandAvailabilityErroredOnce

bool TiltFive.Wand.wandAvailabilityErroredOnce = false

staticprivate

Definition at line 100 of file Wand.cs.

Referenced by TiltFive.Wand.WandCore.TryCheckConnected(), and TiltFive.Wand.TryGetWandAvailability().

◆ wandCores

Dictionary<GlassesHandle, WandPair> TiltFive.Wand.wandCores = new Dictionary<GlassesHandle, WandPair>()

private

The collection of WandCores. GlassesHandles are mapped to pairs of right/left WandCores.

Definition at line 62 of file Wand.cs.

Referenced by TiltFive.Wand.ObtainWandCore(), and TiltFive.Wand.ScanForWands().

◆ wandScanRate

readonly double TiltFive.Wand.wandScanRate = 0.5d

staticprivate

Definition at line 98 of file Wand.cs.

Referenced by TiltFive.Wand.TryScanForWands().

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

Wand.cs

Classes

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetPosition()

◆ GetRotation()

◆ IsTracked()

◆ ObtainWandCore()

◆ ScanForWands()

◆ TryCheckConnected()

◆ TryGetWandAvailability()

◆ TryScanForWands()

◆ Update()

Member Data Documentation

◆ currentFrame

◆ DEFAULT_WAND_HANDEDNESS_OFFSET_GAME_BOARD_SPACE

◆ DEFAULT_WAND_POSITION_GAME_BOARD_SPACE

◆ DEFAULT_WAND_ROTATION_GAME_BOARD_SPACE

◆ incomingHandles

◆ lastScanAttempt

◆ lostHandles

◆ lostWands

◆ wandAvailabilityErroredOnce

◆ wandCores

◆ wandScanRate