The Wand API and runtime. More...

Inheritance diagram for TiltFive.Wand:

Classes
class	WaitUntilWandConnected
	Suspends coroutine execution until the provided player's wand has connected. More...

Static Public Member Functions
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.
static bool	TrySendImpulse (float amplitude, float duration, PlayerIndex playerIndex=PlayerIndex.One, ControllerIndex controllerIndex=ControllerIndex.Right)
	Try to send a haptics impulse to the specified wand.
static void	Update (WandSettings wandSettings, ScaleSettings scaleSettings, GameBoardSettings gameBoardSettings, PlayerIndex playerIndex=PlayerIndex.One)
static void	ScanForWands ()

Additional Inherited Members
Protected Member Functions inherited from TiltFive.Singleton< T >
	Singleton ()
Properties inherited from TiltFive.Singleton< T >
static T	Instance `[get]`

Detailed Description

The Wand API and runtime.

Definition at line 55 of file Wand.cs.

Member Function Documentation

◆ GetPosition()

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

inlinestatic

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 159 of file Wand.cs.

◆ GetRotation()

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

inlinestatic

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 190 of file Wand.cs.

◆ IsTracked()

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

inlinestatic

Definition at line 202 of file Wand.cs.

◆ ScanForWands()

void TiltFive.Wand.ScanForWands ( )

inlinestatic

Definition at line 312 of file Wand.cs.

◆ TryCheckConnected()

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

inlinestatic

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 221 of file Wand.cs.

◆ TrySendImpulse()

bool TiltFive.Wand.TrySendImpulse	(	float	amplitude,
		float	duration,
		PlayerIndex	playerIndex = PlayerIndex::One,
		ControllerIndex	controllerIndex = ControllerIndex::Right )

inlinestatic

Try to send a haptics impulse to the specified wand.

Parameters

amplitude	The amplitude of the impulse, between [0.0,1.0].
duration	The duration of the impulse, between 0.0 and 0.320 s.
playerIndex
controllerIndex

Returns: Returns false if something went wrong while attempting to send the impulse command

Definition at line 268 of file Wand.cs.

◆ Update()

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

inlinestatic

Definition at line 306 of file Wand.cs.

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

C:/Users/mail1/Documents/t5sw/sdk/unity/unity_package/Runtime/Player/Wand/Wand.cs

Classes

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetPosition()

◆ GetRotation()

◆ IsTracked()

◆ ScanForWands()

◆ TryCheckConnected()

◆ TrySendImpulse()

◆ Update()