GNEViewNet.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
/****************************************************************************/
// A view on the network being edited (adapted from GUIViewTraffic)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/gui/windows/GUISUMOAbstractView.h>
 
#include "GNEViewNetHelper.h"
 
 
// ===========================================================================
// class declaration
// ===========================================================================
class GNEFrame;
class GNENet;
class GNEUndoList;
class GNEViewParent;
 
// ===========================================================================
// class definitions
// ===========================================================================
class GNEViewNet : public GUISUMOAbstractView {
    FXDECLARE(GNEViewNet)
 
    
    friend struct GNEViewNetHelper;
 
public:
    /* @brief constructor
     * @param[in] tmpParent temporal FXFrame parent so that we can add items to view area in the desired order
     * @param[in] actualParent FXFrame parent of GNEViewNet
     * @param[in] app main windows
     * @param[in] viewParent viewParent of this viewNet
     * @param[in] net traffic net
     * @param[in] undoList pointer to UndoList module
     * @param[in] glVis a reference to GLVisuals
     * @param[in] share a reference to FXCanvas
     */
    GNEViewNet(FXComposite* tmpParent, FXComposite* actualParent, GUIMainWindow& app,
               GNEViewParent* viewParent, GNENet* net, GNEUndoList* undoList,
               FXGLVisual* glVis, FXGLCanvas* share);
 
    ~GNEViewNet();
 
    void recalculateBoundaries();
 
    void buildViewToolBars(GUIGlChildWindow* v);
 
    void updateViewNet() const;
 
    void forceSupemodeNetwork();
 
    void viewUpdated();
 
    const GNEViewNetHelper::ViewObjectsSelector& getViewObjectsSelector() const;
 
    const GNEViewNetHelper::MoveSingleElementModul& getMoveSingleElementValues() const;
 
    const GNEViewNetHelper::MoveMultipleElementModul& getMoveMultipleElementValues() const;
 
    void updateObjectsInBoundary(const Boundary& boundary);
 
    void updateObjectsInPosition(const Position& pos);
 
    void buildSelectionACPopupEntry(GUIGLObjectPopupMenu* ret, GNEAttributeCarrier* AC);
 
    bool setColorScheme(const std::string& name);
 
    void buildColorRainbow(const GUIVisualizationSettings& s, GUIColorScheme& scheme, int active, GUIGlObjectType objectType,
                           const GUIVisualizationRainbowSettings& rs);
 
    std::vector<std::string> getEdgeLaneParamKeys(bool edgeKeys) const;
 
    std::vector<std::string> getEdgeDataAttrs() const;
 
    std::vector<std::string> getRelDataAttrs() const;
 
    int getDrawingToggle() const;
 
    bool checkSelectEdges() const;
 
    void openObjectDialogAtCursor(const FXEvent* ev);
 
    void openDeleteDialogAtCursor(const std::vector<GUIGlObject*>& GLObjects);
 
    void openSelectDialogAtCursor(const std::vector<GUIGlObject*>& GLObjects);
 
    // save visualization settings
    void saveVisualizationSettings() const;
 
    const GNEViewNetHelper::EditModes& getEditModes() const;
 
    const GNEViewNetHelper::TestingMode& getTestingMode() const;
 
    const GNEViewNetHelper::NetworkViewOptions& getNetworkViewOptions() const;
 
    const GNEViewNetHelper::DemandViewOptions& getDemandViewOptions() const;
 
    const GNEViewNetHelper::DataViewOptions& getDataViewOptions() const;
 
    const GNEViewNetHelper::MouseButtonKeyPressed& getMouseButtonKeyPressed() const;
 
    const GNEViewNetHelper::EditNetworkElementShapes& getEditNetworkElementShapes() const;
 
    long onLeftBtnPress(FXObject*, FXSelector, void*);
 
    long onLeftBtnRelease(FXObject*, FXSelector, void*);
 
    long onMiddleBtnPress(FXObject*, FXSelector, void*);
 
    long onMiddleBtnRelease(FXObject*, FXSelector, void*);
 
    long onRightBtnPress(FXObject*, FXSelector, void*);
 
