Class

Scene

A container that holds the collection of entities rendered by an AR view.

Declaration

class Scene

Overview

You don’t create a Scene instance directly. Instead, you get the one and only scene associated with a view from the scene property of an ARView instance.

Block diagram showing the scene as a property of an AR view, with anchor entities as the scene’s children.

To add content to the view’s scene, you first create and add one or more AnchorEntity instances to the scene’s anchors collection. Anchors tell RealityKit how to pin virtual content to real world objects, like flat surfaces or images. You then add a hierarchy of other Entity instances to each anchor to indicate the geometry and behaviors that RealityKit should render at a given anchor point.

Topics

Identifying the Scene

var name: String

A name for the scene.

var id: ObjectIdentifier

The stable identity of the entity associated with self.

Available when Self conforms to AnyObject.

var id: UInt64

The stable identity of the scene.

typealias Scene.ID

A type of unique identifier used for a scene.

Adding and Removing Anchors

var anchors: Scene.AnchorCollection

The collection of anchors contained in the scene.

func addAnchor(HasAnchoring)

Adds an anchor to the scene’s list of anchors.

func removeAnchor(HasAnchoring)

Removes the specified anchor from the scene.

struct Scene.AnchorCollection

A collection of anchor entities.

Finding Entities

func findEntity(named: String) -> Entity?

Searches the scene’s anchor entity hierarchies for an entity with the given name.

Detecting Intersections

func raycast(origin: SIMD3<Float>, direction: SIMD3<Float>, length: Float, query: CollisionCastQueryType, mask: CollisionGroup, relativeTo: Entity?) -> [CollisionCastHit]

Performs a convex ray cast against all the geometry in the scene for a ray of a given origin, direction, and length.

func raycast(from: SIMD3<Float>, to: SIMD3<Float>, query: CollisionCastQueryType, mask: CollisionGroup, relativeTo: Entity?) -> [CollisionCastHit]

Performs a convex ray cast against all the geometry in the scene for a ray between two end points.

func convexCast(convexShape: ShapeResource, fromPosition: SIMD3<Float>, fromOrientation: simd_quatf, toPosition: SIMD3<Float>, toOrientation: simd_quatf, query: CollisionCastQueryType, mask: CollisionGroup, relativeTo: Entity?) -> [CollisionCastHit]