From ca82f56185616a7b174a8a6cdbeeeaa4a6f1f69c Mon Sep 17 00:00:00 2001
From: James Lyne <jim+github@not-null.co.uk>
Date: Fri, 11 Dec 2020 21:38:50 +0000
Subject: [PATCH] Start layer control implementation

---
 src/api.ts                                  |  4 +-
 src/components/Map.vue                      | 10 +--
 src/components/map/layer/MapLayer.vue       |  4 +-
 src/components/map/layer/MarkerSetLayer.vue |  7 +-
 src/components/map/layer/PlayersLayer.vue   |  5 +-
 src/components/sidebar/WorldListItem.vue    |  6 +-
 src/dynmap.d.ts                             |  4 +-
 src/leaflet/DynmapMap.ts                    | 49 +++++++++++++
 src/leaflet/control/LayerControl.ts         | 78 ---------------------
 src/leaflet/layer/LayerManager.ts           | 32 +++++++++
 src/leaflet/map.ts                          | 29 --------
 src/leaflet/tileLayer/DynmapTileLayer.ts    |  6 +-
 src/store/state.ts                          |  6 +-
 13 files changed, 106 insertions(+), 134 deletions(-)
 create mode 100644 src/leaflet/DynmapMap.ts
 delete mode 100644 src/leaflet/control/LayerControl.ts
 create mode 100644 src/leaflet/layer/LayerManager.ts
 delete mode 100644 src/leaflet/map.ts

