Overlay (JourneyMap API and Example Mod)

java.lang.Object
- journeymap.api.v2.client.display.Displayable
- - journeymap.api.v2.client.display.Overlay

All Implemented Interfaces:

java.lang.Comparable<Displayable>

Direct Known Subclasses:

ImageOverlay, MarkerOverlay, PolygonOverlay
```
@ParametersAreNonnullByDefault
public abstract class Overlay
extends Displayable
```
Provides IDs and key information for map overlays in JourneyMap.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Set<Context.MapType>`	`activeMapTypes`
`protected java.util.Set<Context.UI>`	`activeUIs`
`protected net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>`	`dimension`
`protected int`	`displayOrder`
`protected java.lang.String`	`label`
`protected int`	`maxZoom`
`protected int`	`minZoom`
`protected boolean`	`needsRerender`
`protected java.lang.String`	`overlayGroupName`
`protected IOverlayListener`	`overlayListener`
`protected TextProperties`	`textProperties`
`protected java.lang.String`	`title`

Fields inherited from class journeymap.api.v2.client.display.Displayable
displayType, id, modId

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearFlagForRerender()` Used by JourneyMap after the overlay has been re-rendered.
`void`	`flagForRerender()` Indicate the overlay needs to be re-rendered.
`java.util.Set<Context.MapType>`	`getActiveMapTypes()` Returns a set of enums indicating which map types (Day, Night) the overlay should be active in.
`java.util.Set<Context.UI>`	`getActiveUIs()` Returns a set of enums indicating which JourneyMap UIs (Fullscreen, Minimap, Webmap) the overlay should be active in.
`net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>`	`getDimension()` The dimension this overlay should be displayed in.
`int`	`getDisplayOrder()` Any features are displayed on the map in order of their screen displayOrder, with higher values displaying in front of features with lower values.
`java.lang.String`	`getLabel()` Label text to be displayed on the overlay.
`int`	`getMaxZoom()` The maximum zoom level (UIState.ZOOM_IN_MAX is highest) where the overlay should be visible.
`int`	`getMinZoom()` The minimum zoom level (UIState.FULLSCREEN_ZOOM_MIN is lowest) where the overlay should be visible.
`boolean`	`getNeedsRerender()` Gets whether the overlay needs to be re-rendered.
`java.lang.String`	`getOverlayGroupName()` A suggested group or category name used to organize map overlays.
`IOverlayListener`	`getOverlayListener()` Gets the listener for user events on the overlay.
`TextProperties`	`getTextProperties()` Gets the text properties for the overlay.
`java.lang.String`	`getTitle()` Rollover text to be displayed when the mouse is over the overlay.
`boolean`	`isActiveIn(UIState uiState)` Whether the overlay should be active for the given contexts.
`boolean`	`isInZoomRange(UIState uiState)` Whether the zoom of the given context is within the zoom range of the overlay.
`Overlay`	`setActiveMapTypes(Context.MapType... activeMapTypes)` Set of enums indicating which JourneyMap map types (Day, Night) the overlay should be active in.
`Overlay`	`setActiveUIs(Context.UI... activeUIs)` Set of enums indicating which JourneyMap UIs (Fullscreen, Minimap, Webmap) the overlay should be active in.
`Overlay`	`setDimension(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension)` Sets dimension.
`Overlay`	`setDisplayOrder(int zIndex)` Any features are displayed on the map in order of their screen displayOrder, with higher values displaying in front of features with lower values.
`Overlay`	`setLabel(java.lang.String label)` Label text to be displayed on the overlay.
`Overlay`	`setMaxZoom(int maxZoom)` Sets the maximum zoom level (UIState.ZOOM_IN_MAX is highest) where the overlay should be visible.
`Overlay`	`setMinZoom(int minZoom)` Sets the minimum zoom level (UIState.FULLSCREEN_ZOOM_MIN is lowest) where the overlay should be visible.
`Overlay`	`setOverlayGroupName(java.lang.String overlayGroupName)` A suggested group or category name used to organize map overlays.
`Overlay`	`setOverlayListener(IOverlayListener overlayListener)` Sets a listener for receiving user events related to the Overlay.
`Overlay`	`setTextProperties(TextProperties textProperties)` Sets the text properties for the overlay.
`Overlay`	`setTitle(java.lang.String title)` Rollover text to be displayed when the mouse is over the overlay.
`protected com.google.common.base.MoreObjects.ToStringHelper`	`toStringHelper(Overlay instance)` Provides common output for toStringHelper() to subclasses

