Tracking and visualizing faces
At a glance
| Item | Summary |
|---|---|
| Purpose | Detect faces in a front-camera AR experience, overlay virtual content, and animate facial expressions in real-time. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → ViewController → ARKit APIs. |
| Main patterns | View-controller organization, Protocol-oriented abstraction, Delegate or data-source callbacks |
| Project style | 9 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: DispatchQueue.main.async; none alone proves a background thread. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | ARKit, SceneKit, UIKit, Foundation; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── ARKitFaceExample/
│ ├── AppDelegate.swift
│ ├── ViewController.swift
│ ├── Face Overlay Content/
│ │ ├── VirtualContent.swift
│ │ ├── BlendShapeCharacter.swift
│ │ ├── FaceOcclusionOverlay.swift
│ │ ├── TexturedFace.swift
│ │ ├── TransformVisualization.swift
│ │ └── VideoTexturedFace.swift
│ ├── Utilities.swift
│ └── Base.lproj/
│ └── Main.storyboard
└── ARKitFaceExample.xcodeproj/
├── .xcodesamplecode.plist
└── project.pbxproj
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 6 project/configuration file(s) and 9 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["ViewController"]
N3["ARKit APIs"]
N1 --> N2
N2 --> N3
Reference code
ARKitFaceExample/AppDelegate.swift:11 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
if !ARFaceTrackingConfiguration.isSupported {
/*
Shipping apps cannot require a face-tracking-compatible device, and thus must
offer face tracking AR as a secondary feature. In a shipping app, use the
`isSupported` property to determine whether to offer face tracking AR features.
This sample code has no features other than a demo of ARKit face tracking, so
it replaces the AR view (the initial storyboard in the view controller) with
an alternate view controller containing a static error message.
*/
let storyboard = UIStoryboard(name: "Main", bundle: nil)
window?.rootViewController = storyboard.instantiateViewController(withIdentifier: "unsupportedDeviceMessage")
}
return true
}
}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 ARKit.
Ownership and state
classDiagram
AppDelegate o-- UIWindow : window
ViewController o-- ARSCNView : sceneView
ViewController o-- UITabBar : tabBar
ViewController *-- Dictionary : faceAnchorsAndContentControllers
Ownership evidence
ARKitFaceExample/AppDelegate.swift:13 — stored dependency or nearest verified ownership anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
AppDelegate |
UIWindow (window) |
stores or receives | App/module collaborators |
ViewController |
ARSCNView (sceneView) |
stores or receives | App/module collaborators |
ViewController |
UITabBar (tabBar) |
holds a non-owning reference | The referenced object’s lifecycle is owned elsewhere |
ViewController |
Dictionary (faceAnchorsAndContentControllers) |
owns value state | App/module collaborators |
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 |
|---|---|---|---|
| Queue scheduling | DispatchQueue.main.async |
The source addresses the main dispatch queue. | ARKitFaceExample/ViewController.swift:84 |
@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
ARKitFaceExample/ViewController.swift:84 — representative execution boundary
DispatchQueue.main.async {
self.displayErrorMessage(title: "The AR session failed.", message: errorMessage)
}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 |
|---|---|---|---|
| Source import | ARKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ARKitFaceExample/AppDelegate.swift:9 |
| Source import | SceneKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.swift:9 |
| Source import | UIKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ARKitFaceExample/AppDelegate.swift:8 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.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
ARKitFaceExample/Face Overlay Content/VirtualContent.swift:31 — representative type boundary
protocol VirtualContentController: ARSCNViewDelegate {
// ...
var contentNode: SCNNode? { get set }
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
VirtualContentController |
Defines a capability or collaboration contract | ARSCNViewDelegate |
ViewController |
View lifecycle, callbacks, and feature coordination | UIViewController, ARSessionDelegate |
VirtualContentType |
Defines a closed set of feature states or choices | Int |
BlendShapeCharacter |
Owns feature behavior and collaborator lifecycle | NSObject, VirtualContentController |
FaceOcclusionOverlay |
Owns feature behavior and collaborator lifecycle | NSObject, VirtualContentController |
TexturedFace |
Owns feature behavior and collaborator lifecycle | NSObject, VirtualContentController |
TransformVisualization |
Owns feature behavior and collaborator lifecycle | NSObject, VirtualContentController |
VideoTexturedFace |
Owns feature behavior and collaborator lifecycle | TexturedFace |
The source explicitly defines local protocol relationships: BlendShapeCharacter → VirtualContentController, FaceOcclusionOverlay → VirtualContentController, TexturedFace → VirtualContentController, TransformVisualization → VirtualContentController.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
originalJawY (ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.swift:17) |
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. |
jawNode (ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.swift:19) |
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. |
eyeLeftNode (ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.swift:20) |
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. |
eyeRightNode (ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.swift:21) |
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
ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.swift:17 — representative boundary
class BlendShapeCharacter: NSObject, VirtualContentController {
// ...
private var originalJawY: Float = 0
// ...
}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 |
|---|---|---|
| View lifecycle, callbacks, and feature coordination | ViewController, VirtualContentController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate |
The source’s Delegate suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | ARKitFaceExample/ViewController.swift:12 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Protocol-oriented abstraction | ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.swift:13 |
A local protocol and concrete conformance create an explicit capability boundary. |
| Delegate or data-source callbacks | ARKitFaceExample/AppDelegate.swift:12 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: ViewController, VirtualContentController; Delegate: AppDelegate.
- Protocols:
VirtualContentController. - Methods:
application,viewDidLoad,viewDidAppear,session,resetTracking,displayErrorMessage,tabBar,renderer. - Files:
ARKitFaceExample/AppDelegate.swift,ARKitFaceExample/ViewController.swift,ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.swift,ARKitFaceExample/Face Overlay Content/FaceOcclusionOverlay.swift,ARKitFaceExample/Face Overlay Content/TexturedFace.swift,ARKitFaceExample/Face Overlay Content/TransformVisualization.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches ARKit, SceneKit, UIKit 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.
- Local protocol relationships provide an explicit substitution boundary.
Source map
| Source file | Relevant symbols |
|---|---|
ARKitFaceExample/AppDelegate.swift |
Cited implementation, ARKit, UIKit, AppDelegate |
ARKitFaceExample/Face Overlay Content/VirtualContent.swift |
VirtualContentController, VirtualContentType |
ARKitFaceExample/Face Overlay Content/BlendShapeCharacter.swift |
Cited implementation, SceneKit, Foundation, BlendShapeCharacter |
ARKitFaceExample/ViewController.swift |
ViewController, DispatchQueue.main.async |
ARKitFaceExample/Face Overlay Content/FaceOcclusionOverlay.swift |
FaceOcclusionOverlay |
ARKitFaceExample/Face Overlay Content/TexturedFace.swift |
TexturedFace |
ARKitFaceExample/Face Overlay Content/TransformVisualization.swift |
TransformVisualization |
ARKitFaceExample/Face Overlay Content/VideoTexturedFace.swift |
VideoTexturedFace |
ARKitFaceExample/Utilities.swift |
Feature implementation |