Sample CodemacOSReviewed 2026-07-21View on Apple Developer

Working with content from your Mac app using Spatial Preview

At a glance

Item Summary
Purpose Send and update documents, and work with 3D content live from your macOS app to a visionOS device through the Spatial Preview framework.
App architecture A Swift sample with the source-visible chain SpatialPreviewSampleAppContentViewPlaybackModelSpatialPreview APIs.
Main patterns No named application pattern supported by the extracted structure
Project style 8 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries.
Execution model Source-visible boundaries: Task, await suspension point, @MainActor; none alone proves a background thread.
State/event model Source-visible mechanisms: SwiftUI state property wrapper, @Observable.
Key frameworks/packages SwiftUI, OSLog, SpatialPreview, USDKit, RealityKit; these are source dependencies, not architecture labels.

Project structure

Source bundle/
├── SpatialPreviewSample/
│   ├── SpatialPreviewSample/
│   │   ├── SpatialPreviewSampleApp.swift
│   │   ├── SceneModel.swift
│   │   ├── USDPreviewView.swift
│   │   ├── AnnotationModel.swift
│   │   ├── AnnotationView.swift
│   │   ├── ContentView.swift
│   │   ├── PlaybackModel.swift
│   │   └── SpatialPhotoGalleryView.swift
│   └── SpatialPreviewSample.xcodeproj/
│       ├── .xcodesamplecode.plist
│       └── project.pbxproj
└── Configuration/
    └── SampleCode.xcconfig

Structure observations

  • Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
  • Primary languages: Swift.
  • The verified tree contains 3 project/configuration file(s) and 10 source declaration(s).

Overall architecture

Reference code

SpatialPreviewSample/SpatialPreviewSample/SpatialPreviewSampleApp.swift:15 — architecture anchor

@main
struct SpatialPreviewSampleApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Interpretation

The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into Spatial Preview.

Ownership and state

Ownership evidence

SpatialPreviewSample/SpatialPreviewSample/SpatialPreviewSampleApp.swift:12 — stored dependency or nearest verified ownership anchor

extension Logger {
    static let sampleApp = Logger(subsystem: "com.example.apple-samplecode.SpatialPreviewSample", category: "SampleApp")
}
Owner Object or state Relationship Mutation authority
SpatialPreviewSampleApp Logger (sampleApp) creates and retains Initialized by the owner; the binding is immutable
SceneModel USDStage (stage) stores or receives Owning type writes; wider scope can read
SceneModel Entity (rootEntity) creates and retains Initialized by the owner; the binding is immutable
SceneModel Entity (directionalLightEntity) stores or receives Initialized by the owner; the binding is immutable

Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.

Concurrency, scheduling, and thread safety

Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.

Concern Source mechanism Verified placement or handoff Evidence
Task creation Task The source creates an unstructured task; surrounding context determines inherited actor isolation. SpatialPreviewSample/SpatialPreviewSample/PlaybackModel.swift:68
Suspension boundary await suspension point The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. SpatialPreviewSample/SpatialPreviewSample/PlaybackModel.swift:74
Main isolation @MainActor The cited annotation marks its attached declaration or closure as main-actor isolated. SpatialPreviewSample/SpatialPreviewSample/SceneModel.swift:120

@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.

Reference code

SpatialPreviewSample/SpatialPreviewSample/PlaybackModel.swift:68 — representative execution boundary

            playbackTask = Task {
                let renderRate = 1.0 / 30.0 // 30fps
                // ...
            }

State propagation, frameworks, and dependencies

Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.

Category Mechanism or module Verified role Evidence
State propagation SwiftUI state property wrapper A SwiftUI property wrapper supplies or observes UI state. SpatialPreviewSample/SpatialPreviewSample/AnnotationView.swift:15
State propagation @Observable Observation macro publishes source-visible changes. SpatialPreviewSample/SpatialPreviewSample/PlaybackModel.swift:14
Source import SwiftUI The cited file imports this module; runtime use and architectural role are not inferred. SpatialPreviewSample/SpatialPreviewSample/AnnotationView.swift:8
Source import OSLog The cited file imports this module; runtime use and architectural role are not inferred. SpatialPreviewSample/SpatialPreviewSample/SceneModel.swift:10
Source import SpatialPreview The cited file imports this module; runtime use and architectural role are not inferred. SpatialPreviewSample/SpatialPreviewSample/PlaybackModel.swift:10
Source import USDKit The cited file imports this module; runtime use and architectural role are not inferred. SpatialPreviewSample/SpatialPreviewSample/AnnotationModel.swift:9
Source import RealityKit The cited file imports this module; runtime use and architectural role are not inferred. SpatialPreviewSample/SpatialPreviewSample/PlaybackModel.swift:9
Source import Foundation The cited file imports this module; runtime use and architectural role are not inferred. SpatialPreviewSample/SpatialPreviewSample/AnnotationModel.swift:8

receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.

Class and protocol design

