GUIVisualizationSettings.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 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
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// Stores the information about how to visualize structures
/****************************************************************************/
#ifndef GUIVisualizationSettings_h
#define GUIVisualizationSettings_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include <string>
#include <vector>
#include <map>
#include <utils/common/RGBColor.h>
#include <utils/common/ToString.h>
#include "GUIPropertySchemeStorage.h"


// ===========================================================================
// class declarations
// ===========================================================================
class BaseSchemeInfoSource;
class OutputDevice;
class GUIVisualizationSettings;


// ===========================================================================
// class definitions
// ===========================================================================

// cannot declare this as inner class because it needs to be used in forward
// declaration (@todo fix inclusion order by removing references to guisim!)
struct GUIVisualizationTextSettings {
    GUIVisualizationTextSettings(bool _show, double _size, RGBColor _color, bool _constSize = true) :
        show(_show), size(_size), color(_color), constSize(_constSize) {}

    bool show;
    double size;
    RGBColor color;
    bool constSize;

    bool operator==(const GUIVisualizationTextSettings& other) {
        return show == other.show &&
               size == other.size &&
               color == other.color &&
               constSize == other.constSize;
    }
    bool operator!=(const GUIVisualizationTextSettings& other) {
        return !((*this) == other);
    }

    void print(OutputDevice& dev, const std::string& name) const {
        dev.writeAttr(name + "_show", show);
        dev.writeAttr(name + "_size", size);
        dev.writeAttr(name + "_color", color);
        dev.writeAttr(name + "_constantSize", constSize);
    }

    double scaledSize(double scale, double constFactor = 0.1) const {
        return constSize ? size / scale : size * constFactor;
    }
};


struct GUIVisualizationSizeSettings {
    GUIVisualizationSizeSettings(double _minSize, double _exaggeration = 1.0, bool _constantSize = false) :
        minSize(_minSize), exaggeration(_exaggeration), constantSize(_constantSize) {}

    double minSize;
    double exaggeration;
    // @brief whether the object shall be drawn with constant size regardless of zoom
    bool constantSize;

    bool operator==(const GUIVisualizationSizeSettings& other) {
        return constantSize == other.constantSize &&
               minSize == other.minSize &&
               exaggeration == other.exaggeration;
    }
    bool operator!=(const GUIVisualizationSizeSettings& other) {
        return !((*this) == other);
    }

    void print(OutputDevice& dev, const std::string& name) const {
        dev.writeAttr(name + "_minSize", minSize);
        dev.writeAttr(name + "_exaggeration", exaggeration);
        dev.writeAttr(name + "_constantSize", constantSize);
    }

    double getExaggeration(const GUIVisualizationSettings& s, double factor = 20) const;
};


class GUIVisualizationSettings {
public:

    GUIVisualizationSettings(bool _netedit = false);

    std::string name;

    bool netedit;

    double angle;

    bool dither;



    RGBColor backgroundColor;
    bool showGrid;
    double gridXSize, gridYSize;




    GUIColorer edgeColorer;
    GUIScaler edgeScaler;

    static bool UseMesoSim;
    GUIColorer laneColorer;
    GUIScaler laneScaler;
    bool laneShowBorders;
    bool showBikeMarkings;
    bool showLinkDecals;
    bool showLinkRules;
    bool showRails;
    // Setting bundles for optional drawing names with size and color
    GUIVisualizationTextSettings edgeName, internalEdgeName, cwaEdgeName, streetName;

    bool hideConnectors;
    double laneWidthExaggeration;
    double laneMinSize;
    bool showLaneDirection;
    bool showSublanes;
    bool spreadSuperposed;




    GUIColorer vehicleColorer;
    int vehicleQuality;
    bool showBlinker;
    bool drawLaneChangePreference;
    bool drawMinGap;
    bool showBTRange;
    // Setting bundles for controling the size of the drawn vehicles
    GUIVisualizationSizeSettings vehicleSize;
    // Setting bundles for optional drawing vehicle names
    GUIVisualizationTextSettings vehicleName;




    GUIColorer personColorer;
    int personQuality;
    // Setting bundles for controling the size of the drawn persons
    GUIVisualizationSizeSettings personSize;
    // Setting bundles for optional drawing person names
    GUIVisualizationTextSettings personName;




    GUIColorer containerColorer;
    int containerQuality;
    // Setting bundles for controling the size of the drawn containers
    GUIVisualizationSizeSettings containerSize;
    // Setting bundles for optional drawing person names
    GUIVisualizationTextSettings containerName;




    GUIColorer junctionColorer;
    // Setting bundles for optional drawing junction names and indices
    GUIVisualizationTextSettings drawLinkTLIndex, drawLinkJunctionIndex, junctionName, internalJunctionName;
    bool showLane2Lane;
    bool drawJunctionShape;
    bool drawCrossingsAndWalkingareas;
    // Setting bundles for controling the size of the drawn junction
    GUIVisualizationSizeSettings junctionSize;




    // @todo decouple addExageration for POIs, Polygons, Triggers etc
    int addMode;
    // Setting bundles for controling the size of additional items
    GUIVisualizationSizeSettings addSize;
    // Setting bundles for optional drawing additional names
    GUIVisualizationTextSettings addName;
    // Setting bundles for optional drawing additional full names
    GUIVisualizationTextSettings addFullName;




    GUIColorer poiColorer;
    // Setting bundles for controling the size of the drawn POIs
    GUIVisualizationSizeSettings poiSize;
    // Setting bundles for optional drawing poi names
    GUIVisualizationTextSettings poiName;
    // Setting bundles for optional drawing poi types
    GUIVisualizationTextSettings poiType;

    GUIColorer polyColorer;
    // Setting bundles for controling the size of the drawn polygons
    GUIVisualizationSizeSettings polySize;
    // Setting bundles for optional drawing polygon names
    GUIVisualizationTextSettings polyName;
    // Setting bundles for optional drawing polygon types
    GUIVisualizationTextSettings polyType;

    bool showSizeLegend;

    double scale;

    bool gaming;

    int editMode;

    int editAdditionalMode;

    double selectionScale;

    bool drawForSelecting;

    void initNeteditDefaults();
    void initSumoGuiDefaults();

    void save(OutputDevice& dev) const;

    int getLaneEdgeMode() const;

    int getLaneEdgeScaleMode() const;

    GUIColorScheme& getLaneEdgeScheme();

    GUIScaleScheme& getLaneEdgeScaleScheme();

    bool operator==(const GUIVisualizationSettings& vs2);

    static const RGBColor& getLinkColor(const LinkState& ls);

    static const RGBColor SUMO_color_busStop;

    static const RGBColor SUMO_color_busStop_sign;

    static const RGBColor SUMO_color_containerStop;

    static const RGBColor SUMO_color_containerStop_sign;

    static const RGBColor SUMO_color_chargingStation;

    static const RGBColor SUMO_color_chargingStation_sign;

    static const RGBColor SUMO_color_chargingStation_charge;

    static const RGBColor SUMO_color_E3Entry;

    static const RGBColor SUMO_color_E3Exit;

    double getTextAngle(double objectAngle) const;
};


#endif

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