Class

ARSCNView

A view that enables you to display an AR experience with SceneKit.

Declaration

@interface ARSCNView : SCNView

Overview

The ARSCNView class provides the easiest way to create augmented reality experiences that blend virtual 3D content with a device camera view of the real world. When you run the view's provided ARSession object:

  • The view automatically renders the live video feed from the device camera as the scene background.

  • The world coordinate system of the view's SceneKit scene directly responds to the AR world coordinate system established by the session configuration.

  • The view automatically moves its SceneKit camera to match the real-world movement of the device.

Because ARKit automatically matches SceneKit space to the real world, placing a virtual object such that it appears to maintain a real-world position only requires setting that object's SceneKit position appropriately. (See Providing 3D Virtual Content with SceneKit.)

You don't necessarily need to use the ARAnchor class to track positions of objects you add to the scene, but by implementing ARSCNViewDelegate methods, you can add SceneKit content to any anchors that are automatically detected by ARKit.

Topics

Essentials

Providing 3D Virtual Content with SceneKit

Use SceneKit to add realistic three-dimensional objects to your AR experience.

session

The AR session that manages motion tracking and camera image processing for the view's contents.

scene

The SceneKit scene to be displayed in the view.

Responding to AR Updates

delegate

An object you provide to mediate synchronization of the view's AR scene information with SceneKit content.

ARSCNViewDelegate

Methods you can implement to mediate the automatic synchronization of SceneKit content with an AR session.

Finding Real-World Surfaces

- hitTest:types:

Searches for real-world objects or AR anchors in the captured camera image corresponding to a point in the SceneKit view.

- raycastQueryFromPoint:allowingTarget:alignment:

Creates a raycast query that originates from a point on the view, aligned with the center of the camera's field of view.

Mapping Content to Real-World Positions

- anchorForNode:

Returns the AR anchor associated with the specified SceneKit node, if any.

- nodeForAnchor:

Returns the SceneKit node associated with the specified AR anchor, if any.

- unprojectPoint:ontoPlaneWithTransform:

Returns the projection of a point from 2D view onto a plane in the 3D world space detected by ARKit.

Managing Lighting

automaticallyUpdatesLighting

A Boolean value that specifies whether ARKit creates and updates SceneKit lights in the view's scene.

Debugging AR Display

ARSCNDebugOptions

Options for drawing overlay content to aid debugging of AR tracking in a SceneKit view.

Managing Rendering Effects

rendersMotionBlur

Determines whether the view renders motion blur.

rendersCameraGrain

A flag that determines whether SceneKit applies image noise characteristics to your app's virtual content.

Relationships

Inherits From

See Also

Display

ARSKView

A view that enables you to display an AR experience with SpriteKit.