001 package com.google.gwt.maps.client.services;
002
003 import com.google.gwt.core.client.JavaScriptObject;
004 import com.google.gwt.core.client.JsArray;
005 import com.google.gwt.maps.client.base.LatLng;
006
007 /**
008 * An elevation query sent by the ElevationService containing the path along which to return sampled data. This request defines a continuous path along the earth along which elevation samples should be taken at evenly-spaced distances. All paths from vertex to vertex use segments of the great circle between those two points.
009 * <br><br>
010 * See <a href="https://developers.google.com/maps/documentation/javascript/reference#PathElevationRequest">PathElevationRequest API Doc</a>
011 */
012 public class PathElevationRequest extends JavaScriptObject {
013
014 /**
015 * use newInstance();
016 */
017 protected PathElevationRequest() {}
018
019 /**
020 * An elevation query sent by the ElevationService containing the path along which to return sampled data. This request defines a continuous path along the earth along which elevation samples should be taken at evenly-spaced distances. All paths from vertex to vertex use segments of the great circle between those two points.
021 */
022 public final static PathElevationRequest newInstance() {
023 return JavaScriptObject.createObject().cast();
024 }
025
026 /**
027 * The path along which to collect elevation values.
028 * @param path
029 */
030 public final native void setPath(JsArray<LatLng> path) /*-{
031 this.path = path;
032 }-*/;
033
034 /**
035 * The path along which to collect elevation values.
036 */
037 public final native JsArray<LatLng> getPath() /*-{
038 return this.path;
039 }-*/;
040
041 /**
042 * Required. The number of equidistant points along the given path for which to retrieve elevation data, including the endpoints. The number of samples must be a value between 2 and 1024.
043 * @param samples
044 */
045 public final native void setSamples(int samples) /*-{
046 this.samples = samples;
047 }-*/;
048
049 /**
050 * Required. The number of equidistant points along the given path for which to retrieve elevation data, including the endpoints. The number of samples must be a value between 2 and 1024.
051 */
052 public final native int getSamples() /*-{
053 return this.samples;
054 }-*/;
055
056 }