SUMO - Simulation of Urban MObility
GUISettingsHandler.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
18 // The dialog to change the view (gui) settings.
19 /****************************************************************************/
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <vector>
29 #include <utils/common/ToString.h>
30 #include <utils/common/RGBColor.h>
38 #include <utils/xml/XMLSubSys.h>
39 #include "GUISettingsHandler.h"
40 
41 
42 // ===========================================================================
43 // method definitions
44 // ===========================================================================
45 GUISettingsHandler::GUISettingsHandler(const std::string& content, bool isFile, bool netedit) :
46  SUMOSAXHandler(content),
47  mySettings(netedit),
48  myDelay(-1), myLookFrom(-1, -1, -1), myLookAt(-1, -1, -1),
49  myRotation(0),
50  myCurrentColorer(SUMO_TAG_NOTHING),
51  myCurrentScheme(nullptr),
52  myJamSoundTime(-1) {
53  if (isFile) {
54  XMLSubSys::runParser(*this, content);
55  } else {
56  setFileName("registrySettings");
57  SUMOSAXReader* reader = XMLSubSys::getSAXReader(*this);
58  reader->parseString(content);
59  delete reader;
60  }
61 }
62 
63 
65 }
66 
67 
68 void
70  const SUMOSAXAttributes& attrs) {
71  bool ok = true;
72  switch (element) {
74  std::string file = attrs.get<std::string>(SUMO_ATTR_VALUE, nullptr, ok);
76  }
77  break;
79  myBreakpoints.push_back(attrs.getSUMOTimeReporting(SUMO_ATTR_VALUE, nullptr, ok));
80  break;
82  myViewType = attrs.getOpt<std::string>(SUMO_ATTR_TYPE, nullptr, ok, "default");
83  std::transform(myViewType.begin(), myViewType.end(), myViewType.begin(), tolower);
84  break;
85  case SUMO_TAG_DELAY:
86  myDelay = attrs.getOpt<double>(SUMO_ATTR_VALUE, nullptr, ok, myDelay);
87  break;
88  case SUMO_TAG_VIEWPORT: {
89  const double x = attrs.getOpt<double>(SUMO_ATTR_X, nullptr, ok, myLookFrom.x());
90  const double y = attrs.getOpt<double>(SUMO_ATTR_Y, nullptr, ok, myLookFrom.y());
91  const double z = attrs.getOpt<double>(SUMO_ATTR_ZOOM, nullptr, ok, myLookFrom.z());
92  myLookFrom.set(x, y, z);
93  const double cx = attrs.getOpt<double>(SUMO_ATTR_CENTER_X, nullptr, ok, myLookAt.x());
94  const double cy = attrs.getOpt<double>(SUMO_ATTR_CENTER_Y, nullptr, ok, myLookAt.y());
95  const double cz = attrs.getOpt<double>(SUMO_ATTR_CENTER_Z, nullptr, ok, myLookAt.z());
96  myLookAt.set(cx, cy, cz);
97  myRotation = attrs.getOpt<double>(SUMO_ATTR_ANGLE, nullptr, ok, myRotation);
98  break;
99  }
100  case SUMO_TAG_SNAPSHOT: {
101  bool ok = true;
102  std::string file = attrs.get<std::string>(SUMO_ATTR_FILE, nullptr, ok);
103  if (file != "" && !FileHelpers::isAbsolute(file)) {
105  }
106  mySnapshots[attrs.getOptSUMOTimeReporting(SUMO_ATTR_TIME, file.c_str(), ok, 0)].push_back(file);
107  }
108  break;
110  bool ok = true;
111  mySettings.name = attrs.getOpt<std::string>(SUMO_ATTR_NAME, nullptr, ok, mySettings.name);
114  }
115  }
116  break;
119  break;
121  bool ok = true;
122  mySettings.backgroundColor = RGBColor::parseColorReporting(attrs.getStringSecure("backgroundColor", toString(mySettings.backgroundColor)), "background", nullptr, true, ok);
126  }
127  break;
129  int laneEdgeMode = StringUtils::toInt(attrs.getStringSecure("laneEdgeMode", "0"));
130  int laneEdgeScaleMode = StringUtils::toInt(attrs.getStringSecure("scaleMode", "0"));
149  myCurrentColorer = element;
150  mySettings.edgeColorer.setActive(laneEdgeMode);
151  mySettings.edgeScaler.setActive(laneEdgeScaleMode);
152  mySettings.laneColorer.setActive(laneEdgeMode);
153  mySettings.laneScaler.setActive(laneEdgeScaleMode);
154  }
155  break;
157  myCurrentScheme = nullptr;
158  myCurrentScaleScheme = nullptr;
161  if (myCurrentScheme == nullptr) {
163  }
164  }
167  }
170  }
173  }
176  }
179  }
181  bool ok = true;
182  myCurrentScheme->setInterpolated(attrs.getOpt<bool>(SUMO_ATTR_INTERPOLATED, nullptr, ok, false));
184  }
185  break;
187  myCurrentScheme = nullptr;
188  myCurrentScaleScheme = nullptr;
191  if (myCurrentScaleScheme == nullptr) {
193  }
194  }
196  bool ok = true;
197  myCurrentScaleScheme->setInterpolated(attrs.getOpt<bool>(SUMO_ATTR_INTERPOLATED, nullptr, ok, false));
199  }
200  break;
201 
202  case SUMO_TAG_ENTRY:
203  if (myCurrentScheme != nullptr) {
204  bool ok = true;
205  RGBColor color = attrs.get<RGBColor>(SUMO_ATTR_COLOR, nullptr, ok);
206  if (myCurrentScheme->isFixed()) {
208  } else {
209  myCurrentScheme->addColor(color, attrs.getOpt<double>(SUMO_ATTR_THRESHOLD, nullptr, ok, 0));
210  }
211  } else if (myCurrentScaleScheme != nullptr) {
212  bool ok = true;
213  double scale = attrs.get<double>(SUMO_ATTR_COLOR, nullptr, ok);
214  if (myCurrentScaleScheme->isFixed()) {
216  } else {
217  myCurrentScaleScheme->addColor(scale, attrs.getOpt<double>(SUMO_ATTR_THRESHOLD, nullptr, ok, 0));
218  }
219  }
220  break;
229  myCurrentColorer = element;
230  break;
237  myCurrentColorer = element;
238  break;
244  myCurrentColorer = element;
245  break;
255  "drawCrossingsAndWalkingareas", toString(mySettings.drawCrossingsAndWalkingareas)));
257  myCurrentColorer = element;
258  break;
264  break;
270  myCurrentColorer = element;
271  break;
277  myCurrentColorer = element;
278  break;
281  break;
284  d.filename = attrs.getStringSecure("filename", d.filename);
285  if (d.filename != "" && !FileHelpers::isAbsolute(d.filename)) {
287  }
288  d.centerX = attrs.getOpt<double>(SUMO_ATTR_CENTER_X, nullptr, ok, d.centerX);
289  d.centerY = attrs.getOpt<double>(SUMO_ATTR_CENTER_Y, nullptr, ok, d.centerY);
290  d.centerZ = attrs.getOpt<double>(SUMO_ATTR_CENTER_Z, nullptr, ok, d.centerZ);
291  d.width = attrs.getOpt<double>(SUMO_ATTR_WIDTH, nullptr, ok, d.width);
292  d.height = attrs.getOpt<double>(SUMO_ATTR_HEIGHT, nullptr, ok, d.height);
293  d.altitude = StringUtils::toDouble(attrs.getStringSecure("altitude", toString(d.height)));
294  d.rot = StringUtils::toDouble(attrs.getStringSecure("rotation", toString(d.rot)));
295  d.tilt = StringUtils::toDouble(attrs.getStringSecure("tilt", toString(d.tilt)));
296  d.roll = StringUtils::toDouble(attrs.getStringSecure("roll", toString(d.roll)));
297  d.layer = attrs.getOpt<double>(SUMO_ATTR_LAYER, nullptr, ok, d.layer);
299  d.initialised = false;
300  myDecals.push_back(d);
301  }
302  break;
305  d.filename = "light" + attrs.getOpt<std::string>(SUMO_ATTR_INDEX, nullptr, ok, "0");
306  d.centerX = attrs.getOpt<double>(SUMO_ATTR_CENTER_X, nullptr, ok, d.centerX);
307  d.centerY = attrs.getOpt<double>(SUMO_ATTR_CENTER_Y, nullptr, ok, d.centerY);
308  d.centerZ = attrs.getOpt<double>(SUMO_ATTR_CENTER_Z, nullptr, ok, d.centerZ);
309  d.width = attrs.getOpt<double>(SUMO_ATTR_WIDTH, nullptr, ok, d.width);
310  d.height = attrs.getOpt<double>(SUMO_ATTR_HEIGHT, nullptr, ok, d.height);
311  d.altitude = StringUtils::toDouble(attrs.getStringSecure("altitude", toString(d.height)));
312  d.rot = StringUtils::toDouble(attrs.getStringSecure("rotation", toString(d.rot)));
313  d.tilt = StringUtils::toDouble(attrs.getStringSecure("tilt", toString(d.tilt)));
314  d.roll = StringUtils::toDouble(attrs.getStringSecure("roll", toString(d.roll)));
315  d.layer = attrs.getOpt<double>(SUMO_ATTR_LAYER, nullptr, ok, d.layer);
316  d.initialised = false;
317  myDecals.push_back(d);
318  }
319  break;
321  const std::string id = attrs.get<std::string>(SUMO_ATTR_ID, nullptr, ok);
322  const std::string cmd = attrs.get<std::string>(SUMO_ATTR_COMMAND, nullptr, ok);
323  const double prob = attrs.get<double>(SUMO_ATTR_PROB, id.c_str(), ok);
324  myEventDistributions[id].add(cmd, prob);
325  }
326  break;
328  myJamSoundTime = attrs.get<double>(SUMO_ATTR_VALUE, nullptr, ok);
329  break;
330  default:
331  break;
332  }
333 }
334 
335 
338  const std::string& prefix, const SUMOSAXAttributes& attrs,
339  GUIVisualizationTextSettings defaults) {
340  bool ok = true;
342  StringUtils::toBool(attrs.getStringSecure(prefix + "_show", toString(defaults.show))),
343  StringUtils::toDouble(attrs.getStringSecure(prefix + "_size", toString(defaults.size))),
344  RGBColor::parseColorReporting(attrs.getStringSecure(prefix + "_color", toString(defaults.color)), "textSettings", nullptr, true, ok),
345  RGBColor::parseColorReporting(attrs.getStringSecure(prefix + "_bgColor", toString(defaults.bgColor)), "textSettings", nullptr, true, ok),
346  StringUtils::toBool(attrs.getStringSecure(prefix + "_constantSize", toString(defaults.constSize))));
347 }
348 
349 
352  const std::string& prefix, const SUMOSAXAttributes& attrs,
353  GUIVisualizationSizeSettings defaults) {
355  StringUtils::toDouble(attrs.getStringSecure(prefix + "_minSize", toString(defaults.minSize))),
356  StringUtils::toDouble(attrs.getStringSecure(prefix + "_exaggeration", toString(defaults.exaggeration))),
357  StringUtils::toBool(attrs.getStringSecure(prefix + "_constantSize", toString(defaults.constantSize))),
358  StringUtils::toBool(attrs.getStringSecure(prefix + "_constantSizeSelected", toString(defaults.constantSizeSelected))));
359 }
360 
361 
362 std::string
364  if (mySettings.name != "") {
366  if (view) {
367  FXint index = view->getColoringSchemesCombo().appendItem(mySettings.name.c_str());
368  view->getColoringSchemesCombo().setCurrentItem(index);
370  }
371  }
372  return mySettings.name;
373 }
374 
375 
376 void
378  if (myLookFrom.z() > 0) {
379  // z value stores zoom so we must convert first
380  Position lookFrom(myLookFrom.x(), myLookFrom.y(), view->getChanger().zoom2ZPos(myLookFrom.z()));
381  view->setViewportFromToRot(lookFrom, myLookAt, myRotation);
382  }
383 }
384 
385 
386 void
388  if (!mySnapshots.empty()) {
389  for (auto item : mySnapshots) {
390  for (auto file : item.second) {
391  view->addSnapshot(item.first, file);
392  }
393  }
394  }
395 }
396 
397 
398 bool
400  return !myDecals.empty();
401 }
402 
403 
404 const std::vector<GUISUMOAbstractView::Decal>&
406  return myDecals;
407 }
408 
409 
410 double
412  return myDelay;
413 }
414 
415 
416 std::vector<SUMOTime>
417 GUISettingsHandler::loadBreakpoints(const std::string& file) {
418  std::vector<SUMOTime> result;
419  std::ifstream strm(file.c_str());
420  while (strm.good()) {
421  std::string val;
422  strm >> val;
423  if (val.length() == 0) {
424  continue;
425  }
426  try {
427  SUMOTime value = string2time(val);
428  result.push_back(value);
429  } catch (NumberFormatException& e) {
430  WRITE_ERROR(" A breakpoint-value must be an int. " + toString(e.what()));
431  } catch (EmptyData&) {
432  } catch (ProcessError&) {
433  WRITE_ERROR(" Could not decode breakpoint '" + val + "'");
434  }
435  }
436  return result;
437 }
438 
439 
443  if (result.getOverallProb() > 0 && result.getOverallProb() < 1) {
444  // unscaled probabilities are assumed, fill up with dummy event
445  result.add("", 1. - result.getOverallProb());
446  }
447  return result;
448 }
449 
450 
451 /****************************************************************************/
452 
GUIVisualizationSizeSettings junctionSize
const std::vector< GUISUMOAbstractView::Decal > & getDecals() const
Returns the parsed decals.
GUIVisualizationTextSettings junctionName
A decal (an image) that can be shown.
GUIScaleScheme * myCurrentScaleScheme
The current scaling scheme.
double altitude
The altitude of the image (net coordinates in z-direction, in m)
GUICompleteSchemeStorage gSchemeStorage
bool showSizeLegend
Information whether the size legend shall be drawn.
long long int SUMOTime
Definition: SUMOTime.h:36
GUIVisualizationTextSettings poiType
static std::string getConfigurationRelative(const std::string &configPath, const std::string &path)
Returns the second path as a relative path to the first file.
Definition: FileHelpers.cpp:75
GUIVisualizationTextSettings streetName
double laneWidthExaggeration
The lane exaggeration (upscale thickness)
void myStartElement(int element, const SUMOSAXAttributes &attrs)
Called on the opening of a tag.
double myRotation
View rotation.
bool showBlinker
Information whether vehicle blinkers shall be drawn.
double z() const
Returns the z-position.
Definition: Position.h:67
GUIVisualizationTextSettings addName
int myCurrentColorer
The last color scheme category (edges or vehicles)
GUIVisualizationTextSettings personValue
GUIVisualizationTextSettings personName
GUIColorScheme * myCurrentScheme
The current color scheme.
GUIVisualizationTextSettings poiName
static RGBColor parseColorReporting(const std::string &coldef, const std::string &objecttype, const char *objectid, bool report, bool &ok)
Parses a color information.
Definition: RGBColor.cpp:257
virtual double zoom2ZPos(double zoom) const =0
Returns the camera height at which the given zoom level is reached.
double exaggeration
The size exaggeration (upscale)
GUIColorer laneColorer
The lane colorer.
GUIColorer containerColorer
The container colorer.
A layer number.
GUIColorer edgeColorer
The mesoscopic edge colorer.
const std::string & getFileName() const
returns the current file name
double y() const
Returns the y-position.
Definition: Position.h:62
GUIVisualizationTextSettings edgeValue
bool showRails
Information whether rails shall be drawn.
std::vector< GUISUMOAbstractView::Decal > myDecals
The decals list to fill.
GUIVisualizationTextSettings vehicleName
double x() const
Returns the x-position.
Definition: Position.h:57
double centerX
The center of the image in x-direction (net coordinates, in m)
SAX-reader encapsulation containing binary reader.
Definition: SUMOSAXReader.h:51
Position myLookAt
The point to look at, only needed for osg view.
bool screenRelative
Whether this image should be skipped in 2D-views.
T * getSchemeByName(std::string name)
bool showLaneDirection
Whether to show direction indicators for lanes.
GUIVisualizationTextSettings cwaEdgeName
bool laneShowBorders
Information whether lane borders shall be drawn.
static std::vector< SUMOTime > loadBreakpoints(const std::string &file)
loads breakpoints from the specified file
bool hasDecals() const
Returns whether any decals have been parsed.
bool showLinkRules
Information whether link rules (colored bars) shall be drawn.
void parseString(std::string content)
void set(double x, double y)
set positions x and y
Definition: Position.h:87
SAX-handler base for SUMO-files.
static bool runParser(GenericSAXHandler &handler, const std::string &file, const bool isNet=false)
Runs the given handler on the given file; returns if everything&#39;s ok.
Definition: XMLSubSys.cpp:113
bool dither
Information whether dithering shall be enabled.
double height
The height of the image (net coordinates in y-direction, in m)
double myDelay
The delay loaded.
SUMOTime getSUMOTimeReporting(int attr, const char *objectid, bool &ok, bool report=true) const
Tries to read given attribute assuming it is a SUMOTime.
double getDelay() const
Returns the parsed delay.
double layer
The layer of the image.
GUIVisualizationSettings mySettings
The settings to fill.
static bool toBool(const std::string &sData)
converts a string into the bool value described by it by calling the char-type converter ...
GUIVisualizationSizeSettings polySize
GUIColorer vehicleColorer
The vehicle colorer.
std::string edgeParam
key for coloring by edge parameter
double roll
The roll of the image to the ground plane (in degrees)
RandomDistributor< std::string > getEventDistribution(const std::string &id)
GUIVisualizationTextSettings edgeName
GUIVisualizationSizeSettings addSize
GUIColorer poiColorer
The POI colorer.
GUISettingsHandler(const std::string &content, bool isFile=true, bool netedit=false)
Constructor.
GUIVisualizationTextSettings vehicleValue
void setFileName(const std::string &name)
Sets the current file name.
int addColor(const T &color, const double threshold, const std::string &name="")
std::string name
The name of this setting.
double gridXSize
Information about the grid spacings.
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:49
double minSize
The minimum size to draw this object.
Encapsulated SAX-Attributes.
T get(int attr, const char *objectid, bool &ok, bool report=true) const
Tries to read given attribute assuming it is an int.
static double toDouble(const std::string &sData)
converts a string into the double value described by it by calling the char-type converter ...
GUIVisualizationTextSettings internalEdgeName
static bool isAbsolute(const std::string &path)
Returns the information whether the given path is absolute.
Definition: FileHelpers.cpp:90
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:39
GUIVisualizationTextSettings parseTextSettings(const std::string &prefix, const SUMOSAXAttributes &attrs, GUIVisualizationTextSettings defaults)
parse attributes for textSettings
bool drawMinGap
Information whether the minimum gap shall be drawn.
int addMode
The additional structures visualization scheme.
double rot
The rotation of the image in the ground plane (in degrees)
GUIVisualizationTextSettings polyType
bool showSublanes
Whether to show sublane boundaries.
GUIVisualizationSettings & get(const std::string &name)
Returns the named scheme.
GUIPerspectiveChanger & getChanger() const
get changer
FXComboBox & getColoringSchemesCombo()
get coloring schemes combo
static SUMOSAXReader * getSAXReader(SUMOSAXHandler &handler)
Builds a reader and assigns the handler to it.
Definition: XMLSubSys.cpp:101
SUMOTime string2time(const std::string &r)
Definition: SUMOTime.cpp:42
bool initialised
Whether this image was initialised (inserted as a texture)
GUIVisualizationTextSettings drawLinkTLIndex
GUIColorer polyColorer
The polygon colorer.
GUIColorer personColorer
The person colorer.
GUIVisualizationTextSettings internalJunctionName
double centerY
The center of the image in y-direction (net coordinates, in m)
GUIColorer junctionColorer
The junction colorer.
~GUISettingsHandler()
Destructor.
std::string filename
The path to the file the image is located at.
virtual void setViewportFromToRot(const Position &lookFrom, const Position &lookAt, double rotation)
applies the given viewport settings
static int toInt(const std::string &sData)
converts a string into the integer value described by it by calling the char-type converter...
double laneMinSize
The minimum visual lane width for drawing.
GUIScaler edgeScaler
The mesoscopic edge scaler.
void setSnapshots(GUISUMOAbstractView *view) const
Makes a snapshot if it has been parsed.
std::string myViewType
The view type (osg, opengl, default) loaded.
int containerQuality
The quality of container drawing.
RGBColor backgroundColor
The background color to use.
std::string addSettings(GUISUMOAbstractView *view=0) const
Adds the parsed settings to the global list of settings.
double width
The width of the image (net coordinates in x-direction, in m)
void setColor(const int pos, const T &color)
virtual bool setColorScheme(const std::string &)
set color scheme
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:247
GUIVisualizationSizeSettings poiSize
trigger: the time of the step
T getOpt(int attr, const char *objectid, bool &ok, T defaultValue, bool report=true) const
Tries to read given attribute assuming it is an int.
bool showLinkDecals
Information whether link textures (arrows) shall be drawn.
GUIVisualizationSizeSettings containerSize
void applyViewport(GUISUMOAbstractView *view) const
Sets the viewport which has been parsed.
bool contains(const std::string &name) const
Returns the information whether a setting with the given name is stored.
GUIVisualizationTextSettings addFullName
SUMOTime getOptSUMOTimeReporting(int attr, const char *objectid, bool &ok, SUMOTime defaultValue, bool report=true) const
Tries to read given attribute assuming it is a SUMOTime.
virtual std::string getStringSecure(int id, const std::string &def) const =0
Returns the string-value of the named (by its enum-value) attribute.
double centerZ
The center of the image in z-direction (net coordinates, in m)
GUIVisualizationSizeSettings personSize
int personQuality
The quality of person drawing.
bool showGrid
Information whether a grid shall be shown.
bool drawCrossingsAndWalkingareas
whether crosings and walkingareas shall be drawn
double getOverallProb() const
Return the sum of the probabilites assigned to the members.
double tilt
The tilt of the image to the ground plane (in degrees)
void addSnapshot(SUMOTime time, const std::string &file, const int width=-1, const int height=-1)
Sets the snapshot time to file map.
std::map< SUMOTime, std::vector< std::string > > mySnapshots
mappig of time steps to filenames for potential snapshots
bool showLane2Lane
Information whether lane-to-lane arrows shall be drawn.
std::map< std::string, RandomDistributor< std::string > > myEventDistributions
The parsed event distributions.
GUIVisualizationSizeSettings vehicleSize
bool drawJunctionShape
whether the shape of the junction should be drawn
int vehicleQuality
The quality of vehicle drawing.
std::vector< SUMOTime > myBreakpoints
The parsed breakpoints.
bool add(T val, double prob, bool checkDuplicates=true)
Adds a value with an assigned probability to the distribution.
GUIScaler laneScaler
The lane scaler.
bool spreadSuperposed
Whether to improve visualisation of superposed (rail) edges.
A color information.
GUIVisualizationTextSettings drawLinkJunctionIndex
GUIVisualizationSizeSettings parseSizeSettings(const std::string &prefix, const SUMOSAXAttributes &attrs, GUIVisualizationSizeSettings defaults)
parse attributes for sizeSettings
Position myLookFrom
The viewport loaded, zoom is stored in z coordinate.
bool showBikeMarkings
Information whether bicycle lane marking shall be drawn.
void setInterpolated(const bool interpolate, double interpolationStart=0.f)
void add(const GUIVisualizationSettings &scheme)
Adds a visualization scheme.
GUIVisualizationTextSettings polyName
GUIVisualizationTextSettings containerName