GUIApplicationWindow.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
/****************************************************************************/
// The main window of the SUMO-gui.
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/foxtools/MFXRecentNetworks.h>
#include <utils/foxtools/MFXInterThreadEventClient.h>
#include <utils/gui/windows/GUIMainWindow.h>
 
#include "GUISUMOViewParent.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class Command;
class GUILoadThread;
class GUIRunThread;
class GUIMessageWindow;
class GUIEvent;
class GUIParameterTracker;
class GUIParameterTableWindow;
class GUIDialog_Breakpoints;
class MFXLCDLabel;
class MFXLabelTooltip;
 
 
// ===========================================================================
// class definition
// ===========================================================================
class GUIApplicationWindow : public GUIMainWindow, public MFXInterThreadEventClient {
    // FOX-declarations
    FXDECLARE(GUIApplicationWindow)
 
public:
    GUIApplicationWindow(FXApp* a, const std::string& configPattern);
 
    virtual ~GUIApplicationWindow();
 
 
    virtual void create();
 
    virtual void detach();
 
 
    void loadOnStartup(const bool wait = false);
 
    GUIRunThread* getRunner();
 
    void dependentBuild(const bool isLibsumo);
 
    void setStatusBarText(const std::string& text);
 
    void addRecentNetwork(const FX::FXString& f);
 
    void addRecentConfig(const FX::FXString& f);
 
    FXGLCanvas* getBuildGLCanvas() const;
 
    SUMOTime getCurrentSimTime() const;
 
    double getTrackerInterval() const;
 
    FXCursor* getDefaultCursor();
 
 
    virtual void eventOccurred();
 
    void handleEvent_SimulationLoaded(GUIEvent* e);
 
    void handleEvent_SimulationStep(GUIEvent* e);
 
    void handleEvent_Message(GUIEvent* e);
 
    void handleEvent_SimulationEnded(GUIEvent* e);
 
 
 
    long onCmdNewWindow(FXObject*, FXSelector, void*);
 
    long onCmdOpenConfiguration(FXObject*, FXSelector, void*);
 
    long onCmdOpenNetwork(FXObject*, FXSelector, void*);
 
    long onCmdOpenShapes(FXObject*, FXSelector, void*);
 
    long onCmdOpenEdgeData(FXObject*, FXSelector, void*);
 
    long onCmdReload(FXObject*, FXSelector, void*);
 
    long onCmdQuickReload(FXObject*, FXSelector, void*);
 
    long onCmdOpenRecent(FXObject*, FXSelector, void*);
 
    long onCmdSaveConfig(FXObject*, FXSelector, void*);
 
    long onCmdClose(FXObject*, FXSelector, void*);
 
    long onCmdQuit(FXObject*, FXSelector, void*);
 
    long onCmdEditChosen(FXObject*, FXSelector, void*);
 
    long onCmdEditBreakpoints(FXObject*, FXSelector, void*);
 
    long onCmdEditViewScheme(FXObject*, FXSelector, void*);
 
    long onCmdEditViewport(FXObject*, FXSelector, void*);
 
    long onCmdHelp(FXObject* sender, FXSelector sel, void* ptr);
 
    long onCmdChangelog(FXObject* sender, FXSelector sel, void* ptr);
 
    long onCmdHotkeys(FXObject* sender, FXSelector sel, void* ptr);
 
    long onCmdTutorial(FXObject* sender, FXSelector sel, void* ptr);
 
    long onCmdOpenInNetedit(FXObject*, FXSelector, void*);
 
    long onCmdAppSettings(FXObject*, FXSelector, void*);
 
    long onCmdGaming(FXObject*, FXSelector, void*);
 
    long onCmdToggleDrawJunctionShape(FXObject*, FXSelector, void*);
 
    long onCmdToggleSecondaryShape(FXObject*, FXSelector, void*);
 
    long onCmdFullScreen(FXObject*, FXSelector, void*);
 
    long onCmdListInternal(FXObject*, FXSelector, void*);
 
    long onCmdListParking(FXObject*, FXSelector, void*);
 
    long onCmdListTeleporting(FXObject*, FXSelector, void*);
 
    long onCmdFeedback(FXObject*, FXSelector, void*);
 
    long onCmdAbout(FXObject*, FXSelector, void*);
 
    long onCmdHallOfFame(FXObject*, FXSelector, void*);
 
    long onCmdStart(FXObject*, FXSelector, void*);
 
