GNELane.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
/****************************************************************************/
// A class for visualizing Lane geometry (adapted from GUILaneWrapper)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/elements/GNECandidateElement.h>
#include <netedit/GNELane2laneConnection.h>
 
#include "GNENetworkElement.h"
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUIGLObjectPopupMenu;
class PositionVector;
class GNETLSEditorFrame;
class GNEEdge;
class GNENet;
class GNEConnection;
 
// ===========================================================================
// class definitions
// ===========================================================================
class GNELane : public GNENetworkElement, public GNECandidateElement, public FXDelegator {
    FXDECLARE(GNELane)
 
public:
    class DrawingConstants {
 
    public:
        DrawingConstants(const GNELane* lane);
 
        void update(const GUIVisualizationSettings& s);
 
        double getExaggeration() const;
 
        double getDrawingWidth() const;
 
        double getInternalDrawingWidth() const;
 
        double getOffset() const;
 
        GUIVisualizationSettings::Detail getDetail() const;
 
        bool drawAsRailway() const;
 
        bool drawSuperposed() const;
 
    protected:
        const GNELane* myLane;
 
        double myExaggeration = 0;
 
        double myDrawingWidth = 0;
 
        double myInternalDrawingWidth = 0;
 
        double myOffset = 0;
 
        GUIVisualizationSettings::Detail myDetail = GUIVisualizationSettings::Detail::Level4;
 
        bool myDrawAsRailway = false;
 
        bool myDrawSuperposed = false;
 
    private:
        DrawingConstants() = delete;
 
        DrawingConstants(const DrawingConstants&) = delete;
 
        DrawingConstants& operator=(const DrawingConstants&) = delete;
    };
 
    GNELane(GNEEdge* edge, const int index);
 
    ~GNELane();
 
    GNEEdge* getParentEdge() const;
 
    bool allowPedestrians() const;
 
 
    const GUIGeometry& getLaneGeometry() const;
 
    const PositionVector& getLaneShape() const;
 
    const std::vector<double>& getShapeRotations() const;
 
    const std::vector<double>& getShapeLengths() const;
 
    const DrawingConstants* getDrawingConstants() const;
 
    void updateGeometry();
 
    Position getPositionInView() const;
 
 
 
    bool checkDrawFromContour() const;
 
    bool checkDrawToContour() const;
 
    bool checkDrawRelatedContour() const;
 
    bool checkDrawOverContour() const;
 
    bool checkDrawDeleteContour() const;
 
    bool checkDrawSelectContour() const;
 
    bool checkDrawMoveContour() const;
 
 
    GNEMoveOperation* getMoveOperation();
 
    void removeGeometryPoint(const Position clickedPosition, GNEUndoList* undoList);
 
    std::vector<GNEConnection*> getGNEIncomingConnections();
 
    std::vector<GNEConnection*> getGNEOutcomingConnections();
 
    void updateConnectionIDs();
 
    double getLengthGeometryFactor() const;
 
    // @brief Returns the name of the parent object (if any)
    // @return This object's parent id
    std::string getParentName() const;
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    long onDefault(FXObject*, FXSelector, void*);
 
    double getExaggeration(const GUIVisualizationSettings& s) const;
 
    Boundary getCenteringBoundary() const;
 
    void updateCenteringBoundary(const bool updateGrid);
 
    void drawGL(const GUIVisualizationSettings& s) const;
 
    void deleteGLObject();
 
    void updateGLObject();
 
    int getIndex() const;
 
    double getSpeed() const;
 
    /* @brief method for setting the index of the lane
     * @param[in] index The new index of lane
     */
    void setIndex(int index);
 
    double getLaneParametricLength() const;
 
    double getLaneShapeLength() const;
 
    bool isRestricted(SUMOVehicleClass vclass) const;
 
    const GNELane2laneConnection& getLane2laneConnections() const;
 
    /* @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 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 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);
 
    /* @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;
 
    const Parameterised::Map& getACParametersMap() const;
 
    /* @brief method for setting the special color of the lane
     * @param[in] color Pointer to new special color
     */
    void setSpecialColor(const RGBColor* Color2, double colorValue = std::numeric_limits<double>::max());
 
    double getColorValue(const GUIVisualizationSettings& s, int activeScheme) const;
 
    void drawOverlappedRoutes(const int numRoutes) const;
 
    void drawLaneStopOffset(const GUIVisualizationSettings& s) const;
 
protected:
    GNELane();
 
private:
    GNEEdge* myParentEdge;
 
    int myIndex;
 
    GUIGeometry myLaneGeometry;
 
    DrawingConstants* myDrawingConstants;
 
 
    std::vector<Position> myLaneRestrictedTexturePositions;
 
    std::vector<double> myLaneRestrictedTextureRotations;
 
    const RGBColor* mySpecialColor;
 
    double mySpecialColorValue;
 
    mutable std::vector<RGBColor> myShapeColors;
 
    GNELane2laneConnection myLane2laneConnections;
 
    void setAttribute(SumoXMLAttr key, const std::string& value);
 
    void setMoveShape(const GNEMoveResult& moveResult);
 
    void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
 
    void drawLane(const GUIVisualizationSettings& s) const;
 
    void drawSelectedLane(const GUIVisualizationSettings& s) const;
 
    void drawShapeEdited(const GUIVisualizationSettings& s) const;
 
    void drawChildren(const GUIVisualizationSettings& s) const;
 
    void drawMarkingsAndBoundings(const GUIVisualizationSettings& s) const;
 
    void drawLinkNo(const GUIVisualizationSettings& s) const;
 
    void drawTLSLinkNo(const GUIVisualizationSettings& s) const;
 
    void drawArrows(const GUIVisualizationSettings& s) const;
 
    void drawLane2LaneConnections() const;
 
    void calculateLaneContour(const GUIVisualizationSettings& s) const;
 
    bool setFunctionalColor(int activeScheme, RGBColor& col) const;
 
    bool setMultiColor(const GUIVisualizationSettings& s, const GUIColorer& c, RGBColor& col) const;
 
    bool drawAsWaterway(const GUIVisualizationSettings& s) const;
 
    void drawDirectionIndicators(const GUIVisualizationSettings& s) const;
 
    void drawLaneAsRailway() const;
 
    void drawTextures(const GUIVisualizationSettings& s) const;
 
    void drawStartEndGeometryPoints(const GUIVisualizationSettings& s) const;
 
    RGBColor setLaneColor(const GUIVisualizationSettings& s) const;
 
    void buildEdgeOperations(GUISUMOAbstractView& parent, GUIGLObjectPopupMenu* ret);
 
    void buildLaneOperations(GUISUMOAbstractView& parent, GUIGLObjectPopupMenu* ret);
 
    void buildTemplateOperations(GUISUMOAbstractView& parent, GUIGLObjectPopupMenu* ret);
 
    void buildRechableOperations(GUISUMOAbstractView& parent, GUIGLObjectPopupMenu* ret);
 
    GNELane(const GNELane&) = delete;
 
    GNELane& operator=(const GNELane&) = delete;
};