Class XRControllerState

Represents the current state of the XRBaseController.

Inheritance

object

XRControllerState

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Interaction.Toolkit

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[Serializable]
public class XRControllerState

Constructors

XRControllerState()

Initializes and returns an instance of XRControllerState.

Declaration

public XRControllerState()

XRControllerState(double, Vector3, Quaternion, InputTrackingState, bool)

Initializes and returns an instance of XRControllerState.

Declaration

protected XRControllerState(double time, Vector3 position, Quaternion rotation, InputTrackingState inputTrackingState, bool isTracked)

Parameters

Type	Name	Description
double	time	The time value for this controller.
Vector3	position	The position for this controller.
Quaternion	rotation	The rotation for this controller.
InputTrackingState	inputTrackingState	The inputTrackingState for this controller.
bool	isTracked	Whether the controller is tracked this frame.

XRControllerState(double, Vector3, Quaternion, InputTrackingState, bool, bool, bool, bool)

Initializes and returns an instance of XRControllerState.

Declaration

public XRControllerState(double time, Vector3 position, Quaternion rotation, InputTrackingState inputTrackingState, bool isTracked, bool selectActive, bool activateActive, bool pressActive)

Parameters

Type	Name	Description
double	time	The time value for this controller.
Vector3	position	The position for this controller.
Quaternion	rotation	The rotation for this controller.
InputTrackingState	inputTrackingState	The inputTrackingState for this controller.
bool	isTracked	Whether the controller is tracked this frame.
bool	selectActive	Whether select is active or not.
bool	activateActive	Whether activate is active or not.
bool	pressActive	Whether UI press is active or not.

XRControllerState(double, Vector3, Quaternion, InputTrackingState, bool, bool, bool, bool, float, float, float)

Initializes and returns an instance of XRControllerState.

Declaration

public XRControllerState(double time, Vector3 position, Quaternion rotation, InputTrackingState inputTrackingState, bool isTracked, bool selectActive, bool activateActive, bool pressActive, float selectValue, float activateValue, float pressValue)

Parameters

Type	Name	Description
double	time	The time value for this controller.
Vector3	position	The position for this controller.
Quaternion	rotation	The rotation for this controller.
InputTrackingState	inputTrackingState	The inputTrackingState for this controller.
bool	isTracked	Whether the controller is tracked this frame.
bool	selectActive	Whether select is active or not.
bool	activateActive	Whether activate is active or not.
bool	pressActive	Whether UI press is active or not.
float	selectValue	The select value.
float	activateValue	The activate value.
float	pressValue	The UI press value.

XRControllerState(XRControllerState)

Initializes and returns an instance of XRControllerState.

Declaration

public XRControllerState(XRControllerState value)

Parameters

Type	Name	Description
XRControllerState	value	The XRControllerState object used to create this object.

Fields

activateInteractionState

The activate interaction state.

Declaration

public InteractionState activateInteractionState

Field Value

Type	Description
InteractionState

inputTrackingState

The input tracking state of the controller.

Declaration

public InputTrackingState inputTrackingState

Field Value

Type	Description
InputTrackingState

isTracked

Whether the controller is actively tracked.

Declaration

public bool isTracked

Field Value

Type	Description
bool

position

The position of the controller.

Declaration

public Vector3 position

Field Value

Type	Description
Vector3

rotation

The rotation of the controller.

Declaration

public Quaternion rotation

Field Value

Type	Description
Quaternion

selectInteractionState

The selection interaction state.

Declaration

public InteractionState selectInteractionState

Field Value

Type	Description
InteractionState

time

The time value for this controller.

Declaration

public double time

Field Value

Type	Description
double

uiPressInteractionState

The UI press interaction state.

Declaration

public InteractionState uiPressInteractionState

Field Value

Type	Description
InteractionState

uiScrollValue

The UI scroll value.

Declaration

public Vector2 uiScrollValue

Field Value

Type	Description
Vector2

Methods

ResetFrameDependentStates()

Resets all the interaction states that are based on whether they occurred "this frame".

Declaration

public void ResetFrameDependentStates()

See Also

ResetFrameDependent()

ToString()

Converts state data to a string.

Declaration

public override string ToString()

Returns

Type	Description
string	A string representation.

Overrides

object.ToString()