GNEInternalLane.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 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 class for visualizing Inner Lanes (used when editing traffic lights)
/****************************************************************************/
#pragma once
#include <config.h>
#include "GNENetworkElement.h"
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUIGLObjectPopupMenu;
class GNETLSEditorFrame;
class PositionVector;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GNEInternalLane : public GNENetworkElement, public FXDelegator {
    FXDECLARE(GNEInternalLane)
 
public:
    GNEInternalLane(GNETLSEditorFrame* editor, GNEJunction* junctionParent, const std::string& id,
                    const PositionVector& shape, int tlIndex, LinkState state = LINKSTATE_DEADEND);
 
    ~GNEInternalLane();
 
 
    void updateGeometry();
 
    Position getPositionInView() const;
 
 
 
    bool checkDrawFromContour() const;
 
    bool checkDrawToContour() const;
 
    bool checkDrawRelatedContour() const;
 
    bool checkDrawOverContour() const;
 
    bool checkDrawDeleteContour() const;
 
    bool checkDrawDeleteContourSmall() const;
 
    bool checkDrawSelectContour() const;
 
    bool checkDrawMoveContour() const;
 
 
    GNEMoveOperation* getMoveOperation();
 
    void removeGeometryPoint(const Position clickedPosition, GNEUndoList* undoList);
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    Boundary getCenteringBoundary() const;
 
    void updateCenteringBoundary(const bool updateGrid);
 
    void drawGL(const GUIVisualizationSettings& s) const;
 
    void deleteGLObject();
 
    void updateGLObject();
 
 
    void setLinkState(LinkState state);
 
    LinkState getLinkState() const;
 
    long onDefault(FXObject*, FXSelector, void*);
 
    int getTLIndex() const;
 
    static const StringBijection<FXuint> LinkStateNames;
 
    static RGBColor colorForLinksState(FXuint state);
 
    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    std::string getAttribute(SumoXMLAttr key) const;
 
    /* @brief method for getting the Attribute of an XML key in Position format
     * @param[in] key The attribute key
     * @return position with the value associated to key
     */
    PositionVector getAttributePositionVector(SumoXMLAttr key) const;
 
    /* @brief method for setting the attribute and letting the object perform additional changes
     * @param[in] key The attribute key
     * @param[in] value The new value
     * @param[in] undoList The undoList on which to register changes
     */
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
 
    /* @brief method for checking if the key and their conrrespond attribute are valids
     * @param[in] key The attribute key
     * @param[in] value The value associated to key key
     * @return true if the value is valid, false in other case
     */
    bool isValid(SumoXMLAttr key, const std::string& value);
 
    /* @brief method for check if the value for certain attribute is set
     * @param[in] key The attribute key
     */
    bool isAttributeEnabled(SumoXMLAttr key) const;
 
 
    const Parameterised::Map& getACParametersMap() const;
 
protected:
    GNEInternalLane();
 
private:
    GNEJunction* myJunctionParent;
 
    GUIGeometry myInternalLaneGeometry;
 
    FXuint myState;
    FXDataTarget myStateTarget;
 
    LinkState myOrigState;
 
    FXDataTarget stateTarget;
 
    GNETLSEditorFrame* myEditor;
 
    int myTlIndex;
 
    GUIGLObjectPopupMenu* myPopup;
 
    static StringBijection<FXuint>::Entry linkStateNamesValues[];
 
private:
    void setAttribute(SumoXMLAttr key, const std::string& value);
 
    void setMoveShape(const GNEMoveResult& moveResult);
 
    void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
 
    GNEInternalLane(const GNEInternalLane&) = delete;
 
    GNEInternalLane& operator=(const GNEInternalLane&) = delete;
};