Methods inherited from class journeymap.api.v2.client.display.Displayable
clampOpacity, clampRGB, compareTo, equals, getDisplayType, getGuid, getId, getModId, hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - overlayGroupName
```
protected java.lang.String overlayGroupName
```
  - title
```
protected java.lang.String title
```
  - label
```
protected java.lang.String label
```
  - dimension
```
protected net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension
```
  - minZoom
```
protected int minZoom
```
  - maxZoom
```
protected int maxZoom
```
  - displayOrder
```
protected int displayOrder
```
  - activeUIs
```
protected java.util.Set<Context.UI> activeUIs
```
  - activeMapTypes
```
protected java.util.Set<Context.MapType> activeMapTypes
```
  - textProperties
```
protected TextProperties textProperties
```
  - overlayListener
```
protected IOverlayListener overlayListener
```
  - needsRerender
```
protected boolean needsRerender
```
- Method Detail
  - getDimension
```
public net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> getDimension()
```
    The dimension this overlay should be displayed in.
    
    Returns:
    
    dimension id
  - setDimension
```
public Overlay setDimension(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension)
```
    Sets dimension.
    
    Parameters:
    
    dimension - the dimension
    
    Returns:
    
    this
  - getOverlayGroupName
```
public java.lang.String getOverlayGroupName()
```
    A suggested group or category name used to organize map overlays.
    
    Returns:
    
    the overlay group name
  - setOverlayGroupName
```
public Overlay setOverlayGroupName(java.lang.String overlayGroupName)
```
    A suggested group or category name used to organize map overlays.
    
    Parameters:
    
    overlayGroupName - the overlay group name
    
    Returns:
    
    this
  - getTitle
```
public java.lang.String getTitle()
```
    Rollover text to be displayed when the mouse is over the overlay.
    
    Returns:
    
    the title
  - setTitle
```
public Overlay setTitle(@Nullable
                        java.lang.String title)
```
    Rollover text to be displayed when the mouse is over the overlay.
    
    Parameters:
    
    title - the title
    
    Returns:
    
    this
  - getLabel
```
public java.lang.String getLabel()
```
    Label text to be displayed on the overlay.
    
    Returns:
    
    the label
  - setLabel
```
public Overlay setLabel(@Nullable
                        java.lang.String label)
```
    Label text to be displayed on the overlay.
    
    Parameters:
    
    label - the label
    
    Returns:
    
    this
  - getMinZoom
```
public int getMinZoom()
```
    The minimum zoom level (UIState.FULLSCREEN_ZOOM_MIN is lowest) where the overlay should be visible.
    
    Returns:
    
    the min zoom
  - setMinZoom
```
public Overlay setMinZoom(int minZoom)
```
    Sets the minimum zoom level (UIState.FULLSCREEN_ZOOM_MIN is lowest) where the overlay should be visible.
    
    Parameters:
    
    minZoom - the min zoom
    
    Returns:
    
    this
  - getMaxZoom
```
public int getMaxZoom()
```
    The maximum zoom level (UIState.ZOOM_IN_MAX is highest) where the overlay should be visible.
    
    Returns:
    
    the max zoom
  - setMaxZoom
```
public Overlay setMaxZoom(int maxZoom)
```
    Sets the maximum zoom level (UIState.ZOOM_IN_MAX is highest) where the overlay should be visible.
    
    Parameters:
    
    maxZoom - the max zoom
    
    Returns:
    
    this
  - getDisplayOrder
```
public int getDisplayOrder()
```
    Any features are displayed on the map in order of their screen displayOrder, with higher values displaying in front of features with lower values. Default is 1000.
    
    Specified by:
    
    getDisplayOrder in class Displayable
    
    Returns:
    
    the z index
  - setDisplayOrder
```
public Overlay setDisplayOrder(int zIndex)
```
    Any features are displayed on the map in order of their screen displayOrder, with higher values displaying in front of features with lower values. Default is 1000.
    
    Parameters:
    
    zIndex - the z index
    
    Returns:
    
    this
  - getTextProperties
