Reading this with an AI agent?

Read this page as plain text instead: https://www.nianticspatial.com/docs/llms-api-swift/NSDK.class-Vps2Heading.txt — same content, easier to parse than this HTML, with each platform's steps kept separate.

Every page in the current release follows the same pattern, so you can build the URL directly instead of fetching an index: a page at /api/swift/<page>/ is at /llms-api-swift/<page>.txt.

For every page in this section, read https://www.nianticspatial.com/docs/llms-api-swift.txt; for every section of these docs, read https://www.nianticspatial.com/docs/llms.txt.

←API Reference ←NSDK

Vps2Heading

↳ inherits from CoreLocation.CLHeading

Declaration

final class Vps2Heading

Summary

A CLHeading subclass representing heading data computed by VPS2. VPS2 derives heading from visual-inertial localization rather than a physical magnetometer, so the raw magnetometer component values (x, y, z) are zero and not meaningful.

Constructors

Constructor

required init?(coder: NSCoder)

Overload

init(trueHeading: CLLocationDirection, headingAccuracy: CLLocationDirection, timestamp: Date = Date())

Summary

Creates a Vps2Heading from a VPS2-computed true heading and its accuracy.

Properties

Name	Type	Summary
override var headingAccuracy	CLLocationDirection	Maximum deviation from the reported heading, in degrees. A negative value indicates the heading is invalid.
override var magneticHeading	CLLocationDirection	Heading relative to magnetic north, in degrees. VPS2 does not use a magnetometer, so this mirrors `trueHeading`.
override class var supportsSecureCoding	Bool	-
override var timestamp	Date	The time at which this heading was determined.
override var trueHeading	CLLocationDirection	Heading relative to true north, in degrees.
override var x	CLHeadingComponentValue	Raw magnetometer x-component. VPS2 does not use a magnetometer; returns `0`.
override var y	CLHeadingComponentValue	Raw magnetometer y-component. VPS2 does not use a magnetometer; returns `0`.
override var z	CLHeadingComponentValue	Raw magnetometer z-component. VPS2 does not use a magnetometer; returns `0`.