Package apple.arkit.protocol

Interface ARSCNViewDelegate

All Superinterfaces:

ARSessionObserver, SCNSceneRendererDelegate

public interface ARSCNViewDelegate
extends SCNSceneRendererDelegate, ARSessionObserver

API-Since: 11.0

Method Summary

Modifier and Type	Method	Description
default void	rendererDidAddNodeForAnchor(@NotNull SCNSceneRenderer renderer, @NotNull SCNNode node, @NotNull ARAnchor anchor)	Called when a new node has been mapped to the given anchor.
default void	rendererDidRemoveNodeForAnchor(@NotNull SCNSceneRenderer renderer, @NotNull SCNNode node, @NotNull ARAnchor anchor)	Called when a mapped node has been removed from the scene graph for the given anchor.
default void	rendererDidUpdateNodeForAnchor(@NotNull SCNSceneRenderer renderer, @NotNull SCNNode node, @NotNull ARAnchor anchor)	Called when a node has been updated with data from the given anchor.
default @Nullable SCNNode	rendererNodeForAnchor(@NotNull SCNSceneRenderer renderer, @NotNull ARAnchor anchor)	Implement this to provide a custom node for the given anchor.
default void	rendererWillUpdateNodeForAnchor(@NotNull SCNSceneRenderer renderer, @NotNull SCNNode node, @NotNull ARAnchor anchor)	Called when a node will be updated with data from the given anchor.

Methods inherited from interface apple.arkit.protocol.ARSessionObserver

sessionCameraDidChangeTrackingState, sessionDidChangeGeoTrackingStatus, sessionDidFailWithError, sessionDidOutputAudioSampleBuffer, sessionDidOutputCollaborationData, sessionInterruptionEnded, sessionShouldAttemptRelocalization, sessionWasInterrupted

Methods inherited from interface apple.scenekit.protocol.SCNSceneRendererDelegate

rendererDidApplyAnimationsAtTime, rendererDidApplyConstraintsAtTime, rendererDidRenderSceneAtTime, rendererDidSimulatePhysicsAtTime, rendererUpdateAtTime, rendererWillRenderSceneAtTime

Method Detail

rendererDidAddNodeForAnchor

default void rendererDidAddNodeForAnchor(@NotNull
                                         @NotNull SCNSceneRenderer renderer,
                                         @NotNull
                                         @NotNull SCNNode node,
                                         @NotNull
                                         @NotNull ARAnchor anchor)

Called when a new node has been mapped to the given anchor.

Parameters:

renderer - The renderer that will render the scene.

node - The node that maps to the anchor.

anchor - The added anchor.

rendererDidRemoveNodeForAnchor

default void rendererDidRemoveNodeForAnchor(@NotNull
                                            @NotNull SCNSceneRenderer renderer,
                                            @NotNull
                                            @NotNull SCNNode node,
                                            @NotNull
                                            @NotNull ARAnchor anchor)

Called when a mapped node has been removed from the scene graph for the given anchor.

Parameters:

renderer - The renderer that will render the scene.

node - The node that was removed.

anchor - The anchor that was removed.

rendererDidUpdateNodeForAnchor

default void rendererDidUpdateNodeForAnchor(@NotNull
                                            @NotNull SCNSceneRenderer renderer,
                                            @NotNull
                                            @NotNull SCNNode node,
                                            @NotNull
                                            @NotNull ARAnchor anchor)

Called when a node has been updated with data from the given anchor.

Parameters:

renderer - The renderer that will render the scene.

node - The node that was updated.

anchor - The anchor that was updated.

rendererNodeForAnchor

@Nullable
default @Nullable SCNNode rendererNodeForAnchor(@NotNull
                                                @NotNull SCNSceneRenderer renderer,
                                                @NotNull
                                                @NotNull ARAnchor anchor)

Implement this to provide a custom node for the given anchor. This node will automatically be added to the scene graph. If this method is not implemented, a node will be automatically created. If nil is returned the anchor will be ignored.

Parameters:

renderer - The renderer that will render the scene.

anchor - The added anchor.

Returns:

Node that will be mapped to the anchor or nil.

rendererWillUpdateNodeForAnchor

default void rendererWillUpdateNodeForAnchor(@NotNull
                                             @NotNull SCNSceneRenderer renderer,
                                             @NotNull
                                             @NotNull SCNNode node,
                                             @NotNull
                                             @NotNull ARAnchor anchor)

Called when a node will be updated with data from the given anchor.

Parameters:

renderer - The renderer that will render the scene.

node - The node that will be updated.

anchor - The anchor that was updated.