GUILane.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 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
/****************************************************************************/
// Representation of a lane in the micro simulation (gui-version)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/foxtools/fxheader.h>
#include <string>
#include <utility>
#include <microsim/MSLane.h>
#include <microsim/MSEdge.h>
#include <utils/geom/Position.h>
#include <utils/geom/PositionVector.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/gui/settings/GUIPropertySchemeStorage.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUINet;
class MSVehicle;
class MSNet;
class TesselatedPolygon;
#ifdef HAVE_OSG
namespace osg {
class Geometry;
}
#endif
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUILane : public MSLane, public GUIGlObject {
public:
    GUILane(const std::string& id, double maxSpeed, double friction,
            double length, MSEdge* const edge, int numericalID,
            const PositionVector& shape, double width,
            SVCPermissions permissions,
            SVCPermissions changeLeft, SVCPermissions changeRight,
            int index, bool isRampAccel,
            const std::string& type,
            const PositionVector& outlineShape);
 
 
    ~GUILane();
 
    std::string getParentName() const override {
        return getEdge().getID();
    }
 
    void addSecondaryShape(const PositionVector& shape) override;
 
    double getLengthGeometryFactor(bool secondaryShape) const override {
        return secondaryShape ? myLengthGeometryFactor2 :  myLengthGeometryFactor;
    }
 
    void updateMesoGUISegments() override;
 
 
    const VehCont& getVehiclesSecure() const override;
 
 
    void releaseVehicles() const override;
 
 
 
 
    void planMovements(const SUMOTime t) override;
 
    void setJunctionApproaches() const override;
 
    void executeMovements(const SUMOTime t) override;
 
    void integrateNewVehicles() override;
 
 
    void detectCollisions(SUMOTime timestep, const std::string& stage) override;
 
 
    MSVehicle* removeVehicle(MSVehicle* remVehicle, MSMoveReminder::Notification notification, bool notify) override;
 
    void removeParking(MSBaseVehicle* veh) override;
 
    double setPartialOccupation(MSVehicle* v) override;
 
    void resetPartialOccupation(MSVehicle* v) override;
 
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    Boundary getCenteringBoundary() const override;
 
    void drawGL(const GUIVisualizationSettings& s) const override;
 
    double getClickPriority() const override;
 
    const PositionVector& getShape(bool secondary) const override;
    const std::vector<double>& getShapeRotations(bool secondary) const;
    const std::vector<double>& getShapeLengths(bool secondary) const;
 
    double firstWaitingTime() const;
 
    bool neighLaneNotBidi() const;
 
    void drawMarkings(const GUIVisualizationSettings& s, double scale) const;
 
    void drawBikeMarkings() const;
 
    void drawJunctionChangeProhibitions() const;
 
    void drawDirectionIndicators(double exaggeration, bool spreadSuperposed, bool s2) const;
 
    void debugDrawFoeIntersections() const;
 
    double getEdgeLaneNumber() const;
 
    double getStoredEdgeTravelTime() const;
 
    double getLoadedEdgeWeight() const;
 
    void setReachability(double value) {
        myReachability = value;
    }
 
    double getReachability() const {
        return myReachability;
    }
 
#ifdef HAVE_OSG
    void setGeometry(osg::Geometry* geom) {
        myGeom = geom;
    }
 
    void updateColor(const GUIVisualizationSettings& s);
 
#endif
 
    void closeTraffic(bool rebuildAllowed = true);
 
    bool isClosed() const {
        return myAmClosed;
    }
 
    double getColorValue(const GUIVisualizationSettings& s, int activeScheme) const override;
 
    double getColorValueWithFunctional(const GUIVisualizationSettings& s, int activeScheme) const;
 
    double getColorValueForTracker() const;
 
    double getScaleValue(const GUIVisualizationSettings& s, int activeScheme, bool s2) const;
 
    bool isSelected() const override;
 
    /* @brief sets the color according to the current scheme index and some lane function
     * @param[in] id override active scheme when calling from meso gui
     */
    bool setFunctionalColor(const GUIColorer& c, RGBColor& col, int activeScheme = -1) const;
 
    bool drawAsRailway(const GUIVisualizationSettings& s) const;
 
protected:
    void swapAfterLaneChange(SUMOTime t) override;
 
    void incorporateVehicle(MSVehicle* veh, double pos, double speed, double posLat,
                            const MSLane::VehCont::iterator& at,
                            MSMoveReminder::Notification notification = MSMoveReminder::NOTIFICATION_DEPARTED) override;
 
private:
    void drawLinkNo(const GUIVisualizationSettings& s) const;
    void drawTLSLinkNo(const GUIVisualizationSettings& s, const GUINet& net) const;
    void drawLinkRules(const GUIVisualizationSettings& s, const GUINet& net) const;
    void drawLinkRule(const GUIVisualizationSettings& s, const GUINet& net, const MSLink* link,
                      const PositionVector& shape, double x1, double x2) const;
    void drawArrows(bool secondaryShape) const;
    void drawLane2LaneConnections(double exaggeration, bool s2) const;
 
 
    PositionVector splitAtSegments(const PositionVector& shape);
 
    double getPendingEmits() const;
 
private:
    void initRotations(const PositionVector& shape,
                       std::vector<double>& rotations,
                       std::vector<double>& lengths,
                       std::vector<RGBColor>& colors);
 
    bool setMultiColor(const GUIVisualizationSettings& s, const GUIColorer& c, RGBColor& col) const;
 
    RGBColor setColor(const GUIVisualizationSettings& s) const;
 
    bool drawAsWaterway(const GUIVisualizationSettings& s) const;
 
    bool isLaneOrEdgeSelected() const;
 
    std::vector<RGBColor>& getShapeColors(bool secondary) const;
 
    std::vector<double> myShapeRotations;
    std::vector<double> myShapeRotations2;
 
    std::vector<double> myShapeLengths;
    std::vector<double> myShapeLengths2;
 
    mutable std::vector<RGBColor> myShapeColors;
    mutable std::vector<RGBColor> myShapeColors2;
 
    std::vector<int> myShapeSegments;
    std::vector<int> mySegmentStartIndex;
 
    double myHalfLaneWidth;
 
    double myQuarterLaneWidth;
 
    double myReachability = INVALID_DOUBLE;
 
    mutable std::vector<MSParkingArea*>* myParkingAreas;
 
    mutable TesselatedPolygon* myTesselation;
 
#ifdef HAVE_OSG
    osg::Geometry* myGeom;
#endif
 
    bool myAmClosed;
 
    PositionVector myShape2;
    double myLengthGeometryFactor2;
 
    static GUIVisualizationSettings* myCachedGUISettings;
 
private:
    mutable FXMutex myLock;
 
    static const RGBColor MESO_USE_LANE_COLOR;
 
 
};