Interface

ISimulatorVirtualReality

USI.Core

Simulator-neutral virtual-reality presentation and input state.

public interface ISimulatorVirtualReality

Events

public event EventHandler<SimulatorVirtualRealityChangedEventArgs> ActiveChanged

Raised when the provider explicitly reports entry to or exit from virtual-reality presentation.

public Task<USIResult<Boolean>> TryGetActiveAsync()

Gets whether the simulator is currently presenting in virtual reality.

public Task<USIResult<Boolean>> TryGetGroundTeleportActiveAsync()

Gets whether the user is teleporting on the ground outside the aircraft.

public Task<USIResult<Boolean>> TryGetHandTrackingEnabledAsync()

Gets whether hand tracking is enabled.

public Task<USIResult<Boolean>> TryGetLeftHandTrackedAsync()

Gets whether the user's left hand is currently tracked.

public Task<USIResult<Boolean>> TryGetMarkerDetectedAsync()

Gets whether the provider currently has a valid tracked marker pose.

public Task<USIResult<Boolean>> TryGetMarkerTrackingEnabledAsync()

Gets whether mixed-reality marker tracking is enabled and supported.

public Task<USIResult<Boolean>> TryGetMarkerVisibleAsync()

Gets whether the mixed-reality alignment marker is visible.

public Task<USIResult<VirtualRealityMixedRealityMode>> TryGetMixedRealityModeAsync()

Gets the current mixed-reality passthrough mode.

public Task<USIResult<Boolean>> TryGetMotionControllersActiveAsync()

Gets whether motion controllers are currently in use.

public Task<USIResult<Boolean>> TryGetRightHandTrackedAsync()

Gets whether the user's right hand is currently tracked.

public Task<USIResult<Boolean>> TryGetThreeDimensionalMouseActiveAsync()

Gets whether the simulator's three-dimensional VR mouse is in use.

public Task<USIResult> TryResetViewAsync()

Requests a reset of the provider's virtual-reality view.

public Task<USIResult> TrySetActiveAsync(bool active)

Explicitly enables or disables virtual-reality presentation.

public Task<USIResult> TrySetHandTrackingEnabledAsync(bool enabled)

Explicitly enables or disables hand tracking.

public Task<USIResult> TrySetMarkerTrackingEnabledAsync(bool enabled)

Explicitly enables or disables mixed-reality marker tracking.

public Task<USIResult> TrySetMarkerVisibleAsync(bool visible)

Explicitly shows or hides the mixed-reality alignment marker.

public Task<USIResult> TrySetMixedRealityModeAsync(VirtualRealityMixedRealityMode mode)

Explicitly selects the mixed-reality passthrough mode.

public Task<USIResult> TrySetQuickZoomHeldAsync(bool held)

Holds or releases the provider's momentary virtual-reality quick-zoom control for this SDK connection.