GUISUMOAbstractView.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// The base class for a view
/****************************************************************************/
#ifndef GUISUMOAbstractView_h
#define GUISUMOAbstractView_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#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/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, double zoomDist = 20);

    void centerTo(const Boundary& bound);

    virtual void setViewportFromToRot(const Position& lookFrom, const Position& lookAt, double rotation);

    virtual void copyViewportTo(GUISUMOAbstractView* view);

    double m2p(double meter) const;

    double p2m(double 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 addSnapshot(SUMOTime time, const std::string& file, const int width = -1, const int height = -1);

    std::string makeSnapshot(const std::string& destFile, const int width = -1, const int height = -1);

    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;

    virtual void buildColorRainbow(GUIColorScheme& /*scheme*/, int /*active*/, GUIGlObjectType /*objectType*/) { }

    void remove(GUIDialog_EditViewport*);

    void remove(GUIDialog_ViewSettings*);

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

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

    virtual void startTrack(int /*id*/);

    virtual void stopTrack();

    virtual GUIGlID 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;

    const Position& getPopupPosition() const;

    void destroyPopup();

    void setApplicationSnapshots(std::set<SUMOTime>* snapshots, FXMutex* lock) {
        myApplicationSnapshots = snapshots;
        myApplicationSnapshotsLock = lock;
    }

public:
    struct Decal {
        Decal();

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

public:
    FXComboBox& getColoringSchemesCombo();

    Position getPositionInformation() const;

    Position snapToActiveGrid(const Position& pos) const;

    Position screenPos2NetPos(int x, int y) const;

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

    GUIVisualizationSettings* getVisualisationSettings();

    double getDelay() const;

    void setDelay(double delay);

    virtual const std::vector<SUMOTime> retrieveBreakpoints() const {
        return std::vector<SUMOTime>();
    }

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, double radius);

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

    void showToolTipFor(const GUIGlID id);

protected:
    FXImage* checkGDALImage(Decal& d);

    void drawDecals();

    Boundary applyGLTransform(bool fixRatio = true);

protected:
    GUIMainWindow* myApp;

    GUIGlChildWindow* myParent;

    SUMORTree* myGrid;

    GUIPerspectiveChanger* myChanger;

    bool myInEditMode;

    int myMouseHotspotX, myMouseHotspotY;

    GUIGLObjectPopupMenu* myPopup;

    Position myPopupPosition;

    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::vector<std::tuple<std::string, int, int> > > mySnapshots;
    std::set<SUMOTime>* myApplicationSnapshots;

    MFXMutex mySnapshotsLock;
    FXMutex* myApplicationSnapshotsLock;

    mutable MFXMutex myPolyDrawLock;

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

protected:
    GUISUMOAbstractView() { }
};


#endif

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