ISimulatorCamera
USI.Core
Simulator-neutral current-view state and deterministic view actions.
public interface ISimulatorCameraEvents
ViewChanged
public event EventHandler<SimulatorCameraViewChangedEventArgs> ViewChangedRaised when the provider reports a change between its camera-view categories.
Methods
TryAcquireControlAsync
public Task<USIResult<ControlledSimulatorCamera>> TryAcquireControlAsync(ControlledSimulatorCameraPose initialPose, SimulatorCameraControlPersistence persistence = UntilUserChangesView, SimulatorCameraPresentation presentation = External)Acquires an owned simulator camera using a geographic pose. Providers without an equivalent ownership contract return Unsupported.
TryGetCockpitCameraOffsetAsync
public Task<USIResult<SimulatorCockpitCameraOffset>> TryGetCockpitCameraOffsetAsync()Gets the additional in-cockpit camera transform.
TryGetCockpitFieldOfViewDegreesAsync
public Task<USIResult<Double>> TryGetCockpitFieldOfViewDegreesAsync()Gets the in-cockpit camera field of view in degrees.
TryGetCockpitGForceMotionEnabledAsync
public Task<USIResult<Boolean>> TryGetCockpitGForceMotionEnabledAsync()Gets whether cockpit camera motion responds to aircraft G loading.
TryGetCockpitHeadPoseAsync
public Task<USIResult<SimulatorCockpitHeadPose>> TryGetCockpitHeadPoseAsync()Gets the live cockpit eyepoint pose relative to aircraft CG.
TryGetCockpitInteractionRegionsVisibleAsync
public Task<USIResult<Boolean>> TryGetCockpitInteractionRegionsVisibleAsync()Gets whether clickable cockpit interaction regions are visible.
TryGetCockpitMouseWheelZoomEnabledAsync
public Task<USIResult<Boolean>> TryGetCockpitMouseWheelZoomEnabledAsync()Gets whether the mouse wheel changes zoom in cockpit views.
TryGetCockpitViewActiveAsync
public Task<USIResult<Boolean>> TryGetCockpitViewActiveAsync()Gets whether the current simulator view is a cockpit view.
TryGetCockpitViewCrewPositionAsync
public Task<USIResult<SimulatorCockpitViewCrewPosition>> TryGetCockpitViewCrewPositionAsync()Gets the crew position represented by the active cockpit view.
TryGetControlYokeHiddenAsync
public Task<USIResult<Boolean>> TryGetControlYokeHiddenAsync()Gets whether the cockpit control yoke is currently hidden.
TryGetDisplayProjectionHeadingDegreesAsync
public Task<USIResult<Double>> TryGetDisplayProjectionHeadingDegreesAsync()Gets the display projection heading rotation in degrees.
TryGetDisplayProjectionPitchDegreesAsync
public Task<USIResult<Double>> TryGetDisplayProjectionPitchDegreesAsync()Gets the display projection pitch rotation in degrees.
TryGetDisplayProjectionRollDegreesAsync
public Task<USIResult<Double>> TryGetDisplayProjectionRollDegreesAsync()Gets the display projection roll rotation in degrees.
TryGetDomeProjectionHeadingOffsetDegreesAsync
public Task<USIResult<Double>> TryGetDomeProjectionHeadingOffsetDegreesAsync()Gets the dome-projection horizontal offset in degrees.
TryGetDomeProjectionPitchOffsetDegreesAsync
public Task<USIResult<Double>> TryGetDomeProjectionPitchOffsetDegreesAsync()Gets the dome-projection vertical offset in degrees.
TryGetElevationAsync
public Task<USIResult<SimulatorCameraElevation>> TryGetElevationAsync()Gets the current camera elevations when the provider exposes them.
TryGetExternalHandheldMotionEnabledAsync
public Task<USIResult<Boolean>> TryGetExternalHandheldMotionEnabledAsync()Gets whether external views use a handheld-camera motion effect.
TryGetExternalMouseWheelZoomEnabledAsync
public Task<USIResult<Boolean>> TryGetExternalMouseWheelZoomEnabledAsync()Gets whether the mouse wheel changes zoom in external views.
TryGetEyeTrackerHeadTrackingEnabledAsync
public Task<USIResult<Boolean>> TryGetEyeTrackerHeadTrackingEnabledAsync()Gets whether eye-tracker head motion controls the camera.
TryGetHorizontalFieldOfViewDegreesAsync
public Task<USIResult<Double>> TryGetHorizontalFieldOfViewDegreesAsync()Gets the current horizontal field of view in degrees.
TryGetHorizontalFrustumShiftScreenWidthsAsync
public Task<USIResult<Double>> TryGetHorizontalFrustumShiftScreenWidthsAsync()Gets the horizontal projection shift in viewport-width units. A value of one shifts the frustum by one complete viewport width.
TryGetIndependentVerticalFieldOfViewEnabledAsync
public Task<USIResult<Boolean>> TryGetIndependentVerticalFieldOfViewEnabledAsync()Gets whether vertical field of view is independently configured instead of being derived from horizontal field of view and viewport aspect ratio.
TryGetInfraredHeadTrackingEnabledAsync
public Task<USIResult<Boolean>> TryGetInfraredHeadTrackingEnabledAsync()Gets whether an external infrared head tracker controls the camera.
TryGetInstrumentDescriptionsVisibleAsync
public Task<USIResult<Boolean>> TryGetInstrumentDescriptionsVisibleAsync()Gets whether cockpit instrument descriptions are visible.
TryGetNightVisionEnabledAsync
public Task<USIResult<Boolean>> TryGetNightVisionEnabledAsync()Gets whether the simulator's night-vision visual aid is enabled.
TryGetOrientationAsync
public Task<USIResult<SimulatorCameraOrientation>> TryGetOrientationAsync()Gets the current camera orientation when the provider exposes it.
TryGetRedFlashlightSelectedAsync
public Task<USIResult<Boolean>> TryGetRedFlashlightSelectedAsync()Gets whether the red cockpit flashlight is selected.
TryGetSunglassesEnabledAsync
public Task<USIResult<Boolean>> TryGetSunglassesEnabledAsync()Gets whether the simulator's sunglasses visual aid is enabled.
TryGetTwoDimensionalPanelDefaultScrollPositionAsync
public Task<USIResult<SimulatorPanelScrollPositionPixels>> TryGetTwoDimensionalPanelDefaultScrollPositionAsync()Gets the aircraft-authored default scroll position for a two-dimensional cockpit panel.
TryGetTwoDimensionalPanelScrollPositionAsync
public Task<USIResult<SimulatorPanelScrollPositionPixels>> TryGetTwoDimensionalPanelScrollPositionAsync()Gets the current scroll position of a two-dimensional cockpit panel.
TryGetVerticalFieldOfViewDegreesAsync
public Task<USIResult<Double>> TryGetVerticalFieldOfViewDegreesAsync()Gets the current vertical field of view in degrees.
TryGetVerticalFrustumShiftScreenHeightsAsync
public Task<USIResult<Double>> TryGetVerticalFrustumShiftScreenHeightsAsync()Gets the vertical projection shift in viewport-height units. A value of one shifts the frustum by one complete viewport height.
TryGetViewportSizeAsync
public Task<USIResult<SimulatorViewportSizePixels>> TryGetViewportSizeAsync()Gets the current rendering viewport width and height in pixels.
TryGetWhiteFlashlightSelectedAsync
public Task<USIResult<Boolean>> TryGetWhiteFlashlightSelectedAsync()Gets whether the white cockpit flashlight is selected.
TryLookAsync
public Task<USIResult> TryLookAsync(SimulatorCameraLookDirection direction)Looks in a discrete provider-neutral direction.
TryRecallBookmarkAsync
public Task<USIResult> TryRecallBookmarkAsync(SimulatorCameraBookmark bookmark)Recalls a simulator-managed saved view.
TryResetCurrentViewAsync
public Task<USIResult> TryResetCurrentViewAsync()Resets the currently active view to its provider-defined default.
TrySaveCurrentViewToBookmarkAsync
public Task<USIResult> TrySaveCurrentViewToBookmarkAsync(SimulatorCameraBookmark bookmark)Saves the current view into a simulator-managed slot.
TrySelectViewAsync
public Task<USIResult> TrySelectViewAsync(SimulatorCameraViewPreset view)Selects a camera view when the provider offers that preset.
TrySetCockpitCameraOffsetAsync
public Task<USIResult> TrySetCockpitCameraOffsetAsync(SimulatorCockpitCameraOffset offset)Sets the additional in-cockpit camera transform.
TrySetCockpitFieldOfViewDegreesAsync
public Task<USIResult> TrySetCockpitFieldOfViewDegreesAsync(double degrees)Sets the in-cockpit camera field of view in degrees.
TrySetCockpitGForceMotionEnabledAsync
public Task<USIResult> TrySetCockpitGForceMotionEnabledAsync(bool enabled)Enables or disables cockpit camera motion caused by aircraft G loading.
TrySetCockpitHeadPoseAsync
public Task<USIResult> TrySetCockpitHeadPoseAsync(SimulatorCockpitHeadPose pose)Sets the live cockpit eyepoint pose relative to aircraft CG.
TrySetCockpitInteractionRegionsVisibleAsync
public Task<USIResult> TrySetCockpitInteractionRegionsVisibleAsync(bool visible)Shows or hides clickable cockpit interaction regions.
TrySetCockpitMouseWheelZoomEnabledAsync
public Task<USIResult> TrySetCockpitMouseWheelZoomEnabledAsync(bool enabled)Enables or disables mouse-wheel zoom in cockpit views.
TrySetCockpitViewCrewPositionAsync
public Task<USIResult> TrySetCockpitViewCrewPositionAsync(SimulatorCockpitViewCrewPosition position)Selects the flight-deck crew eyepoint for cockpit views.
TrySetControlYokeHiddenAsync
public Task<USIResult> TrySetControlYokeHiddenAsync(bool hidden)Shows or hides the cockpit control yoke.
TrySetDisplayProjectionHeadingDegreesAsync
public Task<USIResult> TrySetDisplayProjectionHeadingDegreesAsync(double degrees)Sets the display projection heading rotation in degrees.
TrySetDisplayProjectionPitchDegreesAsync
public Task<USIResult> TrySetDisplayProjectionPitchDegreesAsync(double degrees)Sets the display projection pitch rotation in degrees.
TrySetDisplayProjectionRollDegreesAsync
public Task<USIResult> TrySetDisplayProjectionRollDegreesAsync(double degrees)Sets the display projection roll rotation in degrees.
TrySetDomeProjectionHeadingOffsetDegreesAsync
public Task<USIResult> TrySetDomeProjectionHeadingOffsetDegreesAsync(double degrees)Sets the dome-projection horizontal offset in degrees.
TrySetDomeProjectionPitchOffsetDegreesAsync
public Task<USIResult> TrySetDomeProjectionPitchOffsetDegreesAsync(double degrees)Sets the dome-projection vertical offset in degrees.
TrySetExternalHandheldMotionEnabledAsync
public Task<USIResult> TrySetExternalHandheldMotionEnabledAsync(bool enabled)Enables or disables the external handheld-camera motion effect.
TrySetExternalMouseWheelZoomEnabledAsync
public Task<USIResult> TrySetExternalMouseWheelZoomEnabledAsync(bool enabled)Enables or disables mouse-wheel zoom in external views.
TrySetEyeTrackerHeadTrackingEnabledAsync
public Task<USIResult> TrySetEyeTrackerHeadTrackingEnabledAsync(bool enabled)Enables or disables eye-tracker head-motion camera control.
TrySetHorizontalFieldOfViewDegreesAsync
public Task<USIResult> TrySetHorizontalFieldOfViewDegreesAsync(double degrees)Sets the current horizontal field of view in degrees.
TrySetHorizontalFrustumShiftScreenWidthsAsync
public Task<USIResult> TrySetHorizontalFrustumShiftScreenWidthsAsync(double widths)Sets the horizontal projection shift in viewport-width units.
TrySetIndependentVerticalFieldOfViewEnabledAsync
public Task<USIResult> TrySetIndependentVerticalFieldOfViewEnabledAsync(bool enabled)Enables or disables independent vertical-field-of-view control.
TrySetInfraredHeadTrackingEnabledAsync
public Task<USIResult> TrySetInfraredHeadTrackingEnabledAsync(bool enabled)Enables or disables external infrared head-tracker camera control.
TrySetInstrumentDescriptionsVisibleAsync
public Task<USIResult> TrySetInstrumentDescriptionsVisibleAsync(bool visible)Shows or hides cockpit instrument descriptions.
TrySetNightVisionEnabledAsync
public Task<USIResult> TrySetNightVisionEnabledAsync(bool enabled)Enables or disables the simulator's night-vision visual aid.
TrySetRedFlashlightSelectedAsync
public Task<USIResult> TrySetRedFlashlightSelectedAsync(bool selected)Selects or clears the red cockpit flashlight.
TrySetSunglassesEnabledAsync
public Task<USIResult> TrySetSunglassesEnabledAsync(bool enabled)Enables or disables the simulator's sunglasses visual aid.
TrySetTwoDimensionalPanelScrollPositionAsync
public Task<USIResult> TrySetTwoDimensionalPanelScrollPositionAsync(SimulatorPanelScrollPositionPixels position)Sets the current scroll position of a two-dimensional cockpit panel.
TrySetVerticalFieldOfViewDegreesAsync
public Task<USIResult> TrySetVerticalFieldOfViewDegreesAsync(double degrees)Sets the current vertical field of view in degrees.
TrySetVerticalFrustumShiftScreenHeightsAsync
public Task<USIResult> TrySetVerticalFrustumShiftScreenHeightsAsync(double heights)Sets the vertical projection shift in viewport-height units.
TrySetWhiteFlashlightSelectedAsync
public Task<USIResult> TrySetWhiteFlashlightSelectedAsync(bool selected)Selects or clears the white cockpit flashlight.