MapFactory.java

Go to the documentation of this file.

// -*- mode: java; c-basic-offset: 2; -*-
// Copyright 2016-2017 MIT, All rights reserved
// Released under the Apache License, Version 2.0
// http://www.apache.org/licenses/LICENSE-2.0
 
package com.google.appinventor.components.runtime.util;
 
import java.util.Iterator;
import java.util.List;
 
import com.google.appinventor.components.runtime.Component;
import com.google.appinventor.components.runtime.ComponentContainer;
import com.google.appinventor.components.runtime.Form;
import com.google.appinventor.components.runtime.LocationSensor;
import com.google.appinventor.components.runtime.Map;
import org.locationtech.jts.geom.Geometry;
import org.osmdroid.api.IGeoPoint;
import org.osmdroid.util.GeoPoint;
import org.osmdroid.util.BoundingBox;
 
import android.os.Build;
import android.view.View;
 
public final class MapFactory {
  public interface MapEventListener {
    // Map events
    void onReady(MapController map);
 
    void onBoundsChanged();
 
    void onZoom();
 
    void onSingleTap(double latitude, double longitude);
 
    void onDoubleTap(double latitude, double longitude);
 
    void onLongPress(double latitude, double longitude);
 
    // Feature events
    void onFeatureClick(MapFeature feature);
 
    void onFeatureLongPress(MapFeature feature);
 
    void onFeatureStartDrag(MapFeature feature);
 
    void onFeatureDrag(MapFeature feature);
 
    void onFeatureStopDrag(MapFeature feature);
  }
 
  public interface MapController {
    View getView();
 
    double getLatitude();
 
    double getLongitude();
 
    void setCenter(double latitude, double longitude);
 
    void setZoom(int zoom);
 
    int getZoom();
 
    MapType getMapType();
 
    void setMapType(MapType type);
 
    void setCompassEnabled(boolean enable);
 
    boolean isCompassEnabled();
 
    void setZoomEnabled(boolean enable);
 
    boolean isZoomEnabled();
 
    void setZoomControlEnabled(boolean enable);
 
    boolean isZoomControlEnabled();
 
    void setShowUserEnabled(boolean enable);
 
    boolean isShowUserEnabled();
 
    void setRotationEnabled(boolean enable);
 
    boolean isRotationEnabled();
 
    void setPanEnabled(boolean enable);
 
    boolean isPanEnabled();
 
    void panTo(double latitude, double longitude, int zoom, double seconds);
 
    void addEventListener(MapEventListener listener);
 
    BoundingBox getBoundingBox();
 
    void setBoundingBox(BoundingBox bbox);
 
    void addFeature(MapMarker marker);
 
    void addFeature(MapLineString linestring);
 
    void addFeature(MapPolygon polygon);
 
    void addFeature(MapCircle circle);
 
    void addFeature(MapRectangle rectangle);
 
    void removeFeature(MapFeature feature);
 
    void showFeature(MapFeature feature);
 
    void hideFeature(MapFeature feature);
 
    boolean isFeatureVisible(MapFeature feature);
 
    boolean isFeatureCollectionVisible(MapFeatureCollection collection);
 
    void setFeatureCollectionVisible(MapFeatureCollection collection, boolean visible);
 
    void showInfobox(MapFeature feature);
 
    void hideInfobox(MapFeature feature);
 
    boolean isInfoboxVisible(MapFeature feature);
 
    void updateFeaturePosition(MapMarker marker);
 
    void updateFeaturePosition(MapLineString linestring);
 
    void updateFeaturePosition(MapPolygon polygon);
 
    void updateFeatureHoles(MapPolygon polygon);
 
    void updateFeaturePosition(MapCircle circle);
 
    void updateFeaturePosition(MapRectangle rectangle);
 
    void updateFeatureFill(HasFill feature);
 
    void updateFeatureStroke(HasStroke feature);
 
    void updateFeatureText(MapFeature feature);
 
    void updateFeatureDraggable(MapFeature feature);
 
