GNEJunction.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 and editing junctions in netedit (adapted from
// GUIJunctionWrapper)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netbuild/NBNode.h>
#include <netedit/elements/GNECandidateElement.h>
#include <netedit/elements/moving/GNEMoveResult.h>
#include <utils/gui/globjects/GUIPolygon.h>
 
#include "GNENetworkElement.h"
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEConnection;
class GNECrossing;
class GNEEdge;
class GNEInternalLane;
class GNEMoveElementJunction;
class GNEMoveOperation;
class GNENet;
class GNEWalkingArea;
class NBTrafficLightDefinition;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEJunction : public GNENetworkElement, public GNECandidateElement {
 
    friend class GNEChange_TLS;
    friend class GNEChange_Crossing;
    friend class GNEMoveElementJunction;
 
public:
    GNEJunction(GNENet* net, NBNode* nbn, bool loaded = false);
 
    ~GNEJunction();
 
 
    GNEMoveElement* getMoveElement() const override;
 
    Parameterised* getParameters() override;
 
    const Parameterised* getParameters() const override;
 
 
    const PositionVector& getJunctionShape() const;
 
    void updateGeometry() override;
 
    // @note: using an extra function because updateGeometry overrides an abstract virtual function
    void updateGeometryAfterNetbuild(bool rebuildNBNodeCrossings = false);
 
    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;
 
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    double getExaggeration(const GUIVisualizationSettings& s) const override;
 
    Boundary getCenteringBoundary() const override;
 
    void updateCenteringBoundary(const bool updateGrid);
 
    void drawGL(const GUIVisualizationSettings& s) const override;
 
    void deleteGLObject() override;
 
    void updateGLObject() override;
 
    NBNode* getNBNode() const;
 
    std::vector<GNEJunction*> getJunctionNeighbours() const;
 
    void addIncomingGNEEdge(GNEEdge* edge);
 
    void addOutgoingGNEEdge(GNEEdge* edge);
 
    void removeIncomingGNEEdge(GNEEdge* edge);
 
    void removeOutgoingGNEEdge(GNEEdge* edge);
 
    const std::vector<GNEEdge*>& getGNEIncomingEdges() const;
 
    const std::vector<GNEEdge*>& getGNEOutgoingEdges() const;
 
    const std::vector<GNECrossing*>& getGNECrossings() const;
 
    const std::vector<GNEWalkingArea*>& getGNEWalkingAreas() const;
 
    std::vector<GNEConnection*> getGNEConnections() const;
 
    void markAsCreateEdgeSource();
 
    void unMarkAsCreateEdgeSource();
 
    void selectTLS(bool selected);
 
    /* @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 Position format
     * @param[in] key The attribute key
     * @return position 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 correspond 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 override;
 
    /* @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 override;
 
 
    void setResponsible(bool newVal);
 
    /* @brief notify junction that one of its edges has changed its shape, and
     * therefore the junction shape is no longer valid */
    void invalidateShape();
 
    /* @brief update validity of this junctions logic
     * if the logic is invalidated, existing connections are removed via undo-list
     * so that the previous state can be restored
     * also calls invalidateTLS
     * @param[in] valid The new validity of the junction
     * @note: this should always be called with an active command group
     */
    void setLogicValid(bool valid, GNEUndoList* undoList, const std::string& status = FEATURE_GUESSED);
 
    void removeConnectionsFrom(GNEEdge* edge, GNEUndoList* undoList, bool updateTLS, int lane = -1);
 
    void removeConnectionsTo(GNEEdge* edge, GNEUndoList* undoList, bool updateTLS, int lane = -1);
 
    void markAsModified(GNEUndoList* undoList);
 
    /* @brief invalidates loaded or edited TLS
     * @param[in] deletedConnection If a valid connection is given a replacement def with this connection removed
     *   but all other information intact will be computed instead of guessing a new tlDef
     * @note: this should always be called with an active command group
     */
    void invalidateTLS(GNEUndoList* undoList,
                       const NBConnection& deletedConnection = NBConnection::InvalidConnection,
                       const NBConnection& addedConnection = NBConnection::InvalidConnection);
 
    void replaceIncomingConnections(GNEEdge* which, GNEEdge* by, GNEUndoList* undoList);
 
    void removeEdgeFromCrossings(GNEEdge* edge, GNEUndoList* undoList);
 
    bool isLogicValid();
 
    GNECrossing* retrieveGNECrossing(NBNode::Crossing* NBNodeCrossing, bool createIfNoExist = true);
 
    GNEWalkingArea* retrieveGNEWalkingArea(const std::string& NBNodeWalkingAreaID, bool createIfNoExist = true);
 
    void markConnectionsDeprecated(bool includingNeighbours);
 
    void setJunctionType(const std::string& value, GNEUndoList* undoList);
 
    void clearWalkingAreas();
 
    void rebuildGNEWalkingAreas();
 
    void addInternalLane(const GNEInternalLane* internalLane);
 
    void removeInternalLane(const GNEInternalLane* internalLane);
 
protected:
    GNEMoveElementJunction* myMoveElementJunction = nullptr;
 
    NBNode* myNBNode;
 
    Boundary myJunctionBoundary;
 
    int* myDrawingToggle;
 
    GNEContour myCircleContour;
 
    std::vector<GNEEdge*> myGNEIncomingEdges;
 
    std::vector<GNEEdge*> myGNEOutgoingEdges;
 
    std::vector<GNECrossing*> myGNECrossings;
 
    std::vector<GNEWalkingArea*> myGNEWalkingAreas;
 
    std::vector<const GNEInternalLane*> myInternalLanes;
 
    bool myAmCreateEdgeSource = false;
 
    std::string myLogicStatus;
 
    bool myAmResponsible = false;
 
    bool myHasValidLogic;
 
    bool myAmTLSSelected = false;
 
    bool myColorForMissingConnections = false;
 
    mutable TesselatedPolygon myTesselation;
 
    mutable double myExaggeration = 1;
 
private:
    bool drawAsBubble(const GUIVisualizationSettings& s, const double junctionShapeArea) const;
 
    void drawJunctionAsBubble(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                              const double exaggeration) const;
 
    void drawJunctionAsShape(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                             const double exaggeration) const;
 
    void drawJunctionCenter(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d) const;
 
    void drawTLSIcon(const GUIVisualizationSettings& s) const;
 
    void drawElevation(const GUIVisualizationSettings& s) const;
 
    void drawJunctionName(const GUIVisualizationSettings& s) const;
 
    void drawJunctionChildren(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d) const;
 
    void calculateJunctioncontour(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                                  const double exaggeration, const bool drawBubble) const;
 
    void setAttribute(SumoXMLAttr key, const std::string& value) override;
 
    void moveJunctionGeometry(const Position& pos, const bool updateEdgeBoundaries);
 
    RGBColor setColor(const GUIVisualizationSettings& s, bool bubble) const;
 
    double getColorValue(const GUIVisualizationSettings& s, int activeScheme) const override;
 
    void checkMissingConnections();
 
    void addTrafficLight(NBTrafficLightDefinition* tlDef, bool forceInsert);
 
    void removeTrafficLight(NBTrafficLightDefinition* tlDef);
 
    void rebuildGNECrossings(bool rebuildNBNodeCrossings = true);
 
    void removeTLSConnections(std::vector<NBConnection>& connections, GNEUndoList* undoList);
 
    void mirrorXLeftHand();
 
    void buildTLSOperations(GUISUMOAbstractView& parent, GUIGLObjectPopupMenu* ret, const int numSelectedJunctions);
 
    GNEJunction(const GNEJunction&) = delete;
 
    GNEJunction& operator=(const GNEJunction&) = delete;
};