MouseController Class
Definition
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.
Manages the mouse using unity input system.
public ref class MouseController : Microsoft::MixedReality::Toolkit::Input::BaseController
[Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.Mouse, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Any }, "", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0)]
public class MouseController : Microsoft.MixedReality.Toolkit.Input.BaseController
[Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.Mouse, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Any }, "", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)]
public class MouseController : Microsoft.MixedReality.Toolkit.Input.BaseController
[<Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.Mouse, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Any }, "", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0)>]
type MouseController = class
inherit BaseController
[<Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.Mouse, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Any }, "", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)>]
type MouseController = class
inherit BaseController
Public Class MouseController
Inherits BaseController
- Inheritance
- Attributes
Constructors
MouseController(TrackingState, Handedness, IMixedRealityInputSource, MixedRealityInteractionMapping[]) |
Constructor. |
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. |
DefaultLeftHandedInteractions |
The default left-handed interactions for this controller. (Inherited from BaseController) |
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, 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) |
Update() |
Update controller. |