apple.arkit.protocol

Interface ARCoachingOverlayViewDelegate

public interface ARCoachingOverlayViewDelegate

Method Summary

Modifier and Type	Method and Description
default void	coachingOverlayViewDidDeactivate(ARCoachingOverlayView coachingOverlayView) This is called when the view has been deactivated, either manually or automatically
default void	coachingOverlayViewDidRequestSessionReset(ARCoachingOverlayView coachingOverlayView) This is called when the user taps the reset button in the relocalization state
default void	coachingOverlayViewWillActivate(ARCoachingOverlayView coachingOverlayView) This is called when the view activate, either manually or automatically

Method Detail

coachingOverlayViewDidDeactivate

default void coachingOverlayViewDidDeactivate(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(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(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