Package xyz.jpenilla.squaremap.api.marker

Class MultiPolygon

java.lang.Object

xyz.jpenilla.squaremap.api.marker.Marker

xyz.jpenilla.squaremap.api.marker.MultiPolygon

public final class MultiPolygon
extends Marker

MultiPolygon marker, used to display multiple polygons while treating them as a single marker

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MultiPolygon.MultiPolygonPart	MultiPolygonPart is a class to represent sub polygons of MultiPolygons

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
int	hashCode()
static @NonNull MultiPolygon.MultiPolygonPart	part(@NonNull List<Point> points, @NonNull List<List<Point>> negativeSpace)	Create a new MultiPolygon.MultiPolygonPart from a list of points, and a secondary list polygons that make up the negative space
static @NonNull MultiPolygon.MultiPolygonPart	part(@NonNull List<Point> points, @NonNull List<Point> @NonNull ... negativeSpace)	Create a new MultiPolygon.MultiPolygonPart from a list of points, and a secondary list polygons that make up the negative space
static @NonNull MultiPolygon.MultiPolygonPart	part(@NonNull Point @NonNull ... points)	Create a new MultiPolygon.MultiPolygonPart from a list of points
@NonNull List<MultiPolygon.MultiPolygonPart>	subPolygons()	Get the mutable list of the sub polygons which make up this MultiPolygon
void	subPolygons(@NonNull List<MultiPolygon.MultiPolygonPart> subPolygons)	Set a new list of sub polygons.
void	subPolygons(@NonNull MultiPolygon.MultiPolygonPart @NonNull ... subPolygons)	Set a new list of sub polygons.

Methods inherited from class xyz.jpenilla.squaremap.api.marker.Marker

circle, ellipse, icon, icon, icon, markerOptions, markerOptions, markerOptions, markerOptionsMatch, multiPolygon, multiPolygon, multiPolyline, multiPolyline, polygon, polygon, polygon, polygon, polyline, polyline, rectangle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

part

public static @NonNull MultiPolygon.MultiPolygonPart part(@NonNull Point @NonNull ... points)

Create a new MultiPolygon.MultiPolygonPart from a list of points

Parameters:

points - points

Returns:

new part

part

@SafeVarargs
public static @NonNull MultiPolygon.MultiPolygonPart part(@NonNull List<Point> points,
 @NonNull List<Point> @NonNull ... negativeSpace)

Create a new MultiPolygon.MultiPolygonPart from a list of points, and a secondary list polygons that make up the negative space

Parameters:

points - points

negativeSpace - negative space

Returns:

new part

part

public static @NonNull MultiPolygon.MultiPolygonPart part(@NonNull List<Point> points,
 @NonNull List<List<Point>> negativeSpace)

Create a new MultiPolygon.MultiPolygonPart from a list of points, and a secondary list polygons that make up the negative space

Parameters:

points - points

negativeSpace - negative space

Returns:

new part

subPolygons

public @NonNull List<MultiPolygon.MultiPolygonPart> subPolygons()

Get the mutable list of the sub polygons which make up this MultiPolygon

Returns:

sub polygons

subPolygons

public void subPolygons(@NonNull List<MultiPolygon.MultiPolygonPart> subPolygons)

Set a new list of sub polygons. Will remove existing sub polygons.

Parameters:

subPolygons - new sub polygons

subPolygons

public void subPolygons(@NonNull MultiPolygon.MultiPolygonPart @NonNull ... subPolygons)

Set a new list of sub polygons. Will remove existing sub polygons.

Parameters:

subPolygons - new sub polygons

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object