]> git.openstreetmap.org Git - rails.git/blob - app/assets/javascripts/index/directions/osrm.js
Show exit numbers for off ramps in OSRM directions
[rails.git] / app / assets / javascripts / index / directions / osrm.js
1 // OSRM car engine
2 // Doesn't yet support hints
3
4 function OSRMEngine() {
5   var cachedHints = [];
6
7   return {
8     id: "osrm_car",
9     creditline: '<a href="http://project-osrm.org/" target="_blank">OSRM</a>',
10     draggable: true,
11
12     _transformSteps: function(input_steps, line) {
13       var INSTRUCTION_TEMPLATE = {
14         'continue': 'javascripts.directions.instructions.continue',
15         'merge right': 'javascripts.directions.instructions.merge_right',
16         'merge left': 'javascripts.directions.instructions.merge_left',
17         'off ramp right': 'javascripts.directions.instructions.offramp_right',
18         'off ramp left': 'javascripts.directions.instructions.offramp_left',
19         'on ramp right': 'javascripts.directions.instructions.onramp_right',
20         'on ramp left': 'javascripts.directions.instructions.onramp_left',
21         'fork right': 'javascripts.directions.instructions.fork_right',
22         'fork left': 'javascripts.directions.instructions.fork_left',
23         'end of road right': 'javascripts.directions.instructions.endofroad_right',
24         'end of road left': 'javascripts.directions.instructions.endofroad_left',
25         'turn straight': 'javascripts.directions.instructions.continue',
26         'turn slight right': 'javascripts.directions.instructions.slight_right',
27         'turn right': 'javascripts.directions.instructions.turn_right',
28         'turn sharp right': 'javascripts.directions.instructions.sharp_right',
29         'turn uturn': 'javascripts.directions.instructions.uturn',
30         'turn sharp left': 'javascripts.directions.instructions.sharp_left',
31         'turn left': 'javascripts.directions.instructions.turn_left',
32         'turn slight left': 'javascripts.directions.instructions.slight_left',
33         'roundabout': 'javascripts.directions.instructions.roundabout',
34         'rotary': 'javascripts.directions.instructions.roundabout',
35         'depart': 'javascripts.directions.instructions.start',
36         'arrive': 'javascripts.directions.instructions.destination',
37       };
38       var ICON_MAP = {
39         'continue': 0,
40         'merge right': 21,
41         'merge left': 20,
42         'off ramp right': 24,
43         'off ramp left': 25,
44         'on ramp right': 2,
45         'on ramp left': 6,
46         'fork right': 18,
47         'fork left': 19,
48         'end of road right': 22,
49         'end of road left': 23,
50         'turn straight': 0,
51         'turn slight right': 1,
52         'turn right': 2,
53         'turn sharp right': 3,
54         'turn uturn': 4,
55         'turn slight left': 5,
56         'turn left': 6,
57         'turn sharp left': 7,
58         'roundabout': 10,
59         'rotary': 10,
60         'depart': 8,
61         'arrive': 14
62       };
63       var transformed_steps = input_steps.map(function(step, idx) {
64         var maneuver_id;
65
66         // special case handling
67         switch (step.maneuver.type) {
68           case 'on ramp':
69           case 'off ramp':
70           case 'merge':
71           case 'end of road':
72           case 'fork':
73             maneuver_id = step.maneuver.type + ' ' + (step.maneuver.modifier.indexOf('left') >= 0 ? 'left' : 'right');
74             break;
75           case 'depart':
76           case 'arrive':
77           case 'roundabout':
78           case 'rotary':
79             maneuver_id = step.maneuver.type;
80             break;
81           case 'roundabout turn':
82           case 'turn':
83             maneuver_id = "turn " + step.maneuver.modifier;
84             break;
85           // for unknown types the fallback is turn
86           default:
87             maneuver_id = "turn " + step.maneuver.modifier;
88             break;
89         }
90         var template = INSTRUCTION_TEMPLATE[maneuver_id];
91
92         // convert lat,lng pairs to LatLng objects
93         var step_geometry = L.PolylineUtil.decode(step.geometry, { precision: 5 }).map(function(a) { return L.latLng(a); }) ;
94         // append step_geometry on line
95         Array.prototype.push.apply(line, step_geometry);
96
97         var instText = "<b>" + (idx + 1) + ".</b> ";
98         var destinations = "<b>" + step.destinations + "</b>";
99         var namedRoad = true;
100         var name;
101
102         if (step.name && step.ref) {
103           name = "<b>" + step.name + " (" + step.ref + ")</b>";
104         } else if (step.name) {
105           name = "<b>" + step.name + "</b>";
106         } else if (step.ref) {
107           name = "<b>" + step.ref + "</b>";
108         } else {
109           name = I18n.t('javascripts.directions.instructions.unnamed');
110           namedRoad = false;
111         }
112
113         if (step.maneuver.type.match(/rotary|roundabout/)) {
114           if (step.maneuver.exit) {
115             instText += I18n.t(template + '_with_exit', { exit: step.maneuver.exit, name: name } );
116           } else {
117             instText += I18n.t(template + '_without_exit', { name: name } );
118           }
119         } else if (step.maneuver.type.match(/on ramp|off ramp/)) {
120           var params = {};
121           if (step.exits && step.maneuver.type.match(/off ramp/)) params.exit = step.exits;
122           if (step.destinations) params.directions = step.destinations;
123           if (namedRoad) params.directions = name;
124           if (Object.keys(params).length > 0) {
125             template = template + "_with_" + Object.keys(params).join("_");
126           }
127           instText += I18n.t(template, params);
128         } else {
129           instText += I18n.t(template + '_without_exit', { name: name });
130         }
131         return [[step.maneuver.location[1], step.maneuver.location[0]], ICON_MAP[maneuver_id], instText, step.distance, step_geometry];
132       });
133
134       return transformed_steps;
135     },
136
137     getRoute: function (points, callback) {
138
139       var params = [
140         { name: "overview", value: "false" },
141         { name: "geometries", value: "polyline" },
142         { name: "steps", value: true }
143       ];
144
145
146       if (cachedHints.length === points.length) {
147         params.push({name: "hints", value: cachedHints.join(";")});
148       } else {
149         // invalidate cache
150         cachedHints = [];
151       }
152
153       var encoded_coords = points.map(function(p) {
154         return p.lng + ',' + p.lat;
155       }).join(';');
156
157       var req_url = OSM.OSRM_URL + encoded_coords;
158
159       var onResponse = function (data) {
160         if (data.code !== 'Ok')
161           return callback(true);
162
163         cachedHints = data.waypoints.map(function(wp) {
164           return wp.hint;
165         });
166
167         var line = [];
168         var transformLeg = function (leg) {
169           return this._transformSteps(leg.steps, line);
170         };
171
172         var steps = [].concat.apply([], data.routes[0].legs.map(transformLeg.bind(this)));
173
174         callback(false, {
175           line: line,
176           steps: steps,
177           distance: data.routes[0].distance,
178           time: data.routes[0].duration
179         });
180       };
181
182       return $.ajax({
183         url: req_url,
184         data: params,
185         dataType: "json",
186         success: onResponse.bind(this),
187         error: function () {
188           callback(true);
189         }
190       });
191     }
192   };
193 }
194
195 OSM.Directions.addEngine(new OSRMEngine(), true);