GUIBaseVehicle.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2017 German Aerospace Center (DLR) and others.
/****************************************************************************/
//
//   This program and the accompanying materials
//   are made available under the terms of the Eclipse Public License v2.0
//   which accompanies this distribution, and is available at
//   http://www.eclipse.org/legal/epl-v20.html
//
/****************************************************************************/
// A MSVehicle extended by some values for usage within the gui
/****************************************************************************/
#ifndef GUIBaseVehicle_h
#define GUIBaseVehicle_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <vector>
#include <set>
#include <string>
#include <utils/common/RGBColor.h>
#include <utils/foxtools/MFXMutex.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();


    virtual Position getPosition(const double offset = 0) const = 0;

    virtual double getAngle() const = 0;

    double getNaviDegree() const {
        return GeomHelper::naviDegree(getAngle());
    }

    virtual double getColorValue(int activeScheme) const = 0;

    virtual bool drawAction_drawCarriageClass(const GUIVisualizationSettings& s, SUMOVehicleShape guiShape, bool asImage) const = 0;

    virtual double getLastLaneChangeOffset() const = 0;

    virtual void drawRouteHelper(const GUIVisualizationSettings& s, const MSRoute& r) const = 0;

    virtual std::string getStopInfo() const = 0;

    virtual void selectBlockingFoes() const = 0;

    virtual GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent) = 0;

    virtual GUIParameterTableWindow* getTypeParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent) = 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);


    Boundary getCenteringBoundary() const;


    void drawOnPos(const GUIVisualizationSettings& s, const Position& pos, const double angle) const;


    void drawGL(const GUIVisualizationSettings& s) const;


    virtual void drawGLAdditional(GUISUMOAbstractView* const parent, const GUIVisualizationSettings& s) const;




    bool hasActiveAddVisualisation(GUISUMOAbstractView* const parent, int which) const;


    void addActiveAddVisualisation(GUISUMOAbstractView* const parent, int which);


    void removeActiveAddVisualisation(GUISUMOAbstractView* const parent, int which);



    class GUIBaseVehiclePopupMenu : public GUIGLObjectPopupMenu {
        FXDECLARE(GUIBaseVehiclePopupMenu)
    public:
        GUIBaseVehiclePopupMenu(GUIMainWindow& app,
                                GUISUMOAbstractView& parent, GUIGlObject& o, std::map<GUISUMOAbstractView*, int>& additionalVisualizations);

        ~GUIBaseVehiclePopupMenu();

        long onCmdShowAllRoutes(FXObject*, FXSelector, void*);
        long onCmdHideAllRoutes(FXObject*, FXSelector, void*);
        long onCmdShowCurrentRoute(FXObject*, FXSelector, void*);
        long onCmdHideCurrentRoute(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*);

    protected:
        std::map<GUISUMOAbstractView*, int>& myVehiclesAdditionalVisualizations;
        std::map<GUISUMOAbstractView*, int> dummy;

    protected:
        GUIBaseVehiclePopupMenu() : myVehiclesAdditionalVisualizations(dummy) { }

    };



    enum VisualisationFeatures {
        VO_SHOW_BEST_LANES = 1,
        VO_SHOW_ROUTE = 2,
        VO_SHOW_ALL_ROUTES = 4,
        VO_SHOW_LFLINKITEMS = 8,
        VO_DRAW_OUTSIDE_NETWORK = 16
    };

    std::map<GUISUMOAbstractView*, int> myAdditionalVisualizations;


    void drawRoute(const GUIVisualizationSettings& s, int routeNo, double darken) const;



    static bool setFunctionalColor(int activeScheme, const MSBaseVehicle* veh);

protected:
    void setColor(const GUIVisualizationSettings& s) const;

    static void drawPoly(double* poses, double offset);

    void drawAction_drawVehicleAsBoxPlus() const;
    void drawAction_drawVehicleAsTrianglePlus() const;
    bool drawAction_drawVehicleAsPoly(const GUIVisualizationSettings& s) const;

    /* @brief try to draw vehicle as raster image and return true if sucessful
     * @param[in] length The custom length of the vehicle
     *   (defaults to the * length specified in the vehicle type if -1 is passed)
    */
    bool drawAction_drawVehicleAsImage(const GUIVisualizationSettings& s, double length = -1) const;

    const Position& getSeatPosition(int personIndex) const;

    static void drawLinkItem(const Position& pos, SUMOTime arrivalTime, SUMOTime leaveTime, double exagerate);

    inline const MSVehicleType& getVType() const {
        return myVehicle.getVehicleType();
    }


protected:
    mutable MFXMutex myLock;

    mutable PositionVector mySeatPositions;

private:
    MSBaseVehicle& myVehicle;

    MSDevice_Vehroutes* myRoutes;

};


#endif

/****************************************************************************/