GUIPerson.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/gui/globjects/GUIGlObject.h>
#include <utils/common/RGBColor.h>
#include <microsim/transportables/MSPerson.h>
#include <utils/gui/globjects/GUIGLObjectPopupMenu.h>
#include <utils/gui/settings/GUIPropertySchemeStorage.h>
#include "GUIBaseVehicle.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUISUMOAbstractView;
class GUIGLObjectPopupMenu;
class MSDevice_Vehroutes;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUIPerson : public MSPerson, public GUIGlObject {
 
public:
    GUIPerson(const SUMOVehicleParameter* pars, MSVehicleType* vtype, MSTransportable::MSTransportablePlan* plan, const double speedFactor);
 
    ~GUIPerson();
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    GUIParameterTableWindow* getTypeParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    double getExaggeration(const GUIVisualizationSettings& s) const override;
 
    Boundary getCenteringBoundary() const override;
 
    void drawGL(const GUIVisualizationSettings& s) const override;
 
    virtual void drawGLAdditional(GUISUMOAbstractView* const parent, const GUIVisualizationSettings& s) const override;
    //* @}
 
    /* @brief proceeds to the next step of the route,
     * @return Whether the transportables plan continues  */
    bool proceed(MSNet* net, SUMOTime time, const bool vehicleArrived = false) override;
 
    /* @brief set the position of a person while riding in a vehicle
     * @note This must be called by the vehicle before the call to drawGl */
    void setPositionInVehicle(const GUIBaseVehicle::Seat& pos);
 
    double getEdgePos() const override;
 
    int getDirection() const override;
 
    // @note overrides the base method and returns myPositionInVehicle while in driving stage
    Position getPosition() const override;
 
    Position getGUIPosition(const GUIVisualizationSettings* s = nullptr) const;
 
    double getGUIAngle() const;
 
    double getNaviDegree() const;
 
    double getWaitingSeconds() const override;
 
    double getSpeed() const override;
 
    std::string getStageIndexDescription() const;
 
    std::string getEdgeID() const;
 
    std::string getLaneID() const;
 
    std::string getFromEdgeID() const;
 
    std::string getDestinationEdgeID() const;
 
    std::string getDestinationStopID() const;
 
    std::string getVehicleID() const;
 
    double getStopDuration() const;
 
    double getStageArrivalPos() const;
 
 
    bool isSelected() const override;
 
    static bool setFunctionalColor(int activeScheme, const MSPerson* person, RGBColor& col);
 
    double getColorValue(const GUIVisualizationSettings& s, int activeScheme) const override;
 
    double getScaleVisual() const override {
        return getVehicleType().getParameter().scaleVisual;
    }
 
    class GUIPersonPopupMenu : public GUIGLObjectPopupMenu {
        FXDECLARE(GUIPersonPopupMenu)
 
    public:
        GUIPersonPopupMenu(GUIMainWindow& app, GUISUMOAbstractView& parent, GUIGlObject* o);
 
        ~GUIPersonPopupMenu();
 
        long onCmdShowCurrentRoute(FXObject*, FXSelector, void*);
 
        long onCmdHideCurrentRoute(FXObject*, FXSelector, void*);
 
        long onCmdShowWalkingareaPath(FXObject*, FXSelector, void*);
 
        long onCmdHideWalkingareaPath(FXObject*, FXSelector, void*);
 
        long onCmdShowPlan(FXObject*, FXSelector, void*);
 
        long onCmdStartTrack(FXObject*, FXSelector, void*);
 
        long onCmdStopTrack(FXObject*, FXSelector, void*);
 
        long onCmdRemoveObject(FXObject*, FXSelector, void*);
 
    protected:
        FOX_CONSTRUCTOR(GUIPersonPopupMenu)
    };
 
    enum VisualisationFeatures {
        VO_SHOW_WALKINGAREA_PATH = 1,
        VO_SHOW_ROUTE = 2,
        VO_TRACKED = 8
    };
 
 
    bool hasActiveAddVisualisation(GUISUMOAbstractView* const parent, int which) const;
 
    void addActiveAddVisualisation(GUISUMOAbstractView* const parent, int which);
 
    void removeActiveAddVisualisation(GUISUMOAbstractView* const parent, int which) override;
 
 
private:
    void setColor(const GUIVisualizationSettings& s) const;
 
    void drawAction_drawWalkingareaPath(const GUIVisualizationSettings& s) const;
 
    mutable FXMutex myLock;
 
    GUIBaseVehicle::Seat myPositionInVehicle;
 
    std::map<GUISUMOAbstractView*, int> myAdditionalVisualizations;
};