    void updateFeatureImage(MapMarker marker);
 
    void updateFeatureSize(MapMarker marker);
 
    LocationSensor.LocationSensorListener getLocationListener();
 
    int getOverlayCount();
 
    void setRotation(float Rotation);
 
    float getRotation();
 
    void setScaleVisible(boolean show);
 
    boolean isScaleVisible();
 
    void setScaleUnits(MapScaleUnits units);
 
    MapScaleUnits getScaleUnits();
  }
 
  public interface MapFeature extends Component {
    // Properties
 
    String Type();
 
    boolean Visible();
 
    void Visible(boolean visible);
 
    void Draggable(boolean draggable);
 
    boolean Draggable();
 
    void Title(String title);
 
    String Title();
 
    void Description(String description);
 
    String Description();
 
    void EnableInfobox(boolean enable);
 
    boolean EnableInfobox();
 
    // Functions
 
    void ShowInfobox();
 
    void HideInfobox();
 
    // Events
 
    void Click();
 
    void LongClick();
 
    void StartDrag();
 
    void Drag();
 
    void StopDrag();
 
    // non-component methods
 
    <T> T accept(MapFeatureVisitor<T> visitor, Object... arguments);
 
    GeoPoint getCentroid();
 
    Geometry getGeometry();
 
    void setMap(MapFeatureContainer map);
 
    void removeFromMap();
  }
 
  public interface MapFeatureVisitor<T> {
    T visit(MapMarker marker, Object... arguments);
 
    T visit(MapLineString lineString, Object... arguments);
 
    T visit(MapPolygon polygon, Object... arguments);
 
    T visit(MapCircle circle, Object... arguments);
 
    T visit(MapRectangle rectangle, Object... arguments);
  }
 
  public interface MapFeatureContainer extends ComponentContainer, Iterable<MapFeature> {
 
    // Properties
 
    void Features(YailList features);
 
    YailList Features();
 
    // Events
 
    void FeatureClick(MapFeature feature);
 
    void FeatureLongClick(MapFeature feature);
 
    void FeatureStartDrag(MapFeature feature);
 
    void FeatureDrag(MapFeature feature);
 
    void FeatureStopDrag(MapFeature feature);
 
    // non-component methods
 
    Map getMap();
 
    void addFeature(MapFeature feature);
 
    Iterator<MapFeature> iterator();
 
    void removeFeature(MapFeature feature);
  }
 
  public interface HasFill {
    void FillColor(int argb);
 
    int FillColor();
 
    void FillOpacity(float opacity);
 
    float FillOpacity();
  }
 
  public interface HasStroke {
    void StrokeColor(int argb);
 
    int StrokeColor();
 
    void StrokeOpacity(float opacity);
 
    float StrokeOpacity();
 
    void StrokeWidth(int width);
 
    int StrokeWidth();
  }
 
  public interface MapFeatureCollection extends MapFeatureContainer {
    // Properties
 
    boolean Visible();
 
    YailList Features();
 
    void Source(String source);
 
    String Source();
 
    // Functions
 
    void LoadFromURL(String url);
 
    // Events
 
    void GotFeatures(String url, YailList features);
 
    void LoadError(String url, int code, String message);
  }
 
  public interface MapCircle extends MapFeature, HasFill, HasStroke {
    // Properties
 
    void Radius(double radius);
 
    double Radius();
 
    void Latitude(double latitude);
 
    double Latitude();
 
    void Longitude(double longitude);
 
    double Longitude();
 
    // Methods
 
    void SetLocation(double latitude, double longitude);
 
    // Updates from native view
 
    void updateCenter(double latitude, double longitude);
  }
 
  public interface MapRectangle extends MapFeature, HasFill, HasStroke {
    // Properties
 
    void EastLongitude(double east);
 
    double EastLongitude();
 
    void NorthLatitude(double north);
 
    double NorthLatitude();
 
    void SouthLatitude(double south);
 
    double SouthLatitude();
 
