package nl.tudelft.simulation.dsol.animation.gis;

import java.awt.Graphics2D;
import java.awt.geom.Point2D;
import java.io.Serializable;
import java.rmi.RemoteException;
import java.util.List;

import org.djutils.draw.bounds.Bounds2d;
import org.djutils.immutablecollections.ImmutableList;
import org.djutils.immutablecollections.ImmutableMap;

/**
 * This interface defines the map.
 * <p>
 * Copyright (c) 2020-2021 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
 * for project information <a href="https://simulation.tudelft.nl/dsol/manual/" target="_blank">DSOL Manual</a>. The DSOL
 * project is distributed under a three-clause BSD-style license, which can be found at
 * <a href="https://simulation.tudelft.nl/dsol/3.0/license.html" target="_blank">DSOL License</a>.
 * </p>
 * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
 */
public interface GisMapInterface extends Serializable
{
    /**
     * Draw the map on a graphics object.
     * @param graphics Graphics2D; the graphics object
     * @return Graphics2D; the graphics object for command chaining
     * @throws GraphicsException on drawing failure
     * @throws RemoteException on network failure
     */
    Graphics2D drawMap(Graphics2D graphics) throws GraphicsException, RemoteException;

    /**
     * Return the extent of the map in world coordinates.
     * @return Bounds2d; the extent of the map in world coordinates
     * @throws RemoteException on network exception
     */
    Bounds2d getExtent() throws RemoteException;

    /**
     * Return the map of layer names to layers.
     * @return ImmutableMap&lt;LayerInterface, String&gt;; the the map of layer names to layers
     * @throws RemoteException on network exception
     */
    ImmutableMap<String, LayerInterface> getLayerMap() throws RemoteException;

    /**
     * Return a list with all layers for the map.
     * @return ImmutableList&lt;LayerInterface&gt;; a list with all layers
     * @throws RemoteException on network exception
     */
    ImmutableList<LayerInterface> getAllLayers() throws RemoteException;

    /**
     * Return a list with all visible layers for the map.
     * @return ImmutableList&lt;LayerInterface&gt;; a list with all visible layers
     * @throws RemoteException on network exception
     */
    ImmutableList<LayerInterface> getVisibleLayers() throws RemoteException;

    /**
     * Return whether the map has not been changed, and reset the internal parameter to true.
     * @return boolean; whether the map has not been changed, and reset the internal parameter to true
     * @throws RemoteException on network exception
     */
    boolean isSame() throws RemoteException;

    /**
     * Return the name of the map.
     * @return String; the name of the map
     * @throws RemoteException on network exception
     */
    String getName() throws RemoteException;

    /**
     * Return the scale of the map.
     * @return double the scale of the map in its units
     * @throws RemoteException on network exception
     */
    double getScale() throws RemoteException;

    /**
     * Return the scale of the Image.
     * @return double the unitPerPixel
     * @throws RemoteException on network exception
     */
    double getUnitImageRatio() throws RemoteException;

    /**
     * Return property units.
     * @return MapUnits the value of property units.
     * @throws RemoteException on network exception
     */
    MapUnits getUnits() throws RemoteException;

    /**
     * Setter for property extent.
     * @param extent Bounds2d; New value of the map extent.
     * @throws RemoteException on network exception
     */
    void setExtent(Bounds2d extent) throws RemoteException;

    /**
     * Setter for property layers.
     * @param layers List&lt;LayerInterface&gt;; New value of property layers.
     * @throws RemoteException on network exception
     */
    void setLayers(List<LayerInterface> layers) throws RemoteException;

    /**
     * Setter for property layers.
     * @param index int; Index value of layer
     * @param layer LayerInterface; New value of property layers.
     * @throws RemoteException on network exception
     */
    void setLayer(int index, LayerInterface layer) throws RemoteException;

    /**
     * Setter for property layers.
     * @param layer LayerInterface; New value of property layers.
     * @throws RemoteException on network exception
     */
    void addLayer(LayerInterface layer) throws RemoteException;

    /**
     * Hide a layer.
     * @param layer LayerInterface; the layer to hide
     * @throws RemoteException on network exception
     */
    void hideLayer(LayerInterface layer) throws RemoteException;

    /**
     * Show a layer.
     * @param layer LayerInterface; the layer to show
     * @throws RemoteException on network exception
     */
    void showLayer(LayerInterface layer) throws RemoteException;

    /**
     * Hide a layer.
     * @param layerName String; the name of the layer to hide
     * @throws RemoteException on network exception
     */
    void hideLayer(String layerName) throws RemoteException;

    /**
     * Show a layer.
     * @param layerName String; the name of the layer to show
     * @throws RemoteException on network exception
     */
    void showLayer(String layerName) throws RemoteException;

    /**
     * Setter for property name.
     * @param name String; new value of property name.
     * @throws RemoteException on network exception
     */
    void setName(String name) throws RemoteException;

    /**
     * Setter for property units.
     * @param units MapUnits; new value of property units.
     * @throws RemoteException on network exception
     */
    void setUnits(MapUnits units) throws RemoteException;

    /**
     * zooms the map with a particular factor.
     * @param zoomFactor double; (0=1)
     * @throws RemoteException on network exception
     */
    void zoom(double zoomFactor) throws RemoteException;

    /**
     * zooms the map based on a given position in the image.
     * @param pixelPosition Point2D; the position in the image
     * @param zoomFactor double; the zoomFactor (0=1)
     * @throws RemoteException on network exception
     */
    void zoomPoint(Point2D pixelPosition, double zoomFactor) throws RemoteException;

    /**
     * zooms the map based on a given rectangle.
     * @param rectangle SerializableRectangle2D; a rectangle in the map (image units)
     * @throws RemoteException on network exception
     */
    void zoomRectangle(SerializableRectangle2D rectangle) throws RemoteException;

    /**
     * return whether background is drawn or not.
     * @return drawBackground
     */
    boolean isDrawBackground();

    /**
     * set whether background is drawn or not.
     * @param drawBackground boolean; set drawBackground
     */
    void setDrawBackground(boolean drawBackground);

}