package ch.epfl.maze.physical;

import ch.epfl.maze.util.Direction;
import ch.epfl.maze.util.Vector2D;

import java.util.List;

/**
 * World that is represented by a labyrinth of tiles in which an {@code Animal}
 * can move.
 */

public abstract class World {

    /* tiles constants */
    public static final int FREE = 0;
    public static final int WALL = 1;
    public static final int START = 2;
    public static final int EXIT = 3;
    public static final int NOTHING = -1;

    /**
     * Constructs a new world with a labyrinth. The labyrinth must be rectangle.
     *
     * @param labyrinth Structure of the labyrinth, an NxM array of tiles
     */

    public World(int[][] labyrinth) {
        // TODO
    }

    /**
     * Determines whether the labyrinth has been solved by every animal.
     *
     * @return <b>true</b> if no more moves can be made, <b>false</b> otherwise
     */

    abstract public boolean isSolved();

    /**
     * Resets the world as when it was instantiated.
     */

    abstract public void reset();

    /**
     * Returns a copy of the list of all current animals in the world.
     *
     * @return A list of all animals in the world
     */

    abstract public List<Animal> getAnimals();

    /**
     * Checks in a safe way the tile number at position (x, y) in the labyrinth.
     *
     * @param x Horizontal coordinate
     * @param y Vertical coordinate
     * @return The tile number at position (x, y), or the NONE tile if x or y is
     * incorrect.
     */

    public final int getTile(int x, int y) {
        // TODO
        return 0;
    }

    /**
     * Determines if coordinates are free to walk on.
     *
     * @param x Horizontal coordinate
     * @param y Vertical coordinate
     * @return <b>true</b> if an animal can walk on tile, <b>false</b> otherwise
     */

    public final boolean isFree(int x, int y) {
        // TODO
        return false;
    }

    /**
     * Computes and returns the available choices for a position in the
     * labyrinth. The result will be typically used by {@code Animal} in
     * {@link ch.epfl.maze.physical.Animal#move(Direction[]) move(Direction[])}
     *
     * @param position A position in the maze
     * @return An array of all available choices at a position
     */

    public final Direction[] getChoices(Vector2D position) {
        // TODO
        return null;
    }

    /**
     * Returns horizontal length of labyrinth.
     *
     * @return The horizontal length of the labyrinth
     */

    public final int getWidth() {
        // TODO
        return 0;
    }

    /**
     * Returns vertical length of labyrinth.
     *
     * @return The vertical length of the labyrinth
     */

    public final int getHeight() {
        // TODO
        return 0;
    }

    /**
     * Returns the entrance of the labyrinth at which animals should begin when
     * added.
     *
     * @return Start position of the labyrinth, null if none.
     */

    public final Vector2D getStart() {
        // TODO
        return null;
    }

    /**
     * Returns the exit of the labyrinth at which animals should be removed.
     *
     * @return Exit position of the labyrinth, null if none.
     */

    public final Vector2D getExit() {
        // TODO
        return null;
    }
}