Skip to content

Commit 756f375

Browse files
Karl-Bridge-MicrosoftKarl-Bridge-Microsoft
committed
Merged PR 21179: Ge windows.devices.sensors into main
2 parents 196e89a + a5f8252 commit 756f375

49 files changed

Lines changed: 1138 additions & 8 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎windows.devices.sensors/detectedperson.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
-api-id: T:Windows.Devices.Sensors.DetectedPerson
3+
-api-type: winrt class
4+
---
5+
6+
# Windows.Devices.Sensors.DetectedPerson
7+
8+
<!--
9+
public sealed class DetectedPerson
10+
-->
11+
12+
## -description
13+
14+
Represents a detected person as detected by the human presence sensor.
15+
16+
## -remarks
17+
18+
## -see-also
19+
20+
## -examples

‎windows.devices.sensors/detectedperson_distanceinmillimeters.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
-api-id: P:Windows.Devices.Sensors.DetectedPerson.DistanceInMillimeters
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Devices.Sensors.DetectedPerson.DistanceInMillimeters
7+
8+
<!--
9+
public System.Nullable<uint> DistanceInMillimeters { get; }
10+
-->
11+
12+
## -description
13+
14+
Gets the distance in millimeters the detected person is from the human presence sensor.
15+
16+
## -property-value
17+
18+
The distance in millimeters the detected person is from the human presence sensor.
19+
20+
## -remarks
21+
22+
## -see-also
23+
24+
## -examples

‎windows.devices.sensors/detectedperson_engagement.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
-api-id: P:Windows.Devices.Sensors.DetectedPerson.Engagement
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Devices.Sensors.DetectedPerson.Engagement
7+
8+
<!--
9+
public Windows.Devices.Sensors.HumanEngagement Engagement { get; }
10+
-->
11+
12+
## -description
13+
14+
Gets how the detected person is engaged with the device.
15+
16+
## -property-value
17+
18+
How the detected person is engaged with the device.
19+
20+
## -remarks
21+
22+
## -see-also
23+
24+
## -examples

‎windows.devices.sensors/detectedperson_headorientation.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
-api-id: P:Windows.Devices.Sensors.DetectedPerson.HeadOrientation
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Devices.Sensors.DetectedPerson.HeadOrientation
7+
8+
<!--
9+
public Windows.Devices.Sensors.HeadOrientation HeadOrientation { get; }
10+
-->
11+
12+
## -description
13+
14+
Gets the orientation of the detected person's head relative to the human presence sensor, in terms of [roll](headorientation_rollindegrees.md), [pitch](headorientation_pitchindegrees.md), and [yaw](headorientation_yawindegrees.md).
15+
16+
## -property-value
17+
18+
The orientation of the detected person's head relative to the human presence sensor, in terms of [roll](headorientation_rollindegrees.md), [pitch](headorientation_pitchindegrees.md), and [yaw](headorientation_yawindegrees.md).
19+
20+
## -remarks
21+
22+
## -see-also
23+
24+
## -examples

‎windows.devices.sensors/detectedperson_headposition.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
-api-id: P:Windows.Devices.Sensors.DetectedPerson.HeadPosition
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Devices.Sensors.DetectedPerson.HeadPosition
7+
8+
<!--
9+
public Windows.Devices.Sensors.HeadPosition HeadPosition { get; }
10+
-->
11+
12+
## -description
13+
14+
Gets the location of a user's head relative to the human presence sensor, in terms of [azimuth](headposition_azimuthindegrees.md) and [altitude](headposition_altitudeindegrees.md).
15+
16+
## -property-value
17+
18+
the location of a user's head relative to the human presence sensor, in terms of [azimuth](headposition_azimuthindegrees.md) and [altitude](headposition_altitudeindegrees.md).
19+
20+
## -remarks
21+
22+
## -see-also
23+
24+
## -examples

‎windows.devices.sensors/detectedperson_personid.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
-api-id: P:Windows.Devices.Sensors.DetectedPerson.PersonId
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Devices.Sensors.DetectedPerson.PersonId
7+
8+
<!--
9+
public System.Nullable<int> PersonId { get; }
10+
-->
11+
12+
## -description
13+
14+
Gets the unique ID assigned to the detected person.
15+
16+
## -property-value
17+
18+
The unique ID assigned to the detected person.
19+
20+
## -remarks
21+
22+
## -see-also
23+
24+
## -examples

