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(0),
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, 0, ok);
76  }
77  break;
79  myBreakpoints.push_back(attrs.getSUMOTimeReporting(SUMO_ATTR_VALUE, 0, ok));
80  break;
82  myViewType = attrs.getOpt<std::string>(SUMO_ATTR_TYPE, 0, 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, 0, ok, myDelay);
87  break;
88  case SUMO_TAG_VIEWPORT: {
89  const double x = attrs.getOpt<double>(SUMO_ATTR_X, 0, ok, myLookFrom.x());
90  const double y = attrs.getOpt<double>(SUMO_ATTR_Y, 0, ok, myLookFrom.y());
91  const double z = attrs.getOpt<double>(SUMO_ATTR_ZOOM, 0, ok, myLookFrom.z());
92  myLookFrom.set(x, y, z);
93  const double cx = attrs.getOpt<double>(SUMO_ATTR_CENTER_X, 0, ok, myLookAt.x());
94  const double cy = attrs.getOpt<double>(SUMO_ATTR_CENTER_Y, 0, ok, myLookAt.y());
95  const double cz = attrs.getOpt<double>(SUMO_ATTR_CENTER_Z, 0, ok, myLookAt.z());
96  myLookAt.set(cx, cy, cz);
97  myRotation = attrs.getOpt<double>(SUMO_ATTR_ANGLE, 0, 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, 0, 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, 0, 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", 0, true, ok);
126  }
127  break;
129  int laneEdgeMode = TplConvert::_2int(attrs.getStringSecure("laneEdgeMode", "0").c_str());
130  int laneEdgeScaleMode = TplConvert::_2int(attrs.getStringSecure("scaleMode", "0").c_str());
146  myCurrentColorer = element;
147  mySettings.edgeColorer.setActive(laneEdgeMode);
148  mySettings.edgeScaler.setActive(laneEdgeScaleMode);
149  mySettings.laneColorer.setActive(laneEdgeMode);
150  mySettings.laneScaler.setActive(laneEdgeScaleMode);
151  }
152  break;
154  myCurrentScheme = 0;
158  if (myCurrentScheme == 0) {
160  }
161  }
164  }
167  }
170  }
173  }
176  }
178  bool ok = true;
179  myCurrentScheme->setInterpolated(attrs.getOpt<bool>(SUMO_ATTR_INTERPOLATED, 0, ok, false));
181  }
182  break;
184  myCurrentScheme = 0;
188  if (myCurrentScaleScheme == 0) {
190  }
191  }
193  bool ok = true;
196  }
197  break;
198 
199  case SUMO_TAG_ENTRY:
200  if (myCurrentScheme != 0) {
201  bool ok = true;
202  RGBColor color = attrs.get<RGBColor>(SUMO_ATTR_COLOR, 0, ok);
203  if (myCurrentScheme->isFixed()) {
205  } else {
206  myCurrentScheme->addColor(color, attrs.getOpt<double>(SUMO_ATTR_THRESHOLD, 0, ok, 0));
207  }
208  } else if (myCurrentScaleScheme != 0) {
209  bool ok = true;
210  double scale = attrs.get<double>(SUMO_ATTR_COLOR, 0, ok);
211  if (myCurrentScaleScheme->isFixed()) {
213  } else {
214  myCurrentScaleScheme->addColor(scale, attrs.getOpt<double>(SUMO_ATTR_THRESHOLD, 0, ok, 0));
215  }
216  }
217  break;
219  mySettings.vehicleColorer.setActive(TplConvert::_2int(attrs.getStringSecure("vehicleMode", "0").c_str()));
224  myCurrentColorer = element;
225  break;
227  mySettings.personColorer.setActive(TplConvert::_2int(attrs.getStringSecure("personMode", "0").c_str()));
231  myCurrentColorer = element;
232  break;
234  mySettings.containerColorer.setActive(TplConvert::_2int(attrs.getStringSecure("containerMode", "0").c_str()));
238  myCurrentColorer = element;
239  break;
241  mySettings.junctionColorer.setActive(TplConvert::_2int(attrs.getStringSecure("junctionMode", "0").c_str()));
249  "drawCrossingsAndWalkingareas", toString(mySettings.drawCrossingsAndWalkingareas)).c_str());
251  myCurrentColorer = element;
252  break;
258  break;
263  mySettings.poiColorer.setActive(TplConvert::_2int(attrs.getStringSecure("personMode", "0").c_str()));
264  myCurrentColorer = element;
265  break;
270  mySettings.polyColorer.setActive(TplConvert::_2int(attrs.getStringSecure("personMode", "0").c_str()));
271  myCurrentColorer = element;
272  break;
275  break;
278  d.filename = attrs.getStringSecure("filename", d.filename);
279  if (d.filename != "" && !FileHelpers::isAbsolute(d.filename)) {
281  }
282  d.centerX = attrs.getOpt<double>(SUMO_ATTR_CENTER_X, 0, ok, d.centerX);
283  d.centerY = attrs.getOpt<double>(SUMO_ATTR_CENTER_Y, 0, ok, d.centerY);
284  d.centerZ = attrs.getOpt<double>(SUMO_ATTR_CENTER_Z, 0, ok, d.centerZ);
285  d.width = attrs.getOpt<double>(SUMO_ATTR_WIDTH, 0, ok, d.width);
286  d.height = attrs.getOpt<double>(SUMO_ATTR_HEIGHT, 0, ok, d.height);
287  d.altitude = TplConvert::_2double(attrs.getStringSecure("altitude", toString(d.height)).c_str());
288  d.rot = TplConvert::_2double(attrs.getStringSecure("rotation", toString(d.rot)).c_str());
289  d.tilt = TplConvert::_2double(attrs.getStringSecure("tilt", toString(d.tilt)).c_str());
290  d.roll = TplConvert::_2double(attrs.getStringSecure("roll", toString(d.roll)).c_str());
291  d.layer = attrs.getOpt<double>(SUMO_ATTR_LAYER, 0, ok, d.layer);
292  d.screenRelative = TplConvert::_2bool(attrs.getStringSecure("screenRelative", toString(d.screenRelative)).c_str());
293  d.initialised = false;
294  myDecals.push_back(d);
295  }
296  break;
299  d.filename = "light" + attrs.getOpt<std::string>(SUMO_ATTR_INDEX, 0, ok, "0");
300  d.centerX = attrs.getOpt<double>(SUMO_ATTR_CENTER_X, 0, ok, d.centerX);
301  d.centerY = attrs.getOpt<double>(SUMO_ATTR_CENTER_Y, 0, ok, d.centerY);
302  d.centerZ = attrs.getOpt<double>(SUMO_ATTR_CENTER_Z, 0, ok, d.centerZ);
303  d.width = attrs.getOpt<double>(SUMO_ATTR_WIDTH, 0, ok, d.width);
304  d.height = attrs.getOpt<double>(SUMO_ATTR_HEIGHT, 0, ok, d.height);
305  d.altitude = TplConvert::_2double(attrs.getStringSecure("altitude", toString(d.height)).c_str());
306  d.rot = TplConvert::_2double(attrs.getStringSecure("rotation", toString(d.rot)).c_str());
307  d.tilt = TplConvert::_2double(attrs.getStringSecure("tilt", toString(d.tilt)).c_str());
308  d.roll = TplConvert::_2double(attrs.getStringSecure("roll", toString(d.roll)).c_str());
309  d.layer = attrs.getOpt<double>(SUMO_ATTR_LAYER, 0, ok, d.layer);
310  d.initialised = false;
311  myDecals.push_back(d);
312  }
313  break;
315  const std::string id = attrs.get<std::string>(SUMO_ATTR_ID, 0, ok);
316  const std::string cmd = attrs.get<std::string>(SUMO_ATTR_COMMAND, 0, ok);
317  const double prob = attrs.get<double>(SUMO_ATTR_PROB, id.c_str(), ok);
318  myEventDistributions[id].add(cmd, prob);
319  }
320  break;
322  myJamSoundTime = attrs.get<double>(SUMO_ATTR_VALUE, 0, ok);
323  break;
324  default:
325  break;
326  }
327 }
328 
329 
332  const std::string& prefix, const SUMOSAXAttributes& attrs,
333  GUIVisualizationTextSettings defaults) {
334  bool ok = true;
336  TplConvert::_2bool(attrs.getStringSecure(prefix + "_show", toString(defaults.show)).c_str()),
337  TplConvert::_2double(attrs.getStringSecure(prefix + "_size", toString(defaults.size)).c_str()),
338  RGBColor::parseColorReporting(attrs.getStringSecure(prefix + "_color", toString(defaults.color)), "edges", 0, true, ok),
339  TplConvert::_2bool(attrs.getStringSecure(prefix + "_constantSize", toString(defaults.constSize)).c_str()));
340 }
341 
342 
345  const std::string& prefix, const SUMOSAXAttributes& attrs,
346  GUIVisualizationSizeSettings defaults) {
348  TplConvert::_2double(attrs.getStringSecure(prefix + "_minSize", toString(defaults.minSize)).c_str()),
349  TplConvert::_2double(attrs.getStringSecure(prefix + "_exaggeration", toString(defaults.exaggeration)).c_str()),
350  TplConvert::_2bool(attrs.getStringSecure(prefix + "_constantSize", toString(defaults.constantSize)).c_str()));
351 }
352 
353 
354 std::string
356  if (mySettings.name != "") {
358  if (view) {
359  FXint index = view->getColoringSchemesCombo().appendItem(mySettings.name.c_str());
360  view->getColoringSchemesCombo().setCurrentItem(index);
362  }
363  }
364  return mySettings.name;
365 }
366 
367 
368 void
370  if (myLookFrom.z() > 0) {
371  // z value stores zoom so we must convert first
372  Position lookFrom(myLookFrom.x(), myLookFrom.y(), view->getChanger().zoom2ZPos(myLookFrom.z()));
373  view->setViewportFromToRot(lookFrom, myLookAt, myRotation);
374  }
375 }
376 
377 
378 void
380  if (!mySnapshots.empty()) {
381  for (auto item : mySnapshots) {
382  for (auto file : item.second) {
383  view->addSnapshot(item.first, file);
384  }
385  }
386  }
387 }
388 
389 
390 bool
392  return !myDecals.empty();
393 }
394 
395 
396 const std::vector<GUISUMOAbstractView::Decal>&
398  return myDecals;
399 }
400 
401 
402 double
404  return myDelay;
405 }
406 
407 
408 std::vector<SUMOTime>
409 GUISettingsHandler::loadBreakpoints(const std::string& file) {
410  std::vector<SUMOTime> result;
411  std::ifstream strm(file.c_str());
412  while (strm.good()) {
413  std::string val;
414  strm >> val;
415  if (val.length() == 0) {
416  continue;
417  }
418  try {
419  SUMOTime value = string2time(val);
420  result.push_back(value);
421  } catch (NumberFormatException&) {
422  WRITE_ERROR(" A breakpoint-value must be an int, is:" + val);
423  } catch (ProcessError&) {
424  WRITE_ERROR(" Could not decode breakpoint '" + val + "'");
425  } catch (EmptyData&) {}
426  }
427  return result;
428 }
429 
430 
434  if (result.getOverallProb() > 0 && result.getOverallProb() < 1) {
435  // unscaled probabilities are assumed, fill up with dummy event
436  result.add("", 1. - result.getOverallProb());
437  }
438  return result;
439 }
440 
441 
442 /****************************************************************************/
443 
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:66
GUIVisualizationTextSettings addName
int myCurrentColorer
The last color scheme category (edges or vehicles)
GUIVisualizationTextSettings personName
GUIColorScheme * myCurrentScheme
The current color scheme.
GUIVisualizationTextSettings poiName
static bool _2bool(const E *const data)
converts a 0-terminated char-type array into the boolean value described by it
Definition: TplConvert.h:382
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:253
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:61
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:56
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:86
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.
GUIVisualizationSizeSettings polySize
GUIColorer vehicleColorer
The vehicle colorer.
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.
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.
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
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
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:248
GUIVisualizationSizeSettings poiSize
static int _2int(const E *const data)
converts a char-type array into the integer value described by it
Definition: TplConvert.h:149
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)
static double _2double(const E *const data)
converts a char-type array into the double value described by it
Definition: TplConvert.h:305
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