/*
 * Copyright (c) 2018, Adam <Adam@sigterm.info>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.runelite.api;

import net.runelite.api.coords.WorldPoint;

/**
 * Represents an overview of the currently rendered world map.
 */
public interface RenderOverview
{
	/**
	 * Gets the current position of the local player on the world map.
	 *
	 * @return the world map position
	 */
	Point getWorldMapPosition();

	/**
	 * Gets the current zoom level of the world map.
	 *
	 * @return the world map zoon
	 */
	float getWorldMapZoom();

	/**
	 * Sets the target position of the world map.
	 *
	 * @param worldPoint the new target position
	 */
	void setWorldMapPositionTarget(WorldPoint worldPoint);

	/**
	 * Gets the world map manager.
	 *
	 * @return the world map manager
	 */
	WorldMapManager getWorldMapManager();

	/**
	 * Initializes the world map with the provided data.
	 *
	 * @param var1 the new map data
	 */
	void initializeWorldMap(WorldMapData var1);

	/**
	 * The data represented by the render.
	 *
	 * @return the map data
	 */
	WorldMapData getWorldMapData();
}
