PathFinder.h

#ifndef PathFinder_h
#define PathFinder_h

#include <string>

class Maze;

enum MouseMovement {
    MoveForward,            // Move in the direction mouse is facing
    MoveBackward,           // Move opposite of the direction mouse is facing
    TurnClockwise,          // Self explanatory
    TurnCounterClockwise,   // Self explanatory
    TurnAround,             // Face the opposite direction currently facing
    Wait,                   // Do nothing this time, do some computation, then try again later
    Finish                  // Mouse has achieved goals and is ending the simulation
};

class PathFinder {
public:
    virtual ~PathFinder() {}

    /**
     * Function that instructs the maze how to move the mouse.
     *
     * The PathFinder subclass has complete control of where the mouse
     * goes at all times, and the loop will be broken when this method
     * returns MouseMovement::Finish.
     *
     * Implement this method in your subclass (and other methods) for your path finding.
     *
     * @param x: current column of the mouse (0 is the left-most side of the maze)
     * @param y: current row of the mouse (0 is bottom of the maze)
     * @param maze: the maze object that can be queried for current wall positions
     */
    virtual MouseMovement nextMovement(unsigned x, unsigned y, const Maze &maze) = 0;

    /**
     * Function used to draw extra info on the maze.
     *
     * When drawing, the maze will call this method and will insert up to maxInfoLen
     * characters from the return value into the drawn result. This is useful for
     * visually debugging your algorithm (e.g. returning distances to center for each cell).
     *
     * @param x: column of current cell to draw (0 is left-most side of maze)
     * @param y: row of current cell to draw (0 is bottom of the maze)
     * @param maxInfoLen: number of characters to be inserted per cell. Rest of returned characters are ignored.
     * @return string of info
     */
    virtual std::string getInfo(unsigned x, unsigned y, size_t maxInfoLen) {
        (void)x;
        (void)y;
        (void)maxInfoLen;
        return "";
    }
};

#endif