    long onRightBtnRelease(FXObject*, FXSelector, void*);
 
    long onMouseMove(FXObject*, FXSelector, void*);
 
    long onKeyPress(FXObject* o, FXSelector sel, void* data);
 
    long onKeyRelease(FXObject* o, FXSelector sel, void* data);
 
    long onCmdSetSupermode(FXObject*, FXSelector sel, void*);
 
    long onCmdSetMode(FXObject*, FXSelector sel, void*);
 
 
    long onCmdSplitEdge(FXObject*, FXSelector, void*);
 
    long onCmdSplitEdgeBidi(FXObject*, FXSelector, void*);
 
    long onCmdReverseEdge(FXObject*, FXSelector, void*);
 
    long onCmdAddReversedEdge(FXObject*, FXSelector, void*);
 
    long onCmdAddReversedEdgeDisconnected(FXObject*, FXSelector, void*);
 
    long onCmdEditEdgeEndpoint(FXObject*, FXSelector, void*);
 
    long onCmdResetEdgeEndpoint(FXObject*, FXSelector, void*);
 
    long onCmdStraightenEdges(FXObject*, FXSelector, void*);
 
    long onCmdSmoothEdges(FXObject*, FXSelector, void*);
 
    long onCmdStraightenEdgesElevation(FXObject*, FXSelector, void*);
 
    long onCmdSmoothEdgesElevation(FXObject*, FXSelector, void*);
 
    long onCmdResetLength(FXObject*, FXSelector, void*);
 
    long onCmdEdgeUseAsTemplate(FXObject*, FXSelector, void*);
 
    long onCmdEgeApplyTemplate(FXObject*, FXSelector, void*);
 
 
    long onCmdSimplifyShape(FXObject*, FXSelector, void*);
 
    long onCmdDeleteGeometryPoint(FXObject*, FXSelector, void*);
 
    long onCmdClosePolygon(FXObject*, FXSelector, void*);
 
    long onCmdOpenPolygon(FXObject*, FXSelector, void*);
 
    long onCmdSelectPolygonElements(FXObject*, FXSelector, void*);
 
    long onCmdSetFirstGeometryPoint(FXObject*, FXSelector, void*);
 
 
    long onCmdSimplifyShapeEdited(FXObject*, FXSelector, void*);
 
    long onCmdStraightenShapeEdited(FXObject*, FXSelector, void*);
 
    long onCmdCloseShapeEdited(FXObject*, FXSelector, void*);
 
    long onCmdOpenShapeEdited(FXObject*, FXSelector, void*);
 
    long onCmdSetFirstGeometryPointShapeEdited(FXObject*, FXSelector, void*);
 
    long onCmdDeleteGeometryPointShapeEdited(FXObject*, FXSelector, void*);
 
    long onCmdResetShapeEdited(FXObject*, FXSelector, void*);
 
    long onCmdFinishShapeEdited(FXObject*, FXSelector, void*);
 
 
    long onCmdTransformPOI(FXObject*, FXSelector, void*);
 
    long onCmdReverse(FXObject*, FXSelector, void*);
 
    long onCmdAddReverse(FXObject*, FXSelector, void*);
 
    long onCmdSetCustomGeometryPoint(FXObject*, FXSelector, void*);
 
    long onCmdResetEndPoints(FXObject*, FXSelector, void*);
 
    long onCmdDuplicateLane(FXObject*, FXSelector, void*);
 
    long onCmdEditLaneShape(FXObject*, FXSelector, void*);
 
    long onCmdResetLaneCustomShape(FXObject*, FXSelector, void*);
 
    long onCmdResetOppositeLane(FXObject*, FXSelector, void*);
 
    long onCmdLaneOperation(FXObject*, FXSelector sel, void*);
 
    long onCmdLaneReachability(FXObject*, FXSelector sel, void*);
 
    long onCmdOpenAdditionalDialog(FXObject*, FXSelector, void*);
 
    long onCmdResetEdgeEndPoints(FXObject*, FXSelector, void*);
 
    long onCmdEditJunctionShape(FXObject*, FXSelector, void*);
 
