GNEConnection.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2016-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 represent connections between Lanes
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netbuild/NBEdge.h>
#include <utils/gui/div/GUIGeometry.h>
 
#include "GNENetworkElement.h"
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEEdge;
class GNEMoveElementConnection;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEConnection : public GNENetworkElement {
 
    friend class GNEMoveElementConnection;
 
public:
    GNEConnection(GNELane* from, GNELane* to);
 
    ~GNEConnection();
 
 
    GNEMoveElement* getMoveElement() const override;
 
    Parameterised* getParameters() override;
 
    const Parameterised* getParameters() const override;
 
 
 
    const PositionVector& getConnectionShape() const;
 
    void updateGeometry() override;
 
    Position getPositionInView() const;
 
 
 
    bool checkDrawFromContour() const override;
 
    bool checkDrawToContour() const override;
 
    bool checkDrawRelatedContour() const override;
 
    bool checkDrawOverContour() const override;
 
    bool checkDrawDeleteContour() const override;
 
    bool checkDrawDeleteContourSmall() const override;
 
    bool checkDrawSelectContour() const override;
 
    bool checkDrawMoveContour() const override;
 
 
    GNEEdge* getEdgeFrom() const;
 
    GNEEdge* getEdgeTo() const;
 
    GNELane* getLaneFrom() const;
 
    GNELane* getLaneTo() const;
 
    int getFromLaneIndex() const;
 
    int getToLaneIndex() const;
 
    NBEdge::Connection& getNBEdgeConnection() const;
 
    NBConnection getNBConnection() const;
 
    LinkState getLinkState() const;
 
    void markConnectionGeometryDeprecated();
 
    void updateConnectionID();
 
    void updateLinkState();
 
    void smootShape();
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    double getExaggeration(const GUIVisualizationSettings& s) const;
 
    Boundary getCenteringBoundary() const;
 
    void updateCenteringBoundary(const bool updateGrid);
 
    void drawGL(const GUIVisualizationSettings& s) const;
 
    void deleteGLObject();
 
    void updateGLObject();
 
 
    /* @brief method for setting the special color of the connection
     * @param[in] color Pointer to new special color
     */
    void setSpecialColor(const RGBColor* Color2);
 
    /* @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 override;
 
    /* @brief method for getting the Attribute of an XML key in double format
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    double getAttributeDouble(SumoXMLAttr key) const override;
 
    /* @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
     */
    Position getAttributePosition(SumoXMLAttr key) const override;
 
    /* @brief method for getting the Attribute of an XML key in positionVector format
     * @param[in] key The attribute key
     * @return positionVector with the value associated to key
     */
    PositionVector getAttributePositionVector(SumoXMLAttr key) const override;
 
    /* @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) override;
 
    /* @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) override;
 
    /* @brief method for check if the value for certain attribute is set
     * @param[in] key The attribute key
     */
    bool isAttributeEnabled(SumoXMLAttr key) const;
 
    /* @brief method for check if the value for certain attribute is computed (for example, due a network recomputing)
     * @param[in] key The attribute key
     */
    bool isAttributeComputed(SumoXMLAttr key) const;
 
 
protected:
    GNEMoveElementConnection* myMoveElementConnection = nullptr;
 
    LinkState myLinkState;
 
    const RGBColor* mySpecialColor;
 
    GUIGeometry myConnectionGeometry;
 
    GUIGeometry myInternalJunctionMarkerGeometry;
 
    bool myShapeDeprecated;
 
private:
    void setAttribute(SumoXMLAttr key, const std::string& value) override;
 
    void changeTLIndex(SumoXMLAttr key, int tlIndex, int tlIndex2, GNEUndoList* undoList);
 
    bool existNBEdgeConnection() const;
 
    bool checkDrawConnection() const;
 
    RGBColor getConnectionColor(const GUIVisualizationSettings& s) const;
 
    void drawConnection(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                        const GUIGeometry& superposedGeometry, const double exaggeration) const;
 
    void drawConnectionArrows(const GUIVisualizationSettings& s, const GUIGeometry& superposedGeometry,
                              const RGBColor& color) const;
 
    void drawEdgeValues(const GUIVisualizationSettings& s, const PositionVector& shape) const;
 
    void calculateConnectionContour(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                                    const PositionVector& shape, const double exaggeration) const;
 
    GNEConnection(const GNEConnection&) = delete;
 
    GNEConnection& operator=(const GNEConnection&) = delete;
};