Simon Hunt | ef31fb2 | 2014-12-19 13:16:44 -0800 | [diff] [blame] | 1 | /* |
Simon Hunt | 8ead3a2 | 2015-01-06 11:00:15 -0800 | [diff] [blame] | 2 | * Copyright 2014,2015 Open Networking Laboratory |
Simon Hunt | ef31fb2 | 2014-12-19 13:16:44 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | /* |
| 18 | ONOS GUI -- Topology View Module |
Simon Hunt | ef31fb2 | 2014-12-19 13:16:44 -0800 | [diff] [blame] | 19 | */ |
| 20 | |
| 21 | (function () { |
| 22 | 'use strict'; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 23 | |
| 24 | var moduleDependencies = [ |
| 25 | 'onosUtil', |
Simon Hunt | 1e4a001 | 2015-01-21 11:36:08 -0800 | [diff] [blame] | 26 | 'onosSvg', |
| 27 | 'onosRemote' |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 28 | ]; |
| 29 | |
| 30 | // references to injected services etc. |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 31 | var $log, fs, ks, zs, gs, ms, sus, tfs, tis; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 32 | |
| 33 | // DOM elements |
Simon Hunt | 7c8ab8d | 2015-02-03 15:05:15 -0800 | [diff] [blame] | 34 | var ovtopo, svg, defs, zoomLayer, mapG, forceG, noDevsLayer; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 35 | |
| 36 | // Internal state |
Simon Hunt | edf5c0e | 2015-01-29 15:00:53 -0800 | [diff] [blame] | 37 | var zoomer; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 38 | |
| 39 | // Note: "exported" state should be properties on 'self' variable |
| 40 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 41 | // --- Short Cut Keys ------------------------------------------------ |
| 42 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 43 | var keyBindings = { |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 44 | //O: [toggleSummary, 'Toggle ONOS summary pane'], |
| 45 | I: [toggleInstances, 'Toggle ONOS instances pane'], |
| 46 | //D: [toggleDetails, 'Disable / enable details pane'], |
| 47 | |
| 48 | //H: [toggleHosts, 'Toggle host visibility'], |
| 49 | //M: [toggleOffline, 'Toggle offline visibility'], |
| 50 | //B: [toggleBg, 'Toggle background image'], |
| 51 | //P: togglePorts, |
| 52 | |
| 53 | //X: [toggleNodeLock, 'Lock / unlock node positions'], |
| 54 | //Z: [toggleOblique, 'Toggle oblique view (Experimental)'], |
| 55 | L: [cycleLabels, 'Cycle device labels'], |
| 56 | //U: [unpin, 'Unpin node (hover mouse over)'], |
| 57 | R: [resetZoom, 'Reset pan / zoom'], |
| 58 | |
| 59 | //V: [showRelatedIntentsAction, 'Show all related intents'], |
| 60 | //rightArrow: [showNextIntentAction, 'Show next related intent'], |
| 61 | //leftArrow: [showPrevIntentAction, 'Show previous related intent'], |
| 62 | //W: [showSelectedIntentTrafficAction, 'Monitor traffic of selected intent'], |
| 63 | //A: [showAllTrafficAction, 'Monitor all traffic'], |
| 64 | //F: [showDeviceLinkFlowsAction, 'Show device link flows'], |
| 65 | |
| 66 | //E: [equalizeMasters, 'Equalize mastership roles'], |
| 67 | |
| 68 | //esc: handleEscape, |
| 69 | |
| 70 | _helpFormat: [ |
| 71 | ['O', 'I', 'D', '-', 'H', 'M', 'B', 'P' ], |
| 72 | ['X', 'Z', 'L', 'U', 'R' ], |
| 73 | ['V', 'rightArrow', 'leftArrow', 'W', 'A', 'F', '-', 'E' ] |
| 74 | ] |
| 75 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 76 | }; |
| 77 | |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 78 | // mouse gestures |
| 79 | var gestures = [ |
| 80 | ['click', 'Select the item and show details'], |
| 81 | ['shift-click', 'Toggle selection state'], |
| 82 | ['drag', 'Reposition (and pin) device / host'], |
| 83 | ['cmd-scroll', 'Zoom in / out'], |
| 84 | ['cmd-drag', 'Pan'] |
| 85 | ]; |
| 86 | |
| 87 | function toggleInstances() { |
| 88 | if (tis.isVisible()) { |
| 89 | tis.hide(); |
| 90 | } else { |
| 91 | tis.show(); |
| 92 | } |
| 93 | tfs.updateDeviceColors(); |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 94 | } |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 95 | |
| 96 | function cycleLabels() { |
| 97 | $log.debug('Cycle Labels.....'); |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 98 | } |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 99 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 100 | function resetZoom() { |
| 101 | zoomer.reset(); |
| 102 | } |
| 103 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 104 | function setUpKeys() { |
| 105 | ks.keyBindings(keyBindings); |
| 106 | } |
| 107 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 108 | |
| 109 | // --- Glyphs, Icons, and the like ----------------------------------- |
| 110 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 111 | function setUpDefs() { |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 112 | defs = svg.append('defs'); |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 113 | gs.loadDefs(defs); |
| 114 | } |
| 115 | |
| 116 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 117 | // --- Pan and Zoom -------------------------------------------------- |
| 118 | |
| 119 | // zoom enabled predicate. ev is a D3 source event. |
| 120 | function zoomEnabled(ev) { |
| 121 | return (ev.metaKey || ev.altKey); |
| 122 | } |
| 123 | |
| 124 | function zoomCallback() { |
| 125 | var tr = zoomer.translate(), |
| 126 | sc = zoomer.scale(); |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 127 | |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 128 | // keep the map lines constant width while zooming |
Simon Hunt | 737c89f | 2015-01-28 12:23:19 -0800 | [diff] [blame] | 129 | mapG.style('stroke-width', (2.0 / sc) + 'px'); |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 130 | } |
| 131 | |
| 132 | function setUpZoom() { |
Simon Hunt | a7b6a6b | 2015-01-13 19:53:09 -0800 | [diff] [blame] | 133 | zoomLayer = svg.append('g').attr('id', 'topo-zoomlayer'); |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 134 | zoomer = zs.createZoomer({ |
| 135 | svg: svg, |
| 136 | zoomLayer: zoomLayer, |
| 137 | zoomEnabled: zoomEnabled, |
| 138 | zoomCallback: zoomCallback |
| 139 | }); |
| 140 | } |
| 141 | |
| 142 | |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 143 | // callback invoked when the SVG view has been resized.. |
Simon Hunt | b0ec1e5 | 2015-01-28 18:13:49 -0800 | [diff] [blame] | 144 | function svgResized(dim) { |
Simon Hunt | b0ec1e5 | 2015-01-28 18:13:49 -0800 | [diff] [blame] | 145 | tfs.resize(dim); |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 146 | } |
| 147 | |
Simon Hunt | a7b6a6b | 2015-01-13 19:53:09 -0800 | [diff] [blame] | 148 | // --- Background Map ------------------------------------------------ |
| 149 | |
Simon Hunt | 7c8ab8d | 2015-02-03 15:05:15 -0800 | [diff] [blame] | 150 | function setUpNoDevs() { |
| 151 | var g, box; |
| 152 | noDevsLayer = svg.append('g').attr({ |
| 153 | id: 'topo-noDevsLayer', |
| 154 | transform: sus.translate(500,500) |
| 155 | }); |
| 156 | // Note, SVG viewbox is '0 0 1000 1000', defined in topo.html. |
| 157 | // We are translating this layer to have its origin at the center |
| 158 | |
| 159 | g = noDevsLayer.append('g'); |
| 160 | gs.addGlyph(g, 'bird', 100).attr('class', 'noDevsBird'); |
| 161 | g.append('text').text('No devices are connected') |
| 162 | .attr({ x: 120, y: 80}); |
| 163 | |
| 164 | box = g.node().getBBox(); |
| 165 | box.x -= box.width/2; |
| 166 | box.y -= box.height/2; |
| 167 | g.attr('transform', sus.translate(box.x, box.y)); |
| 168 | |
| 169 | showNoDevs(true); |
| 170 | } |
| 171 | |
| 172 | function showNoDevs(b) { |
| 173 | sus.makeVisible(noDevsLayer, b); |
| 174 | } |
| 175 | |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 176 | function showCallibrationPoints() { |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 177 | // temp code for calibration |
| 178 | var points = [ |
| 179 | [0, 0], [0, 1000], [1000, 0], [1000, 1000] |
| 180 | ]; |
Simon Hunt | 737c89f | 2015-01-28 12:23:19 -0800 | [diff] [blame] | 181 | mapG.selectAll('circle') |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 182 | .data(points) |
| 183 | .enter() |
| 184 | .append('circle') |
| 185 | .attr('cx', function (d) { return d[0]; }) |
| 186 | .attr('cy', function (d) { return d[1]; }) |
| 187 | .attr('r', 5) |
| 188 | .style('fill', 'red'); |
Simon Hunt | a7b6a6b | 2015-01-13 19:53:09 -0800 | [diff] [blame] | 189 | } |
| 190 | |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 191 | function setUpMap() { |
Simon Hunt | 737c89f | 2015-01-28 12:23:19 -0800 | [diff] [blame] | 192 | mapG = zoomLayer.append('g').attr('id', 'topo-map'); |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 193 | |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 194 | //showCallibrationPoints(); |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 195 | //return ms.loadMapInto(map, '*continental_us', {mapFillScale:0.5}); |
| 196 | |
| 197 | // returns a promise for the projection... |
| 198 | return ms.loadMapInto(mapG, '*continental_us'); |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 199 | } |
| 200 | |
Simon Hunt | 737c89f | 2015-01-28 12:23:19 -0800 | [diff] [blame] | 201 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 202 | // --- Controller Definition ----------------------------------------- |
| 203 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 204 | angular.module('ovTopo', moduleDependencies) |
| 205 | |
| 206 | .controller('OvTopoCtrl', [ |
Simon Hunt | 54442fa | 2015-01-26 14:17:38 -0800 | [diff] [blame] | 207 | '$scope', '$log', '$location', '$timeout', |
Simon Hunt | 4b66859 | 2015-01-29 17:33:53 -0800 | [diff] [blame] | 208 | 'FnService', 'MastService', 'KeyService', 'ZoomService', |
Simon Hunt | 7c8ab8d | 2015-02-03 15:05:15 -0800 | [diff] [blame] | 209 | 'GlyphService', 'MapService', 'SvgUtilService', |
Simon Hunt | b0ec1e5 | 2015-01-28 18:13:49 -0800 | [diff] [blame] | 210 | 'TopoEventService', 'TopoForceService', 'TopoPanelService', |
Simon Hunt | 4b66859 | 2015-01-29 17:33:53 -0800 | [diff] [blame] | 211 | 'TopoInstService', |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 212 | |
Simon Hunt | a11b4eb | 2015-01-28 16:20:50 -0800 | [diff] [blame] | 213 | function ($scope, _$log_, $loc, $timeout, _fs_, mast, |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 214 | _ks_, _zs_, _gs_, _ms_, _sus_, tes, _tfs_, tps, _tis_) { |
| 215 | var self = this, |
Simon Hunt | 1894d79 | 2015-02-04 17:09:20 -0800 | [diff] [blame^] | 216 | projection, |
| 217 | uplink = { |
| 218 | // provides function calls back into this space |
| 219 | showNoDevs: showNoDevs, |
| 220 | projection: function () { return projection; }, |
| 221 | sendEvent: tes.sendEvent |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 222 | }; |
| 223 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 224 | $log = _$log_; |
Simon Hunt | a11b4eb | 2015-01-28 16:20:50 -0800 | [diff] [blame] | 225 | fs = _fs_; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 226 | ks = _ks_; |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 227 | zs = _zs_; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 228 | gs = _gs_; |
Simon Hunt | 1e8eff4 | 2015-01-08 17:19:02 -0800 | [diff] [blame] | 229 | ms = _ms_; |
Simon Hunt | 7c8ab8d | 2015-02-03 15:05:15 -0800 | [diff] [blame] | 230 | sus = _sus_; |
Simon Hunt | 737c89f | 2015-01-28 12:23:19 -0800 | [diff] [blame] | 231 | tfs = _tfs_; |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 232 | tis = _tis_; |
Simon Hunt | ef31fb2 | 2014-12-19 13:16:44 -0800 | [diff] [blame] | 233 | |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 234 | self.notifyResize = function () { |
Simon Hunt | b0ec1e5 | 2015-01-28 18:13:49 -0800 | [diff] [blame] | 235 | svgResized(fs.windowSize(mast.mastHeight())); |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 236 | }; |
Simon Hunt | ef31fb2 | 2014-12-19 13:16:44 -0800 | [diff] [blame] | 237 | |
Simon Hunt | 54442fa | 2015-01-26 14:17:38 -0800 | [diff] [blame] | 238 | // Cleanup on destroyed scope.. |
Simon Hunt | 584122a | 2015-01-21 15:32:40 -0800 | [diff] [blame] | 239 | $scope.$on('$destroy', function () { |
| 240 | $log.log('OvTopoCtrl is saying Buh-Bye!'); |
Simon Hunt | fd1231a | 2015-01-26 22:14:51 -0800 | [diff] [blame] | 241 | tes.closeSock(); |
Simon Hunt | 626d210 | 2015-01-29 11:54:50 -0800 | [diff] [blame] | 242 | tps.destroyPanels(); |
Simon Hunt | 4b66859 | 2015-01-29 17:33:53 -0800 | [diff] [blame] | 243 | tis.destroyInst(); |
Simon Hunt | 584122a | 2015-01-21 15:32:40 -0800 | [diff] [blame] | 244 | }); |
| 245 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 246 | // svg layer and initialization of components |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 247 | ovtopo = d3.select('#ov-topo'); |
| 248 | svg = ovtopo.select('svg'); |
Simon Hunt | a11b4eb | 2015-01-28 16:20:50 -0800 | [diff] [blame] | 249 | // set the svg size to match that of the window, less the masthead |
| 250 | svg.attr(fs.windowSize(mast.mastHeight())); |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 251 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 252 | setUpKeys(); |
| 253 | setUpDefs(); |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 254 | setUpZoom(); |
Simon Hunt | 7c8ab8d | 2015-02-03 15:05:15 -0800 | [diff] [blame] | 255 | setUpNoDevs(); |
Simon Hunt | 1894d79 | 2015-02-04 17:09:20 -0800 | [diff] [blame^] | 256 | setUpMap().then( |
| 257 | function (proj) { |
| 258 | projection = proj; |
| 259 | $log.debug('** We installed the projection: ', proj); |
| 260 | } |
| 261 | ); |
Simon Hunt | fd1231a | 2015-01-26 22:14:51 -0800 | [diff] [blame] | 262 | |
Simon Hunt | 1894d79 | 2015-02-04 17:09:20 -0800 | [diff] [blame^] | 263 | forceG = zoomLayer.append('g').attr('id', 'topo-force'); |
| 264 | tfs.initForce(forceG, uplink, svg.attr('width'), svg.attr('height')); |
Simon Hunt | 4b66859 | 2015-01-29 17:33:53 -0800 | [diff] [blame] | 265 | tis.initInst(); |
Simon Hunt | 626d210 | 2015-01-29 11:54:50 -0800 | [diff] [blame] | 266 | tps.initPanels(); |
Simon Hunt | fd1231a | 2015-01-26 22:14:51 -0800 | [diff] [blame] | 267 | tes.openSock(); |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 268 | |
| 269 | $log.log('OvTopoCtrl has been created'); |
Simon Hunt | ef31fb2 | 2014-12-19 13:16:44 -0800 | [diff] [blame] | 270 | }]); |
| 271 | }()); |