GNERouteFrame Class Reference

#include <GNERouteFrame.h>

Inheritance diagram for GNERouteFrame:

Collaboration diagram for GNERouteFrame:

Data Structures
class	RouteModeSelector

Public Types
enum class	RouteMode { INVALID , NONCONSECUTIVE_EDGES , CONSECUTIVE_EDGES }
	route creation modes More...

Public Member Functions
bool	addEdgeRoute (GNEEdge *clickedEdge, const GNEViewNetHelper::MouseButtonKeyPressed &mouseButtonKeyPressed)
	add route edge
void	focusUpperElement ()
	focus upper element of frame
virtual void	frameWidthUpdated ()
	function called after setting new width in current frame (can be reimplemented in frame children)
FXVerticalFrame *	getContentFrame () const
	get vertical frame that holds all widgets of frame
FXFont *	getFrameHeaderFont () const
	get font of the header's frame
FXLabel *	getFrameHeaderLabel () const
	get the label for the frame's header
GNEPathCreator *	getPathCreator () const
	get path creator module
int	getScrollBarWidth () const
	get scrollBar width (zero if is hidden)
GNEViewNet *	getViewNet () const
	get view net
	GNERouteFrame (GNEViewParent *viewParent, GNEViewNet *viewNet)
	Constructor.
void	hide ()
	hide delete frame
void	openHelpAttributesDialog (const GNEAttributeCarrier *AC) const
	Open help attributes dialog.
void	setFrameWidth (const int newWidth)
	set width of GNEFrame
void	show ()
	show delete frame
virtual void	updateFrameAfterUndoRedo ()
	function called after undo/redo in the current frame (can be reimplemented in frame children)
	~GNERouteFrame ()
	Destructor.
functions called by moduls that can be reimplemented in frame children (note: reimplement as protected, just for safety)
virtual void	tagSelected ()
	Tag selected in GNETagSelector.
virtual void	demandElementSelected ()
	selected demand element in DemandElementSelector
virtual bool	shapeDrawed ()
	build a shaped element using the drawed shape
virtual void	attributeUpdated (SumoXMLAttr attribute)
	function called after set a valid attribute in AttributeCreator/AttributeEditor/ParametersEditor/...
virtual void	selectedOverlappedElement (GNEAttributeCarrier *AC)
	open GNEAttributesCreator extended dialog

Protected Member Functions
bool	createPath (const bool useLastRoute)
	create path
const std::vector< std::string > &	getPredefinedTagsMML () const
	get predefinedTagsMML

Static Protected Member Functions
static FXLabel *	buildRainbow (FXComposite *parent)
	build rainbow in frame modul

Protected Attributes
FXVerticalFrame *	myContentFrame = nullptr
	Vertical frame that holds all widgets of frame.
FXHorizontalFrame *	myHeaderFrame = nullptr
	fame for header elements
FXHorizontalFrame *	myHeaderLeftFrame = nullptr
	fame for left header elements
FXHorizontalFrame *	myHeaderRightFrame = nullptr
	fame for right header elements
GNEViewNet *	myViewNet = nullptr
	FOX need this.

Private Attributes
FXLabel *	myFrameHeaderLabel = nullptr
	the label for the frame's header
GNEPathCreator *	myPathCreator = nullptr
	path creator modul
GNEPathLegendModule *	myPathLegend = nullptr
	path legend modul
std::vector< std::string >	myPredefinedTagsMML
	Map of attribute ids to their (readable) string-representation (needed for SUMOSAXAttributesImpl_Cached).
GNEAttributesEditor *	myRouteAttributesEditor = nullptr
	internal route attributes editor
CommonXMLStructure::SumoBaseObject *	myRouteBaseObject = nullptr
	route base object
RouteModeSelector *	myRouteModeSelector = nullptr
	route mode selector
FXScrollWindow *	myScrollWindowsContents = nullptr
	scroll windows that holds the content frame

