First draft for the new marker-types

Author: TBlueF

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

@@ -0,0 +1,37 @@
+package de.bluecolored.bluemap.api.marker;
+
+public interface DistanceRangedMarker extends Marker {
+
+	/**
+	 * Getter for the minimum distance of the camera to the position for this {@link Marker} 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 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 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 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!
+	 *
+	 * @param maxDistance the new maximum distance
+	 */
+	void setMaxDistance(double maxDistance);
+
+}

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

@@ -0,0 +1,122 @@
+/*
+ * 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.awt.*;
+
+public interface ExtrudeMarker extends ObjectMarker, DistanceRangedMarker {
+
+	/**
+	 * Getter for {@link Shape} of this {@link ExtrudeMarker}.
+	 * <p>The shape is placed on the xz-plane of the map, so the y-coordinates of the {@link Shape}'s points are the z-coordinates in the map.</p>
+	 * @return the {@link Shape}
+	 */
+	Shape getShape();
+
+	/**
+	 * Getter for the minimum height (y-coordinate) of where the shape is displayed on the map.<br>
+	 * <i>(The shape will be extruded from this value to {@link #getShapeMaxY()} on the map)</i>
+	 * @return the min-height of the shape on the map
+	 */
+	float getShapeMinY();
+
+	/**
+	 * Getter for the maximum height (y-coordinate) of where the shape is displayed on the map.
+	 * <i>(The shape will be extruded from {@link #getShapeMinY()} to this value on the map)</i>
+	 * @return the max-height of the shape on the map
+	 */
+	float getShapeMaxY();
+	
+	/**
+	 * Sets the {@link Shape} of this {@link ExtrudeMarker}.
+	 * <p>The shape is placed on the xz-plane of the map, so the y-coordinates of the {@link Shape}'s points will be the z-coordinates in the map.</p>
+	 * <i>(The shape will be extruded from minY to maxY on the map)</i>
+	 * @param shape the new {@link Shape}
+	 * @param minY the new min-height (y-coordinate) of the shape on the map
+	 * @param maxY the new max-height (y-coordinate) of the shape on the map
+	 */
+	void setShape(Shape shape, float minY, float maxY);
+
+	/**
+	 * If the depth-test is disabled, you can see the marker fully through all objects on the map. If it is enabled, you'll only see the marker when it is not behind anything.
+	 * @return <code>true</code> if the depthTest is enabled
+	 */
+	boolean isDepthTestEnabled();
+	
+	/**
+	 * If the depth-test is disabled, you can see the marker fully through all objects on the map. If it is enabled, you'll only see the marker when it is not behind anything.
+	 * @param enabled if the depth-test should be enabled for this {@link ExtrudeMarker}
+	 */
+	void setDepthTestEnabled(boolean enabled);
+
+	/**
+	 * Getter for the width of the lines of this {@link ExtrudeMarker}.
+	 * @return the width of the lines in pixels
+	 */
+	int getLineWidth();
+
+	/**
+	 * Sets the width of the lines for this {@link ExtrudeMarker}.
+	 * @param width the new width in pixels
+	 */
+	void setLineWidth(int width);
+
+	/**
+	 * Getter for the {@link Color} of the border-line of the shape.
+	 * @return the line-color
+	 */
+	Color getLineColor();
+
+	/**
+	 * Sets the {@link Color} of the border-line of the shape.
+	 * @param color the new line-color
+	 */
+	void setLineColor(Color color);
+
+	/**
+	 * Getter for the fill-{@link Color} of the shape.
+	 * @return the fill-color
+	 */
+	Color getFillColor();
+	
+	/**
+	 * Sets the fill-{@link Color} of the shape.
+	 * @param color the new fill-color
+	 */
+	void setFillColor(Color color);
+	
+	/**
+	 * Sets the border- and fill- color. 
+	 * @param lineColor the new border-color
+	 * @param fillColor the new fill-color
+	 * @see #setLineColor(Color)
+	 * @see #setFillColor(Color)
+	 */
+	default void setColors(Color lineColor, Color fillColor) {
+		setLineColor(lineColor);
+		setFillColor(fillColor);
+	}
+	
+}

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

