journeymap.api.v2.client.model

Class MapPolygon

java.lang.Object

journeymap.api.v2.client.model.MapPolygon

public final class MapPolygon
extends java.lang.Object

A MapPolygon is a sequence of at least 3 BlockPos. The first point must be the LOWER-LEFT (or SouthEast) point in the sequence, and should be ordered counterclockwise. The last point will be connected to the first when rendered.

Note that the actual list passed into the constructor isn't retained; the points are copied into an unmodifiable list. If you need to update the points, pass in a new list entirely.

Setters use the Builder pattern so they can be chained.

Constructor Summary

Constructors

Constructor and Description
MapPolygon(net.minecraft.core.BlockPos... points) Constructor.
MapPolygon(java.util.List<net.minecraft.core.BlockPos> points) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<net.minecraft.core.BlockPos>	getPoints() Gets an unmodifiable list of the points.
java.util.Iterator<net.minecraft.core.BlockPos>	iterator() Iterates the points.
MapPolygon	setPoints(java.util.List<net.minecraft.core.BlockPos> points)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MapPolygon

public MapPolygon(net.minecraft.core.BlockPos... points)

Constructor.

Parameters:

points - See class description for details on ordering.

Throws:

java.lang.IllegalArgumentException - if conditions for a proper polygon aren't met.

MapPolygon

public MapPolygon(java.util.List<net.minecraft.core.BlockPos> points)

Constructor.

Parameters:

points - See class description for details on ordering.

Throws:

java.lang.IllegalArgumentException - if conditions for a proper polygon aren't met.

Method Detail

getPoints

public java.util.List<net.minecraft.core.BlockPos> getPoints()

Gets an unmodifiable list of the points.

Returns:

points

setPoints

public MapPolygon setPoints(java.util.List<net.minecraft.core.BlockPos> points)

iterator

public java.util.Iterator<net.minecraft.core.BlockPos> iterator()

Iterates the points.

Returns:

iterator

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object