GNEEdge.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// A road/street connecting two junctions (netedit-version, adapted from GUIEdge)
// Basically a container for an NBEdge with drawing and editing capabilities
/****************************************************************************/
#ifndef GNEEdge_h
#define GNEEdge_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include "GNENetElement.h"

// ===========================================================================
// class declarations
// ===========================================================================
class GNENet;
class GNEJunction;
class GNELane;
class GNEConnection;
class GNERouteProbe;
class GNEVaporizer;
class GNERerouter;
class GNECrossing;

// ===========================================================================
// class definitions
// ===========================================================================
class GNEEdge : public GNENetElement {

    friend class GNEChange_Lane;
    friend class GNEChange_Connection;

public:
    typedef std::vector<GNELane*> LaneVector;

    typedef std::vector<GNEConnection*> ConnectionVector;

    GNEEdge(NBEdge& nbe, GNENet* net, bool wasSplit = false, bool loaded = false);

    ~GNEEdge();

    void updateGeometry(bool updateGrid);

    bool clickedOverShapeStart(const Position& pos);

    bool clickedOverShapeEnd(const Position& pos);

    void moveShapeStart(const Position& oldPos, const Position& offset);

    void moveShapeEnd(const Position& oldPos, const Position& offset);

    void commitShapeStartChange(const Position& oldPos, GNEUndoList* undoList);

    void commitShapeEndChange(const Position& oldPos, GNEUndoList* undoList);

    void startGeometryMoving();

    void endGeometryMoving();

    int getVertexIndex(const Position& pos, bool createIfNoExist = true);

    int getVertexIndex(const double offset, bool createIfNoExist = true);

    int moveVertexShape(const int index, const Position& oldPos, const Position& offset);

    void moveEntireShape(const PositionVector& oldShape, const Position& offset);

    void commitShapeChange(const PositionVector& oldShape, GNEUndoList* undoList);

    void deleteGeometryPoint(const Position& pos, bool allowUndo = true);

    void updateJunctionPosition(GNEJunction* junction, const Position& origPos, bool updateGrid);

    Boundary getBoundary() const;


    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);

    Boundary getCenteringBoundary() const;

    void drawGL(const GUIVisualizationSettings& s) const;

    NBEdge* getNBEdge();

    GNEJunction* getGNEJunctionSource() const;

    GNEJunction* getGNEJunctionDestiny() const;

    GNEEdge* getOppositeEdge() const;

    void editEndpoint(Position pos, GNEUndoList* undoList);

    void resetEndpoint(const Position& pos, GNEUndoList* undoList);

    /* @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;
    std::string getAttributeForSelection(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 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
     */
    bool isValid(SumoXMLAttr key, const std::string& value);


    bool addGenericParameter(const std::string& key, const std::string& value);

    bool removeGenericParameter(const std::string& key);

    bool updateGenericParameter(const std::string& oldKey, const std::string& newKey);

    bool updateGenericParameterValue(const std::string& key, const std::string& newValue);

    std::string getGenericParametersStr() const;

    std::vector<std::pair<std::string, std::string> > getGenericParameters() const;

    void setGenericParametersStr(const std::string& value);


    void setResponsible(bool newVal);

    void setGeometry(PositionVector geom, bool inner, bool updateGrid);

    void remakeGNEConnections();

    void copyTemplate(GNEEdge* tpl, GNEUndoList* undolist);

    std::set<GUIGlID> getLaneGlIDs();

    const std::vector<GNELane*>& getLanes();

    const std::vector<GNEConnection*>& getGNEConnections();

    GNEConnection* retrieveGNEConnection(int fromLane, NBEdge* to, int toLane, bool createIfNoExist = true);

    bool wasSplit();

    /* @brief compute a splitting position which keeps the resulting edges
     * straight unless the user clicked near a geometry point */
    Position getSplitPos(const Position& clickPos);

    void setMicrosimID(const std::string& newID);

    bool hasRestrictedLane(SUMOVehicleClass vclass) const;

    // the radius in which to register clicks for geometry nodes
    static const double SNAP_RADIUS;

    void clearGNEConnections();

    int getRouteProbeRelativePosition(GNERouteProbe* routeProbe) const;

    std::vector<GNECrossing*> getGNECrossings();

    void removeEdgeOfAdditionalParents(GNEUndoList* undoList, bool allowEmpty);

    void smooth(GNEUndoList* undoList);

    void straightenElevation(GNEUndoList* undoList);

    void smoothElevation(GNEUndoList* undoList);

    PositionVector smoothShape(const PositionVector& shape, bool forElevation);

protected:
    NBEdge& myNBEdge;

    PositionVector myMovingShape;

    GNEJunction* myGNEJunctionSource;

    GNEJunction* myGNEJunctionDestiny;

    PositionVector myOrigShape;

    LaneVector myLanes;

    ConnectionVector myGNEConnections;

    bool myAmResponsible;

    bool myWasSplit;

    std::string myConnectionStatus;

private:
    void setAttribute(SumoXMLAttr key, const std::string& value);

    void mouseOverObject(const GUIVisualizationSettings& s) const;

    void setNumLanes(int numLanes, GNEUndoList* undoList);

    void addLane(GNELane* lane, const NBEdge::Lane& laneAttrs, bool recomputeConnections);

    void removeLane(GNELane* lane, bool recomputeConnections);

    void addConnection(NBEdge::Connection nbCon, bool selectAfterCreation = false);

    void removeConnection(NBEdge::Connection nbCon);

    void removeEdgeFromCrossings(GNEJunction* junction, GNEUndoList* undoList);

    void setShapeStartPos(const Position& pos);

    void setShapeEndPos(const Position& pos);

    GNEEdge(const GNEEdge& s) = delete;

    GNEEdge& operator=(const GNEEdge& s) = delete;
};


#endif

/****************************************************************************/