MapUpdaterState.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.map;
 
import com.realtime.crossfire.jxclient.animations.Animation;
import com.realtime.crossfire.jxclient.animations.Animations;
import com.realtime.crossfire.jxclient.faces.Face;
import com.realtime.crossfire.jxclient.faces.FacesManager;
import com.realtime.crossfire.jxclient.faces.FacesManagerListener;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireTickListener;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireUpdateMapListener;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
import org.jetbrains.annotations.NotNull;
 
public class MapUpdaterState implements CrossfireTickListener, CrossfireUpdateMapListener, FacesManagerListener {
 
    @NotNull
    private final Object sync = new Object();
 
    @NotNull
    private final FacesManager facesManager;
 
    @NotNull
    private final Animations animations;
 
    @NotNull
    private final CfAnimations cfAnimations;
 
    private int mapWidth;
 
    private int mapHeight;
 
    @NotNull
    private final CfMap map = new CfMap();
 
    @NotNull
    private final EventListenerList2<MapListener> mapListeners = new EventListenerList2<>();
 
    @NotNull
    private final EventListenerList2<NewmapListener> newmapListeners = new EventListenerList2<>();
 
    @NotNull
    private final EventListenerList2<MapScrollListener> mapScrollListeners = new EventListenerList2<>();
 
    @NotNull
    private final EventListenerList2<MapSizeListener> mapSizeListeners = new EventListenerList2<>();
 
    @NotNull
    private final Collection<Location> outOfViewMultiFaces = new HashSet<>();
 
    public MapUpdaterState(@NotNull final FacesManager facesManager, @NotNull final Animations animations, @NotNull final CfAnimations cfAnimations) {
        this.facesManager = facesManager;
        this.animations = animations;
        this.cfAnimations = cfAnimations;
 
        cfAnimations.setMapListener(new CfAnimationsMapListener() {
 
            @NotNull
            @Override
            public Object mapBegin() {
                return MapUpdaterState.this.mapBegin();
            }
 
            @Override
            public void mapFace(@NotNull final Location location, final int faceNum) {
                MapUpdaterState.this.mapFace(location, faceNum, false);
            }
 
            @Override
            public void mapEnd() {
                MapUpdaterState.this.mapEnd(false);
            }
 
        });
    }
 
    public void addCrossfireMapListener(@NotNull final MapListener listener) {
        mapListeners.add(listener);
    }
 
    public void removeCrossfireMapListener(@NotNull final MapListener listener) {
        mapListeners.remove(listener);
    }
 
    public void addCrossfireNewmapListener(@NotNull final NewmapListener listener) {
        newmapListeners.add(listener);
    }
 
    public void removeCrossfireNewmapListener(@NotNull final NewmapListener listener) {
        newmapListeners.remove(listener);
    }
 
    public void addCrossfireMapScrollListener(@NotNull final MapScrollListener listener) {
        mapScrollListeners.add(listener);
    }
 
    public void removeCrossfireMapScrollListener(@NotNull final MapScrollListener listener) {
        mapScrollListeners.remove(listener);
    }
 
    public void addMapSizeListener(@NotNull final MapSizeListener listener) {
        mapSizeListeners.add(listener);
    }
 
    public void removeMapSizeListener(@NotNull final MapSizeListener listener) {
        mapSizeListeners.remove(listener);
    }
 
    public void reset() {
        synchronized (sync) {
            newMap(mapWidth, mapHeight);
        }
    }
 
    @NotNull
    @Override
    public Object mapBegin() {
        return sync;
    }
 
    @Override
    public void mapClear(final int x, final int y) {
        assert Thread.holdsLock(sync);
        cfAnimations.mapRemove(x, y);
        outOfViewMultiFaces.clear();
        synchronized (map) {
            map.clearSquare(x, y);
        }
    }
 
    @Override
    public void mapFace(@NotNull final Location location, final int faceNum) {
        mapFace(location, faceNum, true);
    }
 
    public void mapFace(@NotNull final Location location, final int faceNum, final boolean clearAnimation) {
        assert Thread.holdsLock(sync);
        if (clearAnimation) {
            cfAnimations.mapRemove(location);
        }
        final Face face = facesManager.getFace2(faceNum);
        final int x = location.getX();
        final int y = location.getY();
        if (x >= mapWidth || y >= mapHeight) {
            if (face == null) {
                outOfViewMultiFaces.remove(location);
            } else if (face.getTileWidth() > 1 || face.getTileHeight() > 1) {
                outOfViewMultiFaces.add(location);
            }
        }
        synchronized (map) {
            map.setFace(x, y, location.getLayer(), face);
        }
    }
 
