GUISUMOAbstractView.h

Go to the documentation of this file.

/****************************************************************************/
// The base class for a view
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright 2001-2010 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   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.
//
/****************************************************************************/
#ifndef GUISUMOAbstractView_h
#define GUISUMOAbstractView_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <vector>
#include <fx.h>
#include <fx3d.h>
#include <utils/geom/Boundary.h>
#include <utils/geom/Position2D.h>
#include <utils/common/RGBColor.h>
#include <utils/common/SUMOTime.h>
#include <utils/shapes/Polygon2D.h>
#include <utils/gui/globjects/GUIGlObjectTypes.h>
#include <utils/foxtools/MFXMutex.h>
#include <foreign/rtree/SUMORTree.h>

#ifdef _WIN32
#include <windows.h>
#include <GL/gl.h>
#endif


// ===========================================================================
// class declarations
// ===========================================================================
class GUIGLObjectToolTip;
class GUIGlChildWindow;
class GUIVehicle;
class GUIPerspectiveChanger;
class GUIMainWindow;
class GUIGLObjectPopupMenu;
class GUIGlObject;
class GUIDialog_EditViewport;
class GUIDialog_ViewSettings;
class GUIVisualizationSettings;



// ===========================================================================
// class definitions
// ===========================================================================
class GUISUMOAbstractView : public FXGLCanvas {
    FXDECLARE(GUISUMOAbstractView)
public:
    GUISUMOAbstractView(FXComposite *p, GUIMainWindow &app,
                        GUIGlChildWindow *parent, const SUMORTree &grid,
                        FXGLVisual *glVis, FXGLCanvas *share);

    virtual ~GUISUMOAbstractView();

    virtual void buildViewToolBars(GUIGlChildWindow &) { }

    void recenterView();

    virtual void centerTo(const GUIGlObject * const o) throw();

    virtual void setViewport(SUMOReal zoom, SUMOReal xPos, SUMOReal yPos);

    SUMOReal m2p(SUMOReal meter);

    SUMOReal p2m(SUMOReal pixel);

//    bool allowRotation() const;

    void setWindowCursorPosition(FXint x, FXint y);

    FXbool makeCurrent();

    bool isInEditMode();



    long onConfigure(FXObject*,FXSelector,void*);
    long onPaint(FXObject*,FXSelector,void*);
    virtual long onLeftBtnPress(FXObject*,FXSelector,void*);
    virtual long onLeftBtnRelease(FXObject*,FXSelector,void*);
    virtual long onRightBtnPress(FXObject*,FXSelector,void*);
    virtual long onRightBtnRelease(FXObject*,FXSelector,void*);
    virtual long onMouseWheel(FXObject*,FXSelector,void*);
    virtual long onMouseMove(FXObject*,FXSelector,void*);
    virtual long onMouseLeft(FXObject*,FXSelector,void*);

    long onKeyPress(FXObject *o,FXSelector sel,void *data);
    long onKeyRelease(FXObject *o,FXSelector sel,void *data);


    virtual void openObjectDialog();

    void updateToolTip();

    void setSnapshots(std::map<SUMOTime, std::string> snaps);
    FXColor *getSnapshot();
    void checkSnapshots();

    void showViewportEditor();
    virtual void showViewschemeEditor() = 0;
    void showToolTips(bool val);
    virtual void setColorScheme(const std::string &) { }

    void remove(GUIDialog_EditViewport *) {
        myViewportChooser = 0;
    }

    void remove(GUIDialog_ViewSettings *) {
        myVisualizationChanger = 0;
    }


    SUMOReal getGridWidth() const;
    SUMOReal getGridHeight() const;

    virtual void showRoute(GUIVehicle * /*v*/, int /*index=-1*/) throw() { }

    virtual void showBestLanes(GUIVehicle * /*v*/) { }

    virtual void hideRoute(GUIVehicle * /*v*/, int index=-1) throw() { }

    virtual void hideBestLanes(GUIVehicle * /*v*/) { }

    virtual void startTrack(int /*id*/) { }
    virtual void stopTrack() { }
    virtual int getTrackedID() const {
        return -1;
    }


    virtual bool amShowingRouteFor(GUIVehicle * /*v*/, int /*index=-1*/) throw() {
        return false;
    }

    virtual bool amShowingBestLanesFor(GUIVehicle * /*v*/) {
        return false;
    }

    virtual void onGamingClick(Position2D /*pos*/) { }

public:
    enum JunctionColoringScheme {
        VCS_BY_TYPE = 0
    };


    struct Decal {
        Decal()
                : filename(), centerX(0), centerY(0),
                width(1000), height(1000), rot(0),
                initialised(false), glID(-1) { }

        std::string filename;
        SUMOReal centerX;
        SUMOReal centerY;
        SUMOReal width;
        SUMOReal height;
        SUMOReal rot;
        bool initialised;
        int glID;
    };


public:
    FXComboBox &getColoringSchemesCombo();

    Position2D getPositionInformation() const;

    void addDecals(const std::vector<Decal> &decals) throw() {
        myDecals.insert(myDecals.end(), decals.begin(), decals.end());
    }


protected:

    void paintGL();

    void updatePositionInformation() const;

    Position2D getPositionInformation(int x, int y) const;

    virtual int doPaintGL(int /*mode*/, SUMOReal /*scale*/) {
        return 0;
    }

    virtual void doInit() { }

    void paintGLGrid();

    void applyChanges(SUMOReal scale, size_t xoff, size_t yoff);

    void displayLegend() throw();


    void centerTo(Boundary bound);

    unsigned int getObjectUnderCursor();

    void showToolTipFor(unsigned int id);

protected:
    void drawDecals() throw();

protected:
    double myX1, myY1;
    double myCX, myCY;


    GUIMainWindow *myApp;

    GUIGlChildWindow *myParent;

    SUMORTree *myGrid;

    int myWidthInPixels, myHeightInPixels;

    SUMOReal myNetScale;

    GUIPerspectiveChanger *myChanger;

    bool myInEditMode;

    GUIGLObjectToolTip *myToolTip;

    FXint myWindowCursorPositionX, myWindowCursorPositionY;

    int myMouseHotspotX, myMouseHotspotY;

    SUMOReal myRatio;

    SUMOReal myAddScl;

    GUIGLObjectPopupMenu *myPopup;

    GUIVisualizationSettings *myVisualizationSettings;

    bool myUseToolTips;

    bool myAmInitialised;


    GUIDialog_EditViewport *myViewportChooser;
    GUIDialog_ViewSettings *myVisualizationChanger;


    std::vector<Decal> myDecals;

    MFXMutex myDecalsLock;

    std::map<SUMOTime, std::string> mySnapshots;

    mutable MFXMutex myPolyDrawLock;

    enum VehicleOperationType {
        VO_TRACK,
        VO_SHOW_BEST_LANES,
        VO_SHOW_ROUTE
    };

    struct VehicleOps {
        VehicleOperationType type;
        GUIVehicle *vehicle;
        int routeNo;
    };

    std::vector<VehicleOps> myVehicleOps;

    class vehicle_in_ops_finder {
    public:
        explicit vehicle_in_ops_finder(const GUIVehicle * const v)
                : myVehicle(v) { }

        bool operator()(const VehicleOps &vo) {
            return vo.vehicle == myVehicle;
        }

    private:
        const GUIVehicle * const myVehicle;

    };

protected:
    GUISUMOAbstractView() { }

};


#endif

/****************************************************************************/