GUIMainWindow.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
//
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/foxtools/fxheader.h>
#include <vector>
#include <string>
#include <map>
#include <utils/common/StdDefs.h>
#include <utils/common/SUMOTime.h>
#include "GUIAppEnum.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUIEvent;
class GUIGlChildWindow;
class GUISUMOAbstractView;
class MFXStaticToolTip;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUIMainWindow : public FXMainWindow {
 
public:
    GUIMainWindow(FXApp* app);
 
    virtual ~GUIMainWindow();
 
    void addGLChild(GUIGlChildWindow* child);
 
    void addChild(FXMainWindow* child);
 
    void removeGLChild(GUIGlChildWindow* child);
 
    void removeChild(FXMainWindow* child);
 
    FXDockSite* getTopDock();
 
    std::vector<std::string> getViewIDs() const;
 
    GUIGlChildWindow* getViewByID(const std::string& id) const;
 
    void removeViewByID(const std::string& id);
 
    const std::vector<GUIGlChildWindow*>& getViews() const;
 
    void updateChildren(int msg = MID_SIMSTEP);
 
    FXFont* getBoldFont();
 
    FXFont* getFallbackFont();
 
    FXGLVisual* getGLVisual() const;
 
    MFXStaticToolTip* getStaticTooltipMenu() const;
 
    MFXStaticToolTip* getStaticTooltipView() const;
 
    virtual FXGLCanvas* getBuildGLCanvas() const = 0;
 
    virtual SUMOTime getCurrentSimTime() const = 0;
 
    virtual double getTrackerInterval() const = 0;
 
    virtual void setStatusBarText(const std::string&) { }
 
    FXLabel* getCartesianLabel();
 
    FXLabel* getGeoLabel();
 
    FXLabel* getTestLabel();
 
    FXHorizontalFrame* getTestFrame();
 
    bool isGaming() const;
 
    bool listInternal() const;
 
    bool listParking() const;
 
    bool listTeleporting() const;
 
    static GUIMainWindow* getInstance();
 
    virtual double getDelay() const {
        return 0.;
    }
 
    virtual void setDelay(double) {}
 
    virtual void setBreakpoints(const std::vector<SUMOTime>&) {}
 
    virtual void sendBlockingEvent(GUIEvent* event) {
        UNUSED_PARAMETER(event);
    }
 
    GUISUMOAbstractView* getActiveView() const;
 
    virtual long onCmdFullScreen(FXObject*, FXSelector, void*) {
        return 1;
    }
 
    bool isFullScreen() {
        return myAmFullScreen;
    }
 
    const std::map<std::string, std::string>& getOnlineMaps() const {
        return myOnlineMaps;
    }
 
    void addOnlineMap(const std::string& name, const std::string& url) {
        myOnlineMaps[name] = url;
    }
 
    virtual void addBreakpoint(SUMOTime /* time */) {}
 
    virtual const std::vector<SUMOTime> retrieveBreakpoints() const {
        return std::vector<SUMOTime>();
    }
 
    // @brief called when changes language
    long onCmdChangeLanguage(FXObject*, FXSelector, void*);
 
    // @brief called when language is updated
    long onUpdChangeLanguage(FXObject*, FXSelector, void*);
 
protected:
    FOX_CONSTRUCTOR(GUIMainWindow)
 
    
    bool myAmFullScreen;
 
    std::vector<GUIGlChildWindow*> myGLWindows;
 
    std::vector<FXMainWindow*> myTrackerWindows;
 
    FXMutex myTrackerLock;
 
    FXFont* myBoldFont = nullptr;
 
    FXFont* myFallbackFont = nullptr;
 
    FXMDIClient* myMDIClient = nullptr;
 
    FXStatusBar* myStatusbar = nullptr;
 
    FXLabel* myCartesianCoordinate = nullptr;
    FXLabel* myGeoCoordinate = nullptr;
    FXLabel* myTestCoordinate = nullptr;
 
    FXHorizontalFrame* myTraCiFrame = nullptr;
    FXHorizontalFrame* myCartesianFrame = nullptr;
    FXHorizontalFrame* myGeoFrame = nullptr;
    FXHorizontalFrame* myTestFrame = nullptr;
 
    FXGLVisual* myGLVisual = nullptr;
 
    FXDockSite* myTopDock = nullptr;
    FXDockSite* myBottomDock = nullptr;
    FXDockSite* myLeftDock = nullptr;
    FXDockSite* myRightDock = nullptr;
 
    FXMenuPane* myLanguageMenu = nullptr;
 
    MFXStaticToolTip* myStaticTooltipMenu = nullptr;
 
    MFXStaticToolTip* myStaticTooltipView = nullptr;
 
    bool myAmGaming;
 
    bool myListInternal;
 
    bool myListParking;
 
    bool myListTeleporting;
 
    std::map<std::string, std::string> myOnlineMaps;
 
    static GUIMainWindow* myInstance;
 
    void setWindowSizeAndPos();
 
    void storeWindowSizeAndPos();
 
    void buildLanguageMenu(FXMenuBar* menuBar);
 
};