GNELane.h

Go to the documentation of this file.

/****************************************************************************/
// A class for visualizing Lane geometry (adapted from GUILaneWrapper)
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2016 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#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 GNEAdditional;
class GNEAdditionalSet;

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

public:
    typedef std::vector<GNEAdditional*> AdditionalVector;

    typedef std::vector<GNEAdditionalSet*> AdditionalSetVector;


    GNELane(GNEEdge& edge, const int index);

    ~GNELane();

    // @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);

    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);

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

    GNEEdge& getParentEdge();

    Boundary getCenteringBoundary() const;

    void drawGL(const GUIVisualizationSettings& s) const;

    const PositionVector& getShape() const;

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

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

    Boundary getBoundary() const;

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

    unsigned int getIndex() const;

    SUMOReal getSpeed() const;

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

    SUMOReal getLaneParametricLenght() const;

    SUMOReal getLaneShapeLenght() const;

    /* @brief returns the relative position of an element in the lane's shape depending of the parametric lenght
     *        Examples: Lane with Parametric lenght = 100 and Shape lenght = 250. Position 50 returns 125, Position 80 returns 200
     * @param[in] position to calculate their relative position in the lane's shape [0 < position < LaneParametricLenght()]
     * @return the relative position in the lane's shape
     */
    SUMOReal getPositionRelativeToParametricLenght(SUMOReal position) const;

    /* @brief returns the relative position of an element in the lane's shape depending of the shape's lenght
     *        Examples: Lane with Parametric lenght = 100 and Shape lenght = 250. Position = 100 returns 40, Position 220 returns 88
     * @param[in] position to calculate their relative position in the lane's shape [0 < position < LaneShapeLenght]
     * @return the relative position in the lane's shape
     */
    SUMOReal getPositionRelativeToShapeLenght(SUMOReal position) const;

    /* @brief method for adding a reference of a additional element placed in this lane
     * @param[in] additional Pointer to additional element
     */
    void addAdditional(GNEAdditional* additional);

    /* @brief method for remove a reference of a additional element placed in this lane
     * @param[in] additional Pointer to additional element previously added
       @return true if additional element was sucesfully removed, flase in other case
     */
    bool removeAdditional(GNEAdditional* additional);

    const std::vector<GNEAdditional*>& getAdditionals() const;

    bool addAdditionalSet(GNEAdditionalSet* additionalSet);

    bool removeAdditionalSet(GNEAdditionalSet* additionalSet);

    const std::vector<GNEAdditionalSet*>& getAdditionalSets();

    /* @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;

    /* @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);

protected:
    GNELane();

    GNEEdge& myParentEdge;

    int myIndex;

    std::vector<SUMOReal> myShapeRotations;

    std::vector<SUMOReal> myShapeLengths;

    AdditionalVector myAdditionals;

    AdditionalSetVector myAdditionalSets;

    const RGBColor* mySpecialColor;

    mutable std::vector<RGBColor> myShapeColors;

    GNETLSEditorFrame* myTLSEditor;

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

    GNELane(const GNELane&);

    GNELane& operator=(const GNELane&);

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

    void drawLinkNo() const;

    void drawTLSLinkNo() const;

    void drawLinkRules() const;

    void drawArrows() const;

    void drawLane2LaneConnections() const;

    SUMOReal getColorValue(size_t activeScheme) const;

    bool setFunctionalColor(size_t activeScheme) const;

    bool setMultiColor(const GUIColorer& c) const;

    bool drawAsRailway(const GUIVisualizationSettings& s) const;

    bool drawAsWaterway(const GUIVisualizationSettings& s) const;

    void drawCrossties(SUMOReal length, SUMOReal spacing, SUMOReal halfWidth) const;
};


#endif

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