Class

PointLight

An entity that produces an omnidirectional light for virtual objects.

Declaration

class PointLight : 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).

The point light is an omnidirectional light that illuminates all the virtual content within a configurable radius from the light. You can configure the light’s color and intensity.

Topics

Creating a Point Light

init()

Creates a new point light entity.

func clone(recursive: Bool) -> Self

Duplicates a point light entity to create a new point light entity.

Identifying a Point Light

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 point light.

typealias PointLight.ID

A type of unique identifier used for a point light.

Configuring the Point Light

var light: PointLightComponent

A point light component for the entity.

struct PointLightComponent

A component that defines a point light source.

protocol HasPointLight

An interface that defines a point light source component.

Loading a Stored Entity

Stored Entities

Manage entities stored as assets on disk.

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)

Finding the Nearest Anchor

var anchor: HasAnchoring?

Calculating the Collision Shape

func generateCollisionShapes(recursive: Bool)

Playing Animation

var availableAnimations: [AnimationResource]
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 == (Entity, Entity) -> Bool
static func != (PointLight, PointLight) -> Bool
func hash(into: inout Hasher)
var hashValue: Int

Instance Methods

func playAnimation(AnimationResource, transitionDuration: TimeInterval, startsPaused: Bool) -> AnimationPlaybackController

Relationships

Inherits From

Conforms To

See Also

Cameras and Lighting

class PerspectiveCamera

A virtual camera that establishes the rendering perspective.

class DirectionalLight

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

class SpotLight

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