GUISettingsHandler.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
/****************************************************************************/
// The handler for parsing gui settings from xml.
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/xml/SUMOSAXHandler.h>
#include <utils/distribution/RandomDistributor.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUISUMOAbstractView;
class Position;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUISettingsHandler : public SUMOSAXHandler {
public:
    GUISettingsHandler(const std::string& content, bool isFile = true, bool netedit = false);
 

    ~GUISettingsHandler();
 
 



    void myStartElement(int element, const SUMOSAXAttributes& attrs);

    void myEndElement(int element);
 
 

    const std::vector<std::string>& addSettings(GUISUMOAbstractView* view = 0) const;
 

    void applyViewport(GUISUMOAbstractView* view) const;
 

    void setSnapshots(GUISUMOAbstractView* view) const;
 

    bool hasDecals() const;
 

    const std::vector<GUISUMOAbstractView::Decal>& getDecals() const;
 

    double getDelay() const;
 

    const std::vector<SUMOTime>& getBreakpoints() const {
        return myBreakpoints;
    }
 

    static std::vector<SUMOTime> loadBreakpoints(const std::string& file);
 

    const std::string& getViewType() const {
        return myViewType;
    }
 
    RandomDistributor<std::string> getEventDistribution(const std::string& id);
    double getJamSoundTime() {
        return myJamSoundTime;
    }
 
    std::vector<std::string> getTrackers() {
        return myTrackers;
    }
 
    const std::string& getSettingName() const {
        return mySettings.name;
    }
 
private:
    GUIVisualizationSettings mySettings;

    std::vector<std::string> myLoadedSettingNames;

    std::string myViewType;

    double myDelay;

    Position myLookFrom;

    Position myLookAt;

    bool myZCoordSet;

    double myRotation;

    double myZoom;

    std::map<SUMOTime, std::vector<std::string> > mySnapshots;

    std::vector<GUISUMOAbstractView::Decal> myDecals;

    int myCurrentColorer;

    GUIColorScheme* myCurrentScheme;

    GUIScaleScheme* myCurrentScaleScheme;

    std::vector<SUMOTime> myBreakpoints;

    std::map<std::string, RandomDistributor<std::string> > myEventDistributions;
    double myJamSoundTime;

    std::vector<std::string> myTrackers;
 
private:
    RGBColor parseColor(const SUMOSAXAttributes& attrs, const std::string attribute, const RGBColor& defaultValue) const;

    GUIVisualizationTextSettings parseTextSettings(
        const std::string& prefix, const SUMOSAXAttributes& attrs,
        GUIVisualizationTextSettings defaults);

    GUIVisualizationSizeSettings parseSizeSettings(
        const std::string& prefix, const SUMOSAXAttributes& attrs,
        GUIVisualizationSizeSettings defaults);

    GUIVisualizationRainbowSettings parseRainbowSettings(
        const std::string& prefix, const SUMOSAXAttributes& attrs,
        GUIVisualizationRainbowSettings defaults);
};