summaryrefslogtreecommitdiff
path: root/api/franca/navigation
diff options
context:
space:
mode:
Diffstat (limited to 'api/franca/navigation')
-rwxr-xr-xapi/franca/navigation/mapviewer/MapViewerControl.fidl289
-rw-r--r--api/franca/navigation/navigationcore/Guidance.fidl22
2 files changed, 302 insertions, 9 deletions
diff --git a/api/franca/navigation/mapviewer/MapViewerControl.fidl b/api/franca/navigation/mapviewer/MapViewerControl.fidl
index e29af10..0e297ed 100755
--- a/api/franca/navigation/mapviewer/MapViewerControl.fidl
+++ b/api/franca/navigation/mapviewer/MapViewerControl.fidl
@@ -390,7 +390,7 @@ interface MapViewerControl {
}
<**
- @description : setTargetPoint = This method sets the position of the point the camera is always aimed at
+ @description : setTargetPoint = This method sets the position of the point the camera is aimed at
**>
method setTargetPoint {
in {
@@ -1349,6 +1349,286 @@ interface MapViewerControl {
}
<**
+ @description : mapViewRotateBegin = Begin a rotation gesture.
+ **>
+ method mapViewRotateBegin {
+ in {
+ <**
+ @description : sessionHandle = Session handle.
+ **>
+ Handle sessionHandle
+
+ <**
+ @description : mapViewInstanceHandle = Map instance handle.
+ **>
+ Handle mapViewInstanceHandle
+
+ <**
+ @description : anchorPoint = Specifies coordinates in pixels on the screen where the gesture is anchored.
+ **>
+ Pixel anchorPoint
+
+ }
+ error {
+ OK
+ INVALID_SESSION_HANDLE
+ INVALID_MAP_VIEW_INSTANCE_HANDLE
+ INVALID_ANCHOR_POINT
+ }
+ }
+
+
+ <**
+ @description : mapViewRotateUpdate = Provide an update for the rotation gesture.
+ **>
+ method mapViewRotateUpdate {
+ in {
+
+ <**
+ @description : sessionHandle = Session handle.
+ **>
+ Handle sessionHandle
+
+ <**
+ @description : mapViewInstanceHandle = Map instance handle.
+ **>
+ Handle mapViewInstanceHandle
+
+ <**
+ @description : anchorPoint = Specifies coordinates in pixels on the screen where the gesture is anchored.
+ **>
+ Pixel anchorPoint
+
+ <**
+ @description : rotationAngle = The rotation angle in degrees.
+ Range [-179: 180]. Positive (negative) value should result in clockwise (counterclockwise) rotation.
+ **>
+ Int16 rotationAngle
+ }
+ error {
+ OK
+ INVALID_SESSION_HANDLE
+ INVALID_MAP_VIEW_INSTANCE_HANDLE
+ INVALID_ANCHOR_POINT
+ INVALID_ROTATION_ANGLE
+ INVALID_CALL_SEQUENCE
+ }
+ }
+
+ <**
+ @description : mapViewRotateEnd = End the rotation gesture.
+ **>
+ method mapViewRotateEnd {
+ in {
+
+ <**
+ @description : sessionHandle = Session handle.
+ **>
+ Handle sessionHandle
+
+ <**
+ @description : mapViewInstanceHandle = Map instance handle.
+ **>
+ Handle mapViewInstanceHandle
+
+ <**
+ @description : velocity = The remaining velocity of rotation, in degrees per second.
+ **>
+ UInt16 velocity
+ }
+ error {
+ OK
+ INVALID_SESSION_HANDLE
+ INVALID_MAP_VIEW_INSTANCE_HANDLE
+ INVALID_CALL_SEQUENCE
+ }
+ }
+
+ <**
+ @description : mapViewPinchBegin = Begin a pinch gesture.
+ **>
+ method mapViewPinchBegin {
+ in {
+ <**
+ @description : sessionHandle = Session handle.
+ **>
+ Handle sessionHandle
+
+ <**
+ @description : mapViewInstanceHandle = Map instance handle.
+ **>
+ Handle mapViewInstanceHandle
+
+ <**
+ @description : anchorPoint = Specifies coordinates in pixels on the screen where the gesture is anchored.
+ **>
+ Pixel anchorPoint
+
+ }
+ error {
+ OK
+ INVALID_SESSION_HANDLE
+ INVALID_MAP_VIEW_INSTANCE_HANDLE
+ INVALID_ANCHOR_POINT
+ }
+ }
+
+
+ <**
+ @description : mapViewPinchUpdate = Provide an update for the pinch gesture.
+ **>
+ method mapViewPinchUpdate {
+ in {
+
+ <**
+ @description : sessionHandle = Session handle.
+ **>
+ Handle sessionHandle
+
+ <**
+ @description : mapViewInstanceHandle = Map instance handle.
+ **>
+ Handle mapViewInstanceHandle
+
+ <**
+ @description : anchorPoint = Specifies coordinates in pixels on the screen where the gesture is anchored.
+ **>
+ Pixel anchorPoint
+
+ <**
+ @description : scaleFactor = Scale factor relative to the scale during mapViewPinchBegin call
+ **>
+ Double scaleFactor
+ }
+ error {
+ OK
+ INVALID_SESSION_HANDLE
+ INVALID_MAP_VIEW_INSTANCE_HANDLE
+ INVALID_ANCHOR_POINT
+ INVALID_CALL_SEQUENCE
+ }
+ }
+
+ <**
+ @description : mapViewPinchEnd = End the pinch gesture.
+ **>
+ method mapViewPinchEnd {
+ in {
+
+ <**
+ @description : sessionHandle = Session handle.
+ **>
+ Handle sessionHandle
+
+ <**
+ @description : mapViewInstanceHandle = Map instance handle.
+ **>
+ Handle mapViewInstanceHandle
+
+ <**
+ @description : velocity = The remaining velocity of scale, in scale factor per second.
+ **>
+ Double velocity
+ }
+ error {
+ OK
+ INVALID_SESSION_HANDLE
+ INVALID_MAP_VIEW_INSTANCE_HANDLE
+ INVALID_CALL_SEQUENCE
+ }
+ }
+
+
+ <**
+ @description : mapViewTiltBegin = Begin a tilt gesture.
+ **>
+ method mapViewTiltBegin {
+ in {
+ <**
+ @description : sessionHandle = Session handle.
+ **>
+ Handle sessionHandle
+
+ <**
+ @description : mapViewInstanceHandle = Map instance handle.
+ **>
+ Handle mapViewInstanceHandle
+
+ <**
+ @description : anchorPoint = Specifies coordinates in pixels on the screen where the gesture is started.
+ **>
+ Pixel anchorPoint
+
+ }
+ error {
+ OK
+ INVALID_SESSION_HANDLE
+ INVALID_MAP_VIEW_INSTANCE_HANDLE
+ INVALID_ANCHOR_POINT
+ }
+ }
+
+
+ <**
+ @description : mapViewTiltUpdate = Provide an update for the tilt gesture.
+ **>
+ method mapViewTiltUpdate {
+ in {
+
+ <**
+ @description : sessionHandle = Session handle.
+ **>
+ Handle sessionHandle
+
+ <**
+ @description : mapViewInstanceHandle = Map instance handle.
+ **>
+ Handle mapViewInstanceHandle
+
+ <**
+ @description : scale = Current translation on y axis, in pixels from origin coordinates passed in mapViewTiltBegin.
+ **>
+ Int32 translation
+ }
+ error {
+ OK
+ INVALID_SESSION_HANDLE
+ INVALID_MAP_VIEW_INSTANCE_HANDLE
+ INVALID_CALL_SEQUENCE
+ }
+ }
+
+ <**
+ @description : mapViewTiltEnd = End the tilt gesture.
+ **>
+ method mapViewTiltEnd {
+ in {
+
+ <**
+ @description : sessionHandle = Session handle.
+ **>
+ Handle sessionHandle
+
+ <**
+ @description : mapViewInstanceHandle = Map instance handle.
+ **>
+ Handle mapViewInstanceHandle
+
+ <**
+ @description : velocity = The remaining velocity on the y axis, in pixels per second.
+
+ **>
+ UInt32 velocity
+ }
+ error {
+ OK
+ INVALID_SESSION_HANDLE
+ INVALID_MAP_VIEW_INSTANCE_HANDLE
+ INVALID_CALL_SEQUENCE
+ }
+ }
+
+ <**
@description : setMapViewRotation = This method rotates the map
**>
method setMapViewRotation {
@@ -1392,14 +1672,15 @@ interface MapViewerControl {
out {
<**
- @description : rotationAngle = rotation angle in degrees measured from the North axis clockwise. Range[0:360]
+ @description : rotationAngle = rotation angle in degrees measured from the North axis clockwise if possitive
+ or counter clockwise if negative. Range[-179:180].
**>
Int32 rotationAngle
<**
- @description : rotationAnglePerFrame = partial rotation for each map frame in degrees
+ @description : rotationAnglePerSecond = partial rotation angle per second
**>
- Int32 rotationAnglePerFrame
+ Int32 rotationAnglePerSecond
}
}
diff --git a/api/franca/navigation/navigationcore/Guidance.fidl b/api/franca/navigation/navigationcore/Guidance.fidl
index 64de71f..5fedd18 100644
--- a/api/franca/navigation/navigationcore/Guidance.fidl
+++ b/api/franca/navigation/navigationcore/Guidance.fidl
@@ -26,7 +26,7 @@ interface Guidance {
NOT_AVAILABLE = 2
}
- enumeration LaneType extends BasicEnum {
+ enumeration LaneType extends BasicEnum { // Used by laneDirections and directionToFollow (into the UInt32 bitfield)
LANE_INFO_BITMASK_STRAIGHT = 1
LANE_INFO_BITMASK_SLIGHTRIGHT = 2
LANE_INFO_BITMASK_RIGHT = 4
@@ -146,14 +146,14 @@ interface Guidance {
struct LaneInfo { //Note: To describe the divider on the left side of the left-most lane, use the following entry in LANE_INFO: (laneIndex=0xffffffff,laneDirections=0x00000000,directionToFollow=0x00000000,divider=type)
UInt32 laneIndex //number of the individual lane. Counting starts from zero, beginning at the left-most lane in the direction of travel (independent of the driving side)
- ByteBuffer laneDirections //bitfield where each bit corresponds to a certain direction. A 1-bit indicates that the corresponding part of the lane arrow is drawn in the lane information on the street (see the lane info bitmasks)
- LaneType directionToFollow //bitfield where each bit corresponds to a certain direction. A 1-bit indicates that the corresponding part of the lane arrow matches the direction of the corresponding maneuver (see the lane info bitmasks). At most one bit of this bitmask will be set.
+ UInt32 laneDirections //bitfield where each bit corresponds to a certain direction. A 1-bit indicates that the corresponding part of the lane arrow is drawn in the lane information on the street (see the LaneType bitmasks)
+ UInt32 directionToFollow //bitfield where each bit corresponds to a certain direction. A 1-bit indicates that the corresponding part of the lane arrow matches the direction of the corresponding maneuver (see the LaneType bitmasks). At most one bit of this bitmask will be set.
LaneDivider divider //indicates the type of divider between the given lane and the next one to the right, in the direction of travel
}
struct WaypointStruct {
UInt32 waypointOffset //the offset of the way point in meters from the beginning of the route
- UInt32 travelTime //time to reach the way point in seconds
+ UInt32 travelTime //time to reach the waypoint in seconds from the current position
Int32 direction //direction of the way point in degree relatively to the North. Range [0:360]
Side side
Int16 timeZone //time zone of the way point. It is expressed as the time difference from the UTC in minutes
@@ -477,6 +477,12 @@ interface Guidance {
broadcast vehicleLeftTheRoadNetwork {
}
+ <**
+ @description : vehicleReturnedToTheRoadNetwork = This signal is emitted when the vehicle returns to the road network
+ **>
+ broadcast vehicleReturnedToTheRoadNetwork {
+ }
+
<**
@description : guidanceStatusChanged = This signal is emitted when the guidance status changes
**>
@@ -543,6 +549,12 @@ interface Guidance {
}
<**
+ @description : vehicleReturnedToTheRoute = This signal is emitted when the vehicle has returned to the route
+ **>
+ broadcast vehicleReturnedToTheRoute {
+ }
+
+ <**
@description : positionToRouteChanged = This signal is emitted when the vehicle is off-the-road network and either the heading or the distance (or both) to the closest point on the active route changes
**>
broadcast positionToRouteChanged {
@@ -572,4 +584,4 @@ interface Guidance {
RouteChangedCause changeCause
}
}
-} \ No newline at end of file
+}