Circle (MaritimeCloud API)

java.lang.Object
- net.maritimecloud.util.geometry.Area
- - net.maritimecloud.util.geometry.Circle

All Implemented Interfaces:

Serializable, Message
```
public class Circle
extends Area
```
A circle

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static MessageSerializer<Circle> SERIALIZER

Fields
Modifier and Type	Field and Description
`static MessageSerializer<Circle>`	`SERIALIZER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(Circle c)`
`boolean`	`contains(Position position)`
`static Circle`	`create(double latitude, double longitude, double radius)`
`static Circle`	`create(Position center, double radius)` Creates a new circle with the specified center and radius.
`boolean`	`equals(Circle other)`
`boolean`	`equals(Object other)` Equals method
`static Circle`	`fromJSON(CharSequence string)` Creates a message of this type from a JSON.
`double`	`geodesicDistanceTo(Position other)`
`Rectangle`	`getBoundingBox()` Returns a bounding box of the area.
`Position`	`getCenter()` Return the center of the circle.
`double`	`getRadius()` Returns the radius of the circle.
`Position`	`getRandomPosition(Random r)` Returns a random position within the area using a specified random source.
`int`	`hashCode()`
`Circle`	`immutable()` Returns an immutable copy of this message.
`boolean`	`intersects(Area other)`
`boolean`	`intersects(Circle other)`
`boolean`	`intersects(Line line)`
`boolean`	`intersects(Rectangle other)`
`static Circle`	`random()` Returns a random valid circle.
`static Circle`	`random(Random rnd)` Returns a random valid circle.
`double`	`rhumbLineDistanceTo(Position position)`
`String`	`toString()`
`Circle`	`withCenter(Position center)` Returns a new circle with the same radius as this circle but with the new position as the center
`Circle`	`withRadius(double radius)` Returns a new circle with the same center as this circle but with the new radius.

Methods inherited from class net.maritimecloud.util.geometry.Area
contains, getRandomPosition, toJSON, unionOf, unionWith

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZER
```
public static final MessageSerializer<Circle> SERIALIZER
```
- Method Detail
  - contains
```
public boolean contains(Circle c)
```
  - contains
```
public boolean contains(Position position)
```
    Specified by:
    
    contains in class Area
  - equals
```
public boolean equals(Circle other)
```
  - equals
```
public boolean equals(Object other)
```
    Equals method
    
    Overrides:
    
    equals in class Object
  - geodesicDistanceTo
```
public double geodesicDistanceTo(Position other)
```
  - getBoundingBox
```
public Rectangle getBoundingBox()
```
    Returns a bounding box of the area.
    
    Specified by:
    
    getBoundingBox in class Area
    
    Returns:
    
    a bounding box of the area
  - getCenter
```
public Position getCenter()
```
    Return the center of the circle.
    
    Returns:
    
    the center of the circle
  - getRadius
```
public double getRadius()
```
    Returns the radius of the circle.
    
    Returns:
    
    the radius of the circle
  - getRandomPosition
```
public Position getRandomPosition(Random r)
```
    Returns a random position within the area using a specified random source.
    
    Specified by:
    
    getRandomPosition in class Area
    
    Parameters:
    
    r - the random source
    
    Returns:
    
    a random position within the area
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - immutable
```
public Circle 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(Circle other)
```
  - intersects
```
public boolean intersects(Line line)
```
  - intersects
```
public boolean intersects(Rectangle other)
```
  - rhumbLineDistanceTo
```
public double rhumbLineDistanceTo(Position position)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - withCenter
```
public Circle withCenter(Position center)
```
    Returns a new circle with the same radius as this circle but with the new position as the center
    
    Parameters:
    
    center - the new center of the circle
    
    Returns:
    
    a new circle
  - withRadius
```
public Circle withRadius(double radius)
```
    Returns a new circle with the same center as this circle but with the new radius.
    
    Parameters:
    
    radius - the new radius of the circle
    
    Returns:
    
    a new circle
  - create
```
public static Circle create(double latitude,
                            double longitude,
                            double radius)
```
  - create
```
public static Circle create(Position center,
                            double radius)
```
    Creates a new circle with the specified center and radius.
    
    Parameters:
    
    center - the center of the circle
    
    radius - the radius in meters of the circle
    
    Returns:
    
    the new circle
    
    Throws:
    
    NullPointerException - if the specified center is null
    
    IllegalArgumentException - if the specified is not a positive number
  - fromJSON
```
public static Circle 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.
    
    Parameters:
    
    string - the JSON string to parse
    
    Returns:
    
    the parsed area
  - random
```
public static Circle random()
```
    Returns a random valid circle.
    
    Returns:
    
    the random circle
  - random
```
public static Circle random(Random rnd)
```
    Returns a random valid circle.
    
    Parameters:
    
    rnd - the source of randomness
    
    Returns:
    
    the random circle

Class Circle

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

SERIALIZER

Method Detail

contains

contains

equals

equals

geodesicDistanceTo

getBoundingBox

getCenter

getRadius

getRandomPosition

hashCode

immutable

intersects

intersects

intersects

intersects

rhumbLineDistanceTo

toString

withCenter

withRadius

create

create

fromJSON

random

random