AbstractMapRenderer.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.gui.map.renderer;
 
import java.awt.Point;
import java.awt.event.MouseEvent;
import java.io.File;
import java.io.IOException;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import javax.imageio.ImageIO;
import javax.swing.JComponent;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.io.GameObjectParser;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapmodel.MapModel;
import net.sf.gridarta.model.mapmodel.MapSquare;
import net.sf.gridarta.model.validation.errors.ValidationError;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public abstract class AbstractMapRenderer<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends JComponent implements MapRenderer {
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private Map<MapSquare<G, A, R>, ValidationError<G, A, R>> erroneousMapSquares = Collections.emptyMap();
 
    @NotNull
    private final Point tmpPoint = new Point();
 
    @NotNull
    private final MapModel<G, A, R> mapModel;
 
    @Nullable
    private final GameObjectParser<G, A, R> gameObjectParser;
 
    private boolean lightVisible;
 
    protected AbstractMapRenderer(@NotNull final MapModel<G, A, R> mapModel, @Nullable final GameObjectParser<G, A, R> gameObjectParser) {
        this.mapModel = mapModel;
        this.gameObjectParser = gameObjectParser;
    }
 
    @Override
    public void printFullImage(@NotNull final File file) throws IOException {
        ImageIO.write(getFullImage(), "png", file);
    }
 
    public void setErroneousMapSquares(@NotNull final Map<MapSquare<G, A, R>, ValidationError<G, A, R>> erroneousMapSquares) {
        this.erroneousMapSquares = new HashMap<>(erroneousMapSquares);
    }
 
    public abstract void closeNotify();
 
    @Nullable
    @Override
    public String getToolTipText(@NotNull final MouseEvent event) {
        if (!getSquareLocationAt(event.getPoint(), tmpPoint)) {
            return null;
        }
 
        final MapSquare<G, A, R> mapSquare = mapModel.getMapSquare(tmpPoint);
 
        final ToolTipAppender<G, A, R> toolTipAppender = new ToolTipAppender<>(gameObjectParser);
        for (final G gameObject : mapSquare.reverse()) {
            toolTipAppender.appendGameObject(gameObject, false, "");
        }
 
        final ValidationError<G, A, R> error = erroneousMapSquares.get(mapSquare);
        if (error != null) {
            toolTipAppender.appendValidationError(error);
        }
        return toolTipAppender.finish();
    }
 
    @Override
    public void setLightVisible(final boolean lightVisible) {
        if (this.lightVisible == lightVisible) {
            return;
        }
 
        this.lightVisible = lightVisible;
        forceRepaint();
    }
 
    protected boolean isLightVisible() {
        return lightVisible;
    }
 
}