GUIVisualizationSettings.h

Go to the documentation of this file.

/****************************************************************************/
// Stores the information about how to visualize structures
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2014 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef GUIVisualizationSettings_h
#define GUIVisualizationSettings_h


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

#include <string>
#include <vector>
#include <map>
#include <utils/common/RGBColor.h>
#include <utils/common/ToString.h>
#include "GUIColorer.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, float _size, RGBColor _color) :
        show(_show), size(_size), color(_color) {}

    bool show;
    float size;
    RGBColor color;

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

    std::string print(const std::string& name) const {
        return name + "_show=\"" + toString(show) + "\" " +
               name + "_size=\"" + toString(size) + "\" " +
               name + "_color=\"" + toString(color) + "\" ";
    }
};


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

    float minSize;
    float 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);
    }

    std::string print(const std::string& name) const {
        return name + "_minSize=\"" + toString(minSize) + "\" " +
               name + "_exaggeration=\"" + toString(exaggeration) + "\" " +
               name + "_constantSize=\"" + toString(constantSize) + "\" ";
    }

    SUMOReal getExaggeration(const GUIVisualizationSettings& s) const;
};


class GUIVisualizationSettings {
public:

    GUIVisualizationSettings();

    std::string name;

    bool antialiase;
    bool dither;



    RGBColor backgroundColor;
    bool showGrid;
    SUMOReal gridXSize, gridYSize;




#ifdef HAVE_INTERNAL
    GUIColorer edgeColorer;
    GUIScaler edgeScaler;

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

    bool hideConnectors;
    float laneWidthExaggeration;




    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 junctionColorer;
    bool drawLinkTLIndex;
    bool drawLinkJunctionIndex;
    // Setting bundles for optional drawing junction names
    GUIVisualizationTextSettings junctionName, internalJunctionName;
    bool showLane2Lane;
    bool drawJunctionShape;




    // @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 controling the size of the drawn POIs
    GUIVisualizationSizeSettings poiSize;
    // Setting bundles for optional drawing poi names
    GUIVisualizationTextSettings poiName;

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

    bool showSizeLegend;

    SUMOReal scale;

    bool gaming;

    int editMode;

    SUMOReal selectionScale;

    bool drawForSelecting;

    void save(OutputDevice& dev) const;

    size_t getLaneEdgeMode() const;

    size_t getLaneEdgeScaleMode() const;

    GUIColorScheme& getLaneEdgeScheme();

    GUIScaleScheme& getLaneEdgeScaleScheme();

    bool operator==(const GUIVisualizationSettings& vs2);
};


#endif

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