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 (C) 2001-2011 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 <map>
#include <fx.h>
#include <fx3d.h>
#include <utils/foxtools/MFXMutex.h>
#include <utils/geom/Boundary.h>
#include <utils/geom/Position.h>
#include <utils/common/RGBColor.h>
#include <utils/common/SUMOTime.h>
#include <utils/shapes/Polygon.h>
#include <utils/gui/globjects/GUIGlObjectTypes.h>
#include <foreign/rtree/SUMORTree.h>


// ===========================================================================
// class declarations
// ===========================================================================
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();

    void centerTo(GUIGlID id, bool applyZoom, SUMOReal zoomDist=20);

    void centerTo(const Boundary& bound);

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

    SUMOReal m2p(SUMOReal meter) const;

    SUMOReal p2m(SUMOReal pixel) const;

//    bool allowRotation() const;

    void setWindowCursorPosition(FXint x, FXint y);

    FXbool makeCurrent();

    bool isInEditMode();

    GUIPerspectiveChanger& getChanger() const {
        return *myChanger;
    }

    Boundary getVisibleBoundary() const;

    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);


    std::string makeSnapshot(const std::string& destFile);


    void checkSnapshots();

    virtual SUMOTime getCurrentTimeStep() const {
        return 0;
    }



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

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

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


    // @todo: check why this is here
    SUMOReal getGridWidth() const;
    // @todo: check why this is here
    SUMOReal getGridHeight() const;

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

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


    bool addAdditionalGLVisualisation(GUIGlObject* const which);


    bool removeAdditionalGLVisualisation(GUIGlObject* const which);


    void destroyPopup();


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();


    Position getPositionInformation() const;

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


    const GUIVisualizationSettings* getVisualisationSettings() {
        return myVisualizationSettings;
    }


protected:
    void paintGL();

    void updatePositionInformation() const;


    virtual int doPaintGL(int /*mode*/, const Boundary& /*boundary*/) {
        return 0;
    }

    virtual void doInit() { }

    void paintGLGrid();

    void displayLegend();


    GUIGlID getObjectUnderCursor();

    GUIGlID getObjectAtPosition(Position pos);

    std::vector<GUIGlID> getObjectsInBoundary(const Boundary& bound);

    void showToolTipFor(unsigned int id);


protected:
    void drawDecals();

    // applies gl-transformations to fit the Boundary given by myChanger onto
    // the canvas. If fixRatio is true, this boundary will be enlarged to
    // prevent anisotropic stretching. (this should be set to false when doing
    // selections)
    void applyGLTransform(bool fixRatio=true);

protected:
    GUIMainWindow* myApp;

    GUIGlChildWindow* myParent;

    SUMORTree* myGrid;

    GUIPerspectiveChanger* myChanger;

    bool myInEditMode;

    FXint myWindowCursorPositionX, myWindowCursorPositionY;

    int myMouseHotspotX, myMouseHotspotY;

    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;

    std::map<GUIGlObject*, int> myAdditionallyDrawn;


protected:
    GUISUMOAbstractView() { }

};


#endif

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