mirror of https://github.com/webbukkit/dynmap.git
264 lines
9.4 KiB
Java
264 lines
9.4 KiB
Java
package org.dynmap.markers;
|
|
|
|
import java.util.Set;
|
|
|
|
/**
|
|
* This defines the public interface to a marker set object, for use with the MarkerAPI.
|
|
* This represents a logical set of markers, which are presented as a labelled layer on the web UI.
|
|
* Marker sets can be created as persistent or non-persistent, but only persistent marker sets can contain persistent markers.
|
|
*/
|
|
public interface MarkerSet {
|
|
public static final String DEFAULT = "markers"; /* Default set - always exists */
|
|
|
|
/**
|
|
* Get set of all markers currently in the set
|
|
* @return set of markers (set is copy - safe to iterate)
|
|
*/
|
|
public Set<Marker> getMarkers();
|
|
/**
|
|
* Get set of all area markers currently in the set
|
|
* @return set of area markers (set is copy - safe to iterate)
|
|
*/
|
|
public Set<AreaMarker> getAreaMarkers();
|
|
/**
|
|
* Get set of all poly-line markers currently in the set
|
|
* @return set of poly-line markers (set is copy - safe to iterate)
|
|
*/
|
|
public Set<PolyLineMarker> getPolyLineMarkers();
|
|
/**
|
|
* Get set of all circle markers currently in the set
|
|
* @return set of circle markers (set is copy - safe to iterate)
|
|
*/
|
|
public Set<CircleMarker> getCircleMarkers();
|
|
/**
|
|
* Create a new marker in the marker set
|
|
*
|
|
* @param id - ID of the marker - must be unique within the set: if null, unique ID is generated
|
|
* @param label - Label for the marker (plain text)
|
|
* @param world - world ID
|
|
* @param x - x coord
|
|
* @param y - y coord
|
|
* @param z - z coord
|
|
* @param icon - Icon for the marker
|
|
* @param is_persistent - if true, marker is persistent (saved and reloaded on restart). If set is not persistent, this must be false.
|
|
* @return created marker, or null if cannot be created.
|
|
*/
|
|
public Marker createMarker(String id, String label, String world, double x, double y, double z, MarkerIcon icon, boolean is_persistent);
|
|
/**
|
|
* Create a new marker in the marker set
|
|
*
|
|
* @param id - ID of the marker - must be unique within the set: if null, unique ID is generated
|
|
* @param label - Label for the marker
|
|
* @param markup - if true, label is processed as HTML. if false, label is processed as plain text.
|
|
* @param world - world ID
|
|
* @param x - x coord
|
|
* @param y - y coord
|
|
* @param z - z coord
|
|
* @param icon - Icon for the marker
|
|
* @param is_persistent - if true, marker is persistent (saved and reloaded on restart). If set is not persistent, this must be false.
|
|
* @return created marker, or null if cannot be created.
|
|
*/
|
|
public Marker createMarker(String id, String label, boolean markup, String world, double x, double y, double z, MarkerIcon icon, boolean is_persistent);
|
|
/**
|
|
* Get marker by ID
|
|
* @param id - ID of the marker
|
|
* @return marker, or null if cannot be found
|
|
*/
|
|
public Marker findMarker(String id);
|
|
/**
|
|
* Find marker by label - best matching substring
|
|
* @param lbl - label to find (same = best match)
|
|
* @return marker, or null if none found
|
|
*/
|
|
public Marker findMarkerByLabel(String lbl);
|
|
/**
|
|
* Create area marker
|
|
* @param id - marker ID
|
|
* @param lbl - label
|
|
* @param markup - if true, label is HTML markup
|
|
* @param world - world id
|
|
* @param x - x coord list
|
|
* @param z - z coord list
|
|
* @param persistent - true if persistent
|
|
*/
|
|
public AreaMarker createAreaMarker(String id, String lbl, boolean markup, String world, double x[], double z[], boolean persistent);
|
|
/**
|
|
* Get area marker by ID
|
|
* @param id - ID of the area marker
|
|
* @return marker, or null if cannot be found
|
|
*/
|
|
public AreaMarker findAreaMarker(String id);
|
|
/**
|
|
* Find area marker by label - best matching substring
|
|
* @param lbl - label to find (same = best match)
|
|
* @return marker, or null if none found
|
|
*/
|
|
public AreaMarker findAreaMarkerByLabel(String lbl);
|
|
|
|
/**
|
|
* Create poly-line marker
|
|
* @param id - marker ID
|
|
* @param lbl - label
|
|
* @param markup - if true, label is HTML markup
|
|
* @param world - world id
|
|
* @param x - x coord list
|
|
* @param y - y coord list
|
|
* @param z - z coord list
|
|
* @param persistent - true if persistent
|
|
*/
|
|
public PolyLineMarker createPolyLineMarker(String id, String lbl, boolean markup, String world, double x[], double[] y, double z[], boolean persistent);
|
|
/**
|
|
* Get poly-line marker by ID
|
|
* @param id - ID of the poly-line marker
|
|
* @return marker, or null if cannot be found
|
|
*/
|
|
public PolyLineMarker findPolyLineMarker(String id);
|
|
/**
|
|
* Find poly-line marker by label - best matching substring
|
|
* @param lbl - label to find (same = best match)
|
|
* @return marker, or null if none found
|
|
*/
|
|
public PolyLineMarker findPolyLineMarkerByLabel(String lbl);
|
|
|
|
|
|
/**
|
|
* Create circle marker
|
|
* @param id - marker ID
|
|
* @param lbl - label
|
|
* @param markup - if true, label is HTML markup
|
|
* @param world - world id
|
|
* @param x - x of center
|
|
* @param y - y of center
|
|
* @param z - z of center
|
|
* @param xr - radius on x axis
|
|
* @param zr - radius on z axis
|
|
* @param persistent - true if persistent
|
|
*/
|
|
public CircleMarker createCircleMarker(String id, String lbl, boolean markup, String world, double x, double y, double z, double xr, double zr, boolean persistent);
|
|
/**
|
|
* Get circle marker by ID
|
|
* @param id - ID of the circle marker
|
|
* @return marker, or null if cannot be found
|
|
*/
|
|
public CircleMarker findCircleMarker(String id);
|
|
/**
|
|
* Find area marker by label - best matching substring
|
|
* @param lbl - label to find (same = best match)
|
|
* @return marker, or null if none found
|
|
*/
|
|
public CircleMarker findCircleMarkerByLabel(String lbl);
|
|
|
|
/**
|
|
* Get ID of marker set - unique among marker sets
|
|
* @return ID
|
|
*/
|
|
public String getMarkerSetID();
|
|
/**
|
|
* Get label for marker set
|
|
* @return label
|
|
*/
|
|
public String getMarkerSetLabel();
|
|
/**
|
|
* Update label for marker set
|
|
* @param lbl - label for marker set
|
|
*/
|
|
public void setMarkerSetLabel(String lbl);
|
|
/**
|
|
* Test if marker set is persistent
|
|
* @return true if the set is persistent
|
|
*/
|
|
public boolean isMarkerSetPersistent();
|
|
/**
|
|
* Get marker icons allowed in set (if restricted)
|
|
* @return set of allowed marker icons
|
|
*/
|
|
public Set<MarkerIcon> getAllowedMarkerIcons();
|
|
/**
|
|
* Add marker icon to allowed set (must have been created restricted)
|
|
* @param icon - icon to be added
|
|
*/
|
|
public void addAllowedMarkerIcon(MarkerIcon icon);
|
|
/**
|
|
* Remove marker icon from allowed set (must have been created restricted)
|
|
* @param icon - icon to be added
|
|
*/
|
|
public void removeAllowedMarkerIcon(MarkerIcon icon);
|
|
/**
|
|
* Test if marker icon is allowed
|
|
* @param icon - marker icon
|
|
* @return true if allowed, false if not
|
|
*/
|
|
public boolean isAllowedMarkerIcon(MarkerIcon icon);
|
|
/**
|
|
* Get distinct set of marker icons used by set (based on markers currently in set)
|
|
* @return set of marker icons
|
|
*/
|
|
public Set<MarkerIcon> getMarkerIconsInUse();
|
|
/**
|
|
* Delete marker set
|
|
*/
|
|
public void deleteMarkerSet();
|
|
/**
|
|
* Set hide/show default
|
|
* @param hide - if true, layer for set will be hidden by default
|
|
*/
|
|
public void setHideByDefault(boolean hide);
|
|
/**
|
|
* Get hide/show default
|
|
* @return true if layer for set will be hidden by default
|
|
*/
|
|
public boolean getHideByDefault();
|
|
/**
|
|
* Set layer ordering priority (0=default, low before high in layer order)
|
|
*/
|
|
public void setLayerPriority(int prio);
|
|
/**
|
|
* Get layer ordering priority (0=default, low before high in layer order)
|
|
*/
|
|
public int getLayerPriority();
|
|
/**
|
|
* Get min zoom-in for display of layer (hide when zoom is below this setting)
|
|
* @return minzoom (-1 if no minimum)
|
|
*/
|
|
public int getMinZoom();
|
|
/**
|
|
* Set min zoom-in for display of layer
|
|
* @param minzoom - min zoom to display layer (-1 = no minimum)
|
|
*/
|
|
public void setMinZoom(int minzoom);
|
|
/**
|
|
* Get max zoom-in for display of layer (hide when zoom is above this setting)
|
|
* @return maxzoom (-1 if no max)
|
|
*/
|
|
public int getMaxZoom();
|
|
/**
|
|
* Set max zoom-in for display of layer
|
|
* @param maxzoom - max zoom to display layer (-1 = no maximum)
|
|
*/
|
|
public void setMaxZoom(int maxzoom);
|
|
/**
|
|
* Set show/hide label for markers in set
|
|
* @param show - if true, show labels; if false, hide (show on hover); if null, use global default
|
|
*/
|
|
public void setLabelShow(Boolean show);
|
|
/**
|
|
* Get show/hide label for markers
|
|
* @return true, show labels; false, hide (show on hover); null, use global default
|
|
*/
|
|
public Boolean getLabelShow();
|
|
/**
|
|
* Set the default marker icon for markers added to this set
|
|
* @param defmark - default marker
|
|
*/
|
|
public void setDefaultMarkerIcon(MarkerIcon defmark);
|
|
/**
|
|
* Get the default marker icon for the markers added to this set
|
|
* @return default marker
|
|
*/
|
|
public MarkerIcon getDefaultMarkerIcon();
|
|
/**
|
|
* Add entered markers to set based on given coordinates
|
|
*/
|
|
public void addEnteredMarkers(Set<EnterExitMarker> entered, String worldid, double x, double y, double z);
|
|
}
|