Noughty Tours iOS SDK
NoughtyToursSDK is a capture SDK. It drives the device that produces a
virtual tour: LiDAR structure capture, panorama capture, local storage, and
background upload to the Noughty Reality platform.
It vends its capture screens as view controllers you push onto your own
navigation stack, and reports what the user did through a single onEvent
closure per screen. It is not a viewer and it does not render finished tours.
Shape of the API
One NoughtyTours instance for the whole process, built from a Configuration
and started once at launch. Everything else hangs off it.
| Area | Symbols |
|---|---|
| Core | NoughtyTours, Configuration, APIEnvironment |
| Host-provided | OrganizationProviderType, SettingsProviderType, RecordingResolution, FloorPlanStyle |
| Screens | properties, structureCapture, panoramaCapture, StructureCaptureMode |
| Events | PropertyListEvent, PropertyEvent, FloorEvent, RoomEvent, StructureCaptureEvent, PanoramaCaptureEvent |
| Handles | Property, Floor, Room |
| Progress | PropertyStatus, SyncState, statusUpdates(for:) |
| Errors | NoughtyToursError, AuthError, NoughtyToursEntity |
| Diagnostics | Log, LogLevel, LogCategory |
Authentication
Device attestation, not tokens you mint. The device attests against your App ID
using Apple's App Attest, scoped to an organisation your app supplies through
OrganizationProviderType. Nothing syncs until attestation succeeds.
See App Attest.
Pages
| Page | Content |
|---|---|
| Installation | Swift Package Manager, deployment target |
| App Attest | Capability setup, device auth, revoking a session |
| Getting started | Providers, start(), pushing the first screen |
| Screens | properties, structureCapture, panoramaCapture |
| Events and handles | The event enums, and Property / Floor / Room |
| Progress and sync | PropertyStatus, SyncState, background upload |
| Errors | NoughtyToursError, AuthError |
| Logging | Log, LogLevel, LogCategory |