GNELane.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2017 German Aerospace Center (DLR) and others.
/****************************************************************************/
//
//   This program and the accompanying materials
//   are made available under the terms of the Eclipse Public License v2.0
//   which accompanies this distribution, and is available at
//   http://www.eclipse.org/legal/epl-v20.html
//
/****************************************************************************/
// A class for visualizing Lane geometry (adapted from GUILaneWrapper)
/****************************************************************************/
#ifndef GNELane_h
#define GNELane_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include "GNENetElement.h"

// ===========================================================================
// class declarations
// ===========================================================================
class GUIGLObjectPopupMenu;
class PositionVector;
class GNETLSEditorFrame;
class GNEEdge;
class GNENet;
class GNEConnection;
class GNEShape;

// ===========================================================================
// class definitions
// ===========================================================================
class GNELane : public GNENetElement, public FXDelegator {
    FXDECLARE(GNELane)

public:

    GNELane(GNEEdge& edge, const int index);

    ~GNELane();

    GNEEdge& getParentEdge();

    std::vector<GNEConnection*> getGNEIncomingConnections();

    std::vector<GNEConnection*> getGNEOutcomingConnections();

    // update IDs of incoming connections of this lane
    void updateConnectionIDs();

    // @brief Returns the name of the parent object (if any)
    // @return This object's parent id
    const std::string& getParentName() const;

    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);

    long onDefault(FXObject*, FXSelector, void*);

    Boundary getCenteringBoundary() const;

    void drawGL(const GUIVisualizationSettings& s) const;

    const PositionVector& getShape() const;

    const std::vector<double>& getShapeRotations() const;

    const std::vector<double>& getShapeLengths() const;

    Boundary getBoundary() const;

    //  @note: must be called when geometry changes (i.e. junction moved)
    void updateGeometry();

    int getIndex() const;

    double getSpeed() const;

    /* @brief method for setting the index of the lane
     * @param[in] index The new index of lane
     */
    void setIndex(int index);

    double getLaneParametricLength() const;

    double getLaneShapeLength() const;

    void addShapeChild(GNEShape* shape);

    void removeShapeChild(GNEShape* shape);

    const std::vector<GNEShape*>& getShapeChilds() const;

    bool isRestricted(SUMOVehicleClass vclass) const;

    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    std::string getAttribute(SumoXMLAttr key) const;
    std::string getAttributeForSelection(SumoXMLAttr key) const;

    /* @brief method for setting the attribute and letting the object perform additional changes
     * @param[in] key The attribute key
     * @param[in] value The new value
     * @param[in] undoList The undoList on which to register changes
     */
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);

    /* @brief method for checking if the key and their correspond attribute are valids
     * @param[in] key The attribute key
     * @param[in] value The value asociated to key key
     * @return true if the value is valid, false in other case
     */
    bool isValid(SumoXMLAttr key, const std::string& value);

    /* @brief method for setting the special color of the lane
     * @param[in] color Pointer to new special color
     */
    void setSpecialColor(const RGBColor* Color2);

    double getColorValue(int activeScheme) const;

    void removeLaneOfAdditionalParents(GNEUndoList* undoList, bool allowEmpty);

protected:
    GNELane();

    GNEEdge& myParentEdge;

    int myIndex;

    std::vector<double> myShapeRotations;

    std::vector<double> myShapeLengths;

    std::vector<Position> myLaneRestrictedTexturePositions;

    std::vector<double> myLaneRestrictedTextureRotations;

    std::vector<GNEShape*> myShapes;

    const RGBColor* mySpecialColor;

    mutable std::vector<RGBColor> myShapeColors;

    GNETLSEditorFrame* myTLSEditor;

private:
    void setAttribute(SumoXMLAttr key, const std::string& value);

    void drawMarkings(const bool& selectedEdge, double scale) const;

    void drawLinkNo(const GUIVisualizationSettings& s) const;

    void drawTLSLinkNo(const GUIVisualizationSettings& s) const;

    void drawLinkRules() const;

    void drawArrows() const;

    void drawLane2LaneConnections() const;

    bool setFunctionalColor(int activeScheme) const;

    bool setMultiColor(const GUIColorer& c) const;

    bool drawAsRailway(const GUIVisualizationSettings& s) const;

    bool drawAsWaterway(const GUIVisualizationSettings& s) const;

    void drawCrossties(double length, double spacing, double halfWidth) const;

    void drawDirectionIndicators() const;

    void setLaneColor(const GUIVisualizationSettings& s) const;

    GNELane(const GNELane&) = delete;

    GNELane& operator=(const GNELane&) = delete;
};


#endif

/****************************************************************************/