Interface IMixedRealityController

Mixed Reality Toolkit controller definition, used to manage a specific controller type

Namespace: Microsoft.MixedReality.Toolkit.Input

Assembly: cs.temp.dll.dll

Syntax

public interface IMixedRealityController

Properties

AngularVelocity

Declaration

Vector3 AngularVelocity { get; }

Property Value

Type	Description
Vector3

AngularVelocity

Declaration

Vector3 AngularVelocity { get; }

Property Value

Type	Description
Vector3

ControllerHandedness

The designated hand that the Input Source is managing, as defined by the SDK / Unity.

Declaration

Handedness ControllerHandedness { get; }

Property Value

Type	Description
Handedness

ControllerHandedness

The designated hand that the Input Source is managing, as defined by the SDK / Unity.

Declaration

Handedness ControllerHandedness { get; }

Property Value

Type	Description
Handedness

Enabled

Is the controller enabled?

Declaration

bool Enabled { get; set; }

Property Value

Type	Description
Boolean

Enabled

Is the controller enabled?

Declaration

bool Enabled { get; set; }

Property Value

Type	Description
Boolean

InputSource

The registered Input Source for this controller

Declaration

IMixedRealityInputSource InputSource { get; }

Property Value

Type	Description
IMixedRealityInputSource

InputSource

The registered Input Source for this controller

Declaration

IMixedRealityInputSource InputSource { get; }

Property Value

Type	Description
IMixedRealityInputSource

Interactions

Mapping definition for this controller, linking the Physical inputs to logical Input System Actions

Declaration

MixedRealityInteractionMapping[] Interactions { get; }

Property Value

Type	Description
MixedRealityInteractionMapping[]

Interactions

Mapping definition for this controller, linking the Physical inputs to logical Input System Actions

Declaration

MixedRealityInteractionMapping[] Interactions { get; }

Property Value

Type	Description
MixedRealityInteractionMapping[]

IsInPointingPose

Some controllers such as articulated should only be able to invoke pointing/distant interactions in certain poses.

Declaration

bool IsInPointingPose { get; }

Property Value

Type	Description
Boolean

IsInPointingPose

Some controllers such as articulated should only be able to invoke pointing/distant interactions in certain poses.

Declaration

bool IsInPointingPose { get; }

Property Value

Type	Description
Boolean

IsPositionApproximate

Indicates the accuracy of the position data being reported.

Declaration

bool IsPositionApproximate { get; }

Property Value

Type	Description
Boolean

IsPositionApproximate

Indicates the accuracy of the position data being reported.

Declaration

bool IsPositionApproximate { get; }

Property Value

Type	Description
Boolean

IsPositionAvailable

Indicates that this controller is currently providing position data.

Declaration

bool IsPositionAvailable { get; }

Property Value

Type	Description
Boolean

Remarks

This value may change during usage for some controllers. As a best practice, be sure to check this value before using position data.

IsPositionAvailable

Indicates that this controller is currently providing position data.

Declaration

bool IsPositionAvailable { get; }

Property Value

Type	Description
Boolean

Remarks

This value may change during usage for some controllers. As a best practice, be sure to check this value before using position data.

IsRotationAvailable

Indicates that this controller is currently providing rotation data.

Declaration

bool IsRotationAvailable { get; }

Property Value

Type	Description
Boolean

Remarks

This value may change during usage for some controllers. As a best practice, be sure to check this value before using rotation data.

IsRotationAvailable

Indicates that this controller is currently providing rotation data.

Declaration

bool IsRotationAvailable { get; }

Property Value

Type	Description
Boolean

Remarks

This value may change during usage for some controllers. As a best practice, be sure to check this value before using rotation data.

TrackingState

Outputs the current state of the Input Source, whether it is tracked or not. As defined by the SDK / Unity.

Declaration

TrackingState TrackingState { get; }

Property Value

Type	Description
TrackingState

TrackingState

Outputs the current state of the Input Source, whether it is tracked or not. As defined by the SDK / Unity.

Declaration

TrackingState TrackingState { get; }

Property Value

Type	Description
TrackingState

Velocity

Declaration

Vector3 Velocity { get; }

Property Value

Type	Description
Vector3

Velocity

Declaration

Vector3 Velocity { get; }

Property Value

Type	Description
Vector3

Visualizer

The controller's "Visual" Component in the scene.

Declaration

IMixedRealityControllerVisualizer Visualizer { get; }

Property Value

Type	Description
IMixedRealityControllerVisualizer

Visualizer

The controller's "Visual" Component in the scene.

Declaration

IMixedRealityControllerVisualizer Visualizer { get; }

Property Value

Type	Description
IMixedRealityControllerVisualizer