path: root/api/franca/navigation/mapviewer/MapViewerControlTypes.fidl

// SPDX-License-Identifier: MPL-2.0
// Copyright (C) 2014, PCA Peugeot Citro�n, XS Embedded GmbH, TomTom International B.V., Continental Automotive GmbH, BMW Car IT GmbH,  Alpine Electronics R&D Europe GmbH, AISIN AW CO., LTD.,  Neusoft Technology Solutions GmbH, Jaguar Land Rover Limited, Visteon Corporation, Elektrobit Automotive GmbH
// This Source Code Form is subject to the terms of the
// Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
// this file, you can obtain one at http://mozilla.org/MPL/2.0/.

package org.genivi.navigation.navigationcore

import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"

typeCollection MapViewerControlTypes {
	
//	enumeration MapViewType extends BasicEnum { //Base 0x0010
	enumeration MapViewType { //Base 0x0010
		INVALID 	= 0
		MAIN_MAP		= 16
		SPLIT_SCREEN	= 17		
		GUIDING_MAP		= 18
	}
	
//	enumeration MapScaleMode extends BasicEnum { //Base 0x0110
	enumeration MapScaleMode { //Base 0x0110
		INVALID 	= 0
		AUTOMATIC		= 272
		MANUAL			= 273
		HYBRID			= 274
	}

//	enumeration MapPerspective extends BasicEnum { //Base 0x0020
	enumeration MapPerspective { //Base 0x0020
		INVALID 	= 0
		PERSPECTIVE_2D	= 32
		PERSPECTIVE_3D	= 33
	}

//	enumeration MapObject extends BasicEnum {
	enumeration MapObject {
		INVALID 	= 0
		// TODO: Check which elements are really visible
		DET_POI                           //Points Of Interest
		DET_TTI                           //TTI elements
		DET_ONE_WAY_STREET_ARROW          //Arrows marking one way streets
		DET_CITY_NAME                     //City names
		DET_ROAD_NAME                     //Road names
		DET_MOTORWAY_EXIT_MARKER          //Motorway exit signs
		DET_TRAFFIC_LIGHT                 //Traffic lights
		DET_TRAFFIC_LIGHTS_ALONG_ROUTE    //Traffic lights along the route
		DET_ROAD_ICON                     //Road icons
		DET_DTM                           //Digital Terrain Model
		DET_LANDMARKS_3D                  //3D landmarks
		DET_FAVORITES                     //Saved favorite destinations
		DET_ROUTE_BLOCKING                //Highlighting of blocked routes
		DET_ROAD                          //Roads
		DET_POLYGON                       //Polygons
		DET_DESTINATION                   //Destination flag
		DET_MANOEUVRE_MARKER              //Maneuvre point markers
		DET_LANE_GUIDANCE_MARKER          //Lane guidance point markers
		DET_ROUTE                         //Route
		DET_MANOEUVRE_ARROW               //Maneuvre arrows
		DET_TREKKING_TOUR                 //Trekking tours
		DET_TTI_EDGE_HIGHLIGHTING         //TTI highlighted edges
		DET_CITY_MARKER                   //City markers
		DET_VEHICLE                       //Vehicle
		DET_POLYGON_NAME                  //Name of polygons
		DET_OFF_ROAD_ROUTE                //Connection line between end of a route and an off-road destination
		DET_TTI_ARROW                     //Direction arrow for TTI messages
		DET_POI_NAME                      //Points Of Interest with a label
		DET_RASTER_MAP                    //Raster maps
		DET_BREAD_CRUMB_TRAIL             //Line that connects bread crumbs (past positions)
		DET_EDGE_HIGHLIGHTING             //Draw highlighted edges that were selected by MAP_POINT_QUERY0 - MAP_POINT_QUERY4.
		DET_DIRECTION_ARROW               //Draw arrows that indicate driving or walking direction.
		DET_CITY_BUILDINGS                //Render city buildings.
		DET_FPS_DISPLAY                   //Measure and display frames per second.
		DET_CROSSHAIR                     //Display cross-hair.
		DET_DEVDROP_BANNER                //Enables drawing of a banner. The banner indicates that the current version is a developer's version. The banner is rendered across the display.
		DET_FRAME_AROUND_MAP 			   //a frame is rendered around the map.
		DET_CORONA                        //a corona is drawn around the earth.
		DET_WATEREFFECT                   //Demo effect for water.
		DET_TREES                         //Demo effect for trees.
		DET_RAIN                          //Demo effect for rain.
		DET_CITYMODEL_ROUTE_TRANSPARENCY  //Render buildings transparently around route.
		DET_ROUTE_DESTINATION             //Render destination POIs (e.g. destination flags).
		DET_RANGE_DISPLAY                 //Display range display.
		DET_POI_BRANDS                    //Display branded POIs.
		DET_WEATHER_MARKER                //DrawingElementType_DET_WEATHER_MARKER
		DET_WEATHER_OVERLAY               //Weather map overlay
		DET_WAYPOINT_ROUTE
		DET_WAYPOINT_ROUTE_MARKER
		DET_STENCIL		
	}

//	enumeration PanAction extends BasicEnum { //Base 0x0100
	enumeration PanAction { //Base 0x0100
		INVALID 	= 0
		PAN_START		= 256
		PAN_TO			= 257
		PAN_END			= 258
	}
	
//	enumeration Visibility extends BasicEnum { //Base 0x0040
	enumeration Visibility { //Base 0x0040
		INVALID 	= 0
		VISIBLE			= 67
		INVISIBLE		= 68
		FROZEN			= 69
	}

//	enumeration Level extends BasicEnum { //Base 0x0050
	enumeration Level { //Base 0x0050
		INVALID 	= 0
		LEVEL_1			= 80
		LEVEL_2			= 81
		LEVEL_3			= 82
		LEVEL_4			= 83
		LEVEL_5			= 84
	}

//	enumeration MapTheme extends BasicEnum {		
	enumeration MapTheme {		
		INVALID 	= 0
		THEME_BMW_CLASSIC_DAY
		THEME_BMW_CLASSIC_NIGHT
		THEME_BMW_CLASSIC_TRAFFIC_DAY
		THEME_BMW_CLASSIC_TRAFFIC_NIGHT
		THEME_BMW_ALTERNATIVE_DAY
		THEME_BMW_ALTERNATIVE_NIGHT
		THEME_BMW_ALTERNATIVE_TRAFFIC_DAY
		THEME_BMW_ALTERNATIVE_TRAFFIC_NIGHT
		THEME_BMW_GUIDING

		THEME_MINI_CLASSIC_DAY
		THEME_MINI_CLASSIC_NIGHT
		THEME_MINI_CLASSIC_TRAFFIC_DAY
		THEME_MINI_CLASSIC_TRAFFIC_NIGHT
		THEME_MINI_ALTERNATIVE_DAY
		THEME_MINI_ALTERNATIVE_NIGHT
		THEME_MINI_ALTERNATIVE_TRAFFIC_DAY
		THEME_MINI_ALTERNATIVE_TRAFFIC_NIGHT
		THEME_MINI_GUIDING

		THEME_I_CLASSIC_DAY
		THEME_I_CLASSIC_NIGHT
		THEME_I_CLASSIC_TRAFFIC_DAY
		THEME_I_CLASSIC_TRAFFIC_NIGHT
		THEME_I_ALTERNATIVE_DAY
		THEME_I_ALTERNATIVE_NIGHT
		THEME_I_ALTERNATIVE_TRAFFIC_DAY
		THEME_I_ALTERNATIVE_TRAFFIC_NIGHT
		THEME_I_GUIDING						
	}

	<**
		@description : struct generated for DBus argument CreateMapViewInstance_mapViewSize
	**>
	struct Dimension {
		UInt16 horizontalSize
		UInt16 verticalSize
	}

	map MapObjectVisibility {
		MapObject to Boolean
	}

//	enumeration MapScaleUnit extends BasicEnum { //Base 0x0030
	enumeration MapScaleUnit { //Base 0x0030
		INVALID 	= 0
		METER		= 50
		MILE		= 51
		KM			= 52
		YARD		= 53
		FOOT		= 54
	}

//	enumeration MapScaleType extends BasicEnum { //Base 0x0040
	enumeration MapScaleType { //Base 0x0040
		INVALID 	= 0
		MIN			= 64
		MAX			= 65
		MID			= 66
	}

//	enumeration SelectableMapType extends BasicEnum {
	enumeration SelectableMapType {
		INVALID 	= 0
        MET_POI = 2                            //POI.
        MET_POLYGON = 3                        //Polygons.
        MET_EDGE = 4                           //All edges except roads. E.g. railways rivers ferries.
        MET_ROAD = 5                           //Road edges.
        MET_ROAD_ICON = 6                      //Road icons.
        MET_TTI_ICON = 7                       //TTI icons.
        MET_TTI_EDGE = 8                       //TTI edge [Not yet supported].
        MET_CITY_MARKER = 9                    //City names and city markers.
        MET_ROUTE = 10                         //Tours.
        MET_TREKKING_ROUTE = 11                //Trekking tours.
        MET_POSITION = 12                      //Position.
        MET_LANDMARK = 13                      //Landmarks.
        MET_DESTINATION = 14                   //Destinations.
        MET_FAVORITE = 15                      //Favorites.
        MET_PICTURE = 16                       //Picture.
        MET_GENERIC_MARKER  = 17                //Generic markers like weather markers.
		
		CUSTOM_ELEMENT		= 288 //Base 0x0120
		CURRENT_POSITION	= 289
		WAYPOINT			= 290
		POI					= 291
		TRAFFIC_INCIDENT	= 292	
		ROUTE				= 293
		GEOCOORDINATES		= 294
	}

	<**
		@description : struct generated for DBus argument GetScaleList_scaleList
	**>
	struct MapScale {
		UInt16 scaleId
		UInt16 scaleValue
		MapScaleUnit unit
		UInt32 millimetersPerPixel
	}


	<**
		@description : struct generated for DBus argument SetMapViewSaveArea_saveArea
	**>
	struct MapViewArea {
		Double left
		Double right
		Double top
		Double bottom
	}

	<**
		@description : struct generated for DBus argument SetMapViewPan_pixelCoordinates
	**>
	struct Pixel {
		UInt16 x
		UInt16 y
	}


	<**
		@description : struct generated for DBus argument GetDisplayedRoutes_displayedRoutes
	**>
	struct DisplayedRoute {
		Handle	routeHandle
		Boolean highlighted
	}



	<**
		@description : struct generated for DBus argument DisplayCustomElements_customElementsElem4
	**>
	struct AnchorPoint {
		Int16 x
		Int16 y
	}

	<**
		@description : struct generated for DBus argument DisplayCustomElements_customElements
	**>
	struct CustomElement {
		String name
		String iconUri
		Coordinate2D coordinate
		AnchorPoint elem4
	}


	map tCustomElementDict {
		Handle to CustomElement
	}

	<**
		@description : struct generated for DBus argument SelectElementsOnMap_selectedElements
	**>
	struct SelectedMapElement {
		SelectableMapType type
		Coordinate2D position
		ElementValue value
	}

	union ElementValue {
		Int32 trafficIncident
		Handle handle
		CustomElement element
	}
	
	
}