net.maritimecloud.util.geometry

Class Ellipse

java.lang.Object

net.maritimecloud.util.geometry.Area

net.maritimecloud.util.geometry.Ellipse

All Implemented Interfaces:

Serializable, Message

public final class Ellipse
extends Area

This class holds the defining parameters for en ellipse. The location of the ellipse can optionally be offset from the geodetic reference point by dx, dy meters.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static MessageSerializer<Ellipse>	SERIALIZER

Constructor Summary

Constructors

Constructor and Description
Ellipse(Position geodeticReference, double alpha, double beta, double thetaDeg) Create an ellipse with center in the geodetic reference point.
Ellipse(Position geodeticReference, double dx, double dy, double alpha, double beta, double thetaDeg) Create an ellipse offset dx, dy meters from the geodetic reference point.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Position position)
double	getAlpha()
double	getBeta()
Rectangle	getBoundingBox() Returns a bounding box of the area.
Position	getGeodeticReference()
double	getMajorAxisGeodeticHeading()
Position	getRandomPosition(Random random) Returns a random position within the area using a specified random source.
double	getThetaDeg()
double	getX()
double	getY()
Ellipse	immutable() Returns an immutable copy of this message.
boolean	intersects(Area other)
boolean	intersects(Ellipse otherEllipse) Returns true if two safety zones intersect.
List<Position>	samplePerimeter(int n) Sample the perimeter along the ellipse in 'n' points, and return a list of positions all located and evenly distributed on the perimeter.
String	toString()

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

Field Detail

SERIALIZER

public static final MessageSerializer<Ellipse> SERIALIZER

Constructor Detail

Ellipse

public Ellipse(Position geodeticReference,
               double alpha,
               double beta,
               double thetaDeg)

Create an ellipse with center in the geodetic reference point.

Parameters:

geodeticReference - The center point of the ellipse

alpha - Length of half axis in direction theta (in meters)

beta - Length of half axis in direction orthogonal to theta (in meters)

thetaDeg - Direction of half axis alpha measured in degrees; 0 degrees is parallel with the increasing direction of the cartesian X axis.

Ellipse

public Ellipse(Position geodeticReference,
               double dx,
               double dy,
               double alpha,
               double beta,
               double thetaDeg)

Create an ellipse offset dx, dy meters from the geodetic reference point.

Parameters:

geodeticReference - The position, from which the center of the ellipse is offset by (dx, dy) meters.

dx - dx

dy - dy

alpha - Length of half axis in direction theta (in meters)

beta - Length of half axis in direction orthogonal to theta (in meters)

thetaDeg - Direction of half axis alpha measured in degrees; 0 degrees is parallel with the increasing direction of the cartesian X axis.

Method Detail

contains

public boolean contains(Position position)

Specified by:

contains in class Area

getAlpha

public double getAlpha()

getBeta

public double getBeta()

getBoundingBox

public Rectangle getBoundingBox()

Returns a bounding box of the area.

Specified by:

getBoundingBox in class Area

Returns:

a bounding box of the area

getGeodeticReference

public Position getGeodeticReference()

getMajorAxisGeodeticHeading

public double getMajorAxisGeodeticHeading()

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

getThetaDeg

public double getThetaDeg()

getX

public double getX()

getY

public double getY()

immutable

public Ellipse immutable()

Returns an immutable copy of this message.

Returns:

an immutable copy of this message

intersects

public boolean intersects(Area other)

Specified by:

intersects in class Area

intersects

public boolean intersects(Ellipse otherEllipse)

Returns true if two safety zones intersect.

Parameters:

otherEllipse - the other safety zone.

Returns:

whether or not the two elipses intersect

samplePerimeter

public List<Position> samplePerimeter(int n)

Sample the perimeter along the ellipse in 'n' points, and return a list of positions all located and evenly distributed on the perimeter. This is useful e.g. to draw the perimeter on a chart using geodetic coordinates.

Parameters:

n - the number of perimeter samples to return.

Returns:

a list of positions on the perimeter.

toString

public String toString()

Overrides:

toString in class Object