    void WestLongitude(double west);
 
    double WestLongitude();
 
    YailList Center();
 
    YailList Bounds();
 
    // Methods
 
    void SetCenter(double latitude, double longitude);
 
    // Updates from native view
 
    void updateBounds(double north, double west, double south, double east);
  }
 
  public interface MapMarker extends MapFeature, HasFill, HasStroke {
    // Properties
 
    @SuppressWarnings("squid:S00100")
    void ImageAsset(String path);
 
    @SuppressWarnings("squid:S00100")
    String ImageAsset();
 
    @SuppressWarnings("squid:S00100")
    void Latitude(double latitude);
 
    @SuppressWarnings("squid:S00100")
    double Latitude();
 
    @SuppressWarnings("squid:S00100")
    void Longitude(double longitude);
 
    @SuppressWarnings("squid:S00100")
    double Longitude();
 
    @SuppressWarnings("squid:S00100")
    void AnchorHorizontal(int horizontal);
 
    @SuppressWarnings("squid:S00100")
    int AnchorHorizontal();
 
    @SuppressWarnings("squid:S00100")
    void AnchorVertical(int vertical);
 
    @SuppressWarnings("squid:S00100")
    int AnchorVertical();
 
    @SuppressWarnings("squid:S00100")
    void ShowShadow(boolean show);
 
    @SuppressWarnings("squid:S00100")
    boolean ShowShadow();
 
    @SuppressWarnings("squid:S00100")
    void Width(int width);
 
    @SuppressWarnings("squid:S00100")
    int Width();
 
    @SuppressWarnings("squid:S00100")
    void Height(int height);
 
    @SuppressWarnings("squid:S00100")
    int Height();
 
    // Methods
 
    @SuppressWarnings("squid:S00100")
    void SetLocation(double latitude, double longitude);
 
    // convenience methods
 
    IGeoPoint getLocation();
 
    void updateLocation(double latitude, double longitude);
  }
 
  public interface MapLineString extends MapFeature, HasStroke {
 
    YailList Points();
 
    void Points(YailList points);
 
    // For convenient java manipulation
 
    List<GeoPoint> getPoints();
 
    void updatePoints(List<GeoPoint> points);
  }
 
  public interface MapPolygon extends MapFeature, HasFill, HasStroke {
 
    YailList Points();
 
    void Points(YailList points);
 
    YailList HolePoints();
 
    void HolePoints(YailList points);
 
    // For convenient java manipulation
 
    List<List<GeoPoint>> getPoints();
 
    List<List<List<GeoPoint>>> getHolePoints();
 
    void updatePoints(List<List<GeoPoint>> points);
 
    void updateHolePoints(List<List<List<GeoPoint>>> points);
  }
 
  public static final class MapFeatureType {
    private MapFeatureType() {}
 
    public static final String TYPE_MARKER = "Marker";
 
    public static final String TYPE_CIRCLE = "Circle";
 
    public static final String TYPE_RECTANGLE = "Rectangle";
 
    // the following 6 types are defined by GeoJSON
 
    public static final String TYPE_POINT = "Point";
 
    public static final String TYPE_LINESTRING = "LineString";
 
    public static final String TYPE_POLYGON = "Polygon";
 
    @SuppressWarnings("unused")
    public static final String TYPE_MULTIPOINT = "MultiPoint";
 
    @SuppressWarnings("unused")
    public static final String TYPE_MULTILINESTRING = "MultiLineString";
 
    public static final String TYPE_MULTIPOLYGON = "MultiPolygon";
  }
 
  public enum MapType {
    UNKNOWN,
 
    ROADS,
 
    AERIAL,
 
    TERRAIN
  }
 
  public enum MapScaleUnits {
    UNKNOWN,
 
    METRIC,
 
    IMPERIAL
  }
 
  public static MapController newMap(Form form) {
    if (Build.VERSION.SDK_INT < 8) {
      return new DummyMapController();
    } else {
      return new NativeOpenStreetMapController(form);
    }
  }
}