MapCursorActions.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.mapcursor;
 
import java.awt.Point;
import java.util.Set;
import javax.swing.Action;
import net.sf.gridarta.gui.map.mapactions.MapActions;
import net.sf.gridarta.gui.map.mapview.MapView;
import net.sf.gridarta.gui.map.mapview.MapViewManagerListener;
import net.sf.gridarta.gui.map.renderer.MapRenderer;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.direction.Direction;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapcursor.MapCursor;
import net.sf.gridarta.model.mapcursor.MapCursorListener;
import net.sf.gridarta.model.mapmodel.MapFile;
import net.sf.gridarta.model.mapmodel.MapModelListener;
import net.sf.gridarta.model.mapmodel.MapSquare;
import net.sf.gridarta.model.validation.ErrorCollector;
import net.sf.gridarta.utils.EditorAction;
import net.sf.gridarta.utils.Size2D;
import net.sf.japi.swing.action.ActionMethod;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MapCursorActions<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction, MapCursorListener<G, A, R>, MapViewManagerListener<G, A, R> {
 
    private static final int BORDER = 3;
 
    @NotNull
    private static final Direction @NotNull [] DIRECTIONS = Direction.values();
 
    @NotNull
    private final MapActions<G, A, R> mapActions;
 
    @Nullable
    private final Action @NotNull [] aMoveCursor;
 
    @Nullable
    private MapView<G, A, R> currentMapView;
 
    @NotNull
    private final MapModelListener<G, A, R> mapModelListener = new MapModelListener<G, A, R>() {
 
        @Override
        public void mapSizeChanged(@NotNull final Size2D newSize) {
            refreshActions();
        }
 
        @Override
        public void mapSquaresChanged(@NotNull final Set<MapSquare<G, A, R>> mapSquares) {
            // ignore
        }
 
        @Override
        public void mapObjectsChanged(@NotNull final Set<G> gameObjects, @NotNull final Set<G> transientGameObjects) {
            // ignore
        }
 
        @Override
        public void errorsChanged(@NotNull final ErrorCollector<G, A, R> errors) {
            // ignore
        }
 
        @Override
        public void mapFileChanged(@Nullable final MapFile oldMapFile) {
            // ignore
        }
 
        @Override
        public void modifiedChanged() {
            // ignore
        }
 
    };
 
    public MapCursorActions(@NotNull final MapActions<G, A, R> mapActions) {
        this.mapActions = mapActions;
        aMoveCursor = new Action[DIRECTIONS.length];
    }
 
    @ActionMethod
    public void moveCursorNorth() {
        doMoveCursor(true, Direction.NORTH);
    }
 
    @ActionMethod
    public void moveCursorSouth() {
        doMoveCursor(true, Direction.SOUTH);
    }
 
    @ActionMethod
    public void moveCursorEast() {
        doMoveCursor(true, Direction.EAST);
    }
 
    @ActionMethod
    public void moveCursorWest() {
        doMoveCursor(true, Direction.WEST);
    }
 
    @ActionMethod
    public void moveCursorNorthEast() {
        doMoveCursor(true, Direction.NORTH_EAST);
    }
 
    @ActionMethod
    public void moveCursorNorthWest() {
        doMoveCursor(true, Direction.NORTH_WEST);
    }
 
    @ActionMethod
    public void moveCursorSouthEast() {
        doMoveCursor(true, Direction.SOUTH_EAST);
    }
 
    @ActionMethod
    public void moveCursorSouthWest() {
        doMoveCursor(true, Direction.SOUTH_WEST);
    }
 
    private void refreshActions() {
        for (final Direction direction : DIRECTIONS) {
            final Action action = aMoveCursor[direction.ordinal()];
            if (action != null) {
                action.setEnabled(doMoveCursor(false, direction));
            }
        }
    }
 
    private boolean doMoveCursor(final boolean performAction, @NotNull final Direction direction) {
        final MapView<G, A, R> mapView = currentMapView;
        if (mapView == null) {
            return false;
        }
 
        final MapCursor<G, A, R> mapCursor = mapView.getMapCursor();
        if (!mapCursor.goTo(performAction, direction)) {
            if (!mapActions.doEnterMap(performAction, direction)) {
                return false;
            }
        } else if (performAction) {
            final MapRenderer renderer = mapView.getRenderer();
            final Point location = mapCursor.getLocation();
            location.translate(BORDER * direction.getDx(), BORDER * direction.getDy());
            renderer.scrollRectToVisible(renderer.getSquareBounds(location));
        }
 
        return true;
    }
 
    @Override
    public void setAction(@NotNull final Action action, @NotNull final String name) {
        if (name.startsWith("moveCursor")) {
            boolean found = false;
            for (final Direction direction : DIRECTIONS) {
                if (name.equals("moveCursor" + direction.getId())) {
                    aMoveCursor[direction.ordinal()] = action;
                    found = true;
                    break;
                }
            }
            if (!found) {
                throw new IllegalArgumentException("unsupported action name: " + name);
            }
        } else {
            throw new IllegalArgumentException("unsupported action name: " + name);
        }
        refreshActions();
    }
 
    @Override
    public void activeMapViewChanged(@Nullable final MapView<G, A, R> mapView) {
        currentMapView = mapView;
        refreshActions();
    }
 
    @Override
    public void mapViewCreated(@NotNull final MapView<G, A, R> mapView) {
        mapView.getMapControl().getMapModel().addMapModelListener(mapModelListener);
    }
 
    @Override
    public void mapViewClosing(@NotNull final MapView<G, A, R> mapView) {
        mapView.getMapControl().getMapModel().removeMapModelListener(mapModelListener);
    }
 
    @Override
    public void mapCursorChangedPos(@NotNull final Point location) {
        refreshActions();
    }
 
    @Override
    public void mapCursorChangedMode() {
        // ignore
    }
 
    @Override
    public void mapCursorChangedGameObject(@Nullable final MapSquare<G, A, R> mapSquare, @Nullable final G gameObject) {
        // ignore
    }
 
    @Override
    public void mapCursorChangedSize() {
        refreshActions();
    }
 
}