GUIVehicle.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
/****************************************************************************/
// A MSVehicle extended by some values for usage within the gui
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <string>
#include <utils/geom/PositionVector.h>
#include <utils/foxtools/MFXLock.h>
#include <microsim/MSVehicle.h>
#include "GUIBaseVehicle.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUISUMOAbstractView;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUIVehicle : public MSVehicle, public GUIBaseVehicle {
public:
    GUIVehicle(SUMOVehicleParameter* pars, ConstMSRoutePtr route,
               MSVehicleType* type, const double speedFactor);
 
 
    ~GUIVehicle();
 
    Position getPosition(const double offset = 0) const override {
        return MSVehicle::getPosition(offset);
    }
 
    Position getVisualPosition(bool s2, const double offset = 0) const override;
 
    double getAngle() const override {
        return MSVehicle::getAngle();
    }
 
    double getVisualAngle(bool s2) const override;
 
    void drawRouteHelper(const GUIVisualizationSettings& s, ConstMSRoutePtr r, bool future,
                         bool noLoop, const RGBColor& col) const override;
 
    void drawAction_drawVehicleBlinker(double length) const override;
    void drawAction_drawVehicleBrakeLight(double length, bool onlyOne = false) const override;
    void drawAction_drawLinkItems(const GUIVisualizationSettings& s) const override;
    void drawAction_drawVehicleBlueLight() const override;
 
    double getLastLaneChangeOffset() const override;
 
    void drawBestLanes() const override;
 
    void selectBlockingFoes() const override;
 
    double getColorValue(const GUIVisualizationSettings& s, int activeScheme) const override;
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    GUIParameterTableWindow* getTypeParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    bool isSelected() const override;
 
    double getRightSideOnEdge2() const {
        return getRightSideOnEdge();
    }
 
    double getLeftSideOnEdge() const {
        return getRightSideOnEdge() + getVehicleType().getWidth();
    }
 
    int getRightSublaneOnEdge() const;
    int getLeftSublaneOnEdge() const;
 
    std::string getLCStateRight() const;
    std::string getLCStateLeft() const;
    std::string getLCStateCenter() const;
 
    std::string getLaneID() const;
    std::string getBackLaneIDs() const;
    std::string getShadowLaneID() const;
    std::string getTargetLaneID() const;
 
    std::string getDriveWays() const;
 
    double getManeuverDist() const;
    std::string getSpeedMode() const;
    std::string getLaneChangeMode() const;
 
    std::string getDynamicAlignment() const;
 
    void rerouteDRTStop(MSStoppingPlace* busStop);
 
    std::unique_ptr<MFXOptionalLock> getScopeLock() override {
        return std::unique_ptr<MFXOptionalLock>(new MFXLock(myLock));
    }
 
 
protected:
    void drawOutsideNetwork(bool add) override;
 
private:
    /* @brief draw train with individual carriages. The number of carriages is
     * determined from defaultLength of carriages and vehicle length
     * passengerSeats are computed beginning at firstPassengerCarriage */
    void drawAction_drawCarriageClass(const GUIVisualizationSettings& s, double scaledLength, bool asImage) const override;
 
    std::string getStopInfo() const override;
};