    long onCmdResetJunctionShape(FXObject*, FXSelector, void*);
 
    long onCmdReplaceJunction(FXObject*, FXSelector, void*);
 
    long onCmdSplitJunction(FXObject*, FXSelector, void*);
 
    long onCmdSplitJunctionReconnect(FXObject*, FXSelector, void*);
 
    long onCmdSelectRoundabout(FXObject*, FXSelector, void*);
 
    long onCmdConvertRoundabout(FXObject*, FXSelector, void*);
 
    long onEnterConvertRoundabout(FXObject*, FXSelector, void*);
 
    long onLeaveConvertRoundabout(FXObject*, FXSelector, void*);
 
    long onCmdClearConnections(FXObject*, FXSelector, void*);
 
    long onCmdResetConnections(FXObject*, FXSelector, void*);
 
    long onCmdAddTLS(FXObject*, FXSelector, void*);
 
    long onCmdAddJoinTLS(FXObject*, FXSelector, void*);
 
    long onCmdEditConnectionShape(FXObject*, FXSelector, void*);
 
    long onCmdSmoothConnectionShape(FXObject*, FXSelector, void*);
 
    long onCmdEditCrossingShape(FXObject*, FXSelector, void*);
 
    long onCmdEditWalkingAreaShape(FXObject*, FXSelector, void*);
 
 
    long onCmdToggleSelectEdges(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowConnections(FXObject*, FXSelector, void*);
 
    long onCmdToggleHideConnections(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowAdditionalSubElements(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowTAZElements(FXObject*, FXSelector, void*);
 
    long onCmdToggleExtendSelection(FXObject*, FXSelector, void*);
 
    long onCmdToggleChangeAllPhases(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowGrid(FXObject*, FXSelector, void*);
 
    long onCmdToggleDrawJunctionShape(FXObject*, FXSelector, void*);
 
    long onCmdToggleDrawSpreadVehicles(FXObject*, FXSelector, void*);
 
    long onCmdToggleWarnAboutMerge(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowJunctionBubbles(FXObject*, FXSelector, void*);
 
    long onCmdToggleMoveElevation(FXObject*, FXSelector, void*);
 
    long onCmdToggleChainEdges(FXObject*, FXSelector, void*);
 
    long onCmdToggleAutoOppositeEdge(FXObject*, FXSelector, void*);
 
    long onCmdToggleHideNonInspecteDemandElements(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowOverlappedRoutes(FXObject*, FXSelector, void*);
 
    long onCmdToggleHideShapes(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowTrips(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowAllPersonPlans(FXObject*, FXSelector, void*);
 
    long onCmdToggleLockPerson(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowAllContainerPlans(FXObject*, FXSelector, void*);
 
    long onCmdToggleLockContainer(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowAdditionals(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowShapes(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowDemandElementsNetwork(FXObject*, FXSelector, void*);
 
    long onCmdToggleShowDemandElementsData(FXObject*, FXSelector, void*);
 
    long onCmdToggleTAZRelDrawing(FXObject*, FXSelector, void*);
 
    long onCmdToggleTAZDrawFill(FXObject*, FXSelector, void*);
 
    long onCmdToggleTAZRelOnlyFrom(FXObject*, FXSelector, void*);
 
    long onCmdToggleTAZRelOnlyTo(FXObject*, FXSelector, void*);
 
 
 
    long onCmdIntervalBarGenericDataType(FXObject*, FXSelector, void*);
 
    long onCmdIntervalBarDataSet(FXObject*, FXSelector, void*);
 
    long onCmdIntervalBarLimit(FXObject*, FXSelector, void*);
 
    long onCmdIntervalBarSetBegin(FXObject*, FXSelector, void*);
 
    long onCmdIntervalBarSetEnd(FXObject*, FXSelector, void*);
 
    long onCmdIntervalBarSetParameter(FXObject*, FXSelector, void*);
 
 
    long onCmdAddSelected(FXObject*, FXSelector, void*);
 
    long onCmdRemoveSelected(FXObject*, FXSelector, void*);
 
    long onCmdAddEdgeSelected(FXObject*, FXSelector, void*);
 
    long onCmdRemoveEdgeSelected(FXObject*, FXSelector, void*);
 
    long onCmdSetNeteditView(FXObject*, FXSelector sel, void*);
 
    void abortOperation(bool clearSelection = true);
 
    void hotkeyDel();
 
    void hotkeyEnter();
 
    void hotkeyBackSpace();
 
    void hotkeyFocusFrame();
 
    GNEViewParent* getViewParent() const;
 
    GNENet* getNet() const;
 
    GNEUndoList* getUndoList() const;
 
    GNEViewNetHelper::IntervalBar& getIntervalBar();
 
    const std::vector<GNEAttributeCarrier*>& getInspectedAttributeCarriers() const;
 
    GNEViewNetHelper::LockManager& getLockManager();
 
    void setInspectedAttributeCarriers(const std::vector<GNEAttributeCarrier*> ACs);
 
    bool isAttributeCarrierInspected(const GNEAttributeCarrier* AC) const;
 
    void removeFromAttributeCarrierInspected(const GNEAttributeCarrier* AC);
 
    const GNEAttributeCarrier* getFrontAttributeCarrier() const;
 
    const GUIGlObject* getFrontGLObject() const;
 
    void setFrontAttributeCarrier(GNEAttributeCarrier* AC);
 
    void drawTranslateFrontAttributeCarrier(const GNEAttributeCarrier* AC, double typeOrLayer, const double extraOffset = 0);
 
    bool isCurrentlyMovingElements() const;
 
    bool checkOverLockedElement(const GUIGlObject* GLObject, const bool isSelected) const;
 
    GNEDemandElement* getLastCreatedRoute() const;
 
    void setLastCreatedRoute(GNEDemandElement* lastCreatedRoute);
 
    void setStatusBarText(const std::string& text);
 
    void resetLastClickedPosition();
 
    bool autoSelectNodes();
 
    void setSelectorFrameScale(double selectionScale);
 
    void updateControls();
 
    bool changeAllPhases() const;
 
    bool showJunctionAsBubbles() const;
 
    bool checkMergeJunctions();
 
    bool askMergeJunctions(const GNEJunction* movedJunction, const GNEJunction* targetJunction);
 
    bool aksChangeSupermode(const std::string& operation, Supermode expectedSupermode);
 
    bool selectingDetectorsTLSMode() const;
 
    bool selectingJunctionsTLSMode() const;
 
    GNEViewNetHelper::SaveElements& getSaveElements();
 
    GNEViewNetHelper::TimeFormat& getTimeFormat();
 
    bool restrictLane(GNELane* lane, SUMOVehicleClass vclass);
 
    bool addRestrictedLane(GNELane* lane, SUMOVehicleClass vclass, const bool insertAtFront);
 
    bool removeRestrictedLane(GNELane* lane, SUMOVehicleClass vclass);
 
protected:
    GNEViewNet();
 
    int doPaintGL(int mode, const Boundary& bound);
 
    void doInit();
 
    GUIGlID getToolTipID();
 
private:
    GNEViewNetHelper::ViewObjectsSelector myViewObjectsSelector;
 
 
    GNEViewNetHelper::EditModes myEditModes;
 
    GNEViewNetHelper::TestingMode myTestingMode;
 
 
 
    GNEViewNetHelper::MouseButtonKeyPressed myMouseButtonKeyPressed;
 
 
 
    GNEViewNetHelper::CommonCheckableButtons myCommonCheckableButtons;
 
    GNEViewNetHelper::NetworkCheckableButtons myNetworkCheckableButtons;
 
    GNEViewNetHelper::DemandCheckableButtons myDemandCheckableButtons;
 
    GNEViewNetHelper::DataCheckableButtons myDataCheckableButtons;
 
 
 
    GNEViewNetHelper::NetworkViewOptions myNetworkViewOptions;
 
    GNEViewNetHelper::DemandViewOptions myDemandViewOptions;
 
    GNEViewNetHelper::DataViewOptions myDataViewOptions;
 
 
    GNEViewNetHelper::IntervalBar myIntervalBar;
 
 
    GNEViewNetHelper::MoveSingleElementModul myMoveSingleElement;
 
    GNEViewNetHelper::MoveMultipleElementModul myMoveMultipleElements;
 
    // @}
 
 
    GNEViewNetHelper::VehicleOptions myVehicleOptions;
 
    GNEViewNetHelper::VehicleTypeOptions myVehicleTypeOptions;
 
    // @}
 
    GNEViewNetHelper::SaveElements mySaveElements;
 
    GNEViewNetHelper::TimeFormat myTimeFormat;
 
    GNEViewNetHelper::SelectingArea mySelectingArea;
 
    GNEViewNetHelper::EditNetworkElementShapes myEditNetworkElementShapes;
 
    GNEViewNetHelper::LockManager myLockManager;
 
    GNEViewParent* myViewParent = nullptr;
 
    GNENet* myNet = nullptr;
 
    GNEFrame* myCurrentFrame = nullptr;
 
    GNEUndoList* myUndoList = nullptr;
 
    std::vector<GNEAttributeCarrier*> myInspectedAttributeCarriers;
 
    GNEAttributeCarrier* myFrontAttributeCarrier = nullptr;
 
    GNEDemandElement* myLastCreatedRoute = nullptr;
 
    bool myDrawPreviewRoundabout = false;
 
    Position myLastClickedPosition = Position::INVALID;
 
    bool myCreatedPopup = false;
 
    int myDrawingToggle = 0;
 
    void buildEditModeControls();
 
    void updateNetworkModeSpecificControls();
 
    void updateDemandModeSpecificControls();
 
    void updateDataModeSpecificControls();
 
    void deleteNetworkAttributeCarriers(const std::vector<GNEAttributeCarrier*> ACs);
 
    void deleteDemandAttributeCarriers(const std::vector<GNEAttributeCarrier*> ACs);
 
    void deleteDataAttributeCarriers(const std::vector<GNEAttributeCarrier*> ACs);
 
    GNEEdge* getEdgeAtPopupPosition();
 
    GNELane* getLaneAtPopupPosition();
 
    GNEJunction* getJunctionAtPopupPosition();
 
    GNEConnection* getConnectionAtPopupPosition();
 
    GNECrossing* getCrossingAtPopupPosition();
 
    GNEWalkingArea* getWalkingAreaAtPopupPosition();
 
    GNEAdditional* getAdditionalAtPopupPosition();
 
    GNEDemandElement* getDemandElementAtPopupPosition();
 
    GNEPoly* getPolygonAtPopupPosition();
 
    GNEPOI* getPOIAtPopupPosition();
 
    GNETAZ* getTAZAtPopupPosition();
 
    GNENetworkElement* getShapeEditedAtPopupPosition();
 
    void processClick(void* eventData);
 
    void updateCursor();
 
 
    int drawGLElements(const Boundary& bound);
 
    void drawGrid() const;
 
    void drawTemporalDrawingShape() const;
 
    void drawTemporalJunction() const;
 
    void drawTemporalSplitJunction() const;
 
    void drawTemporalRoundabout() const;
 
    void drawTemporalE1TLSLines() const;
 
    void drawTemporalJunctionTLSLines() const;
 
    void drawNeteditAttributesReferences();
 
    void drawTestsCircle() const;
 
 
 
    void processLeftButtonPressNetwork(void* eventData);
 
    void processLeftButtonReleaseNetwork();
 
    void processMoveMouseNetwork(const bool mouseLeftButtonPressed);
 
    void processLeftButtonPressDemand(void* eventData);
 
    void processLeftButtonReleaseDemand();
 
    void processMoveMouseDemand(const bool mouseLeftButtonPressed);
 
    void processLeftButtonPressData(void* eventData);
 
    void processLeftButtonReleaseData();
 
    void processMoveMouseData(const bool mouseLeftButtonPressed);
 
    GNEViewNet(const GNEViewNet&) = delete;
 
    GNEViewNet& operator=(const GNEViewNet&) = delete;
};