Package apple.arkit.protocol

Interface ARCoachingOverlayViewDelegate

  • public interface ARCoachingOverlayViewDelegate
    API-Since: 13.0

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default void coachingOverlayViewDidDeactivate​(@NotNull ARCoachingOverlayView coachingOverlayView)
      This is called when the view has been deactivated, either manually or automatically
      default void coachingOverlayViewDidRequestSessionReset​(@NotNull ARCoachingOverlayView coachingOverlayView)
      This is called when the user taps the reset button in the relocalization state By default, when the relocalization reset button is tapped, the overlay will call run on the session using the current `configuration`, and the `ARSessionRunOptionResetTracking` and `ARSessionRunOptionRemoveExistingAnchors` options.
      default void coachingOverlayViewWillActivate​(@NotNull ARCoachingOverlayView coachingOverlayView)
      This is called when the view activate, either manually or automatically The Developer may hide their application UI in in this callback, and take other appropriate actions to allow `ARCoachingOverlayView` to take over the full screen.

    • Method Detail

      • coachingOverlayViewDidDeactivate

        default void coachingOverlayViewDidDeactivate​(@NotNull
                                              @NotNull ARCoachingOverlayView coachingOverlayView)
        This is called when the view has been deactivated, either manually or automatically
        Parameters:
        coachingOverlayView - The view that was deactivated

      • coachingOverlayViewDidRequestSessionReset

        default void coachingOverlayViewDidRequestSessionReset​(@NotNull
                                                       @NotNull ARCoachingOverlayView coachingOverlayView)
        This is called when the user taps the reset button in the relocalization state By default, when the relocalization reset button is tapped, the overlay will call run on the session using the current `configuration`, and the `ARSessionRunOptionResetTracking` and `ARSessionRunOptionRemoveExistingAnchors` options. The delegate may implement this method to override this behavior. The delegate is then responsible for resetting the session.
        Parameters:
        coachingOverlayView - The view currently active

      • coachingOverlayViewWillActivate

        default void coachingOverlayViewWillActivate​(@NotNull
                                             @NotNull ARCoachingOverlayView coachingOverlayView)
        This is called when the view activate, either manually or automatically The Developer may hide their application UI in in this callback, and take other appropriate actions to allow `ARCoachingOverlayView` to take over the full screen.
        Parameters:
        coachingOverlayView - The view that will be activated