Eclipse SUMO - Simulation of Urban MObility
GUIVehicle.h
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3// Copyright (C) 2001-2023 German Aerospace Center (DLR) and others.
4// This program and the accompanying materials are made available under the
5// terms of the Eclipse Public License 2.0 which is available at
6// https://www.eclipse.org/legal/epl-2.0/
7// This Source Code may also be made available under the following Secondary
8// Licenses when the conditions for such availability set forth in the Eclipse
9// Public License 2.0 are satisfied: GNU General Public License, version 2
10// or later which is available at
11// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13/****************************************************************************/
21// A MSVehicle extended by some values for usage within the gui
22/****************************************************************************/
23#pragma once
24#include <config.h>
25
26#include <vector>
27#include <string>
29#include <microsim/MSVehicle.h>
30#include "GUIBaseVehicle.h"
31
32
33// ===========================================================================
34// class declarations
35// ===========================================================================
37
38
39// ===========================================================================
40// class definitions
41// ===========================================================================
51class GUIVehicle : public MSVehicle, public GUIBaseVehicle {
52public:
61 MSVehicleType* type, const double speedFactor);
62
63
66
71 Position getPosition(const double offset = 0) const {
72 return MSVehicle::getPosition(offset);
73 }
74
75 Position getVisualPosition(bool s2, const double offset = 0) const;
76
81 double getAngle() const {
82 return MSVehicle::getAngle();
83 }
84
89 double getVisualAngle(bool s2) const;
90
94 void drawRouteHelper(const GUIVisualizationSettings& s, ConstMSRoutePtr r, bool future, bool noLoop, const RGBColor& col) const;
95
96 void drawAction_drawVehicleBlinker(double length) const;
97 void drawAction_drawVehicleBrakeLight(double length, bool onlyOne = false) const;
100
105 double getLastLaneChangeOffset() const;
106
107
110 void drawBestLanes() const;
112
114 void selectBlockingFoes() const;
115
117 double getColorValue(const GUIVisualizationSettings& s, int activeScheme) const;
118
127
135
137 bool isSelected() const;
138
140 double getRightSideOnEdge2() const {
141 return getRightSideOnEdge();
142 }
144 double getLeftSideOnEdge() const {
146 }
147
149 int getRightSublaneOnEdge() const;
150 int getLeftSublaneOnEdge() const;
151
153 std::string getLCStateRight() const;
154 std::string getLCStateLeft() const;
155 std::string getLCStateCenter() const;
156
158 std::string getLaneID() const;
159 std::string getBackLaneIDs() const;
160 std::string getShadowLaneID() const;
161 std::string getTargetLaneID() const;
162
164 double getManeuverDist() const;
166 std::string getSpeedMode() const;
168 std::string getLaneChangeMode() const;
169
171 std::string getDynamicAlignment() const;
172
174 void rerouteDRTStop(MSStoppingPlace* busStop);
175
176protected:
178 void drawOutsideNetwork(bool add);
179
180private:
181
182 /* @brief draw train with individual carriages. The number of carriages is
183 * determined from defaultLength of carriages and vehicle length
184 * passengerSeats are computed beginning at firstPassengerCarriage */
185 void drawAction_drawCarriageClass(const GUIVisualizationSettings& s, bool asImage) const;
186
187 /* @brief return the previous lane in this vehicles route including internal lanes
188 * @param[in] current The lane of which the predecessor should be returned
189 * @param[in,out] routeIndex The index of the current or previous non-internal edge in the route
190 */
191 MSLane* getPreviousLane(MSLane* current, int& furtherIndex) const;
192
194 std::string getStopInfo() const;
195
196};
std::shared_ptr< const MSRoute > ConstMSRoutePtr
Definition: Route.h:32
A MSVehicle extended by some values for usage within the gui.
A window containing a gl-object's parameter.
A MSVehicle extended by some values for usage within the gui.
Definition: GUIVehicle.h:51
bool isSelected() const
whether this vehicle is selected in the GUI
Definition: GUIVehicle.cpp:970
int getLeftSublaneOnEdge() const
Definition: GUIVehicle.cpp:987
double getAngle() const
Return current angle.
Definition: GUIVehicle.h:81
Position getPosition(const double offset=0) const
Return current position (x/y, cartesian)
Definition: GUIVehicle.h:71
double getColorValue(const GUIVisualizationSettings &s, int activeScheme) const
gets the color value according to the current scheme index
Definition: GUIVehicle.cpp:592
std::string getDynamicAlignment() const
return the current lateral alignment as string
Definition: GUIVehicle.cpp:263
double getVisualAngle(bool s2) const
Returns the vehicle's direction in radians taking into account secondary shape.
void selectBlockingFoes() const
adds the blocking foes to the current selection
Definition: GUIVehicle.cpp:868
GUIParameterTableWindow * getTypeParameterWindow(GUIMainWindow &app, GUISUMOAbstractView &parent)
Returns an own type parameter window.
Definition: GUIVehicle.cpp:208
void drawBestLanes() const
Draws the vehicle's best lanes.
Definition: GUIVehicle.cpp:679
void drawOutsideNetwork(bool add)
register vehicle for drawing while outside the network
Definition: GUIVehicle.cpp:953
int getRightSublaneOnEdge() const
return the righmost sublane on the edge occupied by the vehicle
Definition: GUIVehicle.cpp:975
void drawRouteHelper(const GUIVisualizationSettings &s, ConstMSRoutePtr r, bool future, bool noLoop, const RGBColor &col) const
Draws the route.
Definition: GUIVehicle.cpp:714
MSLane * getPreviousLane(MSLane *current, int &furtherIndex) const
Definition: GUIVehicle.cpp:778
std::string getStopInfo() const
retrieve information about the current stop state
Definition: GUIVehicle.cpp:838
GUIParameterTableWindow * getParameterWindow(GUIMainWindow &app, GUISUMOAbstractView &parent)
Returns an own parameter window.
Definition: GUIVehicle.cpp:96
std::string getBackLaneIDs() const
double getLeftSideOnEdge() const
return left vehicle side on current edge
Definition: GUIVehicle.h:144
void drawAction_drawCarriageClass(const GUIVisualizationSettings &s, bool asImage) const
draws the given guiShape with distinct carriages/modules
Definition: GUIVehicle.cpp:305
std::string getShadowLaneID() const
double getManeuverDist() const
return the lane-change maneuver distance
double getRightSideOnEdge2() const
return right vehicle side on current edge (without argument)
Definition: GUIVehicle.h:140
std::string getSpeedMode() const
return the speed mode as bit string
GUIVehicle(SUMOVehicleParameter *pars, ConstMSRoutePtr route, MSVehicleType *type, const double speedFactor)
Constructor.
Definition: GUIVehicle.cpp:84
void drawAction_drawVehicleBlinker(double length) const
Definition: GUIVehicle.cpp:540
void rerouteDRTStop(MSStoppingPlace *busStop)
handle route to accomodate to given stop
std::string getLCStateRight() const
return the lanechange state
void drawAction_drawVehicleBlueLight() const
Definition: GUIVehicle.cpp:580
double getLastLaneChangeOffset() const
Returns the time since the last lane change in seconds.
Definition: GUIVehicle.cpp:832
std::string getLaneID() const
return vehicle lane id
void drawAction_drawLinkItems(const GUIVisualizationSettings &s) const
Definition: GUIVehicle.cpp:275
std::string getTargetLaneID() const
std::string getLCStateLeft() const
Position getVisualPosition(bool s2, const double offset=0) const
Return current position taking into account secondary shape.
void drawAction_drawVehicleBrakeLight(double length, bool onlyOne=false) const
Definition: GUIVehicle.cpp:559
~GUIVehicle()
destructor
Definition: GUIVehicle.cpp:91
std::string getLCStateCenter() const
std::string getLaneChangeMode() const
return the lane change mode as bit string
Stores the information about how to visualize structures.
const MSVehicleType & getVehicleType() const
Returns the vehicle's type definition.
Representation of a lane in the micro simulation.
Definition: MSLane.h:84
A lane area vehicles can halt at.
Representation of a vehicle in the micro simulation.
Definition: MSVehicle.h:77
double getRightSideOnEdge(const MSLane *lane=0) const
Get the vehicle's lateral position on the edge of the given lane (or its current edge if lane == 0)
Definition: MSVehicle.cpp:6430
Position getPosition(const double offset=0) const
Return current position (x/y, cartesian)
Definition: MSVehicle.cpp:1216
double getAngle() const
Returns the vehicle's direction in radians.
Definition: MSVehicle.h:736
The car-following model and parameter.
Definition: MSVehicleType.h:63
double getWidth() const
Get the width which vehicles of this class shall have when being drawn.
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:37
Structure representing possible vehicle parameter.