BlueMap/BlueMapCommon/src/main/java/de/bluecolored/bluemap/common/rendermanager/WorldRegionRenderTask.java

/*
 * This file is part of BlueMap, licensed under the MIT License (MIT).
 *
 * Copyright (c) Blue (Lukas Rieger) <https://bluecolored.de>
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package de.bluecolored.bluemap.common.rendermanager;

import com.flowpowered.math.vector.Vector2i;
import de.bluecolored.bluemap.core.map.BmMap;
import de.bluecolored.bluemap.core.world.Grid;
import de.bluecolored.bluemap.core.world.Region;
import de.bluecolored.bluemap.core.world.World;

import java.util.Collection;
import java.util.Comparator;
import java.util.TreeSet;

public class WorldRegionRenderTask implements RenderTask {

	private final BmMap map;
	private final Vector2i worldRegion;
	private final boolean force;

	private TreeSet<Vector2i> tiles;
	private int tileCount;
	private long startTime;

	private volatile int atWork;
	private volatile boolean cancelled;

	public WorldRegionRenderTask(BmMap map, Vector2i worldRegion) {
		this(map, worldRegion, false);
	}

	public WorldRegionRenderTask(BmMap map, Vector2i worldRegion, boolean force) {
		this.map = map;
		this.worldRegion = worldRegion;
		this.force = force;

		this.tiles = null;
		this.tileCount = -1;
		this.startTime = -1;

		this.atWork = 0;
		this.cancelled = false;
	}

	private synchronized void init() {
		tiles = new TreeSet<>(WorldRegionRenderTask::tileComparator);
		startTime = System.currentTimeMillis();

		//Logger.global.logInfo("Starting: " + worldRegion);

		long changesSince = 0;
		if (!force) changesSince = map.getRenderState().getRenderTime(worldRegion);

		Region region = map.getWorld().getRegion(worldRegion.getX(), worldRegion.getY());
		Collection<Vector2i> chunks = region.listChunks(changesSince);

		Grid tileGrid = map.getHiresModelManager().getTileGrid();
		Grid chunkGrid = map.getWorld().getChunkGrid();

		for (Vector2i chunk : chunks) {
			Vector2i tileMin = chunkGrid.getCellMin(chunk, tileGrid);
			Vector2i tileMax = chunkGrid.getCellMax(chunk, tileGrid);

			for (int x = tileMin.getX(); x <= tileMax.getX(); x++) {
				for (int z = tileMin.getY(); z <= tileMax.getY(); z++) {
					tiles.add(new Vector2i(x, z));
				}
			}
		}

		this.tileCount = tiles.size();

		if (tiles.isEmpty()) complete();
	}

	@Override
	public void doWork() {
		if (cancelled) return;

		Vector2i tile;

		synchronized (this) {
			if (tiles == null) init();
			if (tiles.isEmpty()) return;

			tile = tiles.pollFirst();

			this.atWork++;
		}

		//Logger.global.logInfo("Working on " + worldRegion + " - Tile " + tile);
		map.renderTile(tile); // <- actual work

		synchronized (this) {
			this.atWork--;

			if (atWork <= 0 && tiles.isEmpty() && !cancelled) {
				complete();
			}
		}
	}

	private void complete() {
		map.getRenderState().setRenderTime(worldRegion, startTime);

		//Logger.global.logInfo("Done with: " + worldRegion);
	}

	@Override
	public synchronized boolean hasMoreWork() {
		return !cancelled && (tiles == null || !tiles.isEmpty());
	}

	@Override
	public double estimateProgress() {
		if (tiles == null) return 0;
		if (tileCount == 0) return 1;

		double remainingTiles = tiles.size();
		return 1 - (remainingTiles / this.tileCount);
	}

	@Override
	public void cancel() {
		this.cancelled = true;

		synchronized (this) {
			if (tiles != null) this.tiles.clear();
		}
	}

	public BmMap getMap() {
		return map;
	}

	public Vector2i getWorldRegion() {
		return worldRegion;
	}

	public boolean isForce() {
		return force;
	}

	@Override
	public String getDescription() {
		return "Update region " + getWorldRegion() + " for map '" + map.getId() + "'";
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) return true;
		if (o == null || getClass() != o.getClass()) return false;
		WorldRegionRenderTask that = (WorldRegionRenderTask) o;
		return force == that.force && map.getId().equals(that.map.getId()) && worldRegion.equals(that.worldRegion);
	}

	@Override
	public int hashCode() {
		return worldRegion.hashCode();
	}

	private static int tileComparator(Vector2i v1, Vector2i v2) {
		int comp = v1.compareTo(v2);
		if (comp != 0) return comp;
		if (v1.getX() != v2.getX()) return v2.getX() - v1.getX();
		return v2.getY() - v1.getY();
	}

	public static Comparator<WorldRegionRenderTask> defaultComparator(final Vector2i centerRegion) {
		return (task1, task2) -> {
			Vector2i task1Rel = task1.worldRegion.sub(centerRegion);
			Vector2i task2Rel = task2.worldRegion.sub(centerRegion);
			return tileComparator(task1Rel, task2Rel);
		};
	}

}