XboxController Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Input.UnityInput

Assembly:: Microsoft.MixedReality.Toolkit.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Xbox Controller using Unity Input System

public ref class XboxController : Microsoft::MixedReality::Toolkit::Input::UnityInput::GenericJoystickController

[Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.Xbox, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.None }, "Textures/XboxController", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0)]
public class XboxController : Microsoft.MixedReality.Toolkit.Input.UnityInput.GenericJoystickController

[Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.Xbox, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.None }, "Textures/XboxController", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)]
public class XboxController : Microsoft.MixedReality.Toolkit.Input.UnityInput.GenericJoystickController

[<Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.Xbox, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.None }, "Textures/XboxController", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0)>]
type XboxController = class
    inherit GenericJoystickController

[<Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.Xbox, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.None }, "Textures/XboxController", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)>]
type XboxController = class
    inherit GenericJoystickController

Public Class XboxController
Inherits GenericJoystickController

Inheritance: Object

BaseController

GenericJoystickController
XboxController

Attributes: MixedRealityControllerAttribute

Constructors

XboxController(TrackingState, Handedness, IMixedRealityInputSource, MixedRealityInteractionMapping[])

Constructor.

Fields

CurrentControllerPose	The current pose of this controller. (Inherited from GenericJoystickController)
CurrentControllerPosition	The current position of this controller. (Inherited from GenericJoystickController)
CurrentControllerRotation	The current rotation of this controller. (Inherited from GenericJoystickController)
LastControllerPose	The previous pose of this controller. (Inherited from GenericJoystickController)

Properties

AngularVelocity	(Inherited from BaseController)
ControllerHandedness	The designated hand that the Input Source is managing, as defined by the SDK / Unity. (Inherited from BaseController)
DefaultInteractions	Default interactions for Xbox Controller using Unity Input System.
DefaultInteractions	The default interactions for this controller. (Inherited from GenericJoystickController)
DefaultLeftHandedInteractions	The default left-handed interactions for this controller. (Inherited from GenericJoystickController)
DefaultRightHandedInteractions	The default right-handed interactions for this controller. (Inherited from GenericJoystickController)
Definition	Represents the archetypal definition of what this controller supports and can perform. (Inherited from BaseController)
Enabled	Is the controller enabled? (Inherited from BaseController)
InputSource	The registered Input Source for this controller (Inherited from BaseController)
Interactions	Mapping definition for this controller, linking the Physical inputs to logical Input System Actions (Inherited from BaseController)
IsInPointingPose	Some controllers such as articulated should only be able to invoke pointing/distant interactions in certain poses. (Inherited from BaseController)
IsPositionApproximate	Indicates the accuracy of the position data being reported. (Inherited from BaseController)
IsPositionAvailable	Indicates that this controller is currently providing position data. (Inherited from BaseController)
IsRotationAvailable	Indicates that this controller is currently providing rotation data. (Inherited from BaseController)
LeftHandedLegacyInputSupport	(Inherited from GenericJoystickController)
LegacyInputSupport	System.Object.LegacyInputSupport
LegacyInputSupport	(Inherited from GenericJoystickController)
PointerOffsetAngle	The pointer's offset angle. (Inherited from GenericJoystickController)
RightHandedLegacyInputSupport	(Inherited from GenericJoystickController)
TrackingState	Outputs the current state of the Input Source, whether it is tracked or not. As defined by the SDK / Unity. (Inherited from BaseController)
Velocity	(Inherited from BaseController)
Visualizer	(Inherited from BaseController)

Methods

AssignControllerMappings(MixedRealityInteractionMapping[])	Load the Interaction mappings for this controller from the configured Controller Mapping profile (Inherited from BaseController)
SetupConfiguration(Type, InputSourceType)	Obsolete. Sets up the configuration based on the Mixed Reality Controller Mapping Profile. (Inherited from BaseController)
SetupConfiguration(Type)	Obsolete. Sets up the configuration based on the Mixed Reality Controller Mapping Profile. (Inherited from BaseController)
SetupDefaultInteractions()	Assign the default interactions based on this controller's handedness, if necessary. (Inherited from BaseController)
SetupDefaultInteractions(Handedness)	Obsolete. Assign the default interactions based on controller handedness, if necessary. (Inherited from BaseController)
TryAddControllerModelToSceneHierarchy(GameObject)	(Inherited from BaseController)
TryRenderControllerModel(Type, InputSourceType)	Try to render a controller model for this controller from the visualization profile. (Inherited from BaseController)
UpdateButtonData(MixedRealityInteractionMapping)	Update an Interaction Bool data type from a Bool input (Inherited from GenericJoystickController)
UpdateController()	Update the controller data from Unity's Input Manager (Inherited from GenericJoystickController)
UpdateDualAxisData(MixedRealityInteractionMapping)	Update the Touchpad / Thumbstick input from the device (in OpenVR, touchpad and thumbstick are the same input control) (Inherited from GenericJoystickController)
UpdatePoseData(MixedRealityInteractionMapping)	Update Spatial Pointer Data. (Inherited from GenericJoystickController)
UpdateSingleAxisData(MixedRealityInteractionMapping)	Update an Interaction Float data type from a SingleAxis (float) input (Inherited from GenericJoystickController)

Applies to

Share via