CfMapSquare.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-2011 Andreas Kirschbaum.
 */

package com.realtime.crossfire.jxclient.map;

import com.realtime.crossfire.jxclient.faces.Face;
import com.realtime.crossfire.jxclient.protocol.Map2;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class CfMapSquare {

    public static final int DEFAULT_DARKNESS = 255;

    public static final int DEFAULT_SMOOTH = 0;

    public static final int DEFAULT_COLOR = -1;

    public static final int DARKNESS_FULL_BRIGHT = 255;

    @Nullable
    public static final Face DEFAULT_FACE = null;

    @NotNull
    private final CfMap map;

    private final int x;

    private final int y;

    private boolean fogOfWar;

    private int darkness = DEFAULT_DARKNESS;

    private int color = DEFAULT_COLOR;

    @NotNull
    private final Face[] faces = new Face[Map2.NUM_LAYERS];

    @NotNull
    private final CfMapSquare[] heads = new CfMapSquare[Map2.NUM_LAYERS];

    @NotNull
    private final int[] smooths = new int[Map2.NUM_LAYERS];

    public CfMapSquare(@NotNull final CfMap map, final int x, final int y) {
        this.map = map;
        this.x = x;
        this.y = y;
    }

    public int getX() {
        return x;
    }

    public int getY() {
        return y;
    }

    public void dirty() {
        map.squareModified(this);
    }

    public void clear() {
        if (fogOfWar) {
            return;
        }

        // need to check individual values because the server sometimes sends a
        // "clear" command for already cleared squares; without this check the
        // black square would be displayed as fog-of-war
        if (darkness == DEFAULT_DARKNESS) {
            int layer;
            for (layer = 0; layer < faces.length; layer++) {
                if (faces[layer] != DEFAULT_FACE || heads[layer] != null || smooths[layer] != 0) {
                    break;
                }
            }
            if (layer >= faces.length) {
                return;
            }
        }

        fogOfWar = true;
        dirty();
    }

    public boolean setDarkness(final int darkness) {
        final boolean result = fogOfWar;
        final boolean markDirty = fogOfWar || this.darkness != darkness;
        fogOfWar = false;
        this.darkness = darkness;
        if (markDirty) {
            dirty();
        }
        return result;
    }

    public int getDarkness() {
        return darkness;
    }

    public int setSmooth(final int layer, final int smooth) {
        final boolean fogOfWarCleared = fogOfWar;
        final boolean smoothChanged = smooths[layer] != smooth;
        smooths[layer] = smooth;
        final boolean markDirty = fogOfWar || smoothChanged;
        fogOfWar = false;
        if (markDirty) {
            dirty();
        }
        return (fogOfWarCleared ? 1 : 0)|(smoothChanged ? 2 : 0);
    }

    public int getSmooth(final int layer) {
        return smooths[layer];
    }

    public boolean setColor(final int color) {
        final boolean result = fogOfWar;
        final boolean markDirty = fogOfWar || this.color != color;
        fogOfWar = false;
        this.color = color;
        if (markDirty) {
            dirty();
        }
        return result;
    }

    public int getColor() {
        return color;
    }

    public void setFace(final int layer, @Nullable final Face face) {
        if (faces[layer] != face) {
            faces[layer] = face;
            dirty();
        }
    }

    @Nullable
    public Face getFace(final int layer) {
        return faces[layer];
    }

    public void setHeadMapSquare(final int layer, @Nullable final CfMapSquare mapSquare, final boolean setAlways) {
        if (heads[layer] != mapSquare && (setAlways || heads[layer] == null || heads[layer].fogOfWar)) {
            heads[layer] = mapSquare;
            dirty();
        }
    }

    @Nullable
    public CfMapSquare getHeadMapSquare(final int layer) {
        // suppress parts of fog-of-war objects if this square is not
        // fog-of-war
        if (heads[layer] != null && !fogOfWar && heads[layer].fogOfWar) {
            return null;
        }

        return heads[layer];
    }

    public boolean isFogOfWar() {
        return fogOfWar;
    }

    public boolean resetFogOfWar() {
        if (!fogOfWar) {
            return false;
        }

        fogOfWar = false;
        dirty();
        return true;
    }

    @NotNull
    @Override
    public String toString() {
        return x+"/"+y;
    }

}