diff --git a/src/api.ts b/src/api.ts
index 85f4094..ba46716 100644
--- a/src/api.ts
+++ b/src/api.ts
@@ -5,7 +5,7 @@ import {
 	DynmapComponentConfig,
 	DynmapConfigurationResponse,
 	DynmapLine,
-	DynmapMap,
+	DynmapWorldMap,
 	DynmapMarker,
 	DynmapMarkerSet,
 	DynmapMarkerSetUpdates,
@@ -60,7 +60,7 @@ function buildWorlds(response: AxiosResponse): Array<DynmapWorld> {
 		worlds: Array<DynmapWorld> = [];
 
 	(data.worlds || []).forEach((world: any) => {
-		const maps: Map<string, DynmapMap> = new Map();
+		const maps: Map<string, DynmapWorldMap> = new Map();
 
 		(world.maps || []).forEach((map: any) => {
 			maps.set(map.name, {
diff --git a/src/components/Map.vue b/src/components/Map.vue
index c3c9637..e24f84f 100644
--- a/src/components/Map.vue
+++ b/src/components/Map.vue
@@ -14,7 +14,6 @@
 <script lang="ts">
 import {defineComponent, computed} from "@vue/runtime-core";
 import L from 'leaflet';
-import '@/leaflet/map';
 import {useStore} from '@/store';
 import MapLayer from "@/components/map/layer/MapLayer.vue";
 import PlayersLayer from "@/components/map/layer/PlayersLayer.vue";
@@ -26,6 +25,7 @@ import LogoControl from "@/components/map/control/LogoControl.vue";
 import {MutationTypes} from "@/store/mutation-types";
 import {DynmapPlayer} from "@/dynmap";
 import {ActionTypes} from "@/store/action-types";
+import DynmapMap from "@/leaflet/DynmapMap";
 
 export default defineComponent({
 	components: {
@@ -92,7 +92,6 @@ export default defineComponent({
 		},
 		configuration: {
 			handler(newValue) {
-				console.log(newValue.defaultZoom);
 				if(this.leaflet) {
 					this.leaflet.setZoom(newValue.defaultZoom, {
 						animate: false,
@@ -105,12 +104,13 @@ export default defineComponent({
 	},
 
 	mounted() {
-		this.leaflet = new L.Map(this.$el, Object.freeze({
+		this.leaflet = new DynmapMap(this.$el, Object.freeze({
 			zoom: this.configuration.defaultZoom,
 			center: new L.LatLng(0, 0),
 			fadeAnimation: false,
 			zoomAnimation: true,
 			zoomControl: true,
+			layerControl: true,
 			preferCanvas: true,
 			attributionControl: false,
 			crs: L.CRS.Simple,
@@ -118,10 +118,6 @@ export default defineComponent({
 			// markerZoomAnimation: false,
 		}));
 
-		this.leaflet.addControl(new L.Control.Layers({}, {},{
-			position: 'topleft',
-		}));
-
 		this.leaflet.on('moveend', () => {
 			const location = this.currentProjection.latLngToLocation(this.leaflet!.getCenter(), 64),
 				locationString = `${Math.round(location.x)},${Math.round(location.y)},${Math.round(location.z)}`,
diff --git a/src/components/map/layer/MapLayer.vue b/src/components/map/layer/MapLayer.vue
index cc3a449..1fd35d5 100644
--- a/src/components/map/layer/MapLayer.vue
+++ b/src/components/map/layer/MapLayer.vue
@@ -1,6 +1,6 @@
 <script lang="ts">
 import {defineComponent, onMounted, onUnmounted, computed, watch} from "@vue/runtime-core";
-import {DynmapMap} from "@/dynmap";
+import {DynmapWorldMap} from "@/dynmap";
 import {Map} from 'leaflet';
 import {useStore} from "@/store";
 import {HDMapType} from "@/leaflet/mapType/HDMapType";
@@ -14,7 +14,7 @@ export default defineComponent({
 			required: true
 		},
 		map: {
-			type: Object as () => DynmapMap,
+			type: Object as () => DynmapWorldMap,
 			required: true
 		},
 		leaflet: {
diff --git a/src/components/map/layer/MarkerSetLayer.vue b/src/components/map/layer/MarkerSetLayer.vue
index 2c0173a..7e23a03 100644
--- a/src/components/map/layer/MarkerSetLayer.vue
+++ b/src/components/map/layer/MarkerSetLayer.vue
@@ -14,6 +14,7 @@ import GenericMarker from "@/components/map/marker/GenericMarker.vue";
 import Areas from "@/components/map/vector/Areas.vue";
 import Circles from "@/components/map/vector/Circles.vue";
 import Lines from "@/components/map/vector/Lines.vue";
+import DynmapMap from "@/leaflet/DynmapMap";
 
 export default defineComponent({
 	components: {
@@ -25,7 +26,7 @@ export default defineComponent({
 
 	props: {
 		leaflet: {
-			type: Object as () => L.Map,
+			type: Object as () => DynmapMap,
 			required: true,
 		},
 
@@ -51,13 +52,13 @@ export default defineComponent({
 
 		if(!this.markerSet.hidden) {
 			// console.log('Adding markerSetLayer');
-			this.leaflet.addLayer(this.layerGroup);
+			this.leaflet.getLayerManager().addLayer(this.layerGroup, true, this.markerSet.label, 1);
 		}
 	},
 
 	unmounted() {
 		// console.log('Unmounted markerSetLayer');
-		this.leaflet.removeLayer(this.layerGroup);
+		this.leaflet.getLayerManager().removeLayer(this.layerGroup);
 	},
 
 	render() {
diff --git a/src/components/map/layer/PlayersLayer.vue b/src/components/map/layer/PlayersLayer.vue
index 599f917..f0e7ad4 100644
--- a/src/components/map/layer/PlayersLayer.vue
+++ b/src/components/map/layer/PlayersLayer.vue
@@ -7,6 +7,7 @@ import PlayerMarker from "@/components/map/marker/PlayerMarker.vue";
 import {defineComponent, computed} from "@vue/runtime-core";
 import {useStore} from "@/store";
 import L from 'leaflet';
+import DynmapMap from "@/leaflet/DynmapMap";
 
 export default defineComponent({
 	components: {
@@ -15,7 +16,7 @@ export default defineComponent({
 
 	props: {
 		leaflet: {
-			type: Object as () => L.Map,
+			type: Object as () => DynmapMap,
 			required: true,
 		}
 	},
@@ -37,7 +38,7 @@ export default defineComponent({
 		// console.log('Mounted playersLayer');
 		if(!this.componentSettings!.hideByDefault) {
 			// console.log('Adding playersLayer');
-			this.leaflet.addLayer(this.layerGroup);
+			this.leaflet.getLayerManager().addLayer(this.layerGroup, true, useStore().state.messages.players, 1);
 		}
 	},
 
diff --git a/src/components/sidebar/WorldListItem.vue b/src/components/sidebar/WorldListItem.vue
index f174b83..35c856c 100644
--- a/src/components/sidebar/WorldListItem.vue
+++ b/src/components/sidebar/WorldListItem.vue
@@ -12,7 +12,7 @@
 
 <script lang="ts">
 import {useStore} from "@/store";
-import {DynmapMap, DynmapWorld} from "@/dynmap";
+import {DynmapWorldMap, DynmapWorld} from "@/dynmap";
 import {defineComponent} from 'vue';
 import {MutationTypes} from "@/store/mutation-types";
 
@@ -26,13 +26,13 @@ export default defineComponent({
 	},
 
 	computed: {
-		currentMap(): DynmapMap | undefined {
+		currentMap(): DynmapWorldMap | undefined {
 			return useStore().state.currentMap;
 		}
 	},
 
 	methods: {
-		getMapIcon(map: DynmapMap): string {
+		getMapIcon(map: DynmapWorldMap): string {
 			let worldType: string,
 				mapType: string;
 
diff --git a/src/dynmap.d.ts b/src/dynmap.d.ts
index 770ac33..4d3c5cb 100644
--- a/src/dynmap.d.ts
+++ b/src/dynmap.d.ts
@@ -85,10 +85,10 @@ interface DynmapWorld {
 	title: string;
 	height: number;
 	center: Coordinate;
-	maps: Map<String, DynmapMap>;
+	maps: Map<String, DynmapWorldMap>;
 }
 
-interface DynmapMap {
+interface DynmapWorldMap {
 	world: DynmapWorld;
 	background: string;
 	backgroundDay: string;
diff --git a/src/leaflet/DynmapMap.ts b/src/leaflet/DynmapMap.ts
new file mode 100644
index 0000000..0616137
--- /dev/null
+++ b/src/leaflet/DynmapMap.ts
@@ -0,0 +1,49 @@
+import L, {MapOptions} from 'leaflet';
+import LayerManager from "@/leaflet/layer/LayerManager";
+
+interface DynmapMapOptions extends MapOptions {
+	layerControl: boolean;
+}
+
+export default class DynmapMap extends L.Map {
+	private readonly _layerManager: LayerManager;
+	private _controlCorners: any;
+	private	_controlContainer?: HTMLElement;
+	private	_container?: HTMLElement;
+
+	constructor(element: string | HTMLElement, options?: DynmapMapOptions) {
+		super(element, options);
+
+		this._layerManager = Object.seal(new LayerManager(this, options?.layerControl));
+	}
+
+	getLayerManager(): LayerManager {
+		return this._layerManager;
+	}
+
+	_initControlPos() {
+		const corners: any = this._controlCorners = {},
+			l = 'leaflet-',
+			container = this._controlContainer =
+				L.DomUtil.create('div', l + 'control-container', this._container);
+
+		function createCorner(vSide: string, hSide: string) {
+			const className = l + vSide + ' ' + l + hSide;
+
+			corners[`${vSide}${hSide}`] = L.DomUtil.create('div', className, container);
+		}
+
+		createCorner('top', 'left');
+		createCorner('top', 'bar');
+		createCorner('top', 'right');
+		createCorner('top', 'center');
+		createCorner('bottom', 'center');
+		createCorner('bottom', 'bar');
+		createCorner('bottom', 'left');
+		createCorner('bottom', 'right');
+	}
+
+	getUrl() {
+
+	}
+}
diff --git a/src/leaflet/control/LayerControl.ts b/src/leaflet/control/LayerControl.ts
deleted file mode 100644
index f996de5..0000000
--- a/src/leaflet/control/LayerControl.ts
+++ /dev/null
@@ -1,78 +0,0 @@
-import L, {ControlOptions, ControlPosition, LeafletMouseEvent} from 'leaflet';
-import {useStore} from "@/store";
-
-const store = useStore();
-
-export interface CoordinatesControlOptions extends ControlOptions {
-	showY: boolean;
-	showRegion: boolean;
-	showChunk: boolean;
-	label: string;
-}
-
-export class LayerControl extends L.Control.Layers {
-	constructor() {
-		super();
-	}
-
-	// Function override to include pos
-	addOverlay(layer: L.Layer, name: string, pos: number) {
-		this._addLayer(layer, name, true, pos);
-		this._update();
-		return this;
-	}
-
-	// Function override to order layers by pos
-	_addLayer(layer: L.Layer, name: string, overlay, pos: number) {
-		var id = L.stamp(layer);
-
-		this._layers[pos] = {
-			layer: layer,
-			name: name,
-			overlay: overlay,
-			id: id
-		};
-
-		if (this.options.autoZIndex && layer.setZIndex) {
-			this._lastZIndex++;
-			layer.setZIndex(this._lastZIndex);
-		}
-	}
-
-	// Function override to convert the position-based ordering into the id-based ordering
-	_onInputClick() {
-		var i, input, obj,
-		    inputs = this._form.getElementsByTagName('input'),
-		    inputsLen = inputs.length,
-		    baseLayer;
-
-		this._handlingClick = true;
-
-		// Convert ID to pos
-		var id2pos = {};
-		for (i in this._layers) {
-			id2pos[this._layers[i].id] = i;
-		}
-
-		for (i = 0; i < inputsLen; i++) {
-			input = inputs[i];
-			obj = this._layers[id2pos[input.layerId]];
-
-			if (input.checked && !this._map.hasLayer(obj.layer)) {
-				this._map.addLayer(obj.layer);
-				if (!obj.overlay) {
-					baseLayer = obj.layer;
-				}
-			} else if (!input.checked && this._map.hasLayer(obj.layer)) {
-				this._map.removeLayer(obj.layer);
-			}
-		}
-
-		if (baseLayer) {
-			this._map.setZoom(this._map.getZoom());
-			this._map.fire('baselayerchange', {layer: baseLayer});
-		}
-
-		this._handlingClick = false;
-	}
-}
diff --git a/src/leaflet/layer/LayerManager.ts b/src/leaflet/layer/LayerManager.ts
new file mode 100644
index 0000000..8892278
--- /dev/null
+++ b/src/leaflet/layer/LayerManager.ts
@@ -0,0 +1,32 @@
+import L from 'leaflet';
+
+export default class LayerManager {
+	private showControl: boolean = false;
+	private readonly layerControl: L.Control.Layers;
+	private readonly map: L.Map;
+
+	constructor(map: L.Map, showControl?: boolean) {
+		this.showControl = showControl || this.showControl;
+		this.map = map;
+		this.layerControl = new L.Control.Layers({}, {},{
+			position: 'topleft',
+		});
+
+		if(this.showControl) {
+			this.map.addControl(this.layerControl);
+		}
+	}
+
+	addLayer(layer: L.Layer, showInControl: boolean, name: string, position: number) {
+		this.map.addLayer(layer);
+
+		if(showInControl) {
+			this.layerControl.addOverlay(layer, name);
+		}
+	}
+
+	removeLayer(layer: L.Layer) {
+		this.map.removeLayer(layer);
+		this.layerControl.removeLayer(layer);
+	}
+}
\ No newline at end of file
diff --git a/src/leaflet/map.ts b/src/leaflet/map.ts
deleted file mode 100644
index ff99c6f..0000000
--- a/src/leaflet/map.ts
+++ /dev/null
@@ -1,29 +0,0 @@
-import L from 'leaflet';
-
-L.Map.include({
-	_initControlPos: function () {
-		const corners: any = this._controlCorners = {},
-			l = 'leaflet-',
-			container = this._controlContainer =
-				L.DomUtil.create('div', l + 'control-container', this._container);
-
-		function createCorner(vSide: string, hSide: string) {
-			const className = l + vSide + ' ' + l + hSide;
-
-			corners[`${vSide}${hSide}`] = L.DomUtil.create('div', className, container);
-		}
-
-		createCorner('top', 'left');
-		createCorner('top', 'bar');
-		createCorner('top', 'right');
-		createCorner('top', 'center');
-		createCorner('bottom', 'center');
-		createCorner('bottom', 'bar');
-		createCorner('bottom', 'left');
-		createCorner('bottom', 'right');
-	},
-
-	getUrl() {
-
-	}
-});
\ No newline at end of file
diff --git a/src/leaflet/tileLayer/DynmapTileLayer.ts b/src/leaflet/tileLayer/DynmapTileLayer.ts
index 1cc9d02..cc76573 100644
--- a/src/leaflet/tileLayer/DynmapTileLayer.ts
+++ b/src/leaflet/tileLayer/DynmapTileLayer.ts
@@ -1,16 +1,16 @@
 import L, {Coords, DoneCallback, TileLayerOptions} from 'leaflet';
 import {DynmapProjection} from "@/leaflet/projection/DynmapProjection";
-import {Coordinate, DynmapMap} from "@/dynmap";
+import {Coordinate, DynmapWorldMap} from "@/dynmap";
 
 export interface DynmapTileLayerOptions extends TileLayerOptions {
-	mapSettings: DynmapMap;
+	mapSettings: DynmapWorldMap;
 	errorTileUrl: string;
 }
 
 export interface DynmapTileLayer extends L.TileLayer {
 	options: DynmapTileLayerOptions;
 	_projection: DynmapProjection;
-	_mapSettings: DynmapMap;
+	_mapSettings: DynmapWorldMap;
 	_cachedTileUrls: Map<string, string>;
 	_namedTiles: Map<string, DynmapTileElement>;
 	_tileTemplate: DynmapTileElement;
diff --git a/src/store/state.ts b/src/store/state.ts
index c67f54c..d6d690a 100644
--- a/src/store/state.ts
+++ b/src/store/state.ts
@@ -1,6 +1,6 @@
 import {
 	DynmapComponentConfig,
-	DynmapMap, DynmapMarkerSet, DynmapMarkerSetUpdates,
+	DynmapWorldMap, DynmapMarkerSet, DynmapMarkerSetUpdates,
 	DynmapMessageConfig,
 	DynmapPlayer,
 	DynmapServerConfig, DynmapTileUpdate,
@@ -14,7 +14,7 @@ export type State = {
 	components: DynmapComponentConfig;
 
 	worlds: Map<string, DynmapWorld>;
-	maps: Map<string, DynmapMap>;
+	maps: Map<string, DynmapWorldMap>;
 	players: Map<string, DynmapPlayer>;
 	markerSets: Map<string, DynmapMarkerSet>;
 
@@ -25,7 +25,7 @@ export type State = {
 
 	currentWorldState: DynmapWorldState;
 	currentWorld?: DynmapWorld;
-	currentMap?: DynmapMap;
+	currentMap?: DynmapWorldMap;
 	currentProjection: DynmapProjection;
 
 	updateRequestId: number;