grails.mongodb.geo.Circle.groovy Maven / Gradle / Ivy

Go to download
/* Copyright (C) 2014 SpringSource
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package grails.mongodb.geo

import groovy.transform.CompileStatic
import groovy.transform.EqualsAndHashCode
import org.springframework.util.Assert

/**
 * Represents a circle with the radius specified in the unit of the coordinate system
 *
 * @author Graeme Rocher
 * @since 2.0
 */
@EqualsAndHashCode
@CompileStatic
class Circle extends Shape{
    /**
     * The center of the circle
     */
    final Point center
    /**
     * The radius of the circle
     */
    final double radius

    /**
     * Construct a circle for the given center {@link Point} and radius
     * @param center The center {@link Point}
     * @param radius The radius in meters
     */
    Circle(Point center, double radius) {
        Assert.notNull(center, "Argument center cannot be null")
        this.center = center
        this.radius = radius
    }

    /**
     * @return The circle as a coordinate list
     */
    List