Sphere (GORM for MongoDB - 6.1.2.RELEASE)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

grails.mongodb.geo.Sphere

Represents a Sphere with the radius calculated in radians
Authors:
Graeme Rocher
Since:
2.0

Properties Summary

Properties
Type	Name and description
`Point`	`center` The center of there sphere
`Distance`	`distance` The distance used to calculate the radius in radians

Constructor Summary

Constructors
Constructor and description
`Sphere (Point center, Distance distance)` Construct a circle for the given center Point and distance

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.List<? extends java.lang.Object>`	`asList()` The sphere coordinate list with the radius in radians
	`static Sphere`	`valueOf(java.util.List coords, Metric metric = Metric.NEUTRAL)` Constructs a Sphere for the given coordinate list and optional metric

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Shape`	`asList`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - final Point center
    
    The center of there sphere
  - final Distance distance
    
    The distance used to calculate the radius in radians
- Constructor Detail
  - Sphere(Point center, Distance distance)
    
    Construct a circle for the given center Point and distance
    Parameters:
    center - The center Point
    distance - The distance
- Method Detail
  - @java.lang.Override java.util.List<? extends java.lang.Object> asList()
    
    The sphere coordinate list with the radius in radians
    Returns:
    A coordinate list
  - static Sphere valueOf(java.util.List coords, Metric metric = Metric.NEUTRAL)
    
    Constructs a Sphere for the given coordinate list and optional metric
    Returns:
    A Sphere
    Parameters:
    coords - The coordinate list
    metric - The metric to use to calculate radians (defaults to Metric.NEUTRAL

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method