diff options
| -rw-r--r-- | src/components/interfaces/HMI_API.xml | 29 | ||||
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 32 |
2 files changed, 38 insertions, 23 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml index 19e36fc9cb..495c449e85 100644 --- a/src/components/interfaces/HMI_API.xml +++ b/src/components/interfaces/HMI_API.xml @@ -1,7 +1,10 @@ <?xml version="1.0" standalone="yes"?> <!-- -* Copyright (c) 2016, Ford Motor Company + * Copyright (c) 2016, Ford Motor Company + * All rights reserved. + * + * Copyright (c) 2017 Xevo Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -2270,11 +2273,7 @@ </param> </struct> - <struct name="SpatialStruct"> - <param name="id" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> - <description>A user control's identifier. - </description> - </param> + <struct name="Rectangle"> <param name="x" type="Float" mandatory="true"> <description>The X-coordinate of the user control</description> </param> @@ -2289,6 +2288,16 @@ </param> </struct> + <struct name="HapticRect"> + <description>Defines haptic rectangle data for each user control object for video streaming application</description> + <param name="id" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>A user control spatial identifier</description> + </param> + <param name="rect" type="Common.Rectangle" mandatory="true"> + <description>The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs.</description> + </param> + </struct> + </interface> <interface name="Buttons" version="1.2.0" date="2017-04-27"> @@ -3463,12 +3472,12 @@ <param name="appID" type="Integer" mandatory="true"> <description>Internal ID of the application that requested this RPC.</description> </param> - <param name="HapticSpatialData" type="Common.SpatialStruct" minsize="0" maxsize="1000" mandatory="false" array="true"> + <param name="hapticRectData" type="Common.HapticRect" minsize="0" maxsize="1000" mandatory="false" array="true"> <description> - Array of spatial data structures that represent the locations of all user controls present on the HMI. + Array of rectangle data structures that represent the locations of all user controls present on the HMI. This data should be updated if/when the application presents a new screen. - When a request is sent, if successful, it will replace all spatial data previously sent through RPC. - Avoidance of doubt, when an empty HapticSpatialData, it will be clear all spatial data previously sent through RPC. + When a request is sent, if successful, it will replace all rectangle data previously sent through RPC. + Avoidance of doubt, when an empty hapticRectData, it will be clear all rectangle data previously sent through RPC. </description> </param> </function> diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index a7ded6299e..50ebf65aa4 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -2565,22 +2565,28 @@ </param>
</struct>
- <struct name="SpatialStruct">
- <description>Defines spatial for each user control object for video streaming application</description>
- <param name="id" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
- <description>A user control spatial identifier</description>
- </param>
+ <struct name="Rectangle">
<param name="x" type="Float" mandatory="true">
- <description>The X-coordinate of the user control</description>
+ <description>The upper left X-coordinate of the rectangle</description>
</param>
<param name="y" type="Float" mandatory="true">
- <description>The Y-coordinate of the user control</description>
+ <description>The upper left Y-coordinate of the rectangle</description>
</param>
<param name="width" type="Float" mandatory="true">
- <description>The width of the user control's bounding rectangle</description>
+ <description>The width of the rectangle</description>
</param>
<param name="height" type="Float" mandatory="true">
- <description>The height of the user control's bounding rectangle</description>
+ <description>The height of the rectangle</description>
+ </param>
+ </struct>
+
+ <struct name="HapticRect">
+ <description>Defines haptic data for each user control object for video streaming application</description>
+ <param name="id" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
+ <description>A user control spatial identifier</description>
+ </param>
+ <param name="rect" type="Rectangle" mandatory="true">
+ <description>The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs.</description>
</param>
</struct>
@@ -5031,12 +5037,12 @@ Send the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI.
This data will be utilized by the HMI to determine how and when haptic events should occur
</description>
- <param name="HapticSpatialData" type="SpatialStruct" minsize="0" maxsize="1000" mandatory="false" array="true">
+ <param name="hapticRectData" type="HapticRect" minsize="0" maxsize="1000" mandatory="false" array="true">
<description>
- Array of spatial data structures that represent the locations of all user controls present on the HMI.
+ Array of rectangle data structures that represent the locations of all user controls present on the HMI.
This data should be updated if/when the application presents a new screen.
- When a request is sent, if successful, it will replace all spatial data previously sent through RPC.
- If an empty array is sent, the existing spatial data will be cleared
+ When a request is sent, if successful, it will replace all rectangle data previously sent through RPC.
+ If an empty array is sent, the existing rectangle data will be cleared
</description>
</param>
</function>
|