package com.mogo.map;

import com.mogo.map.marker.IMogoMarker;
import com.mogo.map.marker.MogoMarkerOptions;

import java.util.ArrayList;

/**
 * @author congtaowang
 * @since 2019-12-18
 * <p>
 * 地图控制接口
 */
public interface IMogoMap {

    /**
     * 获取地图ui控制器，可以控制内置ui（缩放按钮、指北针等）是否显示及部分手势（滑动、双指缩放等）是否可用。
     *
     * @return
     */
    IUiSettings getUiSettings();

    /**
     * 在地图上添一个图片标记（marker）对象。
     *
     * @param tag     标识服务
     * @param options
     * @return
     */
    IMogoMarker addMarker( String tag, MogoMarkerOptions options );

    /**
     * 在地图上添一组图片标记（marker）对象，并设置是否改变地图状态以至于所有的marker对象都在当前地图可视区域范围内显示。
     *
     * @param tag          标识服务
     * @param options
     * @param moveToCenter
     * @return
     */
    ArrayList< IMogoMarker > addMarkers( String tag, ArrayList< MogoMarkerOptions > options, boolean moveToCenter );

    /**
     * 从地图上删除所有的overlay（marker，circle，polyline 等对象）。
     */
    void clear();

    /**
     * 从地图上删除所有的覆盖物（marker，circle，polyline 等对象），但myLocationOverlay（内置定位覆盖物）除外。
     *
     * @param isKeepMyLocationOverlay
     */
    void clear( boolean isKeepMyLocationOverlay );

    /**
     * 设置屏幕上的某个像素点为地图中心点。
     *
     * @param x
     * @param y
     */
    void setPointToCenter( int x, int y );

    /**
     * 设置地图POI是否允许点击。
     *
     * @param touchPoiEnable
     */
    void setTouchPoiEnable( boolean touchPoiEnable );

    /**
     * 设置是否打开交通路况图层。
     *
     * @param enable
     */
    void setTrafficEnable( boolean enable );

    /**
     * 设置是否显示3D建筑物，默认显示。
     *
     * @param enabled
     */
    void showBuildings( boolean enabled );

    /**
     * 设置是否显示室内地图，默认不显示。
     *
     * @param enable
     */
    void showIndoorMap( boolean enable );

    /**
     * 设置是否显示底图文字标注，默认显示。
     *
     * @param enable
     */
    void showMapText( boolean enable );

    /**
     * 停止当前执行的改变地图状态的动画。
     */
    void stopAnimation();
}