Inclinometer Inclinometer Inclinometer Inclinometer Inclinometer Class

Definition

Represents an inclinometer sensor.

This sensor returns pitch, roll, and yaw values that correspond to rotation angles around the x, y, and z axes, respectively.

For an example implementation, see the inclinometer sample https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/Inclinometer.

public : sealed class Inclinometer
struct winrt::Windows::Devices::Sensors::Inclinometer
public sealed class Inclinometer
Public NotInheritable Class Inclinometer
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Sensor data is provided relative to the device's fixed sensor coordinate system, and is independent of display orientation. For applications that rely on sensor data for input control or to manipulate elements on the screen, the developer must take current display orientation into account and compensate the data appropriately. For more info about the sensor coordinate system, see Sensor data and display orientation.

The following example demonstrates how a UWP app built with XAML and C# uses the GetDefault method to establish a connection to an inclinometer. If no integrated inclinometer is found, the method will return a null value.

_inclinometer = Inclinometer.GetDefault();

The following example demonstrates how a UWP app built with XAML registers a ReadingChanged event handler.

private void ScenarioEnable(object sender, RoutedEventArgs e)
{
    if (_inclinometer != null)
    {
        // Establish the report interval
        _inclinometer.ReportInterval = _desiredReportInterval;

        Window.Current.VisibilityChanged += new WindowVisibilityChangedEventHandler(VisibilityChanged);
        _inclinometer.ReadingChanged += new TypedEventHandler<Inclinometer, InclinometerReadingChangedEventArgs>(ReadingChanged);

        ScenarioEnableButton.IsEnabled = false;
        ScenarioDisableButton.IsEnabled = true;
    }
    else
    {
        rootPage.NotifyUser("No inclinometer found", NotifyType.StatusMessage);
    }
}

The following example shows the ReadingChanged event handler.

async private void ReadingChanged(object sender, InclinometerReadingChangedEventArgs e)
{
    await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
    {
        InclinometerReading reading = e.Reading;
        ScenarioOutput_X.Text = String.Format("{0,5:0.00}", reading.PitchDegrees);
        ScenarioOutput_Y.Text = String.Format("{0,5:0.00}", reading.RollDegrees);
        ScenarioOutput_Z.Text = String.Format("{0,5:0.00}", reading.YawDegrees);
    });
}

Version history

Windows version SDK version Value added
1607 14393 GetDefault(SensorReadingType)
1709 16299 FromIdAsync
1709 16299 GetDeviceSelector
1709 16299 MaxBatchSize
1709 16299 ReportLatency

Properties

DeviceId DeviceId DeviceId DeviceId DeviceId

Gets the device identifier.

MaxBatchSize MaxBatchSize MaxBatchSize MaxBatchSize MaxBatchSize

Gets the maximum number of events that can be batched by the sensor.

MinimumReportInterval MinimumReportInterval MinimumReportInterval MinimumReportInterval MinimumReportInterval

Gets the minimum report interval supported by the inclinometer.

ReadingTransform ReadingTransform ReadingTransform ReadingTransform ReadingTransform

Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

ReadingType ReadingType ReadingType ReadingType ReadingType

Gets the sensor reading type.

ReportInterval ReportInterval ReportInterval ReportInterval ReportInterval

Gets or sets the current report interval for the inclinometer.

ReportLatency ReportLatency ReportLatency ReportLatency ReportLatency

Gets or sets the delay between batches of sensor information.

Methods

FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String)

Asynchronously obtains the sensor from its identifier.

GetCurrentReading() GetCurrentReading() GetCurrentReading() GetCurrentReading() GetCurrentReading()

Gets the current inclinometer reading.

GetDefault() GetDefault() GetDefault() GetDefault() GetDefault()

Returns the default inclinometer for absolute readings.

GetDefault(SensorReadingType) GetDefault(SensorReadingType) GetDefault(SensorReadingType) GetDefault(SensorReadingType) GetDefault(SensorReadingType)

Returns the default inclinometer based on the SensorReadingType.

GetDefaultForRelativeReadings() GetDefaultForRelativeReadings() GetDefaultForRelativeReadings() GetDefaultForRelativeReadings() GetDefaultForRelativeReadings()

Returns the default inclinometer for relative readings.

GetDeviceSelector(SensorReadingType) GetDeviceSelector(SensorReadingType) GetDeviceSelector(SensorReadingType) GetDeviceSelector(SensorReadingType) GetDeviceSelector(SensorReadingType)

Gets the device selector.

Events

ReadingChanged ReadingChanged ReadingChanged ReadingChanged ReadingChanged

Occurs each time the inclinometer reports a new sensor reading.

See also