This API is thread-save, so you can use it async, off the main-server-thread, to save performance!
*/ public abstract class BlueMapAPI { - private static BlueMapAPI instance; - @Deprecated - private static final CollectionSee the documentation of {@link BlueMapWorld#getUuid()} for more information about the nature of the worlds {@link UUID}s!
- * - * @see BlueMapWorld#getUuid() - * - * @param uuid the {@link UUID} of the world + * Getter for a {@link BlueMapWorld} loaded by BlueMap. * + * @param world Any object that BlueMap can use to identify a world. + *+ * This could be: + *
The given path is used as file-name and (separated with '/') optional folders to organize the image-files. Do NOT include the file-ending! (e.g. "someFolder/somePOIIcon" will result in a file "somePOIIcon.png" in a folder "someFolder").
If the image file with the given path already exists, it will be replaced.
- * - * @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, - * which can be used as it is e.g. in the {@link de.bluecolored.bluemap.api.marker.POIMarker#setIcon(String, Vector2i)} method - * @throws IOException If an {@link IOException} is thrown while writing the image - */ - public abstract String createImage(BufferedImage image, String path) throws IOException; - - /** - * Lists all images that are available. This includes all images previously created with the {@link #createImage(BufferedImage, String)} - * function, but might include more. - * @return A map of available images where: - *true if a listener was removed as a result of this call
- *
- * @deprecated Implementing {@link BlueMapAPIListener} can cause a ClassNotFoundException when you soft-depend on BlueMap and your plugin/mod gets used without BlueMap.
- * Use {@link BlueMapAPI#onEnable(Consumer)} and {@link BlueMapAPI#onDisable(Consumer)} instead.
- */
- @Deprecated
- public static synchronized boolean unregisterListener(BlueMapAPIListener listener) {
- return BlueMapAPI.listener.remove(listener);
+ public String getAPIVersion() {
+ return VERSION;
}
/**
@@ -206,9 +178,8 @@ public static synchronized boolean unregisterListener(Consumertrue if the instance has been registered, false if there already was an instance registered
- * @throws ExecutionException if a {@link BlueMapAPIListener} threw an exception during the registration
+ * @throws ExecutionException if a listener threw an exception during the registration
*/
- @SuppressWarnings("deprecation")
protected static synchronized boolean registerInstance(BlueMapAPI instance) throws ExecutionException {
if (BlueMapAPI.instance != null) return false;
@@ -224,15 +195,6 @@ protected static synchronized boolean registerInstance(BlueMapAPI instance) thro
}
}
- // backwards compatibility
- for (BlueMapAPIListener listener : BlueMapAPI.listener) {
- try {
- listener.onEnable(BlueMapAPI.instance);
- } catch (Throwable ex) {
- thrownExceptions.add(ex);
- }
- }
-
if (!thrownExceptions.isEmpty()) {
ExecutionException ex = new ExecutionException(thrownExceptions.get(0));
for (int i = 1; i < thrownExceptions.size(); i++) {
@@ -248,9 +210,8 @@ protected static synchronized boolean registerInstance(BlueMapAPI instance) thro
* Used by BlueMap to unregister the API and call the listeners properly.
* @param instance the {@link BlueMapAPI} instance
* @return true if the instance was unregistered, false if there was no or an other instance registered
- * @throws ExecutionException if a {@link BlueMapAPIListener} threw an exception during the un-registration
+ * @throws ExecutionException if a listener threw an exception during the un-registration
*/
- @SuppressWarnings("deprecation")
protected static synchronized boolean unregisterInstance(BlueMapAPI instance) throws ExecutionException {
if (BlueMapAPI.instance != instance) return false;
@@ -264,15 +225,6 @@ protected static synchronized boolean unregisterInstance(BlueMapAPI instance) th
}
}
- // backwards compatibility
- for (BlueMapAPIListener listener : BlueMapAPI.listener) {
- try {
- listener.onDisable(BlueMapAPI.instance);
- } catch (Exception ex) {
- thrownExceptions.add(ex);
- }
- }
-
BlueMapAPI.instance = null;
if (!thrownExceptions.isEmpty()) {
diff --git a/src/main/java/de/bluecolored/bluemap/api/BlueMapAPIListener.java b/src/main/java/de/bluecolored/bluemap/api/BlueMapAPIListener.java
deleted file mode 100644
index f351c0c..0000000
--- a/src/main/java/de/bluecolored/bluemap/api/BlueMapAPIListener.java
+++ /dev/null
@@ -1,52 +0,0 @@
-/*
- * This file is part of BlueMap, licensed under the MIT License (MIT).
- *
- * Copyright (c) Blue (Lukas Rieger) (Note: This method will likely be called asynchronously, not on the server-thread!
- * @param blueMapApi the {@link BlueMapAPI} - */ - default void onEnable(BlueMapAPI blueMapApi) {} - - /** - * Called before BlueMap is being unloaded and stopped, after this method returns the API is no longer usable!(Note: This method will likely be called asynchronously, not on the server-thread!
- * @param blueMapApi the {@link BlueMapAPI} - */ - default void onDisable(BlueMapAPI blueMapApi) {} - -} diff --git a/src/main/java/de/bluecolored/bluemap/api/BlueMapMap.java b/src/main/java/de/bluecolored/bluemap/api/BlueMapMap.java index bd4dd0b..9f9337d 100644 --- a/src/main/java/de/bluecolored/bluemap/api/BlueMapMap.java +++ b/src/main/java/de/bluecolored/bluemap/api/BlueMapMap.java @@ -27,8 +27,9 @@ import com.flowpowered.math.vector.Vector2i; import com.flowpowered.math.vector.Vector3d; import com.flowpowered.math.vector.Vector3i; +import de.bluecolored.bluemap.api.marker.MarkerSet; -import java.util.Optional; +import java.util.Map; import java.util.function.Predicate; /** @@ -55,6 +56,13 @@ public interface BlueMapMap { */ BlueMapWorld getWorld(); + /** + * Getter for a (modifiable) {@link Map} of {@link MarkerSet}s with the key being the {@link MarkerSet}'s id. + * Changing this map will change the {@link MarkerSet}s and markers displayed on the web-app for this map. + * @return a {@link Map} of {@link MarkerSet}s. + */ + MapGetter for the {@link UUID} of the world.
- *- * The {@link UUID}s of this worlds are not guaranteed to be consistent across reloads/restarts! - *
- *
- * Implementation notes:
- * The used UUID highly depends on the implementation
- *
| Sponge | The UUID is equal to the returned UUID by world-instances of the Sponge-API, so you can just use spongeWorld.getUniqueId() |
|---|---|
| Bukkit | The UUID is equal to the returned UUID by world-instances of the Bukkit-API, so you can just use bukkitWorld.getUID() |
| Forge | The UUID is randomly generated, and changes on each reload/restart |
| CLI | The UUID is randomly generated, and changes on each reload/restart |
world: ).
diff --git a/src/main/java/de/bluecolored/bluemap/api/renderer/RenderAPI.java b/src/main/java/de/bluecolored/bluemap/api/RenderManager.java
similarity index 51%
rename from src/main/java/de/bluecolored/bluemap/api/renderer/RenderAPI.java
rename to src/main/java/de/bluecolored/bluemap/api/RenderManager.java
index 060b9b1..fb8f6e1 100644
--- a/src/main/java/de/bluecolored/bluemap/api/renderer/RenderAPI.java
+++ b/src/main/java/de/bluecolored/bluemap/api/RenderManager.java
@@ -22,93 +22,17 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
-package de.bluecolored.bluemap.api.renderer;
+package de.bluecolored.bluemap.api;
import com.flowpowered.math.vector.Vector2i;
-import com.flowpowered.math.vector.Vector3i;
-import de.bluecolored.bluemap.api.BlueMapMap;
-import de.bluecolored.bluemap.api.BlueMapWorld;
import java.io.IOException;
import java.util.Collection;
-import java.util.UUID;
/**
- * The {@link RenderAPI} is used to schedule tile-renders and process them on a number of different threads.
+ * The {@link RenderManager} is used to schedule tile-renders and process them on a number of different threads.
*/
-public interface RenderAPI {
-
- /**
- * Schedules the render of the map-tile at this block position for all maps of this world.true if this renderer is running
*/
boolean isRunning();
/**
* Starts the renderer if it is not already running.
+ * The renderer will be started with the configured number of render threads.
*/
void start();
/**
- * Pauses the renderer if it currently is running.
+ * Starts the renderer if it is not already running.
+ * The renderer will be started with the given number of render threads.
+ * @param threadCount the number of render threads to use,
+ * must be greater than 0 and should be less than or equal to the number of available cpu-cores.
*/
- void pause();
+ void start(int threadCount);
+
+ /**
+ * Stops the renderer if it currently is running.
+ */
+ void stop();
}
diff --git a/src/main/java/de/bluecolored/bluemap/api/WebApp.java b/src/main/java/de/bluecolored/bluemap/api/WebApp.java
new file mode 100644
index 0000000..2e86f20
--- /dev/null
+++ b/src/main/java/de/bluecolored/bluemap/api/WebApp.java
@@ -0,0 +1,55 @@
+package de.bluecolored.bluemap.api;
+
+import de.bluecolored.bluemap.api.marker.Marker;
+import de.bluecolored.bluemap.api.marker.POIMarker;
+import com.flowpowered.math.vector.Vector2i;
+
+import java.awt.image.BufferedImage;
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.Map;
+import java.util.UUID;
+
+public interface WebApp {
+
+ /**
+ * Getter for the configured web-root folder
+ * @return The {@link Path} of the web-root folder
+ */
+ Path getWebRoot();
+
+ /**
+ * Shows or hides the given player from being shown on the web-app.
+ * @param player the UUID of the player
+ * @param visible true if the player-marker should be visible, false if it should be hidden
+ */
+ void setPlayerVisibility(UUID player, boolean visible);
+
+ /**
+ * 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).
+ *
+ * The given path is used as file-name and (separated with '/') optional folders to organize the image-files.
+ * Do NOT include the file-ending! (e.g. "someFolder/somePOIIcon" will result in a file "somePOIIcon.png" in a folder "someFolder").
If the image file with the given path already exists, it will be replaced.
+ * + * @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, + * which can be used as it is e.g. in the {@link POIMarker#setIcon(String, Vector2i)} method + * @throws IOException If an {@link IOException} is thrown while writing the image + */ + String createImage(BufferedImage image, String path) throws IOException; + + /** + * Lists all images that are available. This includes all images previously created with the {@link #createImage(BufferedImage, String)} + * function, but might include more. + * @return A map of available images where: + *(The position of the marker will be the center of the shape (it's bounding box))
+ * + * @param label the label of the marker + * @param shape the {@link Shape} of the marker + * @param shapeMinY the minimum y-position of the extruded shape + * @param shapeMaxY the maximum y-position of the extruded shape + * + * @see #setLabel(String) + * @see #setShape(Shape, float, float) + */ + public ExtrudeMarker(String label, Shape shape, float shapeMinY, float shapeMaxY) { + this(label, calculateShapeCenter(Objects.requireNonNull(shape, "shape must not be null"), shapeMinY, shapeMaxY), shape, shapeMinY, shapeMaxY); + } + + /** + * Creates a new {@link ExtrudeMarker}. + *(Since the shape has its own positions, the position is only used to determine e.g. the distance to the camera)
+ * + * @param label the label of the marker + * @param position the coordinates of the marker + * @param shape the shape of the marker + * @param shapeMinY the minimum y-position of the extruded shape + * @param shapeMaxY the maximum y-position of the extruded shape + * + * @see #setLabel(String) + * @see #setPosition(Vector3d) + * @see #setShape(Shape, float, float) + */ + public ExtrudeMarker(String label, Vector3d position, Shape shape, float shapeMinY, float shapeMaxY) { + super("extrude", label, position); + this.shape = Objects.requireNonNull(shape, "shape must not be null"); + this.shapeMinY = shapeMinY; + this.shapeMaxY = shapeMaxY; + } /** * Getter for {@link Shape} of this {@link ExtrudeMarker}. *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.
* @return the {@link Shape} */ - Shape getShape(); + public Shape getShape() { + return shape; + } /** * Getter for the minimum height (y-coordinate) of where the shape is displayed on the map.(Invoke this after changing the {@link Shape} to make sure the markers position gets updated as well)
+ */ + public void centerPosition() { + setPosition(calculateShapeCenter(shape, shapeMinY, shapeMaxY)); + } /** * 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. * @returntrue if the depthTest is enabled
*/
- boolean isDepthTestEnabled();
+ public boolean isDepthTestEnabled() {
+ return depthTest;
+ }
/**
* 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);
+ public void setDepthTestEnabled(boolean enabled) {
+ this.depthTest = enabled;
+ }
/**
* Getter for the width of the lines of this {@link ExtrudeMarker}.
* @return the width of the lines in pixels
*/
- int getLineWidth();
+ public int getLineWidth() {
+ return lineWidth;
+ }
/**
* Sets the width of the lines for this {@link ExtrudeMarker}.
* @param width the new width in pixels
*/
- void setLineWidth(int width);
+ public void setLineWidth(int width) {
+ this.lineWidth = width;
+ }
/**
* Getter for the {@link Color} of the border-line of the shape.
* @return the line-color
*/
- Color getLineColor();
+ public Color getLineColor() {
+ return lineColor;
+ }
/**
* Sets the {@link Color} of the border-line of the shape.
* @param color the new line-color
*/
- void setLineColor(Color color);
+ public void setLineColor(Color color) {
+ this.lineColor = Objects.requireNonNull(color, "color must not be null");
+ }
/**
* Getter for the fill-{@link Color} of the shape.
* @return the fill-color
*/
- Color getFillColor();
+ public Color getFillColor() {
+ return fillColor;
+ }
/**
* Sets the fill-{@link Color} of the shape.
* @param color the new fill-color
*/
- void setFillColor(Color color);
+ public void setFillColor(Color color) {
+ this.fillColor = Objects.requireNonNull(color, "color must not be null");
+ }
/**
* Sets the border- and fill- color.
@@ -114,9 +198,15 @@ public interface ExtrudeMarker extends ObjectMarker, DistanceRangedMarker {
* @see #setLineColor(Color)
* @see #setFillColor(Color)
*/
- default void setColors(Color lineColor, Color fillColor) {
+ public void setColors(Color lineColor, Color fillColor) {
setLineColor(lineColor);
setFillColor(fillColor);
}
+ private static Vector3d calculateShapeCenter(Shape shape, float shapeMinY, float shapeMaxY) {
+ Vector2d center = shape.getMin().add(shape.getMax()).mul(0.5);
+ float centerY = (shapeMinY + shapeMaxY) * 0.5f;
+ return new Vector3d(center.getX(), centerY, center.getY());
+ }
+
}
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/HtmlMarker.java b/src/main/java/de/bluecolored/bluemap/api/marker/HtmlMarker.java
index fb111d1..1248b45 100644
--- a/src/main/java/de/bluecolored/bluemap/api/marker/HtmlMarker.java
+++ b/src/main/java/de/bluecolored/bluemap/api/marker/HtmlMarker.java
@@ -24,29 +24,76 @@
*/
package de.bluecolored.bluemap.api.marker;
-import com.flowpowered.math.vector.Vector2i;
-import de.bluecolored.bluemap.api.BlueMapAPI;
-public interface HtmlMarker extends Marker, DistanceRangedMarker {
+import com.flowpowered.math.vector.Vector2i;
+import com.flowpowered.math.vector.Vector3d;
+
+import java.util.Objects;
+
+/**
+ * A marker that is a html-element placed somewhere on the map.
+ */
+public class HtmlMarker extends DistanceRangedMarker {
+
+ private Vector2i anchor;
+ private String html;
+
+ /**
+ * Creates a new {@link HtmlMarker}.
+ *
+ * @param label the label of the marker
+ * @param position the coordinates of the marker
+ * @param html the html-content of the marker
+ *
+ * @see #setLabel(String)
+ * @see #setPosition(Vector3d)
+ * @see #setHtml(String)
+ */
+ public HtmlMarker(String label, Vector3d position, String html) {
+ this(label, position, html, new Vector2i(0, 0));
+ }
+
+ /**
+ * Creates a new {@link HtmlMarker}.
+ *
+ * @param label the label of the marker
+ * @param position the coordinates of the marker
+ * @param html the html-content of the marker
+ * @param anchor the anchor-point of the html-content
+ *
+ * @see #setLabel(String)
+ * @see #setPosition(Vector3d)
+ * @see #setHtml(String)
+ * @see #setAnchor(Vector2i)
+ */
+ public HtmlMarker(String label, Vector3d position, String html, Vector2i anchor) {
+ super("html", label, position);
+ this.html = Objects.requireNonNull(html, "html must not be null");
+ this.anchor = Objects.requireNonNull(anchor, "anchor must not be null");
+ }
/**
* Getter for the position (in pixels) where the html-element is anchored to the map.
* @return the anchor-position in pixels
*/
- Vector2i getAnchor();
+ public Vector2i getAnchor() {
+ return anchor;
+ }
/**
* Sets the position (in pixels) where the html-element is anchored to the map.
* @param anchor the anchor-position in pixels
*/
- void setAnchor(Vector2i anchor);
+ public void setAnchor(Vector2i anchor) {
+ this.anchor = Objects.requireNonNull(anchor, "anchor must not be null");
+ }
/**
* Sets the position (in pixels) where the html-element is anchored to the map.
* @param x the anchor-x-position in pixels
* @param y the anchor-y-position in pixels
*/
- default void setAnchor(int x, int y) {
+ public void setAnchor(int x, int y) {
setAnchor(new Vector2i(x, y));
}
@@ -54,7 +101,9 @@ default void setAnchor(int x, int y) {
* Getter for the html-code of this HTML marker
* @return the html-code
*/
- String getHtml();
+ public String getHtml() {
+ return html;
+ }
/**
* Sets the html for this {@link HtmlMarker}.
@@ -66,6 +115,8 @@ default void setAnchor(int x, int y) {
*
* @param html the html that will be inserted as the marker.
*/
- void setHtml(String html);
+ public void setHtml(String html) {
+ this.html = Objects.requireNonNull(html, "html must not be null");
+ }
}
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/Line.java b/src/main/java/de/bluecolored/bluemap/api/marker/Line.java
index 2f336c0..5c65daa 100644
--- a/src/main/java/de/bluecolored/bluemap/api/marker/Line.java
+++ b/src/main/java/de/bluecolored/bluemap/api/marker/Line.java
@@ -25,6 +25,7 @@
package de.bluecolored.bluemap.api.marker;
import com.flowpowered.math.vector.Vector3d;
+import org.jetbrains.annotations.Nullable;
import java.util.Arrays;
@@ -34,8 +35,9 @@
public class Line {
private final Vector3d[] points;
- private Vector3d min = null;
- private Vector3d max = null;
+
+ @Nullable
+ private Vector3d min = null, max = null;
public Line(Vector3d... points) {
if (points.length < 2) throw new IllegalArgumentException("A line has to have at least 2 points!");
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/LineMarker.java b/src/main/java/de/bluecolored/bluemap/api/marker/LineMarker.java
index e3a5cf3..33f2437 100644
--- a/src/main/java/de/bluecolored/bluemap/api/marker/LineMarker.java
+++ b/src/main/java/de/bluecolored/bluemap/api/marker/LineMarker.java
@@ -24,56 +24,125 @@
*/
package de.bluecolored.bluemap.api.marker;
-import java.awt.*;
+import com.flowpowered.math.vector.Vector3d;
+import de.bluecolored.bluemap.api.math.Color;
-public interface LineMarker extends ObjectMarker, DistanceRangedMarker {
+import java.util.Objects;
+
+public class LineMarker extends ObjectMarker {
+
+ private Line line;
+ private boolean depthTest = true;
+ private int lineWidth = 2;
+ private Color lineColor = new Color(255, 0, 0, 1f);
+
+ /**
+ * Creates a new {@link LineMarker}.
+ * (The position of the marker will be the center of the line (it's bounding box))
+ * + * @param label the label of the marker + * @param line the {@link Line} of the marker + * + * @see #setLabel(String) + * @see #setLine(Line) + */ + public LineMarker(String label, Line line) { + this(label, calculateLineCenter(Objects.requireNonNull(line, "shape must not be null")), line); + } + + /** + * Creates a new {@link LineMarker}. + *(Since the line has its own positions, the position is only used to determine e.g. the distance to the camera)
+ * + * @param label the label of the marker + * @param position the coordinates of the marker + * @param line the {@link Line} of the marker + * + * @see #setLabel(String) + * @see #setPosition(Vector3d) + * @see #setLine(Line) + */ + public LineMarker(String label, Vector3d position, Line line) { + super("extrude", label, position); + this.line = Objects.requireNonNull(line, "line must not be null"); + } /** * Getter for {@link Line} of this {@link LineMarker}. * @return the {@link Line} */ - Line getLine(); + public Line getLine() { + return line; + } /** * Sets the {@link Line} of this {@link LineMarker}. * @param line the new {@link Line} + * + * @see #centerPosition() */ - void setLine(Line line); + public void setLine(Line line) { + this.line = Objects.requireNonNull(line, "line must not be null"); + } + + /** + * Sets the position of this {@link LineMarker} to the center of the {@link Line} (it's bounding box). + *(Invoke this after changing the {@link Line} to make sure the markers position gets updated as well)
+ */ + public void centerPosition() { + setPosition(calculateLineCenter(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. * @returntrue if the depthTest is enabled
*/
- boolean isDepthTestEnabled();
+ public boolean isDepthTestEnabled() {
+ return depthTest;
+ }
/**
* 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);
+ public void setDepthTestEnabled(boolean enabled) {
+ this.depthTest = enabled;
+ }
/**
* Getter for the width of the lines of this {@link LineMarker}.
* @return the width of the lines in pixels
*/
- int getLineWidth();
+ public int getLineWidth() {
+ return lineWidth;
+ }
/**
* Sets the width of the lines for this {@link LineMarker}.
* @param width the new width in pixels
*/
- void setLineWidth(int width);
+ public void setLineWidth(int width) {
+ this.lineWidth = width;
+ }
/**
* Getter for the {@link Color} of the border-line of the shape.
* @return the line-color
*/
- Color getLineColor();
+ public Color getLineColor() {
+ return lineColor;
+ }
/**
* Sets the {@link Color} of the border-line of the shape.
* @param color the new line-color
*/
- void setLineColor(Color color);
+ public void setLineColor(Color color) {
+ this.lineColor = Objects.requireNonNull(color, "color must not be null");
+ }
+
+ private static Vector3d calculateLineCenter(Line line) {
+ return line.getMin().add(line.getMax()).mul(0.5);
+ }
}
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/LinkMarker.java b/src/main/java/de/bluecolored/bluemap/api/marker/LinkMarker.java
deleted file mode 100644
index 9a6604e..0000000
--- a/src/main/java/de/bluecolored/bluemap/api/marker/LinkMarker.java
+++ /dev/null
@@ -1,60 +0,0 @@
-/*
- * This file is part of BlueMap, licensed under the MIT License (MIT).
- *
- * Copyright (c) Blue (Lukas Rieger) true 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-address of this {@link Marker}.null to disable the link
- * @param newTab whether the link should be opened in a new tab
- */
- void setLink(String link, boolean newTab);
-
- /**
- * Removes the link of this {@link Marker}.
- */
- void removeLink();
-
-}
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/Marker.java b/src/main/java/de/bluecolored/bluemap/api/marker/Marker.java
index 6fb21a6..6205f1f 100644
--- a/src/main/java/de/bluecolored/bluemap/api/marker/Marker.java
+++ b/src/main/java/de/bluecolored/bluemap/api/marker/Marker.java
@@ -25,135 +25,84 @@
package de.bluecolored.bluemap.api.marker;
import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.BlueMapMap;
-import java.util.Optional;
+import java.util.Objects;
/**
- * A marker that is displayed on one of the maps in the web-app.
- * Each marker has an id that is unique in the {@link MarkerSet} that it is in.
+ * The Base-Class for all markers that can be displayed in the web-app. + * + * @see HtmlMarker + * @see POIMarker + * @see ShapeMarker + * @see ExtrudeMarker + * @see LineMarker */ -public interface Marker { +public abstract class Marker { + + private final String type; + private String label; + private Vector3d position; + + public Marker(String type, String label, Vector3d position) { + this.type = Objects.requireNonNull(type, "type cannot be null"); + this.label = Objects.requireNonNull(label, "label cannot be null"); + this.position = Objects.requireNonNull(position, "position cannot be null"); + } /** - * Getter for the id of this {@link Marker}. - *The id is unique in the {@link MarkerSet} that this marker is in.
- * @return the id of this {@link Marker} + * Returns the type of the marker. + * @return the type-id of the 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); + public String getType() { + return type; + } /** * Getter for the label of this marker. * @return the label of this {@link Marker} */ - String getLabel(); + public String getLabel() { + return label; + } /** * Sets the label of this {@link Marker}. - *- * Using html-tags in the label is possible but deprecated! - *
- *
- * Important:
- * Html-tags in the label will not be escaped, so you can use them to style the {@link Marker}-labels.
- * Make sure you escape all html-tags from possible user inputs to prevent possible XSS-Attacks on the web-client!
- *
(HTML-Tags will be escaped.)
* * @param label the new label for this {@link Marker} */ - void setLabel(String label); + public void setLabel(String label) { + //escape html-tags + this.label = label + .replace("&", "&") + .replace("<", "<") + .replace(">", ">"); + } /** - * Getter for the minimum distance of the camera to the position ({@link #getPosition()} of the {@link Marker} for it to be displayed.true the link ({@link #getLink()}) will be opened in a new tab.
- * @return whether the link will be opened in a new tab
- * @see #getLink()
- * @deprecated Not all marker-types support this
- */
- boolean isNewTab();
-
- /**
- * Sets the link-address of this {@link Marker}.null to disable the link
- * @param newTab whether the link should be opened in a new tab
- * @deprecated Not all marker-types support this
- */
- void setLink(String link, boolean newTab);
-
- /**
- * Removes the link of this {@link Marker}.
- * @deprecated Not all marker-types support this
- */
- void removeLink();
+ public void setPosition(int x, int y, int z) {
+ setPosition(new Vector3d(x, y, z));
+ }
}
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/MarkerAPI.java b/src/main/java/de/bluecolored/bluemap/api/marker/MarkerAPI.java
deleted file mode 100644
index aef1f44..0000000
--- a/src/main/java/de/bluecolored/bluemap/api/marker/MarkerAPI.java
+++ /dev/null
@@ -1,104 +0,0 @@
-/*
- * This file is part of BlueMap, licensed under the MIT License (MIT).
- *
- * Copyright (c) Blue (Lukas Rieger) markers.json that is used to display different Markers on the map.
- *
- * Important:
- * 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()}!
- *
To avoid any concurrent modifications to the markers.json, make sure your {@link MarkerAPI} is always loaded before making any changes, and saved right after the changes.
removeMarkerSet(markerSet.getId()).
- *
- * @param markerSet the {@link MarkerSet} to be removed
- * @return true if the {@link MarkerSet} was removed, false 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 true if the {@link MarkerSet} was removed, false 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 markers.json.markers.json
- */
- void load() throws IOException;
-
- /**
- * Saves all changes made with this instance to the markers.json.markers.json
- */
- void save() throws IOException;
-
-}
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/MarkerSet.java b/src/main/java/de/bluecolored/bluemap/api/marker/MarkerSet.java
index d20cfee..c174020 100644
--- a/src/main/java/de/bluecolored/bluemap/api/marker/MarkerSet.java
+++ b/src/main/java/de/bluecolored/bluemap/api/marker/MarkerSet.java
@@ -24,59 +24,83 @@
*/
package de.bluecolored.bluemap.api.marker;
-import com.flowpowered.math.vector.Vector2d;
-import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.BlueMapMap;
-
-import java.util.Collection;
-import java.util.Optional;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
/**
* A set of {@link Marker}s that are displayed on the maps in the web-app.
- *
- * Each {@link MarkerSet} has an unique id.
*/ -public interface MarkerSet { +public class MarkerSet { + + private String label; + private boolean toggleable, defaultHidden; + private final MapThe label is used in the web-app to name the toggle-button of this {@link MarkerSet} if it is toggleable. ({@link #isToggleable()})
* @return the label of this {@link MarkerSet} */ - String getLabel(); - + public String getLabel() { + return label; + } /** * Sets the label of this {@link MarkerSet}. *The label is used in the web-app to name the toggle-button of this {@link MarkerSet} if it is toggleable. ({@link #isToggleable()})
* @param label the new label */ - void setLabel(String label); + public void setLabel(String label) { + this.label = label; + } /** * Checks if the {@link MarkerSet} is toggleable. *If this is true, the web-app will display a toggle-button for this {@link MarkerSet} so the user can choose to enable/disable all markers of this set.
If this is true, the web-app will display a toggle-button for this {@link MarkerSet} so the user can choose to enable/disable all markers of this set.
(Since the shape has its own positions, the position is only used to determine e.g. the distance to the camera)
- * - * @param id the id of the new marker - * @param map the {@link BlueMapMap} of the new marker - * @param position the position of the new marker - * @param shape the Shape of the marker (See: {@link ShapeMarker#setShape(Shape, float)}) - * @param y the height (y-position on the map) of shape of the marker (See: {@link ShapeMarker#setShape(Shape, float)}) - * @return the created {@link ShapeMarker} + * @return a {@link Map} of all {@link Marker}s of this {@link MarkerSet}. */ - ShapeMarker createShapeMarker(String id, BlueMapMap map, Vector3d position, Shape shape, float y); - - /** - * Creates a {@link ShapeMarker} with the given id and adds it to this {@link MarkerSet}.(Since the shape has its own positions, the position is only used to determine e.g. the distance to the camera)
- * - * @param id the id of the new marker - * @param map the {@link BlueMapMap} of the new marker - * @param posX the x-position of the new marker - * @param posY the y-position of the new marker - * @param posZ the z-position of the new marker - * @param shape the Shape of the marker (See: {@link ShapeMarker#setShape(Shape, float)}) - * @param y the height (y-position on the map) of shape of the marker (See: {@link ShapeMarker#setShape(Shape, float)}) - * @return the created {@link ShapeMarker} - */ - default ShapeMarker createShapeMarker(String id, BlueMapMap map, double posX, double posY, double posZ, Shape shape, float y) { - return createShapeMarker(id, map, new Vector3d(posX, posY, posZ), shape, y); + public Map(The position of the marker will be the center of the shape (it's bounding box))
- * - * @param id the id of the new marker - * @param map the {@link BlueMapMap} of the new marker - * @param shape the Shape of the marker (See: {@link ShapeMarker#setShape(Shape, float)}) - * @param y the height of shape of the marker (See: {@link ShapeMarker#setShape(Shape, float)}) - * @return the created {@link ShapeMarker} - */ - default ShapeMarker createShapeMarker(String id, BlueMapMap map, Shape shape, float y) { - Vector2d center = shape.getMin().add(shape.getMax()).div(2); - return createShapeMarker(id, map, new Vector3d(center.getX(), y, center.getY()), shape, y); - } - - /** - * Creates a {@link ExtrudeMarker} with the given id and adds it to this {@link MarkerSet}.(Since the shape has its own positions, the position is only used to determine e.g. the distance to the camera)
- * - * @param id the id of the new marker - * @param map the {@link BlueMapMap} of the new marker - * @param position the position of the new marker - * @param shape the {@link Shape} of the marker (See: {@link ExtrudeMarker#setShape(Shape, float, float)}) - * @param minY the min-height (y-position on the map) of the shape of the marker (See: {@link ExtrudeMarker#setShape(Shape, float, float)}) - * @param maxY the max-height (y-position on the map) of the shape of the marker (See: {@link ExtrudeMarker#setShape(Shape, float, float)}) - * @return the created {@link ExtrudeMarker} - */ - ExtrudeMarker createExtrudeMarker(String id, BlueMapMap map, Vector3d position, Shape shape, float minY, float maxY); - - /** - * Creates a {@link ExtrudeMarker} with the given id and adds it to this {@link MarkerSet}.(Since the shape has its own positions, the position is only used to determine e.g. the distance to the camera)
- * - * @param id the id of the new marker - * @param map the {@link BlueMapMap} of the new marker - * @param posX the x-position of the new marker - * @param posY the y-position of the new marker - * @param posZ the z-position of the new marker - * @param shape the {@link Shape} of the marker (See: {@link ExtrudeMarker#setShape(Shape, float, float)}) - * @param minY the min-height (y-position on the map) of the shape of the marker (See: {@link ExtrudeMarker#setShape(Shape, float, float)}) - * @param maxY the max-height (y-position on the map) of the shape of the marker (See: {@link ExtrudeMarker#setShape(Shape, float, float)}) - * @return the created {@link ExtrudeMarker} - */ - default ExtrudeMarker createExtrudeMarker(String id, BlueMapMap map, double posX, double posY, double posZ, Shape shape, float minY, float maxY) { - return createExtrudeMarker(id, map, new Vector3d(posX, posY, posZ), shape, minY, maxY); - } - - /** - * Creates a {@link ExtrudeMarker} with the given id and adds it to this {@link MarkerSet}.(The position of the marker will be the center of the shape (it's bounding box))
- * - * @param id the id of the new marker - * @param map the {@link BlueMapMap} of the new marker - * @param shape the {@link Shape} of the marker (See: {@link ExtrudeMarker#setShape(Shape, float, float)}) - * @param minY the min-height (y-position on the map) of the shape of the marker (See: {@link ExtrudeMarker#setShape(Shape, float, float)}) - * @param maxY the max-height (y-position on the map) of the shape of the marker (See: {@link ExtrudeMarker#setShape(Shape, float, float)}) - * @return the created {@link ExtrudeMarker} - */ - default ExtrudeMarker createExtrudeMarker(String id, BlueMapMap map, Shape shape, float minY, float maxY) { - Vector2d center = shape.getMin().add(shape.getMax()).div(2f); - float y = (minY + maxY)/2f; - return createExtrudeMarker(id, map, new Vector3d(center.getX(), y, center.getY()), shape, minY, maxY); - } - - /** - * Creates a {@link LineMarker} with the given id and adds it to this {@link MarkerSet}.(Since the line has its own positions, the position is only used to determine e.g. the distance to the camera)
- * - * @param id the id of the new marker - * @param map the {@link BlueMapMap} of the new marker - * @param position the position of the new marker - * @param line the {@link Line} of the marker (See: {@link LineMarker#setLine(Line)}) - * @return the created {@link LineMarker} - */ - LineMarker createLineMarker(String id, BlueMapMap map, Vector3d position, Line line); - - /** - * Creates a {@link LineMarker} with the given id and adds it to this {@link MarkerSet}.(Since the line has its own positions, the position is only used to determine e.g. the distance to the camera)
- * - * @param id the id of the new marker - * @param map the {@link BlueMapMap} of the new marker - * @param posX the x-position of the new marker - * @param posY the y-position of the new marker - * @param posZ the z-position of the new marker - * @param line the {@link Line} of the marker (See: {@link LineMarker#setLine(Line)}) - * @return the created {@link LineMarker} - */ - default LineMarker createLineMarker(String id, BlueMapMap map, double posX, double posY, double posZ, Line line) { - return createLineMarker(id, map, new Vector3d(posX, posY, posZ), line); - } - - /** - * Creates a {@link LineMarker} with the given id and adds it to this {@link MarkerSet}.(The position of the marker will be the center of the line (it's bounding box))
- * - * @param id the id of the new marker - * @param map the {@link BlueMapMap} of the new marker - * @param line the {@link Line} of the marker (See: {@link LineMarker#setLine(Line)}) - * @return the created {@link LineMarker} - */ - default LineMarker createLineMarker(String id, BlueMapMap map, Line line) { - Vector3d center = line.getMin().add(line.getMax()).div(2f); - return createLineMarker(id, map, center, line); - } - - /** - * Removes the given Marker from this {@link MarkerSet}.removeMarker(marker.getId()).
- *
- * @param marker the {@link Marker} to be removed
- * @return true if the {@link Marker} was removed, false if that {@link Marker} didn't exist
- */
- default boolean removeMarker(Marker marker) {
- return removeMarker(marker.getId());
- }
-
- /**
- * Removes the {@link Marker} with the given id.
- *
- * @param id the id of the {@link Marker} to be removed
- * @return true if the {@link Marker} was removed, false if there was no {@link Marker} with that id
- */
- boolean removeMarker(String id);
-
}
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/ObjectMarker.java b/src/main/java/de/bluecolored/bluemap/api/marker/ObjectMarker.java
index c58cba3..cea4857 100644
--- a/src/main/java/de/bluecolored/bluemap/api/marker/ObjectMarker.java
+++ b/src/main/java/de/bluecolored/bluemap/api/marker/ObjectMarker.java
@@ -24,13 +24,34 @@
*/
package de.bluecolored.bluemap.api.marker;
-public interface ObjectMarker extends Marker, LinkMarker {
+import com.flowpowered.math.vector.Vector3d;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Objects;
+import java.util.Optional;
+
+public abstract class ObjectMarker extends DistanceRangedMarker {
+
+ private String detail;
+
+ @Nullable
+ private String link;
+ private boolean newTab;
+
+ public ObjectMarker(String type, String label, Vector3d position) {
+ super(type, label, position);
+ this.detail = Objects.requireNonNull(label, "label must not be null");
+ this.link = null;
+ this.newTab = false;
+ }
/**
* Getter for the detail of this marker. The label can include html-tags.
* @return the detail of this {@link ObjectMarker}
*/
- String getDetail();
+ public String getDetail() {
+ return detail;
+ }
/**
* Sets the detail of this {@link ObjectMarker}. The detail can include html-tags.true the link ({@link #getLink()}) will be opened in a new tab.
+ * @return whether the link will be opened in a new tab
+ * @see #getLink()
+ */
+ public boolean isNewTab() {
+ return newTab;
+ }
+
+ /**
+ * Sets the link-address of this {@link Marker}.null to disable the link
+ * @param newTab whether the link should be opened in a new tab
+ */
+ public void setLink(String link, boolean newTab) {
+ this.link = Objects.requireNonNull(link, "link must not be null");
+ this.newTab = newTab;
+ }
+
+ /**
+ * Removes the link of this {@link Marker}.
+ */
+ public void removeLink() {
+ this.link = null;
+ this.newTab = false;
+ }
}
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/POIMarker.java b/src/main/java/de/bluecolored/bluemap/api/marker/POIMarker.java
index f25c9fe..94fe97e 100644
--- a/src/main/java/de/bluecolored/bluemap/api/marker/POIMarker.java
+++ b/src/main/java/de/bluecolored/bluemap/api/marker/POIMarker.java
@@ -25,47 +25,83 @@
package de.bluecolored.bluemap.api.marker;
import com.flowpowered.math.vector.Vector2i;
+import com.flowpowered.math.vector.Vector3d;
+import de.bluecolored.bluemap.api.WebApp;
-import de.bluecolored.bluemap.api.BlueMapAPI;
+import java.util.Objects;
-public interface POIMarker extends Marker, DistanceRangedMarker {
+public class POIMarker extends DistanceRangedMarker {
+
+ private String icon;
+ private Vector2i anchor;
+
+ /**
+ * Creates a new {@link POIMarker} with the standard icon.
+ *
+ * @param label the label of the marker
+ * @param position the coordinates of the marker
+ *
+ * @see #setLabel(String)
+ * @see #setPosition(Vector3d)
+ */
+ public POIMarker(String label, Vector3d position) {
+ this(label, position, "assets/poi.svg", new Vector2i(25, 45));
+ }
+
+ /**
+ * Creates a new {@link POIMarker}.
+ *
+ * @param label the label of the marker
+ * @param position the coordinates of the marker
+ * @param iconAddress the html-content of the marker
+ * @param anchor the anchor-point of the html-content
+ *
+ * @see #setLabel(String)
+ * @see #setPosition(Vector3d)
+ * @see #setIcon(String, Vector2i)
+ */
+ public POIMarker(String label, Vector3d position, String iconAddress, Vector2i anchor) {
+ super("poi", label, position);
+ this.icon = Objects.requireNonNull(iconAddress, "iconAddress must not be null");
+ this.anchor = Objects.requireNonNull(anchor, "anchor must not be null");
+ }
/**
* Getter for the relative address of the icon used to display this {@link POIMarker}
* @return the relative web-address of the icon
*/
- String getIconAddress();
-
- /**
- * Getter for the position (in pixels) where the icon is anchored to the map.
- * @return the anchor-position in pixels
- * @deprecated Use {@link #getAnchor()} instead
- */
- default Vector2i getIconAnchor() {
- return getAnchor();
+ public String getIconAddress() {
+ return icon;
}
/**
* Getter for the position (in pixels) where the icon is anchored to the map.
* @return the anchor-position in pixels
*/
- Vector2i getAnchor();
+ public Vector2i getAnchor() {
+ return anchor;
+ }
/**
* Sets the icon for this {@link POIMarker}.
- * @param iconAddress the web-address of the icon-image. Can be an absolute or relative. You can also use an address returned by {@link BlueMapAPI#createImage(java.awt.image.BufferedImage, String)}.
+ * @param iconAddress the web-address of the icon-image. Can be an absolute or relative.
+ * You can also use an address returned by {@link WebApp#createImage(java.awt.image.BufferedImage, String)}.
* @param anchorX the x-position of the position (in pixels) where the icon is anchored to the map
* @param anchorY the y-position of the position (in pixels) where the icon is anchored to the map
*/
- default void setIcon(String iconAddress, int anchorX, int anchorY) {
+ public void setIcon(String iconAddress, int anchorX, int anchorY) {
setIcon(iconAddress, new Vector2i(anchorX, anchorY));
}
/**
* Sets the icon for this {@link POIMarker}.
- * @param iconAddress the web-address of the icon-image. Can be an absolute or relative. You can also use an address returned by {@link BlueMapAPI#createImage(java.awt.image.BufferedImage, String)}.
+ * @param iconAddress the web-address of the icon-image. Can be an absolute or relative.
+ * You can also use an address returned by {@link WebApp#createImage(java.awt.image.BufferedImage, String)}.
* @param anchor the position of the position (in pixels) where the icon is anchored to the map
*/
- void setIcon(String iconAddress, Vector2i anchor);
+ public void setIcon(String iconAddress, Vector2i anchor) {
+ this.icon = Objects.requireNonNull(iconAddress, "iconAddress must not be null");
+ this.anchor = Objects.requireNonNull(anchor, "anchor must not be null");
+ }
}
diff --git a/src/main/java/de/bluecolored/bluemap/api/marker/ShapeMarker.java b/src/main/java/de/bluecolored/bluemap/api/marker/ShapeMarker.java
index 75dcabf..eed2d9a 100644
--- a/src/main/java/de/bluecolored/bluemap/api/marker/ShapeMarker.java
+++ b/src/main/java/de/bluecolored/bluemap/api/marker/ShapeMarker.java
@@ -24,105 +24,157 @@
*/
package de.bluecolored.bluemap.api.marker;
-import java.awt.Color;
-public interface ShapeMarker extends ObjectMarker, DistanceRangedMarker {
+import com.flowpowered.math.vector.Vector2d;
+import com.flowpowered.math.vector.Vector3d;
+import de.bluecolored.bluemap.api.math.Color;
+
+import java.util.Objects;
+
+public class ShapeMarker extends ObjectMarker {
+
+ private Shape shape;
+ private float shapeY;
+ private boolean depthTest = true;
+ private int lineWidth = 2;
+ private Color lineColor = new Color(255, 0, 0, 1f);
+ private Color fillColor = new Color(200, 0, 0, 0.3f);
+
+ /**
+ * Creates a new {@link ShapeMarker}.
+ * (The position of the marker will be the center of the shape (it's bounding box))
+ * + * @param label the label of the marker + * @param shape the {@link Shape} of the marker + * @param shapeY the y-position of the shape + * + * @see #setLabel(String) + * @see #setShape(Shape, float) + */ + public ShapeMarker(String label, Shape shape, float shapeY) { + this(label, calculateShapeCenter(Objects.requireNonNull(shape, "shape must not be null"), shapeY), shape, shapeY); + } + + /** + * Creates a new {@link ShapeMarker}. + *(Since the shape has its own positions, the position is only used to determine e.g. the distance to the camera)
+ * + * @param label the label of the marker + * @param position the coordinates of the marker + * @param shape the shape of the marker + * @param shapeY the y-position of the shape + * + * @see #setLabel(String) + * @see #setPosition(Vector3d) + * @see #setShape(Shape, float) + */ + public ShapeMarker(String label, Vector3d position, Shape shape, float shapeY) { + super("shape", label, position); + this.shape = Objects.requireNonNull(shape, "shape must not be null"); + this.shapeY = shapeY; + } /** * Getter for {@link Shape} of this {@link ShapeMarker}. *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.
* @return the {@link Shape} */ - Shape getShape(); - - /** - * Getter for the height (y-coordinate) of where the shape is displayed on the map. - * @return the height of the shape on the map - * @deprecated Use {@link #getShapeY()} instead - */ - default float getHeight() { - return getShapeY(); + public Shape getShape() { + return shape; } /** * Getter for the height (y-coordinate) of where the shape is displayed on the map. * @return the height of the shape on the map */ - float getShapeY(); + public float getShapeY() { + return shapeY; + } /** * Sets the {@link Shape} of this {@link ShapeMarker}. *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.
* @param shape the new {@link Shape} * @param y the new height (y-coordinate) of the shape on the map + * + * @see #centerPosition() */ - void setShape(Shape shape, float y); + public void setShape(Shape shape, float y) { + this.shape = Objects.requireNonNull(shape, "shape must not be null"); + this.shapeY = y; + } + + /** + * Sets the position of this {@link ShapeMarker} to the center of the {@link Shape} (it's bounding box). + *(Invoke this after changing the {@link Shape} to make sure the markers position gets updated as well)
+ */ + public void centerPosition() { + setPosition(calculateShapeCenter(shape, shapeY)); + } /** * 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. * @returntrue if the depthTest is enabled
*/
- boolean isDepthTestEnabled();
+ public boolean isDepthTestEnabled() {
+ return depthTest;
+ }
/**
* 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 ShapeMarker}
*/
- void setDepthTestEnabled(boolean enabled);
+ public void setDepthTestEnabled(boolean enabled) {
+ this.depthTest = enabled;
+ }
/**
* Getter for the width of the border-line of this {@link ShapeMarker}.
* @return the width of the line in pixels
*/
- int getLineWidth();
+ public int getLineWidth() {
+ return lineWidth;
+ }
/**
* Sets the width of the border-line for this {@link ShapeMarker}.
* @param width the new width in pixels
*/
- void setLineWidth(int width);
-
- /**
- * Getter for the {@link Color} of the border of the shape.
- * @return the border-color
- * @deprecated Use {@link #getLineColor()} instead
- */
- default Color getBorderColor() {
- return getLineColor();
- }
-
- /**
- * Sets the {@link Color} of the border of the shape.
- * @param color the new border-color
- * @deprecated Use {@link #setLineColor(Color)} instead
- */
- default void setBorderColor(Color color){
- setLineColor(color);
+ public void setLineWidth(int width) {
+ this.lineWidth = width;
}
/**
* Getter for the {@link Color} of the border-line of the shape.
* @return the line-color
*/
- Color getLineColor();
+ public Color getLineColor() {
+ return lineColor;
+ }
/**
* Sets the {@link Color} of the border-line of the shape.
* @param color the new line-color
*/
- void setLineColor(Color color);
+ public void setLineColor(Color color) {
+ this.lineColor = Objects.requireNonNull(color, "color must not be null");
+ }
/**
* Getter for the fill-{@link Color} of the shape.
* @return the fill-color
*/
- Color getFillColor();
+ public Color getFillColor() {
+ return fillColor;
+ }
/**
* Sets the fill-{@link Color} of the shape.
* @param color the new fill-color
*/
- void setFillColor(Color color);
+ public void setFillColor(Color color) {
+ this.fillColor = Objects.requireNonNull(color, "color must not be null");
+ }
/**
* Sets the border- and fill- color.
@@ -131,9 +183,14 @@ default void setBorderColor(Color color){
* @see #setLineColor(Color)
* @see #setFillColor(Color)
*/
- default void setColors(Color lineColor, Color fillColor) {
+ public void setColors(Color lineColor, Color fillColor) {
setLineColor(lineColor);
setFillColor(fillColor);
}
+ private static Vector3d calculateShapeCenter(Shape shape, float shapeY) {
+ Vector2d center = shape.getMin().add(shape.getMax()).mul(0.5);
+ return new Vector3d(center.getX(), shapeY, center.getY());
+ }
+
}
diff --git a/src/main/java/de/bluecolored/bluemap/api/math/Color.java b/src/main/java/de/bluecolored/bluemap/api/math/Color.java
new file mode 100644
index 0000000..60883b9
--- /dev/null
+++ b/src/main/java/de/bluecolored/bluemap/api/math/Color.java
@@ -0,0 +1,83 @@
+package de.bluecolored.bluemap.api.math;
+
+import java.util.Objects;
+
+public class Color {
+
+ private final int r, g, b;
+ private final float a;
+
+ /**
+ * Creates a new color with the given red, green and blue values.
+ *
+ * @param red the red value in range 0-255
+ * @param green the green value in range 0-255
+ * @param blue the blue value in range 0-255
+ */
+ public Color(int red, int green, int blue) {
+ this(red, green, blue, 1);
+ }
+
+ /**
+ * Creates a new color with the given red, green, blue and alpha values.
+ *
+ * @param red the red value in range 0-255
+ * @param green the green value in range 0-255
+ * @param blue the blue value in range 0-255
+ * @param alpha the alpha value in range 0-1
+ */
+ public Color(int red, int green, int blue, float alpha) {
+ this.r = red;
+ this.g = green;
+ this.b = blue;
+ this.a = alpha;
+ }
+
+ /**
+ * Creates a new color from the given integer in the format 0xAARRGGBB.
+ * @param i the integer to create the color from
+ */
+ public Color(int i) {
+ this((i >> 16) & 0xFF, (i >> 8) & 0xFF, i & 0xFF, ((i >> 24) & 0xFF) / 255f);
+ }
+
+ /**
+ * The value can be an integer in String-Format (see {@link #Color(int)}) or a string in hexadecimal format
+ * prefixed with # (css-style: e.g. #f16 becomes #ff1166).
+ * @param cssColorString The string to parse to a color
+ * @throws NumberFormatException If the value is not formatted correctly.
+ */
+ public Color(String cssColorString) {
+ this(parseColorString(Objects.requireNonNull(cssColorString)));
+ }
+
+ public int getRed() {
+ return r;
+ }
+ public int getGreen() {
+ return g;
+ }
+
+ public int getBlue() {
+ return b;
+ }
+
+ public float getAlpha() {
+ return a;
+ }
+
+ private static int parseColorString(String val) {
+ if (val.charAt(0) == '#') {
+ val = val.substring(1);
+ if (val.length() == 3) val = val + "f";
+ if (val.length() == 4) val = "" + val.charAt(0) + val.charAt(0) + val.charAt(1) + val.charAt(1) + val.charAt(2) + val.charAt(2) + val.charAt(3) + val.charAt(3);
+ if (val.length() == 6) val = val + "ff";
+ if (val.length() != 8) throw new NumberFormatException("Invalid color format!");
+ val = val.substring(6, 8) + val.substring(0, 6); // move alpha to front
+ return Integer.parseUnsignedInt(val, 16);
+ }
+
+ return Integer.parseInt(val);
+ }
+
+}
diff --git a/src/main/resources/de.bluecolored.bluemap.api/version b/src/main/resources/de.bluecolored.bluemap.api/version
new file mode 100644
index 0000000..f048a44
--- /dev/null
+++ b/src/main/resources/de.bluecolored.bluemap.api/version
@@ -0,0 +1,3 @@
+${version}
+${gitHash}
+${gitClean}
\ No newline at end of file