com.google.gwt.maps.client.geometrylib.SphericalUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-maps-api Show documentation
There is a newer version: 3.10.0-alpha-7
package com.google.gwt.maps.client.geometrylib;

/*
 * #%L
 * GWT Maps API V3 - Core API
 * %%
 * Copyright (C) 2011 - 2012 GWT Maps API V3
 * %%
 * 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.
 * #L%
 */

import com.google.gwt.core.client.JsArray;
import com.google.gwt.maps.client.base.LatLng;
import com.google.gwt.maps.client.mvc.MVCArray;

/**
 * Utility functions for computing geodesic angles, distances and areas.

 * The default radius is Earth's radius of 6378137 meters.

 * 

 * See Encoding Utils API
 * Doc
 */
public class SphericalUtils {

  /**
   * Computes the area of the given loop. Loops must be closed.
   * 
   * @param loop
   */
  public static final native double computeArea(JsArray loop) /*-{
    return $wnd.google.maps.geometry.spherical.computeArea(loop);
  }-*/;

  /**
   * Computes the area of the given loop. Loops must be closed.
   * 
   * @param loop
   */
  public static final native double computeArea(MVCArray loop) /*-{
    return $wnd.google.maps.geometry.spherical.computeArea(loop);
  }-*/;

  /**
   * Computes the area of the given loop. Loops must be closed.
   * 
   * @param loop
   * @param radius
   */
  public static final native double computeArea(JsArray loop, int radius) /*-{
    return $wnd.google.maps.geometry.spherical.computeArea(loop, radius);
  }-*/;

  /**
   * Computes the area of the given loop. Loops must be closed.
   * 
   * @param loop
   * @param radius
   */
  public static final native double computeArea(MVCArray loop, int radius) /*-{
    return $wnd.google.maps.geometry.spherical.computeArea(loop, radius);
  }-*/;

  /**
   * Computes the distance between two LatLngs.
   * 
   * @param from
   * @param to
   */
  public static final native double computeDistanceBetween(LatLng from, LatLng to) /*-{
    return $wnd.google.maps.geometry.spherical.computeDistanceBetween(from, to);
  }-*/;

  /**
   * Computes the distance between two LatLngs.
   * 
   * @param from
   * @param to
   * @param radius
   */
  public static final native double computeDistanceBetween(LatLng from, LatLng to, int radius) /*-{
    return $wnd.google.maps.geometry.spherical.computeDistanceBetween(from, to,
        radius);
  }-*/;

  /**
   * Computes the heading from one LatLng to another LatLng.
   * 
   * @param from
   * @param to
   */
  public static final native double computeHeading(LatLng from, LatLng to) /*-{
    return $wnd.google.maps.geometry.spherical.computeHeading(from, to);
  }-*/;

  /**
   * Computes the length of the given path.
   * 
   * @param path
   */
  public static final native double computeLength(JsArray path) /*-{
    return $wnd.google.maps.geometry.spherical.computeLength(path);
  }-*/;

  /**
   * Computes the length of the given path.
   * 
   * @param path
   */
  public static final native double computeLength(MVCArray path) /*-{
    return $wnd.google.maps.geometry.spherical.computeLength(path);
  }-*/;

  /**
   * Computes the length of the given path.
   * 
   * @param path
   * @param radius
   */
  public static final native double computeLength(JsArray path, int radius) /*-{
    return $wnd.google.maps.geometry.spherical.computeLength(path, radius);
  }-*/;

  /**
   * Computes the length of the given path.
   * 
   * @param path
   * @param radius
   */
  public static final native double computeLength(MVCArray path, int radius) /*-{
    return $wnd.google.maps.geometry.spherical.computeLength(path, radius);
  }-*/;

  /**
   * Computes the LatLng produced by starting from a given LatLng and heading a given distance.
   * 
   * @param from
   * @param distance
   * @param heading
   */
  public static final native LatLng computeOffset(LatLng from, int distance, int heading) /*-{
    return $wnd.google.maps.geometry.spherical.computeOffset(from, distance,
        heading);
  }-*/;

  /**
   * Computes the LatLng produced by starting from a given LatLng and heading a given distance.
   * 
   * @param from
   * @param distance
   * @param heading
   * @param radius
   */
  public static final native LatLng computeOffset(LatLng from, int distance, int heading, int radius) /*-{
    return $wnd.google.maps.geometry.spherical.computeOffset(from, distance,
        heading, radius);
  }-*/;

  /**
   * Computes the signed area of the given loop. Loops must be closed. The signed area may be used to determine the
   * orientation of a loop.
   * 
   * @param loop
   */
  public static final native double computeSignedArea(JsArray loop) /*-{
    return $wnd.google.maps.geometry.spherical.computeSignedArea(loop);
  }-*/;

  /**
   * Computes the signed area of the given loop. Loops must be closed. The signed area may be used to determine the
   * orientation of a loop.
   * 
   * @param loop
   */
  public static final native double computeSignedArea(MVCArray loop) /*-{
    return $wnd.google.maps.geometry.spherical.computeSignedArea(loop);
  }-*/;

  /**
   * Computes the signed area of the given loop. Loops must be closed. The signed area may be used to determine the
   * orientation of a loop.
   * 
   * @param loop
   * @param radius
   */
  public static final native double computeSignedArea(JsArray loop, int radius) /*-{
    return $wnd.google.maps.geometry.spherical.computeSignedArea(loop, radius);
  }-*/;

  /**
   * Computes the signed area of the given loop. Loops must be closed. The signed area may be used to determine the
   * orientation of a loop.
   * 
   * @param loop
   * @param radius
   */
  public static final native double computeSignedArea(MVCArray loop, int radius) /*-{
    return $wnd.google.maps.geometry.spherical.computeSignedArea(loop, radius);
  }-*/;

  /**
   * Travels a fraction of the way from one LatLng to another LatLng.
   * 
   * @param from
   * @param to
   * @param fraction
   */
  public static final native LatLng interpolate(LatLng from, LatLng to, double fraction) /*-{
    return $wnd.google.maps.geometry.spherical.interpolate(from, to, fraction);
  }-*/;

}