Add MarkerAPI and rename the Renderer to RenderAPI

Author: TBlueF

src/main/java/de/bluecolored/bluemap/api/BlueMapAPI.java

@@ -24,24 +24,39 @@
  */
 package de.bluecolored.bluemap.api;
 
+import java.awt.image.BufferedImage;
+import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Optional;
 import java.util.UUID;
 
+import de.bluecolored.bluemap.api.marker.Marker;
+import de.bluecolored.bluemap.api.marker.MarkerAPI;
 import de.bluecolored.bluemap.api.renderer.BlueMapMap;
 import de.bluecolored.bluemap.api.renderer.BlueMapWorld;
-import de.bluecolored.bluemap.api.renderer.Renderer;
+import de.bluecolored.bluemap.api.renderer.RenderAPI;
 
+/**
+ * An API to control the running instance of BlueMap.
+ * <p>This API is thread-save, so you <b>can</b> use it async, off the main-server-thread, to save performance!</p> 
+ */
 public abstract class BlueMapAPI {
 	private static BlueMapAPI instance;
 	private static Collection<BlueMapAPIListener> listener = new ArrayList<>();
 
 	/**
-	 * Getter for the {@link Renderer} instance.
-	 * @return the {@link Renderer}
+	 * Getter for the {@link RenderAPI}.
+	 * @return the {@link RenderAPI}
 	 */
-	public abstract Renderer getRenderer();
+	public abstract RenderAPI getRenderAPI();
+	
+	/**
+	 * Getter for the {@link MarkerAPI}.<br>
+	 * Calling this gives you a fresh loaded {@link MarkerAPI}, so you don't have to call {@link MarkerAPI#load()} right away!
+	 * @return the {@link MarkerAPI}
+	 */
+	public abstract MarkerAPI getMarkerAPI() throws IOException;
 
 	/**
 	 * Getter for all {@link BlueMapMap}s loaded by BlueMap.
@@ -75,6 +90,18 @@ public abstract class BlueMapAPI {
 	 */
 	public abstract Optional<BlueMapMap> getMap(String id);
 
+	/**
+	 * Creates an image-file with the given {@link BufferedImage} somewhere in the web-root, so it can be used in the web-app (e.g. for {@link Marker}-icons).
+	 * 
+	 * <p>The given <code>path</code> is used as file-name and (separated with '/') optional folders to organize the image-files. Do NOT include the file-ending! (e.g. <code>"someFolder/somePOIIcon"</code> will result in a file "somePOIIcon.png" in a folder "someFolder").</p>
+	 * <p>If the image file with the given path already exists, it will be replaced.</p>
+	 * 
+	 * @param image the image to create
+	 * @param path the path/name of this image, the separator-char is '/'
+	 * @return the relative address of the image in the web-app
+	 */
+	public abstract String createImage(BufferedImage image, String path);
+	
 	/**
 	 * Getter for the installed BlueMap version
 	 * @return the version-string
@@ -132,7 +159,7 @@ protected static synchronized boolean unregisterInstance(BlueMapAPI instance) {
 
 		for (BlueMapAPIListener listener : BlueMapAPI.listener) {
 			listener.onDisable(BlueMapAPI.instance);
-		}	
+		}
 
 		BlueMapAPI.instance = null;
 

src/main/java/de/bluecolored/bluemap/api/marker/Marker.java

@@ -0,0 +1,144 @@
+/*
+ * This file is part of BlueMap, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) Blue (Lukas Rieger) <https://bluecolored.de>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package de.bluecolored.bluemap.api.marker;
+
+import java.util.Optional;
+
+import com.flowpowered.math.vector.Vector3d;
+
+import de.bluecolored.bluemap.api.renderer.BlueMapMap;
+
+/**
+ * A marker that is displayed on one of the maps in the web-app.
+ * <p>Each marker has an id that is unique in the {@link MarkerSet} that it is in.</p> 
+ */
+public interface Marker {
+
+	/**
+	 * Getter for the id of this {@link Marker}.
+	 * <p>The id is unique in the {@link MarkerSet} that this marker is in.</p>
+	 * @return the id of this {@link Marker}
+	 */
+	String getId();
+	
+	/**
+	 * Getter for the {@link BlueMapMap} this {@link Marker} lives in.
+	 * @return the {@link BlueMapMap} this {@link Marker} lives in
+	 */
+	BlueMapMap getMap();
+	
+	/**
+	 * Sets the {@link BlueMapMap} this {@link Marker} lives in
+	 * @param map the new {@link BlueMapMap}
+	 */
+	void setMap(BlueMapMap map);
+	
+	/**
+	 * Getter for the position of where this {@link Marker} lives on the map. 
+	 * @return the position of this {@link Marker}
+	 */
+	Vector3d getPosition();
+	
+	/**
+	 * Sets the position of where this {@link Marker} lives on the map. 
+	 * @param position the new position
+	 */
+	void setPosition(Vector3d position);
+	
+	/**
+	 * Getter for the minimum distance of the camera to the position ({@link #getPosition()} of the {@link Marker} for it to be displayed.<br>
+	 * If the camera is closer to this {@link Marker} than this distance, it will be hidden!
+	 *  
+	 * @return the minimum distance for this {@link Marker} to be displayed
+	 */
+	double getMinDistance();
+	
+	/**
+	 * Sets the minimum distance of the camera to the position ({@link #getPosition()} of the {@link Marker} for it to be displayed.<br>
+	 * If the camera is closer to this {@link Marker} than this distance, it will be hidden!
+	 * 
+	 * @param minDistance the new minimum distance
+	 */
+	void setMinDistance(double minDistance);
+	
+	/**
+	 * Getter for the maximum distance of the camera to the position ({@link #getPosition()} of the {@link Marker} for it to be displayed.<br>
+	 * If the camera is further to this {@link Marker} than this distance, it will be hidden!
+	 *  
+	 * @return the maximum distance for this {@link Marker} to be displayed
+	 */
+	double getMaxDistance();
+	
+	/**
+	 * Sets the maximum distance of the camera to the position ({@link #getPosition()} of the {@link Marker} for it to be displayed.<br>
+	 * If the camera is closer to this {@link Marker} than this distance, it will be hidden!
+	 * 
+	 * @param maxDistance the new maximum distance
+	 */
+	void setMaxDistance(double maxDistance);
+	
+	/**
+	 * Getter for the label of this marker. The label can include html-tags.
+	 * @return the label of this 
+	 */
+	String getLabel();
+	
+	/**
+	 * Sets the label of this {@link Marker}. The label can include html-tags.
+	 * <p>
+	 * 	<b>Important:</b><br>
+	 * 	Html-tags in the label will not be escaped, so you can use them to style the {@link Marker}-labels.<br>
+	 * 	Make sure you escape all html-tags from possible user inputs to prevent possible <a href="https://en.wikipedia.org/wiki/Cross-site_scripting">XSS-Attacks</a> on the web-client!
+	 * </p>
+	 * 
+	 * @param label the new label for this {@link Marker}
+	 */
+	void setLabel(String label);
+	
+	/**
+	 * Gets the link-adress of this {@link Marker}.<br>
+	 * If a link is present, this link will be followed when the user clicks on the marker in the web-app.
+	 * 
+	 * @return the {@link Optional} link
+	 */
+	Optional<String> getLink();
+
+	/**
+	 * If this is <code>true</code> the link ({@link #getLink()}) will be opened in a new tab.
+	 * @return whether the link will be opened in a new tab
+	 * @see #getLink()
+	 */
+	boolean isNewTab();
+	
+	/**
+	 * Sets the link-adress of this {@link Marker}.<br>
+	 * If a link is present, this link will be followed when the user clicks on the marker in the web-app.
+	 * 
+	 * @param link the link, or <code>null</code> to disable the link
+	 * @param newTab whether the link should be opened in a new tab
+	 */
+	void setLink(String link, boolean newTab);
+	
+}

src/main/java/de/bluecolored/bluemap/api/marker/MarkerAPI.java

@@ -0,0 +1,111 @@
+/*
+ * This file is part of BlueMap, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) Blue (Lukas Rieger) <https://bluecolored.de>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package de.bluecolored.bluemap.api.marker;
+
+import java.io.IOException;
+import java.util.Collection;
+import java.util.Optional;
+
+import de.bluecolored.bluemap.api.BlueMapAPI;
+
+/**
+ * The {@link MarkerAPI} for easy manipulation of the <code>markers.json</code> that is used to display different Markers on the map.
+ * <p>
+ * 	<b>Important:</b><br>
+ * 	If you made changes to any {@link MarkerSet} or {@link Marker} including creations and deletions, you need to finally save your changes by calling {@link #save()}!<br>
+ * </p>
+ * <p>To avoid any concurrent modifications to the <code>markers.json</code>, make sure your {@link MarkerAPI} is always loaded before making any changes, and saved right after the changes.</p> 
+ * 
+ * @see BlueMapAPI#getMarkerAPI()
+ */
+public interface MarkerAPI {
+
+	/**
+	 * Getter for an <i>unmodifiable</i> {@link Collection} containing all {@link MarkerSet}s that are currently loaded with BlueMap.
+	 * 
+	 * @return a {@link Collection} with all loaded {@link MarkerSet}s
+	 */
+	Collection<MarkerSet> getMarkerSets();
+	
+	/**
+	 * Getter for a loaded {@link MarkerSet} with the given id.<br>
+	 * Returns an empty {@link Optional} if no {@link MarkerSet} with that id is loaded.  
+	 * 
+	 * @param id the id of the {@link MarkerSet}
+	 * @return an {@link Optional}&lt;{@link MarkerSet}&gt; with the given id 
+	 */
+	Optional<MarkerSet> getMarkerSet(String id);
+	
+	/**
+	 * Created a new {@link MarkerSet} with the given id.<br>
+	 * If there is already a {@link MarkerSet} with that id loaded, no new {@link MarkerSet} is created and the existing one is returned.
+	 * 
+	 * @param id the id of the {@link MarkerSet}
+	 * @return a {@link MarkerSet} with the given id
+	 */
+	MarkerSet createMarkerSet(String id);
+
+	/**
+	 * Adds the given {@link MarkerSet}.<br>
+	 * If a {@link MarkerSet} with the id of the given {@link MarkerSet} already exists it will be replaced!
+	 * @param markerSet the {@link MarkerSet} to be added
+	 */
+	void addMarkerSet(MarkerSet markerSet);
+	
+	/**
+	 * Removes the given {@link MarkerSet}.<br>
+	 * This is equivalent to calling <code>removeMarkerSet(markerSet.getId())</code>.
+	 * 
+	 * @param markerSet the {@link MarkerSet} to be removed
+	 * @return <code>true</code> if the {@link MarkerSet} was removed, <code>false</code> if that {@link MarkerSet} didn't exist
+	 */
+	default boolean removeMarkerSet(MarkerSet markerSet) {
+		return removeMarkerSet(markerSet.getId());
+	}
+	
+	/**
+	 * Removes the {@link MarkerSet} with the given id.
+	 * 
+	 * @param id the id of the {@link MarkerSet} to be removed
+	 * @return <code>true</code> if the {@link MarkerSet} was removed, <code>false</code> if there was no {@link MarkerSet} with that id
+	 */
+	boolean removeMarkerSet(String id);
+	
+	/**
+	 * Loads changes made by others, changes could be from other plugin's using the API or external changes to the <code>markers.json</code>.<br>
+	 * Calling this will <b>override all unsaved changes</b> you made with this instance!
+	 *  
+	 * @throws IOException if an {@link IOException} occurred while loading the <code>markers.json</code>
+	 */
+	void load() throws IOException;
+	
+	/**
+	 * Saves all changes made with this instance to the <code>markers.json</code>.<br> 
+	 * 
+	 * @throws IOException if an {@link IOException} occurred while saving the <code>markers.json</code>
+	 */
+	void save() throws IOException;
+	
+}