‎windows.devices.sensors/headorientation.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
-api-id: T:Windows.Devices.Sensors.HeadOrientation
3+
-api-type: winrt class
4+
---
5+
6+
# Windows.Devices.Sensors.HeadOrientation
7+
8+
<!--
9+
public sealed class HeadOrientation
10+
-->
11+
12+
## -description
13+
14+
Represents an object that describes the orientation a user's head is facing relative to the human presence sensor, in terms of [roll](headorientation_rollindegrees.md), [pitch](headorientation_pitchindegrees.md), and [yaw](headorientation_yawindegrees.md).
15+
16+
## -remarks
17+
18+
The X-axis is in the plane of the device screen. It is positive towards the right-hand side of the screen, from the perspective of a user facing the device. (For devices without a screen, the axes are defined relative to the front panel of the device.)
19+
20+
The Y-axis is in the plane of the screen. It is positive towards the top of the screen.
21+
22+
The Z-axis is perpendicular to the screen. It is positive towards the user facing the device.
23+
24+
The axes are fixed relative to the device and don't change with device rotation.
25+
26+
The following image shows how roll, pitch, and yaw are described by the human presence APIs.
27+
28+
:::image type="content" source="images/human-presence-roll-pitch-yaw.png" alt-text="Diagram depicting how roll, pitch, and yaw are described by the human presence APIs.":::
29+
30+
## -see-also
31+
32+
[HeadPosition](headposition.md)
33+
34+
## -examples

‎windows.devices.sensors/headorientation_pitchindegrees.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
-api-id: P:Windows.Devices.Sensors.HeadOrientation.PitchInDegrees
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Devices.Sensors.HeadOrientation.PitchInDegrees
7+
8+
<!--
9+
public System.Nullable<double> PitchInDegrees { get; }
10+
-->
11+
12+
## -description
13+
14+
Gets the counterclockwise rotation of the user's head around the X'-axis (or lateral axis), in degrees.
15+
16+
## -property-value
17+
18+
The counterclockwise rotation of the user's head around the X'-axis (or lateral axis), in degrees.
19+
20+
This value has a range of [-180, 180) degrees.
21+
22+
## -remarks
23+
24+
Similar to tilting the nose of an aeroplane up or down.
25+
26+
In the zero position, the X'-axis is parallel to the device's X-axis and points from the center of the person's face towards the right, from the device perspective.
27+
28+
:::image type="content" source="images/human-presence-roll-pitch-yaw.png" alt-text="Diagram depicting how roll, pitch, and yaw are described by the human presence APIs.":::
29+
30+
## -see-also
31+
32+
[YawInDegrees](headorientation_yawindegrees.md), [RollInDegrees](headorientation_rollindegrees.md)
33+
34+
## -examples

‎windows.devices.sensors/headorientation_rollindegrees.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
-api-id: P:Windows.Devices.Sensors.HeadOrientation.RollInDegrees
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Devices.Sensors.HeadOrientation.RollInDegrees
7+
8+
<!--
9+
public System.Nullable<double> RollInDegrees { get; }
10+
-->
11+
12+
## -description
13+
14+
Gets the counterclockwise rotation of the user's head around the Z'-axis (or longitudinal axis), in degrees.
15+
16+
## -property-value
17+
18+
The counterclockwise rotation of the user's head around the Z'-axis (or longitudinal axis), in degrees.
19+
20+
This value has a range of [0, 360) degrees.
21+
22+
## -remarks
23+
24+
Similar to tilting the motion of a wheel on a car or bike.
25+
26+
In the zero position, the Z'-axis is parallel to the device's Z-axis and points from the center of the person's face towards the device.
27+
28+
:::image type="content" source="images/human-presence-roll-pitch-yaw.png" alt-text="Diagram depicting how roll, pitch, and yaw are described by the human presence APIs.":::
29+
30+
## -see-also
31+
32+
[YawInDegrees](headorientation_yawindegrees.md), [PitchInDegrees](headorientation_pitchindegrees.md)
33+
34+
## -examples

‎windows.devices.sensors/headorientation_yawindegrees.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
-api-id: P:Windows.Devices.Sensors.HeadOrientation.YawInDegrees
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Devices.Sensors.HeadOrientation.YawInDegrees
7+
8+
<!--
9+
public System.Nullable<double> YawInDegrees { get; }
10+
-->
11+
12+
## -description
13+
14+
Gets the counterclockwise rotation of the user's head around the Y'-axis (or vertical axis), in degrees.
15+
16+
## -property-value
17+
18+
The counterclockwise rotation of the user's head around the Y'-axis (or vertical axis), in degrees.
19+
20+
This value has a range of [-90, 90) degrees.
21+
22+
## -remarks
23+
24+
Similar to turning your head left or right.
25+
26+
In the zero position, the Y'-axis is parallel to the device's Y-axis and points from the center of the person's face upwards.
27+
28+
:::image type="content" source="images/human-presence-roll-pitch-yaw.png" alt-text="Diagram depicting how roll, pitch, and yaw are described by the human presence APIs.":::
29+
30+
## -see-also
31+
32+
[RollInDegrees](headorientation_rollindegrees.md), [PitchInDegrees](headorientation_pitchindegrees.md)
33+
34+
## -examples

0 commit comments

Comments
 (0)