    long onCmdStop(FXObject*, FXSelector, void*);
 
    long onCmdStep(FXObject*, FXSelector, void*);
 
    long onCmdSaveState(FXObject*, FXSelector, void*);
 
    long onCmdLoadState(FXObject*, FXSelector, void*);
 
    long onCmdTimeToggle(FXObject*, FXSelector, void*);
 
    long onCmdDelayInc(FXObject*, FXSelector, void*);
 
    long onCmdDelayDec(FXObject*, FXSelector, void*);
 
    long onCmdDelayToggle(FXObject*, FXSelector, void*);
 
    long onCmdDemandScale(FXObject*, FXSelector, void*);
 
    long onCmdNewView(FXObject*, FXSelector, void*);
 
#ifdef HAVE_OSG
    long onCmdNewOSG(FXObject*, FXSelector, void*);
#endif
 
    long onUpdOpen(FXObject*, FXSelector, void*);
 
    long onUpdReload(FXObject*, FXSelector, void*);
 
    long onUpdOpenRecent(FXObject*, FXSelector, void*);
 
    long onUpdAddView(FXObject*, FXSelector, void*);
 
    long onUpdStart(FXObject* sender, FXSelector, void* ptr);
 
    long onUpdStop(FXObject*, FXSelector, void*);
 
    long onUpdStep(FXObject*, FXSelector, void*);
 
    long onUpdNeedsNetwork(FXObject*, FXSelector, void*);
 
    long onUpdNeedsSumoConfig(FXObject*, FXSelector, void*);
 
    long onUpdTraCIStatus(FXObject*, FXSelector, void*);
 
    long onCmdClearMsgWindow(FXObject*, FXSelector, void*);
 
    long onCmdBreakpoint(FXObject*, FXSelector, void*);
 
    long onCmdBreakpointEarly(FXObject*, FXSelector, void*);
 
    long onCmdLocate(FXObject*, FXSelector, void*);
 
    long onCmdShowStats(FXObject*, FXSelector, void*);
 
    long onLoadThreadEvent(FXObject*, FXSelector, void*);
 
    long onRunThreadEvent(FXObject*, FXSelector, void*);
 
    long onClipboardRequest(FXObject* sender, FXSelector sel, void* ptr);
 
    long onKeyPress(FXObject* o, FXSelector sel, void* data);
 
    long onKeyRelease(FXObject* o, FXSelector sel, void* data);
 
 
    virtual double getDelay() const;
 
    virtual void setDelay(double delay);
 
    virtual void setBreakpoints(const std::vector<SUMOTime>& breakpoints);
 
    void addBreakpoint(SUMOTime time);
 
    virtual void sendBlockingEvent(GUIEvent* event);
 
    const std::vector<SUMOTime> retrieveBreakpoints() const;
 
    void eraseBreakpointDialog();
 
    void addHotkey(int key, Command* press, Command* release);
 
protected:
    FOX_CONSTRUCTOR(GUIApplicationWindow)
 
    
    virtual void addToWindowsMenu(FXMenuPane* menuPane);
 
    virtual void fillMenuBar();
 
    virtual void buildToolBars();
 
    void buildRecentNetworks(FXMenuPane* fileMenu, FXMenuPane* fileMenuRecentNetworks);
 
    void buildRecentConfigs(FXMenuPane* fileMenu, FXMenuPane* fileMenuRecentConfigs);
 
    std::string myName;
 
    GUILoadThread* myLoadThread = nullptr;
 
    GUIRunThread* myRunThread = nullptr;
 
    bool myWasStarted = false;
 
    int myViewNumber;
 
    bool myAmLoading = false;
 
    bool myIsReload = false;
 
    long long  myGuiSettingsFileMTime = -2;
 
    FXMenuPane* myFileMenu = nullptr,
                *myEditMenu = nullptr,
                 *mySelectByPermissions = nullptr,
                  *mySettingsMenu = nullptr,
                   *myLocatorMenu = nullptr,
                    *myControlMenu = nullptr,
                     *myWindowMenu = nullptr,
                      *myHelpMenu = nullptr;
 
    FXMenuPane* myFileMenuRecentNetworks = nullptr;
 
    FXMenuPane* myFileMenuRecentConfigs = nullptr;
 
    FXMenuCascade* mySelectLanesMenuCascade = nullptr;
 
    FXMenuCheck* myLoadAdditionalsInNetedit = nullptr;
 
