Class

SpotLight

An entity that illuminates virtual content in a cone-shaped volume.

Declaration

class SpotLight : Entity

Overview

During an AR session, RealityKit automatically lights your virtual objects to match real-world lighting. You can also explicitly add virtual lights that act upon your virtual content. This is typically most useful outside of an AR session (with the view’s cameraMode property set to ARView.CameraMode.nonAR).

Topics

Creating a Spotlight

init()

Creates a spotlight entity.

func clone(recursive: Bool) -> Self

Duplicates a spotlight entity to create a new spotlight entity.

Identifying a Spotlight

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 spotlight.

typealias SpotLight.ID

A type of unique identifier used for a spotlight.

Configuring the Spot Light

var light: SpotLightComponent

A spotlight component for the entity.

struct SpotLightComponent

A component that defines a spotlight source.

var shadow: SpotLightComponent.Shadow?

The shadow cast by a spot light.

protocol HasSpotLight

An interface that defines a spot light source component.

Loading a Stored Entity

Stored Entities

Manage entities stored as assets on disk.

Adding Components

struct SpotLight.ComponentSet

Positioning Entities in Space

The Transform Component

Synchronizing an Entity Among Peers

var synchronization: SynchronizationComponent?
struct SynchronizationComponent

A component that synchronizes an entity between processes and networked applications.

var isOwner: Bool
func requestOwnership(timeout: TimeInterval, (SynchronizationComponent.OwnershipTransferCompletionResult) -> Void)
func withUnsynchronized(() -> Void)

Establishing a Hierarchy

var parent: Entity?
func setParent(Entity?, preservingWorldTransform: Bool)
func removeFromParent(preservingWorldTransform: Bool)
var children: Entity.ChildCollection
func addChild(Entity, preservingWorldTransform: Bool)
func removeChild(Entity, preservingWorldTransform: Bool)
struct SpotLight.ChildCollection

Finding the Nearest Anchor

var anchor: HasAnchoring?

Calculating the Collision Shape

func generateCollisionShapes(recursive: Bool)

Playing Animation

var availableAnimations: [AnimationResource]
func playAnimation(AnimationResource, transitionDuration: TimeInterval, startsPaused: Bool) -> AnimationPlaybackController
func playAnimation(named: String, transitionDuration: TimeInterval, startsPaused: Bool, recursive: Bool) -> AnimationPlaybackController
func stopAllAnimations(recursive: Bool)

Playing Audio

func prepareAudio(AudioResource) -> AudioPlaybackController
func playAudio(AudioResource) -> AudioPlaybackController
func stopAllAudio()

Describing the Light

var debugDescription: String

Comparing Lights

static func != (SpotLight, SpotLight) -> Bool
static func == (Entity, Entity) -> Bool
func hash(into: inout Hasher)
var hashValue: Int

Relationships

Inherits From

Conforms To

See Also

Cameras and Lighting

class PerspectiveCamera

A virtual camera that establishes the rendering perspective.

class PointLight

An entity that produces an omnidirectional light for virtual objects.

class DirectionalLight

An entity that casts a virtual light in a particular direction.