net.maritimecloud.util.geometry

Class Polygon

java.lang.Object

net.maritimecloud.util.geometry.Area

net.maritimecloud.util.geometry.Polygon

All Implemented Interfaces:

Serializable, Iterable<Position>, Message

public class Polygon
extends Area
implements Iterable<Position>

A polygon consisting of multiple points.

Author:

Kasper Nielsen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static MessageSerializer<Polygon>	SERIALIZER The serializer of the polygon.

Constructor Summary

Constructors

Constructor and Description
Polygon(Position... positions)

Method Summary

Modifier and Type	Method and Description
boolean	contains(Position position)
static Polygon	create(Position... positions)
Rectangle	getBoundingBox() Returns a bounding box of the area.
List<Position>	getPoints()
Position	getRandomPosition(Random random) Returns a random position within the area using a specified random source.
Polygon	immutable() Returns an immutable copy of this message.
boolean	intersects(Area other)
Iterator<Position>	iterator()

Methods inherited from class net.maritimecloud.util.geometry.Area

contains, fromJSON, getRandomPosition, toJSON, unionOf, unionWith

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

SERIALIZER

public static final MessageSerializer<Polygon> SERIALIZER

The serializer of the polygon.

Constructor Detail

Polygon

public Polygon(Position... positions)

Method Detail

contains

public boolean contains(Position position)

Specified by:

contains in class Area

getBoundingBox

public Rectangle getBoundingBox()

Returns a bounding box of the area.

Specified by:

getBoundingBox in class Area

Returns:

a bounding box of the area

getRandomPosition

public Position getRandomPosition(Random random)

Returns a random position within the area using a specified random source.

Specified by:

getRandomPosition in class Area

Parameters:

random - the random source

Returns:

a random position within the area

immutable

public Polygon immutable()

Returns an immutable copy of this message.

Specified by:

immutable in interface Message

Returns:

an immutable copy of this message

intersects

public boolean intersects(Area other)

Specified by:

intersects in class Area

create

public static Polygon create(Position... positions)

getPoints

public List<Position> getPoints()

iterator

public Iterator<Position> iterator()

Specified by:

iterator in interface Iterable<Position>