Skip to main content
←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)

Parameters​

NameTypeSummary
coderNSCoder
-

Overload​

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

Summary​

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

Parameters​

NameTypeSummary
trueHeadingCLLocationDirection
Heading in degrees clockwise from true north. Negative indicates invalid.
headingAccuracyCLLocationDirection
Maximum deviation from trueHeading, in degrees. Negative indicates invalid.
timestampDate
The time at which the heading was determined. Defaults to the current time.

Properties​

NameTypeSummary
override var headingAccuracyCLLocationDirection
Maximum deviation from the reported heading, in degrees.
A negative value indicates the heading is invalid.
override var magneticHeadingCLLocationDirection
Heading relative to magnetic north, in degrees.
VPS2 does not use a magnetometer, so this mirrors trueHeading.
override class var supportsSecureCodingBool
-
override var timestampDate
The time at which this heading was determined.
override var trueHeadingCLLocationDirection
Heading relative to true north, in degrees.
override var xCLHeadingComponentValue
Raw magnetometer x-component. VPS2 does not use a magnetometer; returns 0.
override var yCLHeadingComponentValue
Raw magnetometer y-component. VPS2 does not use a magnetometer; returns 0.
override var zCLHeadingComponentValue
Raw magnetometer z-component. VPS2 does not use a magnetometer; returns 0.

Methods​

NameTypeSummary
override copyAny
-
override encodevoid
-

Relationships​

conforms to: Foundation.NSCopying
conforms to: Foundation.NSSecureCoding
conforms to: Foundation.NSCoding

conforms to: ObjectiveC.NSObjectProtocol

conforms to: Swift.Equatable
conforms to: Swift.Hashable
conforms to: Swift.CVarArg
conforms to: Swift.CustomStringConvertible
conforms to: Swift.CustomDebugStringConvertible