MapVisuals.H

Go to the documentation of this file.

/**************************************************************
 *      Name: Aldo Alejandro Avila (aavila)
 *      File: MapVisuals.H
 *      Asgn: visuals
 *      Date: Thu Mar 24 16:14:11 EST 2005
 **************************************************************/
/************************************************************** 
 * This class is the core of the mapVisuals for our program.  The
 * first method defined will only be used once, and it will be offline.
 * Once all the mapTile gifs have been created, the webGUI will be able
 * to call the other two methods to access both a visual and textual
 * description of the user's requested route 
 *  
 * - Testing Strategy -
 * All three methods will require the same type of testing strategy.  Using
 * dummy data passed in from a dummy db or webGUI, I will check to see if
 * my maps look how they are supposed to, my path follows the instructions and
 * lies correctly on top of the map, and my text description is correct.
 * -Due to limited amounts of time the dummy data testing will not be finished
 * until the end of spring break
 * -Dummy data testing should be complete by the end of spring break
 *  and ready for integration with the actuall database.  
 * -Middle of spring break, dummy data testing will start for draw route
 * -End of spring break (weekend), dummy data testing will start for text
 * description
 * -Integration with webGUI should commence the week after spring break is
 * is over.
 *************************************************************************/

#ifndef MapVisuals_Header
#define MapVisuals_Header

#include <iostream>
#include <string>
#include "BQStructs.H"
#include "qimage.h"

#include "MapGenerator.H"


using namespace std;

const int NOTHING = 0;
const int LEFT = 1;
const int RIGHT = 2;
const int UP = 3;
const int DOWN = 4;

class MapVisuals {

public:
  
  MapVisuals(DBInterface* db,bool tiles=false);
  virtual ~MapVisuals();
  
  /**********************************************************************
   * Since the TilesGeneration method isn't really called by another component
   * it doesn't really need to be shown on the interface.  Instead we will
   * have a method that returns true if the tiles have been generated.  If
   * its false then we know that the tiles haven't been made.
   *************************************************************************/
  bool areTilesGenerated();
  
  /**************************************************************************
   * PathDesc is a struct that is defined elsewhere in our program.  I will
   * use this struct to obtain graphical information from the database so
   * that I can draw out a path.  The zoom parameter will determine how big
   * this path must be drawn, in order to accommodate the map that is being
   * shown by the webGUI. I then draw this route on the tiles and return the
   * whole image to the webGUI.  For right now, I am returning a QImage, but
   * most likely that will change.
   *************************************************************************/
  string drawRoute(path_t* route, int dZoom=-1,int sX=0, int sY=0,int Pan=0,string routeID="");
  
  /************************************************************************* 
   * PathDesc is a struct that is defined elsewhere in our program.  Using
    * the struct, I am able to obtain intersection information that I can
   * then use to call getPath on the database.  Once I have obtained the
   * all the information, this method will create a string that will 
   * give the user instructions on how to get to their destination.
   *************************************************************************/
  string routeInstructions(path_t route);

  /**************************************************************************
   * Once a user clicks on a portion of the map, I am returned an x and y
   * coordinate.  Using the coordinates I check if the user clicked on a 
   * road and then return the streetSeg that the user clicked on
   *************************************************************************/
  seg_t streetHit(double x, double y);

protected:

private:
  MapGenerator* m_mGenerator;
  int m_argc;
  char* m_argv;
  DBInterface* m_db;
};

#endif

---