Class CompassSensor
Input device representing the device's compass, reporting heading relative to magnetic and true north.
Inherited Members
Namespace: UnityEngine.InputSystem
Assembly: Unity.InputSystem.dll
Syntax
public class CompassSensor : Sensor
Remarks
Readings are only valid while the device is enabled through EnableDevice(InputDevice). Whether trueHeading requires a running location service to be meaningful is platform-dependent. On Android, it falls back to magneticHeading unless a recent location fix is available (when LocationSensor is started). Behavior on other platforms may differ.
Don't drive heading updates from both this device and the legacy UnityEngine.Input.compass API in
the same project. Both share the same underlying platform heading service, so disabling this device also
stops updates for the legacy API (the reverse is also true). Use a single compass API for each project.
Properties
current
The compass sensor that most recently became current.
Declaration
public static CompassSensor current { get; }
Property Value
| Type | Description |
|---|---|
| CompassSensor | Current compass sensor or |
Remarks
When a compass sensor is added, it becomes current, because not all of its controls are noisy. When the current compass sensor is removed, the remaining compass sensor that was updated last becomes current. For more information about when a device becomes current, refer to MakeCurrent().
headingAccuracy
Accuracy of the heading reading in degrees.
Declaration
public AxisControl headingAccuracy { get; protected set; }
Property Value
| Type | Description |
|---|---|
| AxisControl | A negative value indicates the reading is unreliable. |
magneticHeading
Heading in degrees relative to magnetic north.
Declaration
public AxisControl magneticHeading { get; protected set; }
Property Value
| Type | Description |
|---|---|
| AxisControl | 0 is north, 90 is east, 180 is south, and 270 is west. |
rawVector
Raw geomagnetic field measured by the magnetometer, in microteslas.
Declaration
public Vector3Control rawVector { get; protected set; }
Property Value
| Type | Description |
|---|---|
| Vector3Control | Geomagnetic field on the x, y, and z device axes. |
timestamp
Time at which the last heading was measured, in seconds.
Declaration
public DoubleControl timestamp { get; protected set; }
Property Value
| Type | Description |
|---|---|
| DoubleControl | Timestamp of the most recent reading, as measured by the underlying sensor hardware. On the web platform, no native measurement time is available, so this reflects the time the reading was received instead. |
trueHeading
Heading in degrees relative to geographic (true) north.
Declaration
public AxisControl trueHeading { get; protected set; }
Property Value
| Type | Description |
|---|---|
| AxisControl | On Android, meaningful only while a recent location fix is available (when LocationSensor is started); otherwise equal to magneticHeading. Behavior on other platforms may differ. |
Methods
FinishSetup()
Perform final initialization tasks after the control hierarchy has been put into place.
Declaration
protected override void FinishSetup()
Overrides
Remarks
This method can be overridden to perform control- or device-specific setup work. The most common use case is for looking up child controls and storing them in local getters.
Examples
public class MyDevice : InputDevice
{
public ButtonControl button { get; private set; }
public AxisControl axis { get; private set; }
protected override void OnFinishSetup()
{
// Cache controls in getters.
button = GetChildControl("button");
axis = GetChildControl("axis");
}
}
MakeCurrent()
Makes this device the current device of its type.
Declaration
public override void MakeCurrent()
Overrides
Remarks
Many types of devices have .current getters that return the current device of that type
(for example, current). The current device of a type is the device of that
type that most recently became current. For a built-in sensor, the type is the class that derives directly
from Sensor. For example, an Android gyroscope becomes current.
The Input System calls this method in the following cases:
- When a device is added. If all the device's controls are noisy, the device becomes current only if no other device of its type is current. For example, a second gyroscope doesn't replace the first one as current, because all of a gyroscope sensor's controls are noisy.
- When input changes a control that isn't noisy. Input on noisy controls doesn't call this method.
- When a device's usage changes, with the same rule as when the device is added.
- When a layout change recreates a device. The new device is current if the old one was.
- When a device is removed. The remaining device of its type that was updated last becomes current.
If no device of that type is left,
.currentisnull. If you remove a sensor that isn't current,.currentstays the same.
A device with noisy controls (noisy) can receive events that carry no user interaction. For example, the PlayStation®4 (PS4) gamepad has a gyro and keeps sending events when nobody uses it. Without the rule for noisy controls, the PS4 gamepad would make itself current while the user plays with another gamepad.
When you call this method yourself, the device becomes current even if its controls are noisy.
If you override this method, call base.MakeCurrent(). Otherwise, the built-in .current
getters don't return the device, and the rules above don't apply to it.
See Also
OnRemoved()
Called by the system when the device is removed from devices.
Declaration
protected override void OnRemoved()
Overrides
Remarks
Examples
using UnityEngine.InputSystem;
public class MyDevice : InputDevice
{
public static MyDevice current { get; private set; }
protected override void OnRemoved()
{
// use this context to unassign the current device for instance
base.OnRemoved();
if (current == this)
current = null;
}
}