SpatialPreviewSample/SpatialPreviewSample/SpatialPreviewSampleApp.swift:16 — representative type boundary

@main
struct SpatialPreviewSampleApp: App {
    // ...
            ContentView()
    // ...
}
Type Responsibility Depends on or conforms to
SpatialPreviewSampleApp Application entry and top-level composition App
SceneModel Feature data or observable state Concrete collaborators/imported frameworks
USDPreviewView User-interface presentation and input forwarding View
USDModelPreviewView User-interface presentation and input forwarding View
AnnotationsView User-interface presentation and input forwarding View
ContentView User-interface presentation and input forwarding View
PlaybackModel Feature data or observable state Concrete collaborators/imported frameworks
SpatialPhotoGalleryView User-interface presentation and input forwarding View
SceneLayout Defines a closed set of feature states or choices String, CaseIterable, Identifiable
Annotation Represents a feature value or composable behavior Identifiable

No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.

Access control

Symbol Access Verified effect Likely rationale
setAttribute (SpatialPreviewSample/SpatialPreviewSample/AnnotationModel.swift:88) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: hide an implementation step that is not part of the collaboration surface.
model (SpatialPreviewSample/SpatialPreviewSample/AnnotationView.swift:12) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.
newText (SpatialPreviewSample/SpatialPreviewSample/AnnotationView.swift:15) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.
annotationsList (SpatialPreviewSample/SpatialPreviewSample/AnnotationView.swift:35) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.

Reference code

SpatialPreviewSample/SpatialPreviewSample/AnnotationModel.swift:88 — representative boundary

    private func setAttribute<T: USDPrim.Attribute.Value>(token: USDToken,
                                                          value: T,
                                                          variability: USDPrim.Property.Variability = .uniform) {
        // ...
    }

Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.

Logic ownership and placement

Logic Owning type or file Placement rationale
Application entry and top-level composition SpatialPreviewSampleApp The source’s App suffix makes this role explicit.
Feature data or observable state PlaybackModel, SceneModel The source’s Model suffix makes this role explicit.
User-interface presentation and input forwarding AnnotationsView, ContentView, SpatialPhotoGalleryView, USDModelPreviewView The source’s View suffix makes this role explicit.

Design patterns

Pattern Source evidence Purpose or tradeoff
No named application pattern SpatialPreviewSample/SpatialPreviewSample/SpatialPreviewSampleApp.swift:15 The verified source directly composes concrete framework types; this document avoids forcing a pattern name.

Naming conventions

  • Types: App: SpatialPreviewSampleApp; Model: PlaybackModel, SceneModel; View: AnnotationsView, ContentView, SpatialPhotoGalleryView, USDModelPreviewView, USDPreviewView.
  • Protocols: no local protocol declaration in the scanned source.
  • Methods: setupStageComponent, loadStage, reload, addAnnotation, loadAnnotations, applyLayout, receiveActiveLayout, shareStage.
  • Files: SpatialPreviewSample/SpatialPreviewSample/SpatialPreviewSampleApp.swift, SpatialPreviewSample/SpatialPreviewSample/SceneModel.swift, SpatialPreviewSample/SpatialPreviewSample/USDPreviewView.swift, SpatialPreviewSample/SpatialPreviewSample/ContentView.swift, SpatialPreviewSample/SpatialPreviewSample/PlaybackModel.swift, SpatialPreviewSample/SpatialPreviewSample/SpatialPhotoGalleryView.swift.

Architecture takeaways

  • SpatialPreviewSampleApp is the main source-visible entry or composition anchor for this sample.
  • Framework work reaches SwiftUI, SpatialPreview, USDKit, RealityKit through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
  • Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
  • Access-control conclusions separate verified language visibility from the likely design rationale.
  • The source does not justify labeling the design protocol-oriented.

Source map

Source file Relevant symbols
SpatialPreviewSample/SpatialPreviewSample/SpatialPreviewSampleApp.swift Cited implementation, SpatialPreviewSampleApp
SpatialPreviewSample/SpatialPreviewSample/AnnotationModel.swift Cited implementation, USDKit, Foundation, Annotation
SpatialPreviewSample/SpatialPreviewSample/AnnotationView.swift Cited implementation, SwiftUI state property wrapper, SwiftUI, AnnotationsView
SpatialPreviewSample/SpatialPreviewSample/PlaybackModel.swift Task, await suspension point, @Observable, SpatialPreview, RealityKit, PlaybackModel
SpatialPreviewSample/SpatialPreviewSample/SceneModel.swift @MainActor, OSLog, SceneLayout, SceneModel
SpatialPreviewSample/SpatialPreviewSample/USDPreviewView.swift USDPreviewView, USDModelPreviewView
SpatialPreviewSample/SpatialPreviewSample/ContentView.swift ContentView
SpatialPreviewSample/SpatialPreviewSample/SpatialPhotoGalleryView.swift SpatialPhotoGalleryView