MapModel.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 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.model.mapmodel;

import java.awt.Point;
import java.io.Serializable;
import java.util.List;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.baseobject.BaseObject;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.validation.ErrorCollector;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public interface MapModel<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends Iterable<MapSquare<G, A, R>>, Serializable {

    void mapClosed();

    void clearMap();

    boolean isEmpty();

    @NotNull
    A getMapArchObject();

    void addMapModelListener(@NotNull MapModelListener<G, A, R> listener);

    void removeMapModelListener(@NotNull MapModelListener<G, A, R> listener);

    void addMapTransactionListener(@NotNull MapTransactionListener<G, A, R> listener);

    void removeMapTransactionListener(@NotNull MapTransactionListener<G, A, R> listener);

    void beginSquareChange(@NotNull MapSquare<G, A, R> mapSquare);

    void endSquareChange(@NotNull MapSquare<G, A, R> mapSquare);

    void beginGameObjectChange(@NotNull G gameObject);

    void endGameObjectChange(@NotNull G gameObject);

    void transientGameObjectChange(@NotNull G gameObject);

    void beginTransaction(@NotNull String name);

    void endTransaction();

    void endTransaction(boolean fireEvent);

    void endAllTransactions();

    int getTransactionDepth();

    boolean isAnyTransactionActive();

    @NotNull
    MapSquare<G, A, R> getMapSquare(@NotNull Point pos);

    void addObjectListToMap(@NotNull Iterable<G> objects);

    void addGameObjectToMap(@NotNull G gameObject, @NotNull Point pos, @NotNull InsertionMode<G, A, R> insertionMode);

    void moveEnv(@NotNull G gameObject, @NotNull Point pos, @NotNull G nextGameObject);

    void moveInv(@NotNull G gameObject, @NotNull GameObject<G, A, R> prevGameObject);

    @Nullable
    G insertBaseObject(@NotNull BaseObject<G, A, R, ?> baseObject, @NotNull Point pos, boolean allowMany, boolean join, @NotNull InsertionMode<G, A, R> insertionMode);

    @Nullable
    G insertArchToMap(@NotNull BaseObject<G, A, R, ?> templateBaseObject, @Nullable G nextGameObject, @NotNull Point pos, boolean join);

    void removeGameObject(@NotNull G gameObject, boolean join);

    boolean isMultiArchFittingToMap(@NotNull Archetype<G, A, R> archetype, @NotNull Point pos, boolean allowDouble);

    void setErrors(@NotNull ErrorCollector<G, A, R> errors);

    @NotNull
    ErrorCollector<G, A, R> getErrors();

    boolean isAreaEmpty(int left, int top, int width, int height);

    void addActiveEditType(int editType);

    void setMapFile(@Nullable MapFile mapFile);

    @Nullable
    MapFile getMapFile();

    @NotNull
    MapFile getMapFile(@NotNull MapPath mapPath) throws SameMapException, UnsavedMapException;

    @NotNull
    List<G> getAllGameObjects();

    boolean isModified();

    void resetModified();

    void facesReloaded();

    void nextPoint(Point point, int direction);

}