```
public TextProperties getTextProperties()
```
    Gets the text properties for the overlay.
    
    Returns:
    
    properties
  - setTextProperties
```
public Overlay setTextProperties(TextProperties textProperties)
```
    Sets the text properties for the overlay.
    
    Parameters:
    
    textProperties - properties
    
    Returns:
    
    this
  - getActiveUIs
```
public java.util.Set<Context.UI> getActiveUIs()
```
    Returns a set of enums indicating which JourneyMap UIs (Fullscreen, Minimap, Webmap) the overlay should be active in.
    
    Returns:
    
    enumset
  - setActiveUIs
```
public Overlay setActiveUIs(Context.UI... activeUIs)
```
    Set of enums indicating which JourneyMap UIs (Fullscreen, Minimap, Webmap) the overlay should be active in.
    
    Parameters:
    
    activeUIs - active UIs
    
    Returns:
    
    this
  - getActiveMapTypes
```
public java.util.Set<Context.MapType> getActiveMapTypes()
```
    Returns a set of enums indicating which map types (Day, Night) the overlay should be active in.
    
    Returns:
    
    enumset
  - setActiveMapTypes
```
public Overlay setActiveMapTypes(Context.MapType... activeMapTypes)
```
    Set of enums indicating which JourneyMap map types (Day, Night) the overlay should be active in.
    
    Parameters:
    
    activeMapTypes - active types
    
    Returns:
    
    this
  - isActiveIn
```
public boolean isActiveIn(UIState uiState)
```
    Whether the overlay should be active for the given contexts.
    
    Parameters:
    
    uiState - UIState
    
    Returns:
    
    true if the overlay should be active
  - isInZoomRange
```
public boolean isInZoomRange(UIState uiState)
```
    Whether the zoom of the given context is within the zoom range of the overlay.
    
    Parameters:
    
    uiState - UIState
    
    Returns:
    
    true if the zoom of uiState is within the zoom range of the overlay
  - getOverlayListener
```
public IOverlayListener getOverlayListener()
```
    Gets the listener for user events on the overlay.
    
    Returns:
    
    listener impl or null
  - setOverlayListener
```
public Overlay setOverlayListener(@Nullable
                                  IOverlayListener overlayListener)
```
    Sets a listener for receiving user events related to the Overlay.
    
    Parameters:
    
    overlayListener - IOverlayListener impl
    
    Returns:
    
    this
  - flagForRerender
```
public void flagForRerender()
```
    Indicate the overlay needs to be re-rendered. Typically you don't need to use this unless you are updating an overlay dynamically and the chances aren't shown until the map is panned or zoomed. For example within and IOverlayListener. Overusing this can cause performance problems.
  - clearFlagForRerender
```
public void clearFlagForRerender()
```
    Used by JourneyMap after the overlay has been re-rendered.
  - getNeedsRerender
```
public boolean getNeedsRerender()
```
    Gets whether the overlay needs to be re-rendered.
    
    Returns:
    
    true if rerender needed
  - toStringHelper
```
protected final com.google.common.base.MoreObjects.ToStringHelper toStringHelper(Overlay instance)
```
    Provides common output for toStringHelper() to subclasses
    
    Parameters:
    
    instance - subclass
    
    Returns:
    
    helper for continuing to add properties on subclass

Class Overlay

Field Summary

Fields inherited from class journeymap.api.v2.client.display.Displayable

Method Summary

Methods inherited from class journeymap.api.v2.client.display.Displayable

Methods inherited from class java.lang.Object

Field Detail

overlayGroupName

title

label

dimension

minZoom

maxZoom

displayOrder

activeUIs

activeMapTypes

textProperties

overlayListener

needsRerender

Method Detail

getDimension

setDimension

getOverlayGroupName

setOverlayGroupName

getTitle

setTitle

getLabel

setLabel

getMinZoom

setMinZoom

getMaxZoom

setMaxZoom

getDisplayOrder

setDisplayOrder

getTextProperties

setTextProperties

getActiveUIs

setActiveUIs

getActiveMapTypes

setActiveMapTypes

isActiveIn

isInZoomRange

getOverlayListener

setOverlayListener

flagForRerender

clearFlagForRerender

getNeedsRerender

toStringHelper