GUIBaseVehicle.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 MSVehicle extended by some values for usage within the gui
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <set>
#include <string>
#include <utils/foxtools/fxheader.h>
#include <utils/common/RGBColor.h>
#include <utils/geom/GeomHelper.h>
#include <utils/geom/PositionVector.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/gui/globjects/GUIGLObjectPopupMenu.h>
#include <utils/gui/settings/GUIPropertySchemeStorage.h>
#include <microsim/MSVehicle.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUISUMOAbstractView;
class GUIGLObjectPopupMenu;
class MSDevice_Vehroutes;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUIBaseVehicle : public GUIGlObject {
public:
 
    GUIBaseVehicle(MSBaseVehicle& vehicle);
 
    ~GUIBaseVehicle();
 
    struct Seat {
        Seat(): pos(Position::INVALID), angle(0) {}
 
        Seat(const Position& _pos, double _angle):
            pos(_pos), angle(_angle) {}
 
        Position pos;
        double angle;
    };
    typedef std::vector<Seat> Seats;
 
    virtual Position getPosition(const double offset = 0) const = 0;
 
    virtual Position getVisualPosition(bool s2, const double offset = 0) const = 0;
 
    virtual double getAngle() const = 0;
 
    virtual double getVisualAngle(bool s2) const = 0;
 
    double getNaviDegree() const {
        return GeomHelper::naviDegree(getAngle());
    }
 
    virtual void drawAction_drawCarriageClass(const GUIVisualizationSettings& s, double scaledLength, bool asImage) const = 0;
 
    virtual double getLastLaneChangeOffset() const = 0;
 
    virtual void drawRouteHelper(const GUIVisualizationSettings& s, ConstMSRoutePtr r, bool future, bool noLoop, const RGBColor& col) const = 0;
 
    virtual std::string getStopInfo() const = 0;
 
    virtual void selectBlockingFoes() const = 0;
 
    virtual void drawAction_drawVehicleBlinker(double /*length*/) const {}
    virtual void drawAction_drawVehicleBrakeLight(double length, bool onlyOne = false) const {
        UNUSED_PARAMETER(length);
        UNUSED_PARAMETER(onlyOne);
    }
    virtual void drawAction_drawLinkItems(const GUIVisualizationSettings& /*s*/) const {}
    virtual void drawAction_drawPersonsAndContainers(const GUIVisualizationSettings& s) const;
    virtual void drawBestLanes() const {};
    virtual void drawAction_drawVehicleBlueLight() const {}
 
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    void removedPopupMenu() override;
 
    double getExaggeration(const GUIVisualizationSettings& s) const override;
 
    virtual Boundary getCenteringBoundary() const override;
 
    const std::string getOptionalName() const override;
 
    void drawOnPos(const GUIVisualizationSettings& s, const Position& pos, const double angle) const;
 
 
    void drawGL(const GUIVisualizationSettings& s) const override;
 
 
    virtual void drawGLAdditional(GUISUMOAbstractView* const parent, const GUIVisualizationSettings& s) const override;
 
 
    bool hasActiveAddVisualisation(GUISUMOAbstractView* const parent, int which) const;
 
    void addActiveAddVisualisation(GUISUMOAbstractView* const parent, int which);
 
    void removeActiveAddVisualisation(GUISUMOAbstractView* const parent, int which) override;
 
    int getNumPassengers() const;
 
    int getNumContainers() const;
 
    std::string getDeviceDescription();
 
    class GUIBaseVehiclePopupMenu : public GUIGLObjectPopupMenu {
        FXDECLARE(GUIBaseVehiclePopupMenu)
 
    public:
        GUIBaseVehiclePopupMenu(GUIMainWindow& app, GUISUMOAbstractView& parent, GUIGlObject* o);
 
        ~GUIBaseVehiclePopupMenu();
 
