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 | 1e4a001 | 2015-01-21 11:36:08 -0800 | [diff] [blame] | 31 | var $log, ks, zs, gs, ms, wss; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 32 | |
| 33 | // DOM elements |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 34 | var ovtopo, svg, defs, zoomLayer, map; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 35 | |
| 36 | // Internal state |
Simon Hunt | 970e7fd | 2015-01-22 17:46:28 -0800 | [diff] [blame] | 37 | var zoomer, wsock; |
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 | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 44 | W: [logWarning, '(temp) log a warning'], |
| 45 | E: [logError, '(temp) log an error'], |
| 46 | R: [resetZoom, 'Reset pan / zoom'] |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 47 | }; |
| 48 | |
| 49 | // ----------------- |
| 50 | // these functions are necessarily temporary examples.... |
| 51 | function logWarning() { |
| 52 | $log.warn('You have been warned!'); |
| 53 | } |
| 54 | function logError() { |
| 55 | $log.error('You are erroneous!'); |
| 56 | } |
| 57 | // ----------------- |
| 58 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 59 | function resetZoom() { |
| 60 | zoomer.reset(); |
| 61 | } |
| 62 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 63 | function setUpKeys() { |
| 64 | ks.keyBindings(keyBindings); |
| 65 | } |
| 66 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 67 | |
| 68 | // --- Glyphs, Icons, and the like ----------------------------------- |
| 69 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 70 | function setUpDefs() { |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 71 | defs = svg.append('defs'); |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 72 | gs.loadDefs(defs); |
| 73 | } |
| 74 | |
| 75 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 76 | // --- Pan and Zoom -------------------------------------------------- |
| 77 | |
| 78 | // zoom enabled predicate. ev is a D3 source event. |
| 79 | function zoomEnabled(ev) { |
| 80 | return (ev.metaKey || ev.altKey); |
| 81 | } |
| 82 | |
| 83 | function zoomCallback() { |
| 84 | var tr = zoomer.translate(), |
| 85 | sc = zoomer.scale(); |
| 86 | $log.log('ZOOM: translate = ' + tr + ', scale = ' + sc); |
| 87 | |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 88 | // keep the map lines constant width while zooming |
| 89 | map.style('stroke-width', (2.0 / sc) + 'px'); |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | function setUpZoom() { |
Simon Hunt | a7b6a6b | 2015-01-13 19:53:09 -0800 | [diff] [blame] | 93 | zoomLayer = svg.append('g').attr('id', 'topo-zoomlayer'); |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 94 | zoomer = zs.createZoomer({ |
| 95 | svg: svg, |
| 96 | zoomLayer: zoomLayer, |
| 97 | zoomEnabled: zoomEnabled, |
| 98 | zoomCallback: zoomCallback |
| 99 | }); |
| 100 | } |
| 101 | |
| 102 | |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 103 | // callback invoked when the SVG view has been resized.. |
| 104 | function svgResized(w, h) { |
| 105 | // not used now, but may be required later... |
| 106 | } |
| 107 | |
Simon Hunt | a7b6a6b | 2015-01-13 19:53:09 -0800 | [diff] [blame] | 108 | // --- Background Map ------------------------------------------------ |
| 109 | |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 110 | function showCallibrationPoints() { |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 111 | // temp code for calibration |
| 112 | var points = [ |
| 113 | [0, 0], [0, 1000], [1000, 0], [1000, 1000] |
| 114 | ]; |
| 115 | map.selectAll('circle') |
| 116 | .data(points) |
| 117 | .enter() |
| 118 | .append('circle') |
| 119 | .attr('cx', function (d) { return d[0]; }) |
| 120 | .attr('cy', function (d) { return d[1]; }) |
| 121 | .attr('r', 5) |
| 122 | .style('fill', 'red'); |
Simon Hunt | a7b6a6b | 2015-01-13 19:53:09 -0800 | [diff] [blame] | 123 | } |
| 124 | |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 125 | function setUpMap() { |
| 126 | map = zoomLayer.append('g').attr('id', 'topo-map'); |
| 127 | //ms.loadMapInto(map, '*continental_us', {mapFillScale:0.5}); |
| 128 | ms.loadMapInto(map, '*continental_us'); |
| 129 | //showCallibrationPoints(); |
| 130 | } |
| 131 | |
Simon Hunt | 1e4a001 | 2015-01-21 11:36:08 -0800 | [diff] [blame] | 132 | // --- Web Socket Connection ----------------------------------------- |
| 133 | |
Simon Hunt | 584122a | 2015-01-21 15:32:40 -0800 | [diff] [blame] | 134 | function onWsOpen() { |
| 135 | $log.log('web socket opened...'); |
| 136 | |
| 137 | } |
| 138 | |
Simon Hunt | 970e7fd | 2015-01-22 17:46:28 -0800 | [diff] [blame] | 139 | function onWsMessage(ev) { |
| 140 | $log.log('got JSON event: ', ev); |
Simon Hunt | 584122a | 2015-01-21 15:32:40 -0800 | [diff] [blame] | 141 | |
| 142 | } |
| 143 | |
Simon Hunt | 970e7fd | 2015-01-22 17:46:28 -0800 | [diff] [blame] | 144 | function onWsClose(closeEvent) { |
| 145 | $log.log('web socket closed...', closeEvent); |
Simon Hunt | 584122a | 2015-01-21 15:32:40 -0800 | [diff] [blame] | 146 | |
| 147 | } |
| 148 | |
Simon Hunt | bb920fd | 2015-01-22 17:06:32 -0800 | [diff] [blame] | 149 | // wsport indicates web-socket-server port other than the default. |
| 150 | // Used for testing with the mock-web-socket-server. |
| 151 | function setUpWebSocket(wsport) { |
Simon Hunt | 970e7fd | 2015-01-22 17:46:28 -0800 | [diff] [blame] | 152 | wsock = wss.createWebSocket('topology', { |
Simon Hunt | 584122a | 2015-01-21 15:32:40 -0800 | [diff] [blame] | 153 | onOpen: onWsOpen, |
| 154 | onMessage: onWsMessage, |
Simon Hunt | bb920fd | 2015-01-22 17:06:32 -0800 | [diff] [blame] | 155 | onClose: onWsClose, |
| 156 | wsport: wsport |
Simon Hunt | 584122a | 2015-01-21 15:32:40 -0800 | [diff] [blame] | 157 | }); |
| 158 | |
| 159 | // TODO: handle "guiSuccessor" functionality (replace host) |
| 160 | // TODO: implement retry on close functionality |
| 161 | |
| 162 | |
Simon Hunt | 970e7fd | 2015-01-22 17:46:28 -0800 | [diff] [blame] | 163 | $log.log('created web socket', wsock); |
Simon Hunt | 584122a | 2015-01-21 15:32:40 -0800 | [diff] [blame] | 164 | // TODO: complete implementation... |
Simon Hunt | 1e4a001 | 2015-01-21 11:36:08 -0800 | [diff] [blame] | 165 | |
| 166 | } |
| 167 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 168 | // --- Controller Definition ----------------------------------------- |
| 169 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 170 | angular.module('ovTopo', moduleDependencies) |
| 171 | |
| 172 | .controller('OvTopoCtrl', [ |
Simon Hunt | bb920fd | 2015-01-22 17:06:32 -0800 | [diff] [blame] | 173 | '$scope', '$log', '$location', |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 174 | 'KeyService', 'ZoomService', 'GlyphService', 'MapService', |
Simon Hunt | 1e4a001 | 2015-01-21 11:36:08 -0800 | [diff] [blame] | 175 | 'WebSocketService', |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 176 | |
Simon Hunt | bb920fd | 2015-01-22 17:06:32 -0800 | [diff] [blame] | 177 | function ($scope, _$log_, $loc, _ks_, _zs_, _gs_, _ms_, _wss_) { |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 178 | var self = this; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 179 | $log = _$log_; |
| 180 | ks = _ks_; |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 181 | zs = _zs_; |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 182 | gs = _gs_; |
Simon Hunt | 1e8eff4 | 2015-01-08 17:19:02 -0800 | [diff] [blame] | 183 | ms = _ms_; |
Simon Hunt | 1e4a001 | 2015-01-21 11:36:08 -0800 | [diff] [blame] | 184 | wss = _wss_; |
Simon Hunt | ef31fb2 | 2014-12-19 13:16:44 -0800 | [diff] [blame] | 185 | |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 186 | self.notifyResize = function () { |
Simon Hunt | 0541fb8 | 2015-01-14 18:59:57 -0800 | [diff] [blame] | 187 | svgResized(svg.style('width'), svg.style('height')); |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 188 | }; |
Simon Hunt | ef31fb2 | 2014-12-19 13:16:44 -0800 | [diff] [blame] | 189 | |
Simon Hunt | 584122a | 2015-01-21 15:32:40 -0800 | [diff] [blame] | 190 | $scope.$on('$destroy', function () { |
| 191 | $log.log('OvTopoCtrl is saying Buh-Bye!'); |
| 192 | // TODO: cleanup when the scope is destroyed... |
| 193 | // for example, closing the web socket. |
| 194 | |
| 195 | }); |
| 196 | |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 197 | // svg layer and initialization of components |
Simon Hunt | 426bd86 | 2015-01-14 16:48:41 -0800 | [diff] [blame] | 198 | ovtopo = d3.select('#ov-topo'); |
| 199 | svg = ovtopo.select('svg'); |
| 200 | |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 201 | setUpKeys(); |
| 202 | setUpDefs(); |
Simon Hunt | cacce34 | 2015-01-07 16:13:05 -0800 | [diff] [blame] | 203 | setUpZoom(); |
Simon Hunt | a7b6a6b | 2015-01-13 19:53:09 -0800 | [diff] [blame] | 204 | setUpMap(); |
Simon Hunt | bb920fd | 2015-01-22 17:06:32 -0800 | [diff] [blame] | 205 | setUpWebSocket($loc.search().wsport); |
Simon Hunt | 6cc5369 | 2015-01-07 11:33:45 -0800 | [diff] [blame] | 206 | |
| 207 | $log.log('OvTopoCtrl has been created'); |
Simon Hunt | ef31fb2 | 2014-12-19 13:16:44 -0800 | [diff] [blame] | 208 | }]); |
| 209 | }()); |