GUISUMOAbstractView.h

Go to the documentation of this file.

/****************************************************************************/
// The base class for a view
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2016 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO 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 3 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>
// fx3d includes windows.h so we need to guard against macro pollution
#ifdef WIN32
#define NOMINMAX
#endif
#include <fx3d.h>
#ifdef WIN32
#undef NOMINMAX
#endif

#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&) { }

    virtual void recenterView();

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

    void centerTo(const Boundary& bound);

    virtual void setViewport(const Position& lookFrom, const Position& lookAt);

    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;

    Boundary getVisibleBoundary() const;


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


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

    //@brief open object dialog
    virtual void openObjectDialog();

    void updateToolTip();


    void setSnapshots(std::map<SUMOTime, std::string> snaps);

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

    virtual void saveFrame(const std::string& destFile, FXColor* buf);

    virtual void endSnapshot() {}

    virtual void checkSnapshots();

    virtual SUMOTime getCurrentTimeStep() const;

    GUIDialog_EditViewport* getViewportEditor();

    virtual void showViewportEditor();

    void showViewschemeEditor();

    void showToolTips(bool val);

    virtual bool setColorScheme(const std::string&);

    GUIVisualizationSettings* getVisualisationSettings() const;

    void remove(GUIDialog_EditViewport*);

    void remove(GUIDialog_ViewSettings*);

    // @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;

    virtual void onGamingClick(Position /*pos*/);


    bool addAdditionalGLVisualisation(const GUIGlObject* const which);

    bool removeAdditionalGLVisualisation(const GUIGlObject* const which);

    bool isAdditionalGLVisualisationEnabled(GUIGlObject* const which) const;

    void destroyPopup();

public:
    struct Decal {
        Decal();

        std::string filename;
        SUMOReal centerX;
        SUMOReal centerY;
        SUMOReal centerZ;
        SUMOReal width;
        SUMOReal height;
        SUMOReal altitude;
        SUMOReal rot;
        SUMOReal tilt;
        SUMOReal roll;
        SUMOReal layer;
        bool initialised;
        bool skip2D;
        int glID;
        FXImage* image;
    };

public:
    FXComboBox& getColoringSchemesCombo();

    Position getPositionInformation() const;

    void addDecals(const std::vector<Decal>& decals);

    GUIVisualizationSettings* getVisualisationSettings();

    SUMOReal getDelay() const;

    void setDelay(SUMOReal delay);

protected:
    void paintGL();

    void updatePositionInformation() const;

    virtual int doPaintGL(int /*mode*/, const Boundary& /*boundary*/);

    virtual void doInit();

    void paintGLGrid();

    void displayLegend();

    GUIGlID getObjectUnderCursor();

    GUIGlID getObjectAtPosition(Position pos);

    std::vector<GUIGlID> getObjectsAtPosition(Position pos, SUMOReal radius);

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

    void showToolTipFor(unsigned int id);

protected:
    FXImage* checkGDALImage(Decal& d);

    void drawDecals();

    void applyGLTransform(bool fixRatio = true);

protected:
    GUIMainWindow* myApp;

    GUIGlChildWindow* myParent;

    SUMORTree* myGrid;

    GUIPerspectiveChanger* myChanger;

    bool myInEditMode;

    int myMouseHotspotX, myMouseHotspotY;

    GUIGLObjectPopupMenu* myPopup;

    GUIVisualizationSettings* myVisualizationSettings;

    bool myUseToolTips;

    bool myAmInitialised;

    GUIDialog_EditViewport* myViewportChooser;

    FXint myWindowCursorPositionX, myWindowCursorPositionY;

    GUIDialog_ViewSettings* myVisualizationChanger;

    std::vector<Decal> myDecals;

    MFXMutex myDecalsLock;

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

    mutable MFXMutex myPolyDrawLock;

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

protected:
    GUISUMOAbstractView() { }
};


#endif

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