@@ -0,0 +1,50 @@
+/*
+ * 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 com.flowpowered.math.vector.Vector2i;
+import de.bluecolored.bluemap.api.BlueMapAPI;
+
+public interface HtmlMarker extends Marker, DistanceRangedMarker {
+
+	/**
+	 * Getter for the position (in pixels) where the icon is anchored to the map.
+	 * @return the anchor-position in pixels
+	 */
+	Vector2i getAnchor();
+	
+	/**
+	 * Sets the html for this {@link HtmlMarker}.
+	 *
+	 * <p>
+	 * 	<b>Important:</b><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 html the html-element that will be inserted as the marker.
+	 */
+	void setHtml(String html);
+	
+}

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

@@ -0,0 +1,96 @@
+/*
+ * 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 com.flowpowered.math.vector.Vector3d;
+
+import java.util.Arrays;
+
+/**
+ * A line consisting of 2 or more {@link Vector3d}-points.
+ */
+public class Line {
+
+	private final Vector3d[] points;
+	private Vector3d min = null;
+	private Vector3d max = null;
+
+	public Line(Vector3d... points) {
+		if (points.length < 2) throw new IllegalArgumentException("A line has to have at least 2 points!");
+		this.points = points;
+	}
+	
+	/**
+	 * Getter for the amount of points in this line.
+	 * @return the amount of points
+	 */
+	public int getPointCount() {
+		return points.length;
+	}
+	
+	public Vector3d getPoint(int i) {
+		return points[i];
+	}
+	
+	/**
+	 * Getter for <b>a copy</b> of the points array.<br> 
+	 * <i>(A line is immutable once created)</i>
+	 * @return the points of this line
+	 */
+	public Vector3d[] getPoints() {
+		return Arrays.copyOf(points, points.length);
+	}
+	
+	/**
+	 * Calculates and returns the minimum corner of the axis-aligned-bounding-box of this line.
+	 * @return the min of the AABB of this line
+	 */
+	public Vector3d getMin() {
+		if (this.min == null) {
+			Vector3d min = points[0];
+			for (int i = 1; i < points.length; i++) {
+				min = min.min(points[i]);
+			}
+			this.min = min;
+		}
+		return this.min;
+	}
+	
+	/**
+	 * Calculates and returns the maximum corner of the axis-aligned-bounding-box of this line.
+	 * @return the max of the AABB of this line
+	 */
+	public Vector3d getMax() {
+		if (this.max == null) {
+			Vector3d max = points[0];
+			for (int i = 1; i < points.length; i++) {
+				max = max.max(points[i]);
+			}
+			this.max = max;
+		}
+		return this.max;
+	}
+	
+}

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

@@ -0,0 +1,79 @@
+/*
+ * 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.awt.*;
+
+public interface LineMarker extends ObjectMarker, DistanceRangedMarker {
+
+	/**
+	 * Getter for {@link Line} of this {@link LineMarker}.
+	 * @return the {@link Line}
+	 */
+	Line getLine();
+	
+	/**
+	 * Sets the {@link Line} of this {@link LineMarker}.
+	 * @param line the new {@link Line}
+	 */
+	void setLine(Line line);
+
+	/**
+	 * If the depth-test is disabled, you can see the marker fully through all objects on the map. If it is enabled, you'll only see the marker when it is not behind anything.
+	 * @return <code>true</code> if the depthTest is enabled
+	 */
+	boolean isDepthTestEnabled();
+	
+	/**
+	 * If the depth-test is disabled, you can see the marker fully through all objects on the map. If it is enabled, you'll only see the marker when it is not behind anything.
+	 * @param enabled if the depth-test should be enabled for this {@link LineMarker}
+	 */
+	void setDepthTestEnabled(boolean enabled);
+
+	/**
+	 * Getter for the width of the lines of this {@link LineMarker}.
+	 * @return the width of the lines in pixels
+	 */
+	int getLineWidth();
+
+	/**
+	 * Sets the width of the lines for this {@link LineMarker}.
+	 * @param width the new width in pixels
+	 */
+	void setLineWidth(int width);
+
+	/**
+	 * Getter for the {@link Color} of the border-line of the shape.
+	 * @return the line-color
+	 */
+	Color getLineColor();
+
+	/**
+	 * Sets the {@link Color} of the border-line of the shape.
+	 * @param color the new line-color
+	 */
+	void setLineColor(Color color);
+	
+}