SpatialInteractionController SpatialInteractionController SpatialInteractionController SpatialInteractionController Class

Definition

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

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents the specifics of a motion controller.

public : sealed class SpatialInteractionController : ISpatialInteractionControllerpublic sealed class SpatialInteractionController : ISpatialInteractionControllerPublic NotInheritable Class SpatialInteractionController Implements ISpatialInteractionController// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Properties

HasThumbstick HasThumbstick HasThumbstick HasThumbstick

Gets whether the motion controller has a thumbstick.

public : PlatForm::Boolean HasThumbstick { get; }public bool HasThumbstick { get; }Public ReadOnly Property HasThumbstick As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Whether the controller has a thumbstick.

HasTouchpad HasTouchpad HasTouchpad HasTouchpad

Gets whether the motion controller has a touchpad.

public : PlatForm::Boolean HasTouchpad { get; }public bool HasTouchpad { get; }Public ReadOnly Property HasTouchpad As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Whether the controller has a touchpad.

ProductId ProductId ProductId ProductId

Gets the product identifier for this motion controller.

public : ushort ProductId { get; }public ushort ProductId { get; }Public ReadOnly Property ProductId As ushort// You can use this property in JavaScript.
Value
ushort ushort ushort ushort

The product identifier.

Remarks

The VendorId, ProductId and Version properties can be used together to identify a particular controller design. This can then be used on occluded Mixed Reality headsets to choose a matching render model to display in the user's surroundings.

SimpleHapticsController SimpleHapticsController SimpleHapticsController SimpleHapticsController

Provides access to the motion controller's ability to vibrate in the user's hand.

public : SimpleHapticsController SimpleHapticsController { get; }public SimpleHapticsController SimpleHapticsController { get; }Public ReadOnly Property SimpleHapticsController As SimpleHapticsController// You can use this property in JavaScript.

Remarks

If this motion controller supports haptics, this property returns a SimpleHapticsController object that provides access to the controller's vibration functionality. Otherwise, this property returns null.

VendorId VendorId VendorId VendorId

Gets the vendor identifier for this motion controller.

public : ushort VendorId { get; }public ushort VendorId { get; }Public ReadOnly Property VendorId As ushort// You can use this property in JavaScript.
Value
ushort ushort ushort ushort

The vendor identifier.

Remarks

The VendorId, ProductId and Version properties can be used together to identify a particular controller design. This can then be used on occluded Mixed Reality headsets to choose a matching render model to display in the user's surroundings.

Version Version Version Version

Gets the version, or revision, number for this motion controller.

public : ushort Version { get; }public ushort Version { get; }Public ReadOnly Property Version As ushort// You can use this property in JavaScript.
Value
ushort ushort ushort ushort

The version number.

Remarks

The VendorId, ProductId and Version properties can be used together to identify a particular controller design. This can then be used on occluded Mixed Reality headsets to choose a matching render model to display in the user's surroundings.

Methods

TryGetRenderableModelAsync() TryGetRenderableModelAsync() TryGetRenderableModelAsync() TryGetRenderableModelAsync()

Prerelease. Gets a renderable model stream for this controller, which can be unpacked and rendered to represent this controller.

public : IAsyncOperation<IRandomAccessStreamWithContentType> TryGetRenderableModelAsync()public IAsyncOperation<IRandomAccessStreamWithContentType> TryGetRenderableModelAsync()Public Function TryGetRenderableModelAsync() As IAsyncOperation( Of IRandomAccessStreamWithContentType )// You can use this method in JavaScript.
Returns
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

The model stream is returned as a glTF 2.0 Core binary file. Apps may articulate the model to match the motion of the controller's component parts by updating the transforms of the nodes in the model's internal hierarchy.