        long onCmdShowAllRoutes(FXObject*, FXSelector, void*);
        long onCmdHideAllRoutes(FXObject*, FXSelector, void*);
        long onCmdShowCurrentRoute(FXObject*, FXSelector, void*);
        long onCmdHideCurrentRoute(FXObject*, FXSelector, void*);
        long onCmdShowFutureRoute(FXObject*, FXSelector, void*);
        long onCmdHideFutureRoute(FXObject*, FXSelector, void*);
        long onCmdShowRouteNoLoops(FXObject*, FXSelector, void*);
        long onCmdHideRouteNoLoops(FXObject*, FXSelector, void*);
        long onCmdShowBestLanes(FXObject*, FXSelector, void*);
        long onCmdHideBestLanes(FXObject*, FXSelector, void*);
        long onCmdStartTrack(FXObject*, FXSelector, void*);
        long onCmdStopTrack(FXObject*, FXSelector, void*);
        long onCmdShowLFLinkItems(FXObject*, FXSelector, void*);
        long onCmdHideLFLinkItems(FXObject*, FXSelector, void*);
        long onCmdShowFoes(FXObject*, FXSelector, void*);
        long onCmdSelectTransported(FXObject*, FXSelector, void*);
        long onCmdRemoveObject(FXObject*, FXSelector, void*);
        long onCmdToggleStop(FXObject*, FXSelector, void*);
 
    protected:
        FOX_CONSTRUCTOR(GUIBaseVehiclePopupMenu)
    };
 
 
 
    enum VisualisationFeatures {
        VO_SHOW_BEST_LANES = 1 << 0,
        VO_SHOW_ROUTE = 1 << 1,
        VO_SHOW_ALL_ROUTES = 1 << 2,
        VO_SHOW_LFLINKITEMS = 1 << 3,
        VO_DRAW_OUTSIDE_NETWORK = 1 << 4,
        VO_SHOW_FUTURE_ROUTE = 1 << 5,
        VO_SHOW_ROUTE_NOLOOP = 1 << 6,
        VO_TRACK = 1 << 7
    };
 
    std::map<GUISUMOAbstractView*, int> myAdditionalVisualizations;
 
 
    void drawRoute(const GUIVisualizationSettings& s, int routeNo, double darken, bool future = false, bool noLoop = false) const;
 
    void drawStopLabels(const GUIVisualizationSettings& s, bool noLoop, const RGBColor& col) const;
 
    void drawParkingInfo(const GUIVisualizationSettings& s) const;
 
    void drawChargingInfo(const GUIVisualizationSettings& s) const;
 
    const MSBaseVehicle& getVehicle() {
        return myVehicle;
    }
 
    double getScaleValue(const GUIVisualizationSettings& s, int activeScheme) const;
 
    double getScaleVisual() const override {
        return myVehicle.getVehicleType().getParameter().scaleVisual;
    }
 
    static bool setFunctionalColor(int activeScheme, const MSBaseVehicle* veh, RGBColor& col);
 
protected:
 
    RGBColor setColor(const GUIVisualizationSettings& s) const;
 
    const Seat& getSeatPosition(int personIndex) const;
    const Seat& getContainerPosition(int containerIndex) const;
 
    static void drawLinkItem(const Position& pos, SUMOTime arrivalTime, SUMOTime leaveTime, double exagerate);
 
    inline const MSVehicleType& getVType() const {
        return myVehicle.getVehicleType();
    }
 
    bool drawAction_drawVehicleAsPolyWithCarriagges(const GUIVisualizationSettings& s, double scaledLength, bool asImage = false) const;
 
    void computeSeats(const Position& front, const Position& back, double seatOffset, int maxSeats, double exaggeration, int& requiredSeats, Seats& into, double extraOffset = 0) const;
 
    bool drawReversed(const GUIVisualizationSettings& s) const;
 
 
protected:
    mutable FXMutex myLock;
 
    mutable Seats mySeatPositions;
    mutable Seats myContainerPositions;
 
private:
    MSBaseVehicle& myVehicle;
 
    MSDevice_Vehroutes* myRoutes;
 
    GUIGLObjectPopupMenu* myPopup;
 
};