    FXMenuCheck* myLoadDemandInNetedit = nullptr;
 
    FXMenuCommand* myOpenInNetedit = nullptr;
 
    std::vector<FXButton*> myStatButtons;
 
    GUIMessageWindow* myMessageWindow = nullptr;
 
    FXSplitter* myMainSplitter = nullptr;
 
    FXToolBarShell* myToolBarDrag1 = nullptr,
                    *myToolBarDrag2 = nullptr,
                     *myToolBarDrag3 = nullptr,
                      *myToolBarDrag4 = nullptr,
                       *myToolBarDrag5 = nullptr,
                        *myMenuBarDrag = nullptr,
                         *myToolBarDrag8 = nullptr;
 
    double mySimDelay = 0.;
 
    FXDataTarget* mySimDelayTarget = nullptr;
 
    FXRealSpinner* mySimDelaySpinner = nullptr;
 
    FXSlider* mySimDelaySlider = nullptr;
 
    MFXLabelTooltip* myScaleTrafficTooltip = nullptr;
 
    FXRealSpinner* myDemandScaleSpinner = nullptr;
 
    double myAlternateSimDelay = 0;
 
    MFXSynchQue<GUIEvent*> myEvents;
 
    FXMDIMenu* myMDIMenu = nullptr;
 
    FXMenuBar* myMenuBar = nullptr;
 
    FXToolBar* myToolBar1 = nullptr,
               *myToolBar2 = nullptr,
                *myToolBar3 = nullptr,
                 *myToolBar4 = nullptr,
                  *myToolBar5 = nullptr,
                   *myToolBar8 = nullptr;
 
    MFXLCDLabel* myLCDLabel = nullptr;
 
    FXEX::MFXThreadEvent myLoadThreadEvent;
 
    FXEX::MFXThreadEvent myRunThreadEvent;
 
    MFXRecentNetworks myRecentNetworks;
 
    MFXRecentNetworks myRecentConfigs;
 
    std::string myConfigPattern;
 
    bool hadDependentBuild = false;
 
    bool myShowTimeAsHMS = false;
 
    bool myHaveNotifiedAboutSimEnd = false;
 
    FXMutex myEventMutex;
 
    FXCondition myEventCondition;
 
    FXMenuCheck* myGamingModeCheckbox;
 
 
    RandomDistributor<std::string> myJamSounds;
 
    RandomDistributor<std::string> myCollisionSounds;
 
    double myJamSoundTime = 60;
 
    static std::mt19937 myGamingRNG;
 
    int myPreviousCollisionNumber = 0;
 
    bool myTLSGame = false;
 
    MFXLCDLabel* myWaitingTimeLabel = nullptr;
 
    SUMOTime myWaitingTime = 0;
 
    MFXLCDLabel* myTimeLossLabel = nullptr;
 
    SUMOTime myTimeLoss = 0;
 
    MFXLCDLabel* myTotalDistanceLabel = nullptr;
 
    double myTotalDistance = 0;
 
    MFXLCDLabel* myEmergencyVehicleLabel = nullptr;
 
    SUMOTime myEmergencyVehicleCount = 0;
 
    FXToolBar* myToolBar6 = nullptr,
               *myToolBar7 = nullptr,
                *myToolBar9 = nullptr,
                 *myToolBar10 = nullptr;
 
    FXToolBarShell* myToolBarDrag6 = nullptr,
                    *myToolBarDrag7 = nullptr,
                     *myToolBarDrag9 = nullptr,
                      *myToolBarDrag10 = nullptr;
 
    long myLastStepEventMillis;
 
    std::map<int, Command*> myHotkeyPress;
 
    std::map<int, Command*> myHotkeyRelease;
 
    GUIDialog_Breakpoints* myBreakpointDialog = nullptr;
 
private:
    void loadConfigOrNet(const std::string& file);
 
    void closeAllWindows();
 
    void updateTimeLCD(SUMOTime time);
 
    void updateTimeLCDTooltip();
 
    GUISUMOAbstractView* openNewView(GUISUMOViewParent::ViewType vt = GUISUMOViewParent::VIEW_2D_OPENGL, std::string caption = "");
 
    void checkGamingEvents();
 
    void checkGamingEventsDRT();
 
    GUIApplicationWindow(const GUIApplicationWindow& s) = delete;
 
    GUIApplicationWindow& operator=(const GUIApplicationWindow& s) = delete;
};