    @Override
    public void mapAnimation(@NotNull final Location location, final int animationNum, final int animationType) {
        assert Thread.holdsLock(sync);
        final Animation animation = animations.get(animationNum);
        if (animation == null) {
            System.err.println("unknown animation id "+animationNum+", ignoring");
            return;
        }
 
        synchronized (map) {
            map.setFace(location.getX(), location.getY(), location.getLayer(), null);
        }
        cfAnimations.mapAdd(location, animation, animationType);
    }
 
    @Override
    public void mapAnimationSpeed(@NotNull final Location location, final int animationSpeed) {
        assert Thread.holdsLock(sync);
        cfAnimations.mapUpdateSpeed(location, animationSpeed);
    }
 
    @Override
    public void mapSmooth(@NotNull final Location location, final int smooth) {
        assert Thread.holdsLock(sync);
        synchronized (map) {
            map.setSmooth(location.getX(), location.getY(), location.getLayer(), smooth);
        }
    }
 
    @Override
    public void mapDarkness(final int x, final int y, final int darkness) {
        assert Thread.holdsLock(sync);
        synchronized (map) {
            map.setDarkness(x, y, darkness);
        }
    }
 
    @Override
    public void magicMap(final int x, final int y, final byte @NotNull [] @NotNull [] data) {
        assert Thread.holdsLock(sync);
        synchronized (map) {
            map.setMagicMap(x, y, data);
        }
    }
 
    @Override
    public void mapEnd() {
        mapEnd(true);
    }
 
    public void mapEnd(final boolean alwaysProcess) {
        assert Thread.holdsLock(sync);
        synchronized (map) {
            final Set<CfMapSquare> squares = map.getDirtyMapSquares();
            if (!alwaysProcess && squares.isEmpty()) {
                return;
            }
 
            for (MapListener listener : mapListeners) {
                listener.mapChanged(map, squares);
            }
        }
    }
 
    @Override
    public void mapScroll(final int dx, final int dy) {
        assert Thread.holdsLock(sync);
        synchronized (map) {
            for (Location location : outOfViewMultiFaces) {
                cfAnimations.mapRemove(location);
                map.setFace(location.getX(), location.getY(), location.getLayer(), null);
            }
            outOfViewMultiFaces.clear();
 
            if (map.processMapScroll(dx, dy, mapWidth, mapHeight)) {
                cfAnimations.mapClear();
            } else {
                cfAnimations.mapScroll(dx, dy);
            }
        }
 
        for (MapScrollListener mapscrollListener : mapScrollListeners) {
            mapscrollListener.mapScrolled(dx, dy);
        }
    }
 
    @Override
    public void faceUpdated(@NotNull final Face face) {
        synchronized (mapBegin()) {
            //noinspection NestedSynchronizedStatement
            synchronized (map) {
                map.updateFace(face.getFaceNum(), mapWidth, mapHeight);
            }
            mapEnd();
        }
    }
 
    @Override
    public void newMap(final int mapWidth, final int mapHeight) {
        synchronized (sync) {
            final boolean changed = this.mapWidth != mapWidth || this.mapHeight != mapHeight;
            this.mapWidth = mapWidth;
            this.mapHeight = mapHeight;
            //noinspection NestedSynchronizedStatement
            synchronized (map) {
                map.reset(mapWidth, mapHeight);
            }
 
            cfAnimations.mapSetSize(mapWidth, mapHeight);
 
            if (changed) {
                for (MapSizeListener listener : mapSizeListeners) {
                    listener.mapSizeChanged(mapWidth, mapHeight);
                }
            }
 
            for (NewmapListener listener : newmapListeners) {
                listener.commandNewmapReceived();
            }
        }
    }
 
    @NotNull
    public CfMap getMap() {
        return map;
    }
 
    public int getMapWidth() {
        synchronized (map) {
            return mapWidth;
        }
    }
 
    public int getMapHeight() {
        synchronized (map) {
            return mapHeight;
        }
    }
 
    @Override
    public void tick(final int tickNo) {
        synchronized (sync) {
            cfAnimations.tick(tickNo);
        }
    }
 
}