GNERouteFrame.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 Widget for create route elements
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/elements/demand/GNERouteHandler.h>
#include <netedit/frames/GNEFrame.h>
#include <netedit/frames/GNEPathLegendModule.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNERoute;
 
// ===========================================================================
// class definitions
// ===========================================================================
class GNERouteFrame : public GNEFrame {
 
public:
 
    enum class RouteMode {
        INVALID,                // invalid RouteMode
        NONCONSECUTIVE_EDGES,   // Create route clicking over non consecutive edges
        CONSECUTIVE_EDGES       // Create route clicking over consecutive edges
    };
 
    // ===========================================================================
    // class RouteModeSelector
    // ===========================================================================
 
    class RouteModeSelector : public MFXGroupBoxModule {
        FXDECLARE(GNERouteFrame::RouteModeSelector)
 
    public:
        RouteModeSelector(GNERouteFrame* routeFrameParent);
 
        ~RouteModeSelector();
 
        const RouteMode& getCurrentRouteMode() const;
 
        bool isValidMode() const;
 
        bool isValidVehicleClass() const;
 
        void areParametersValid();
 
        long onCmdSelectRouteMode(FXObject*, FXSelector, void*);
 
        long onCmdSelectVClass(FXObject*, FXSelector, void*);
 
    protected:
        FOX_CONSTRUCTOR(RouteModeSelector)
 
    private:
        GNERouteFrame* myRouteFrameParent;
 
        MFXComboBoxIcon* myRouteModeMatchBox = nullptr;
 
        MFXComboBoxIcon* myVClassMatchBox = nullptr;
 
        RouteMode myCurrentRouteMode = RouteMode::NONCONSECUTIVE_EDGES;
 
        GNERoute* myRouteTemplate = nullptr;
 
        bool myValidVClass = true;
 
        std::vector<std::pair<RouteMode, std::string> > myRouteModesStrings;
    };
 
    GNERouteFrame(GNEViewParent* viewParent, GNEViewNet* viewNet);
 
    ~GNERouteFrame();
 
    void show();
 
    void hide();
 
    bool addEdgeRoute(GNEEdge* clickedEdge, const GNEViewNetHelper::MouseButtonKeyPressed& mouseButtonKeyPressed);
 
    GNEPathCreator* getPathCreator() const;
 
protected:
    bool createPath(const bool useLastRoute);
 
private:
    GNERouteHandler myRouteHandler;
 
    CommonXMLStructure::SumoBaseObject* myRouteBaseObject;
 
    RouteModeSelector* myRouteModeSelector;
 
    GNEAttributesCreator* myRouteAttributes;
 
    GNEPathCreator* myPathCreator;
 
    GNEPathLegendModule* myPathLegend;
};