journeymap.api.v2.client.display

Class PolygonOverlay

java.lang.Object

journeymap.api.v2.client.display.Displayable

journeymap.api.v2.client.display.Overlay

journeymap.api.v2.client.display.PolygonOverlay

All Implemented Interfaces:

java.lang.Comparable<Displayable>

@ParametersAreNonnullByDefault
public final class PolygonOverlay
extends Overlay

A polygon overlay displays a geometric area on a map. For example: An area of claimed chunks.

Setters use the Builder pattern so they can be chained.

Note that like all Displayables, simply changing this object doesn't guarantee the player will get the changes. You must call IClientAPI.show(Displayable) in order for the changes to take effect in JourneyMap.

Field Summary

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

activeMapTypes, activeUIs, dimension, displayOrder, label, maxZoom, minZoom, needsRerender, overlayGroupName, overlayListener, textProperties, title

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

displayType, id, modId

Constructor Summary

Constructors

Constructor and Description
PolygonOverlay(java.lang.String modId, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, ShapeProperties shapeProperties, MapPolygon outerArea) Constructor.
PolygonOverlay(java.lang.String modId, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, ShapeProperties shapeProperties, MapPolygon outerArea, java.util.List<MapPolygon> holes) Constructor.
PolygonOverlay(java.lang.String modId, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, ShapeProperties shapeProperties, MapPolygonWithHoles polygon) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<MapPolygon>	getHoles() (optional) A list of polygons treated as holes inside the outerArea
MapPolygon	getOuterArea() A polygon of the outer area to be displayed.
ShapeProperties	getShapeProperties() Gets the shape properties used to display the polygons.
PolygonOverlay	setHoles(java.util.List<MapPolygon> holes) Sets a list of polygons treated as holes inside the outerArea
PolygonOverlay	setOuterArea(MapPolygon outerArea) Sets the polygon of the outer area to be displayed.
PolygonOverlay	setPolygonWithHoles(MapPolygonWithHoles polygon) Sets the outer area and holes in one go.
PolygonOverlay	setShapeProperties(ShapeProperties shapeProperties) Sets the shape properties used to display the polygons.
java.lang.String	toString()

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

clearFlagForRerender, flagForRerender, getActiveMapTypes, getActiveUIs, getDimension, getDisplayOrder, getLabel, getMaxZoom, getMinZoom, getNeedsRerender, getOverlayGroupName, getOverlayListener, getTextProperties, getTitle, isActiveIn, isInZoomRange, setActiveMapTypes, setActiveUIs, setDimension, setDisplayOrder, setLabel, setMaxZoom, setMinZoom, setOverlayGroupName, setOverlayListener, setTextProperties, setTitle, toStringHelper

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, wait, wait, wait

Constructor Detail

PolygonOverlay

public PolygonOverlay(java.lang.String modId,
                      net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
                      ShapeProperties shapeProperties,
                      MapPolygon outerArea)

Constructor.

Parameters:

modId - Your mod id.

outerArea - A polygon of the outer area to be displayed.

PolygonOverlay

public PolygonOverlay(java.lang.String modId,
                      net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
                      ShapeProperties shapeProperties,
                      MapPolygonWithHoles polygon)

Constructor.

Parameters:

modId - Your mod id.

polygon - A polygon of the outer area with holes to be displayed.

PolygonOverlay

public PolygonOverlay(java.lang.String modId,
                      net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
                      ShapeProperties shapeProperties,
                      MapPolygon outerArea,
                      @Nullable
                      java.util.List<MapPolygon> holes)

Constructor.

Parameters:

modId - Your mod id.

outerArea - A polygon of the outer area to be displayed.

holes - (Optional) A list of polygons treated as holes inside the outerArea

Method Detail

getOuterArea

public MapPolygon getOuterArea()

A polygon of the outer area to be displayed.

Returns:

the outer area

setOuterArea

public PolygonOverlay setOuterArea(MapPolygon outerArea)

Sets the polygon of the outer area to be displayed.

Parameters:

outerArea - polygon

Returns:

this

getHoles

public java.util.List<MapPolygon> getHoles()

(optional) A list of polygons treated as holes inside the outerArea

Returns:

null if none specified

setHoles

public PolygonOverlay setHoles(@Nullable
                               java.util.List<MapPolygon> holes)

Sets a list of polygons treated as holes inside the outerArea

Parameters:

holes - polygons

Returns:

this

setPolygonWithHoles

public PolygonOverlay setPolygonWithHoles(MapPolygonWithHoles polygon)

Sets the outer area and holes in one go.

getShapeProperties

public ShapeProperties getShapeProperties()

Gets the shape properties used to display the polygons.

Returns:

properties

setShapeProperties

public PolygonOverlay setShapeProperties(ShapeProperties shapeProperties)

Sets the shape properties used to display the polygons.

Parameters:

shapeProperties - properties

Returns:

this

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object