Static Private Attributes
static FXFont *	myFrameHeaderFont = nullptr
	static Font for the Header (it's common for all headers, then create only one time)

Detailed Description

Definition at line 38 of file GNERouteFrame.h.

Member Enumeration Documentation

RouteMode

enum class GNERouteFrame::RouteMode

strong

route creation modes

Enumerator
INVALID
NONCONSECUTIVE_EDGES
CONSECUTIVE_EDGES

Definition at line 43 of file GNERouteFrame.h.

Constructor & Destructor Documentation

GNERouteFrame()

GNERouteFrame::GNERouteFrame	(	GNEViewParent *	viewParent,
		GNEViewNet *	viewNet )

Constructor.

viewParent GNEViewParent in which this GNEFrame is placed

viewNet viewNet that uses this GNEFrame

Definition at line 186 of file GNERouteFrame.cpp.

References GNEAttributesEditorType::CREATOR, GNENet::getDemandPathManager(), GNEViewNet::getNet(), GNEFrame::GNEFrame(), myPathCreator, myPathLegend, myRouteAttributesEditor, myRouteBaseObject, myRouteModeSelector, and TL.

Referenced by GNERouteFrame::RouteModeSelector::RouteModeSelector().

Here is the caller graph for this function:

~GNERouteFrame()

GNERouteFrame::~GNERouteFrame

(

)

Destructor.

Definition at line 204 of file GNERouteFrame.cpp.

References myRouteBaseObject.

Member Function Documentation

addEdgeRoute()

bool GNERouteFrame::addEdgeRoute	(	GNEEdge *	clickedEdge,
		const GNEViewNetHelper::MouseButtonKeyPressed &	mouseButtonKeyPressed )

add route edge

Parameters

edge	edge to be added
mouseButtonKeyPressed	key pressed during click

Returns

true if element was successfully added

Definition at line 229 of file GNERouteFrame.cpp.

References GNEViewNetHelper::MouseButtonKeyPressed::controlKeyPressed(), myPathCreator, myRouteModeSelector, GNEFrame::myViewNet, and GNEViewNetHelper::MouseButtonKeyPressed::shiftKeyPressed().

attributeUpdated()

void GNEFrame::attributeUpdated ( SumoXMLAttr attribute )

virtualinherited

function called after set a valid attribute in AttributeCreator/AttributeEditor/ParametersEditor/...

Reimplemented in GNEMeanDataFrame, GNERouteDistributionFrame, GNETypeDistributionFrame, and GNETypeFrame.

Definition at line 220 of file GNEFrame.cpp.

buildRainbow()

FXLabel * GNEFrame::buildRainbow ( FXComposite * parent )

staticprotectedinherited

build rainbow in frame modul

Definition at line 245 of file GNEFrame.cpp.

References MFXUtils::getFXColor(), GNEViewNetHelper::getRainbowScaledColors(), GUIDesignAuxiliarHorizontalFrame, GUIDesignLabel, GUIDesignLabelThick, and TL.

Referenced by GNEGenericDataFrame::AttributeSelector::AttributeSelector(), and GNETAZFrame::TAZEdgesGraphic::TAZEdgesGraphic().

Here is the caller graph for this function:

createPath()

bool GNERouteFrame::createPath ( const bool useLastRoute )

protectedvirtual

create path

Reimplemented from GNEFrame.

Definition at line 250 of file GNERouteFrame.cpp.

References GNEAttributeCarrier::getID(), GNE_ATTR_DEMAND_FILE, myPathCreator, myRouteAttributesEditor, myRouteBaseObject, GNEFrame::myViewNet, RouteHandler::parseSumoBaseObject(), SUMO_ATTR_EDGES, SUMO_ATTR_ID, and SUMO_TAG_ROUTE.

demandElementSelected()

void GNEFrame::demandElementSelected ( )

virtualinherited

selected demand element in DemandElementSelector

Reimplemented in GNEContainerFrame, GNEContainerPlanFrame, GNEPersonFrame, GNEPersonPlanFrame, GNEStopFrame, and GNEVehicleFrame.

Definition at line 207 of file GNEFrame.cpp.

focusUpperElement()

void GNEFrame::focusUpperElement ( )

inherited

focus upper element of frame

Definition at line 104 of file GNEFrame.cpp.

References myFrameHeaderLabel.

Referenced by GNEInspectorFrame::inspectClickedElements().

Here is the caller graph for this function:

frameWidthUpdated()

void GNEFrame::frameWidthUpdated ( )

virtualinherited

function called after setting new width in current frame (can be reimplemented in frame children)

Reimplemented in GNETLSEditorFrame.

Definition at line 192 of file GNEFrame.cpp.

Referenced by setFrameWidth().

Here is the caller graph for this function:

getContentFrame()

FXVerticalFrame * GNEFrame::getContentFrame ( ) const

inherited

get vertical frame that holds all widgets of frame

Definition at line 151 of file GNEFrame.cpp.

References myContentFrame.

getFrameHeaderFont()

FXFont * GNEFrame::getFrameHeaderFont ( ) const

inherited

get font of the header's frame

Definition at line 163 of file GNEFrame.cpp.

References myFrameHeaderFont.

getFrameHeaderLabel()

FXLabel * GNEFrame::getFrameHeaderLabel ( ) const

inherited

get the label for the frame's header

Definition at line 157 of file GNEFrame.cpp.

References myFrameHeaderLabel.

Referenced by GNEInspectorFrame::refreshInspection().

Here is the caller graph for this function:

getPathCreator()

GNEPathCreator * GNERouteFrame::getPathCreator

(

)

const

get path creator module

Definition at line 244 of file GNERouteFrame.cpp.

References myPathCreator.

getPredefinedTagsMML()

const std::vector< std::string > & GNEFrame::getPredefinedTagsMML ( ) const

protectedinherited

get predefinedTagsMML

Definition at line 239 of file GNEFrame.cpp.

References myPredefinedTagsMML.

Referenced by GNEContainerFrame::buildContainer(), GNEPersonFrame::buildPerson(), GNEVehicleFrame::buildVehicleOverRoute(), and GNEVehicleFrame::createPath().

Here is the caller graph for this function:

getScrollBarWidth()

int GNEFrame::getScrollBarWidth ( ) const

inherited

get scrollBar width (zero if is hidden)

Definition at line 169 of file GNEFrame.cpp.

References myScrollWindowsContents.

getViewNet()

GNEViewNet * GNEFrame::getViewNet ( ) const

inherited

get view net

Definition at line 145 of file GNEFrame.cpp.

References myViewNet.

Referenced by GNEGenericDataFrame::AttributeSelector::AttributeSelector(), GNEAttributesEditorType::buildRows(), GNEDeleteFrame::SubordinatedElements::checkElements(), GNETLSTable::Column::Column(), GNEDistributionFrame::DistributionSelector::DistributionSelector(), GNEDistributionFrame::DistributionValuesEditor::DistributionValuesEditor(), GNEAdditionalFrame::E2MultilaneLegendModule::E2MultilaneLegendModule(), GNEDemandElementSelector::GNEDemandElementSelector(), GNEMatchAttribute::GNEMatchAttribute(), GNEPathLegendModule::GNEPathLegendModule(), GNECrossingFrame::Information::Information(), GNECreateEdgeFrame::LaneTypeSelector::LaneTypeSelector(), GNEConnectorFrame::Legend::Legend(), GNEProhibitionFrame::Legend::Legend(), GNEMeanDataFrame::MeanDataSelector::MeanDataSelector(), GNEProhibitionFrame::Selection::Selection(), GNESelectorFrame::SelectionHierarchy::SelectionHierarchy(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNEDeleteFrame::SubordinatedElements::SubordinatedElements(), GNETLSEditorFrame::TLSAttributes::TLSAttributes(), GNETLSEditorFrame::TLSJunction::TLSJunction(), GNETLSEditorFrame::TLSPhases::TLSPhases(), and GNETLSEditorFrame::TLSPrograms::TLSPrograms().

Here is the caller graph for this function:

hide()

void GNERouteFrame::hide ( )

virtual

hide delete frame

Reimplemented from GNEFrame.

Definition at line 219 of file GNERouteFrame.cpp.

References GNEFrame::hide(), and GNEFrame::myViewNet.

openHelpAttributesDialog()

void GNEFrame::openHelpAttributesDialog ( const GNEAttributeCarrier * AC ) const

inherited

Open help attributes dialog.

Definition at line 179 of file GNEFrame.cpp.

References myViewNet.

selectedOverlappedElement()

void GNEFrame::selectedOverlappedElement ( GNEAttributeCarrier * AC )

virtualinherited

open GNEAttributesCreator extended dialog

Reimplemented in GNEInspectorFrame, and GNETLSEditorFrame.

Definition at line 226 of file GNEFrame.cpp.

setFrameWidth()

void GNEFrame::setFrameWidth ( const int newWidth )

inherited

set width of GNEFrame

Definition at line 128 of file GNEFrame.cpp.

References frameWidthUpdated(), GUIDesignFrameAreaMargin, myContentFrame, and myScrollWindowsContents.

Referenced by GNEInspectorFrame::refreshInspection().

Here is the caller graph for this function:

shapeDrawed()

bool GNEFrame::shapeDrawed ( )

virtualinherited

build a shaped element using the drawed shape

Reimplemented in GNEShapeFrame, and GNETAZFrame.

Definition at line 213 of file GNEFrame.cpp.

show()

void GNERouteFrame::show ( )

virtual

show delete frame

Reimplemented from GNEFrame.

Definition at line 210 of file GNERouteFrame.cpp.

References myRouteModeSelector, and GNEFrame::show().

Referenced by GNERouteFrame::RouteModeSelector::RouteModeSelector().

Here is the caller graph for this function:

tagSelected()

void GNEFrame::tagSelected ( )

virtualinherited

Tag selected in GNETagSelector.

Reimplemented in GNEAdditionalFrame, GNEContainerFrame, GNEContainerPlanFrame, GNEPersonFrame, GNEPersonPlanFrame, GNEShapeFrame, GNEStopFrame, GNEVehicleFrame, and GNEWireFrame.

Definition at line 201 of file GNEFrame.cpp.

updateFrameAfterUndoRedo()

void GNEFrame::updateFrameAfterUndoRedo ( )

virtualinherited

function called after undo/redo in the current frame (can be reimplemented in frame children)

Reimplemented in GNEGenericDataFrame, GNEInspectorFrame, GNEMeanDataFrame, and GNESelectorFrame.

Definition at line 186 of file GNEFrame.cpp.

Field Documentation

myContentFrame

FXVerticalFrame* GNEFrame::myContentFrame = nullptr

protectedinherited

Vertical frame that holds all widgets of frame.

Definition at line 125 of file GNEFrame.h.

Referenced by getContentFrame(), GNESelectorFrame::getContentFrame(), GNEFrame(), and setFrameWidth().

myFrameHeaderFont

FXFont * GNEFrame::myFrameHeaderFont = nullptr

staticprivateinherited

static Font for the Header (it's common for all headers, then create only one time)

Definition at line 147 of file GNEFrame.h.

Referenced by getFrameHeaderFont(), GNEFrame(), and ~GNEFrame().

myFrameHeaderLabel

FXLabel* GNEFrame::myFrameHeaderLabel = nullptr

privateinherited

the label for the frame's header

Definition at line 150 of file GNEFrame.h.

Referenced by focusUpperElement(), getFrameHeaderLabel(), and GNEFrame().

myHeaderFrame

FXHorizontalFrame* GNEFrame::myHeaderFrame = nullptr

protectedinherited

fame for header elements

Definition at line 128 of file GNEFrame.h.

Referenced by GNEFrame().

myHeaderLeftFrame

FXHorizontalFrame* GNEFrame::myHeaderLeftFrame = nullptr

protectedinherited

fame for left header elements

Definition at line 131 of file GNEFrame.h.

Referenced by GNEFrame(), GNEInspectorFrame::GNEInspectorFrame(), and GNEInspectorFrame::refreshInspection().

myHeaderRightFrame

FXHorizontalFrame* GNEFrame::myHeaderRightFrame = nullptr

protectedinherited

fame for right header elements

Definition at line 134 of file GNEFrame.h.

Referenced by GNEFrame().

myPathCreator

GNEPathCreator* GNERouteFrame::myPathCreator = nullptr

private

path creator modul

Definition at line 148 of file GNERouteFrame.h.

Referenced by addEdgeRoute(), createPath(), getPathCreator(), and GNERouteFrame().

myPathLegend

GNEPathLegendModule* GNERouteFrame::myPathLegend = nullptr

private

path legend modul

Definition at line 151 of file GNERouteFrame.h.

Referenced by GNERouteFrame().

myPredefinedTagsMML

std::vector<std::string> GNEFrame::myPredefinedTagsMML

privateinherited

Map of attribute ids to their (readable) string-representation (needed for SUMOSAXAttributesImpl_Cached).

Definition at line 153 of file GNEFrame.h.

Referenced by getPredefinedTagsMML(), and GNEFrame().

myRouteAttributesEditor

GNEAttributesEditor* GNERouteFrame::myRouteAttributesEditor = nullptr

private

internal route attributes editor

Definition at line 145 of file GNERouteFrame.h.

Referenced by createPath(), and GNERouteFrame().

myRouteBaseObject

CommonXMLStructure::SumoBaseObject* GNERouteFrame::myRouteBaseObject = nullptr

private

route base object

Definition at line 139 of file GNERouteFrame.h.

Referenced by createPath(), GNERouteFrame(), and ~GNERouteFrame().

myRouteModeSelector

RouteModeSelector* GNERouteFrame::myRouteModeSelector = nullptr

private

route mode selector

Definition at line 142 of file GNERouteFrame.h.

Referenced by addEdgeRoute(), GNERouteFrame(), and show().

myScrollWindowsContents

FXScrollWindow* GNEFrame::myScrollWindowsContents = nullptr

privateinherited

scroll windows that holds the content frame

Definition at line 144 of file GNEFrame.h.

Referenced by getScrollBarWidth(), GNEFrame(), and setFrameWidth().

myViewNet

GNEViewNet* GNEFrame::myViewNet = nullptr

protectedinherited

FOX need this.

View Net

Definition at line 122 of file GNEFrame.h.

Referenced by GNEAdditionalFrame::addAdditional(), GNECreateEdgeFrame::addBikelane(), GNEContainerFrame::addContainer(), GNEContainerPlanFrame::addContainerPlanElement(), GNECrossingFrame::addCrossing(), GNEEdgeDataFrame::addEdgeData(), GNERouteFrame::addEdgeRoute(), GNETAZFrame::addOrRemoveTAZMember(), GNEPersonFrame::addPerson(), GNEPersonPlanFrame::addPersonPlanElement(), GNECreateEdgeFrame::addSidewalk(), GNEStopFrame::addStop(), GNEVehicleFrame::addVehicle(), GNEWireFrame::addWire(), GNEConnectorFrame::buildConnection(), GNEContainerFrame::buildContainer(), GNETLSEditorFrame::buildInternalLanes(), GNEPersonFrame::buildPerson(), GNEProhibitionFrame::buildProhibition(), GNETAZRelDataFrame::buildTAZRelationData(), GNEVehicleFrame::buildVehicleOverRoute(), GNEWireFrame::buildWireOverView(), GNETLSEditorFrame::cleanup(), GNEWireFrame::createBaseWireObject(), GNEAdditionalFrame::createPath(), GNEContainerFrame::createPath(), GNEContainerPlanFrame::createPath(), GNEEdgeRelDataFrame::createPath(), GNEPersonFrame::createPath(), GNEPersonPlanFrame::createPath(), GNERouteFrame::createPath(), GNEVehicleFrame::createPath(), GNEWireFrame::createPath(), GNECreateEdgeFrame::disablePedestrians(), GNETAZFrame::dropTAZMembers(), GNETLSEditorFrame::editJunction(), GNETLSEditorFrame::editTLS(), GNEStopFrame::getStopParameter(), getViewNet(), GNEFrame(), GNETypeFrame::GNETypeFrame(), GNETLSEditorFrame::handleChange(), GNESelectorFrame::handleIDs(), GNEConnectorFrame::handleLaneClick(), GNETLSEditorFrame::handleMultiChange(), GNEProhibitionFrame::handleProhibitionClick(), GNEContainerFrame::hide(), GNEContainerPlanFrame::hide(), hide(), GNEGenericDataFrame::hide(), GNEInspectorFrame::hide(), GNEPersonFrame::hide(), GNEPersonPlanFrame::hide(), GNERouteFrame::hide(), GNEVehicleFrame::hide(), GNEAdditionalFrame::initBaseAdditionalObject(), GNEConnectorFrame::initTargets(), GNEInspectorFrame::inspectClickedElements(), GNEInspectorFrame::inspectElement(), GNEInspectorFrame::inspectElements(), GNETLSEditorFrame::isTLSSaved(), GNEProhibitionFrame::Legend::Legend(), openHelpAttributesDialog(), GNETLSEditorFrame::parseTLSPrograms(), GNECreateEdgeFrame::processClick(), GNEShapeFrame::processClick(), GNEShapeFrame::processClickPOI(), GNEShapeFrame::processClickPOIGeo(), GNEShapeFrame::processClickPOILanes(), GNEInspectorFrame::refreshInspection(), GNEDeleteFrame::removeAttributeCarrier(), GNEDeleteFrame::removeGeometryPoint(), GNEDeleteFrame::removeSelectedAttributeCarriers(), GNESelectorFrame::selectAttributeCarrier(), GNEDeleteFrame::selectedACsToDelete(), GNEInspectorFrame::selectedOverlappedElement(), GNEShapeFrame::shapeDrawed(), GNETAZFrame::shapeDrawed(), GNEContainerPlanFrame::show(), show(), GNEMoveFrame::show(), GNEPersonPlanFrame::show(), GNEStopFrame::show(), GNEWireFrame::show(), and GNEAdditionalFrame::tagSelected().

---

The documentation for this class was generated from the following files:

• GNERouteFrame.h
• GNERouteFrame.cpp