GenericXRSDKController Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.XRSDK.Input

Assembly:: Microsoft.MixedReality.Toolkit.Providers.XRSDK.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.

public ref class GenericXRSDKController : Microsoft::MixedReality::Toolkit::Input::BaseController

public ref class GenericXRSDKController : Microsoft::MixedReality::Toolkit::Input::BaseController, Microsoft::MixedReality::Toolkit::Input::IMixedRealityHapticFeedback

[Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.GenericUnity, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Left, Microsoft.MixedReality.Toolkit.Utilities.Handedness.Right }, "", Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags.UseCustomInteractionMappings)]
public class GenericXRSDKController : Microsoft.MixedReality.Toolkit.Input.BaseController

[Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.GenericUnity, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Left, Microsoft.MixedReality.Toolkit.Utilities.Handedness.Right }, "", Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags.UseCustomInteractionMappings, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)]
public class GenericXRSDKController : Microsoft.MixedReality.Toolkit.Input.BaseController, Microsoft.MixedReality.Toolkit.Input.IMixedRealityHapticFeedback

[<Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.GenericUnity, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Left, Microsoft.MixedReality.Toolkit.Utilities.Handedness.Right }, "", Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags.UseCustomInteractionMappings)>]
type GenericXRSDKController = class
    inherit BaseController

[<Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.GenericUnity, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Left, Microsoft.MixedReality.Toolkit.Utilities.Handedness.Right }, "", Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags.UseCustomInteractionMappings, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)>]
type GenericXRSDKController = class
    inherit BaseController
    interface IMixedRealityHapticFeedback

Public Class GenericXRSDKController
Inherits BaseController

Public Class GenericXRSDKController
Inherits BaseController
Implements IMixedRealityHapticFeedback

Inheritance: Object

BaseController
GenericXRSDKController

Derived: Microsoft.MixedReality.Toolkit.XRSDK.Oculus.Input.OculusXRSDKTouchController

Microsoft.MixedReality.Toolkit.XRSDK.OpenXR.HPReverbG2Controller

Microsoft.MixedReality.Toolkit.XRSDK.OpenXR.MicrosoftArticulatedHand

Microsoft.MixedReality.Toolkit.XRSDK.OpenXR.MicrosoftMotionController

Microsoft.MixedReality.Toolkit.XRSDK.OpenXR.OculusController

More…

Attributes: MixedRealityControllerAttribute

Implements: IMixedRealityHapticFeedback

Constructors

GenericXRSDKController(TrackingState, Handedness, IMixedRealityInputSource, MixedRealityInteractionMapping[])
GenericXRSDKController(TrackingState, Handedness, IMixedRealityInputSource, MixedRealityInteractionMapping[], IMixedRealityInputSourceDefinition)

Fields

CurrentControllerPose	The current pose of this XR SDK controller.
CurrentControllerPosition	The current position of this XR SDK controller.
CurrentControllerRotation	The current rotation of this XR SDK controller.
LastControllerPose	The previous pose of this XR SDK controller.

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	The default interactions for this controller. (Inherited from BaseController)
DefaultLeftHandedInteractions	The default left-handed interactions for this controller.
DefaultLeftHandedInteractions	The default left-handed interactions for this controller. (Inherited from BaseController)
DefaultRightHandedInteractions	The default right-handed interactions for this controller.
DefaultRightHandedInteractions	The default right-handed interactions for this controller. (Inherited from BaseController)
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)
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)	Obsolete. Sets up the configuration based on the Mixed Reality 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)
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)
StartHapticImpulse(Single, Single)	Start haptic feedback by the input device.
StopHapticFeedback()	Terminates haptic feedback by the input device.
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, InputDevice)	Update an interaction bool data type from a bool input
UpdateController(InputDevice)	Update the controller data from XR SDK.
UpdateDualAxisData(MixedRealityInteractionMapping, InputDevice)	Update the touchpad / thumbstick input from the device
UpdatePoseData(MixedRealityInteractionMapping, InputDevice)	Update spatial grip data.
UpdateSingleAxisData(MixedRealityInteractionMapping, InputDevice)	Update an interaction float data type from a SingleAxis (float) input
UpdateSixDofData(InputDevice)
UpdateSourceData(InputDevice)	Update the source input from the device.
UpdateVelocity(InputDevice)

Applies to