net.maritimecloud.util.geometry

Class Area

java.lang.Object

net.maritimecloud.util.geometry.Area

All Implemented Interfaces:

Serializable, Message

Direct Known Subclasses:

Circle, Ellipse, Polygon, Rectangle

public abstract class Area
extends Object
implements Message, Serializable

A shape has an area

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static MessageSerializer<Area>	SERIALIZER A parser of areas.

Constructor Summary

Constructors

Constructor and Description
Area()

Method Summary

Modifier and Type	Method and Description
boolean	contains(Area area) Returns true if the specified element is fully contained in the shape, otherwise false.
abstract boolean	contains(Position position)
static Area	fromJSON(CharSequence string) Creates a message of this type from a JSON throwing a runtime exception if the format of the message does not match a valid area.
abstract Rectangle	getBoundingBox() Returns a bounding box of the area.
Position	getRandomPosition() Returns a random position within the area.
abstract Position	getRandomPosition(Random random) Returns a random position within the area using a specified random source.
abstract boolean	intersects(Area other)
String	toJSON() Returns a JSON representation of this message
static Area	unionOf(Area... areas)
Area	unionWith(Area other) Returns a union of this area with the specified area.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.maritimecloud.message.Message

immutable

Field Detail

SERIALIZER

public static final MessageSerializer<Area> SERIALIZER

A parser of areas.

Constructor Detail

Area

public Area()

Method Detail

contains

public boolean contains(Area area)

Returns true if the specified element is fully contained in the shape, otherwise false.

Parameters:

area - the area to test

Returns:

true if the specified element is fully contained in the shape, otherwise false

contains

public abstract boolean contains(Position position)

getBoundingBox

public abstract Rectangle getBoundingBox()

Returns a bounding box of the area.

Returns:

a bounding box of the area

getRandomPosition

public final Position getRandomPosition()

Returns a random position within the area.

Returns:

a random position within the area

getRandomPosition

public abstract Position getRandomPosition(Random random)

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

Parameters:

random - the random source

Returns:

a random position within the area

intersects

public abstract boolean intersects(Area other)

toJSON

public String toJSON()

Returns a JSON representation of this message

Specified by:

toJSON in interface Message

Returns:

a JSON representation of this message

unionWith

public final Area unionWith(Area other)

Returns a union of this area with the specified area.

Parameters:

other - the area to join with this area.

Returns:

the joined area

fromJSON

public static Area fromJSON(CharSequence string)

Creates a message of this type from a JSON throwing a runtime exception if the format of the message does not match a valid area.

Parameters:

string - the JSON string to parse

Returns:

the parsed area

unionOf

public static Area unionOf(Area... areas)